Update an inventory model

How to update an existing inventory model via API

To update an existing inventory model, send a PATCH request to the /api/inventory_models/: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_models/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.name

string

Optional

attributes.strategy

string

Optional

attributes.stock_locations_cutoff

integer

Optional

attributes.stock_reservation_cutoff

integer

Optional

attributes.put_stock_transfers_on_hold

boolean

Optional

attributes.manual_stock_decrement

boolean

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

Example

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

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "inventory_models",
    "id": "xYZkjABcde",
    "attributes": {
      "reference": "ANY-EXTERNAL-REFEFERNCE"
    }
  }
}'

Last updated