Update Location Profile

curl --request PUT \
  --url https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Rack Pick Face",
  "description": "Pickable shelf locations on rack aisles, excluding ground-level overflow.",
  "match": [
    {
      "field": "location_label",
      "operator": "starts_with",
      "values": [
        "RK"
      ]
    },
    {
      "field": "slot_type",
      "operator": "is_one_of",
      "values": [
        4
      ]
    },
    {
      "cel": "is_pickable"
    }
  ]
}
'

import requests

url = "https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}"

payload = {
    "name": "Rack Pick Face",
    "description": "Pickable shelf locations on rack aisles, excluding ground-level overflow.",
    "match": [{
            "field": "location_label",
            "operator": "starts_with",
            "values": ["RK"]
        }, {
            "field": "slot_type",
            "operator": "is_one_of",
            "values": [4]
        }, { "cel": "is_pickable" }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Rack Pick Face',
    description: 'Pickable shelf locations on rack aisles, excluding ground-level overflow.',
    match: [
      {field: 'location_label', operator: 'starts_with', values: ['RK']},
      {field: 'slot_type', operator: 'is_one_of', values: [4]},
      {cel: 'is_pickable'}
    ]
  })
};

fetch('https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Rack Pick Face',
    'description' => 'Pickable shelf locations on rack aisles, excluding ground-level overflow.',
    'match' => [
        [
                'field' => 'location_label',
                'operator' => 'starts_with',
                'values' => [
                                'RK'
                ]
        ],
        [
                'field' => 'slot_type',
                'operator' => 'is_one_of',
                'values' => [
                                4
                ]
        ],
        [
                'cel' => 'is_pickable'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}"

	payload := strings.NewReader("{\n  \"name\": \"Rack Pick Face\",\n  \"description\": \"Pickable shelf locations on rack aisles, excluding ground-level overflow.\",\n  \"match\": [\n    {\n      \"field\": \"location_label\",\n      \"operator\": \"starts_with\",\n      \"values\": [\n        \"RK\"\n      ]\n    },\n    {\n      \"field\": \"slot_type\",\n      \"operator\": \"is_one_of\",\n      \"values\": [\n        4\n      ]\n    },\n    {\n      \"cel\": \"is_pickable\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Rack Pick Face\",\n  \"description\": \"Pickable shelf locations on rack aisles, excluding ground-level overflow.\",\n  \"match\": [\n    {\n      \"field\": \"location_label\",\n      \"operator\": \"starts_with\",\n      \"values\": [\n        \"RK\"\n      ]\n    },\n    {\n      \"field\": \"slot_type\",\n      \"operator\": \"is_one_of\",\n      \"values\": [\n        4\n      ]\n    },\n    {\n      \"cel\": \"is_pickable\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Rack Pick Face\",\n  \"description\": \"Pickable shelf locations on rack aisles, excluding ground-level overflow.\",\n  \"match\": [\n    {\n      \"field\": \"location_label\",\n      \"operator\": \"starts_with\",\n      \"values\": [\n        \"RK\"\n      ]\n    },\n    {\n      \"field\": \"slot_type\",\n      \"operator\": \"is_one_of\",\n      \"values\": [\n        4\n      ]\n    },\n    {\n      \"cel\": \"is_pickable\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "There was an error processing the request."
    }
  ]
}

Location Profiles

Update Location Profile

Updates the Location Profile identified by the id and profile_id path parameters. Only the properties present in the body are applied.

Omitting match keeps the saved definition; send match: [] to mean “every non-temporary location in the warehouse” explicitly.

Returns 202 Accepted when the request started a new materialization, and 200 OK when the definition was unchanged and a published revision is already serving the profile. An unchanged definition submitted while a build is still in flight also returns 202, because the submitted definition has not published yet. During a replacement, status may remain ready because the previous revision still serves consumers. Poll pending_revision instead: successful publication is complete when it becomes null, while a failed replacement remains present with a failed status.

PUT

inventory

warehouses

{id}

location-profiles

{profile_id}

Update Location Profile

curl --request PUT \
  --url https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Rack Pick Face",
  "description": "Pickable shelf locations on rack aisles, excluding ground-level overflow.",
  "match": [
    {
      "field": "location_label",
      "operator": "starts_with",
      "values": [
        "RK"
      ]
    },
    {
      "field": "slot_type",
      "operator": "is_one_of",
      "values": [
        4
      ]
    },
    {
      "cel": "is_pickable"
    }
  ]
}
'

