Update an inventory stock location

How to update an existing inventory stock location via API

To update an existing inventory stock location, send a PATCH request to the /api/inventory_stock_locations/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://yourdomain.commercelayer.io/api/inventory_stock_locations/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.priority

integer

Optional

attributes.on_hold

boolean

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.stock_location

object

Optional

relationships.inventory_model

object

Optional

Example

The following request updates the inventory stock location identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/inventory_stock_locations/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "inventory_stock_locations",
    "id": "xYZkjABcde",
    "attributes": {
      "on_hold": false
    },
    "relationships": {
      "stock_location": {
        "data": {
          "type": "stock_locations",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Last updated