import requests

url = "https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}"

payload = {
    "name": "Rack Pick Face",
    "description": "Pickable shelf locations on rack aisles, excluding ground-level overflow.",
    "match": [{
            "field": "location_label",
            "operator": "starts_with",
            "values": ["RK"]
        }, {
            "field": "slot_type",
            "operator": "is_one_of",
            "values": [4]
        }, { "cel": "is_pickable" }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Rack Pick Face',
    description: 'Pickable shelf locations on rack aisles, excluding ground-level overflow.',
    match: [
      {field: 'location_label', operator: 'starts_with', values: ['RK']},
      {field: 'slot_type', operator: 'is_one_of', values: [4]},
      {cel: 'is_pickable'}
    ]
  })
};

fetch('https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Rack Pick Face',
    'description' => 'Pickable shelf locations on rack aisles, excluding ground-level overflow.',
    'match' => [
        [
                'field' => 'location_label',
                'operator' => 'starts_with',
                'values' => [
                                'RK'
                ]
        ],
        [
                'field' => 'slot_type',
                'operator' => 'is_one_of',
                'values' => [
                                4
                ]
        ],
        [
                'cel' => 'is_pickable'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}"

	payload := strings.NewReader("{\n  \"name\": \"Rack Pick Face\",\n  \"description\": \"Pickable shelf locations on rack aisles, excluding ground-level overflow.\",\n  \"match\": [\n    {\n      \"field\": \"location_label\",\n      \"operator\": \"starts_with\",\n      \"values\": [\n        \"RK\"\n      ]\n    },\n    {\n      \"field\": \"slot_type\",\n      \"operator\": \"is_one_of\",\n      \"values\": [\n        4\n      ]\n    },\n    {\n      \"cel\": \"is_pickable\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Rack Pick Face\",\n  \"description\": \"Pickable shelf locations on rack aisles, excluding ground-level overflow.\",\n  \"match\": [\n    {\n      \"field\": \"location_label\",\n      \"operator\": \"starts_with\",\n      \"values\": [\n        \"RK\"\n      ]\n    },\n    {\n      \"field\": \"slot_type\",\n      \"operator\": \"is_one_of\",\n      \"values\": [\n        4\n      ]\n    },\n    {\n      \"cel\": \"is_pickable\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/location-profiles/{profile_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Rack Pick Face\",\n  \"description\": \"Pickable shelf locations on rack aisles, excluding ground-level overflow.\",\n  \"match\": [\n    {\n      \"field\": \"location_label\",\n      \"operator\": \"starts_with\",\n      \"values\": [\n        \"RK\"\n      ]\n    },\n    {\n      \"field\": \"slot_type\",\n      \"operator\": \"is_one_of\",\n      \"values\": [\n        4\n      ]\n    },\n    {\n      \"cel\": \"is_pickable\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "There was an error processing the request."
    }
  ]
}

Authorizations

Authorization

string

header

required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

integer<int32>

required

The id of the referenced Warehouse.

profile_id

integer<int32>

required

The id of the referenced LocationProfile.

Body

application/json

The body of a Location Profile update request. Every property is optional and only the ones present are applied.

Omitting match keeps the saved definition — it never clears it to the all-locations one. Send match: [] to mean "every non-temporary location in the warehouse" explicitly. A profile that has no saved definition at all (a legacy record) must be sent a match.

name

string

The profile name, which must be unique within the warehouse.

Required string length: 1 - 255

Example:

"Rack Pick Face"

description

string | null

An optional explanation of the locations represented by this profile. Send null to clear it.

Maximum string length: 16000

Example:

"Pickable shelf locations on rack aisles, excluding ground-level overflow."

match

LocationProfileMatchClauseInput · object[]

Replaces the ordered clauses defining membership. Sending a definition that differs from the saved one starts a new materialization. A definition accepts at most 64 clauses, 250 values per clause, 1,000 values across all clauses, and 512 KiB of JSON.

Maximum array length: 64

Show child attributes

Example:

[
  {
    "field": "location_label",
    "operator": "starts_with",
    "values": ["RK"]
  },
  {
    "field": "slot_type",
    "operator": "is_one_of",
    "values": [4]
  },
  { "cel": "is_pickable" }
]

Response

OK - The operation completed successfully and there is no response body.

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Update Location Profile

Authorizations

Path Parameters

Body

Response