Create an inventory model

How to create an inventory model via API

To create a new inventory model, send a POST request to the /api/inventory_models endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/inventory_models

Arguments

Body ParameterTypeRequired

type

string

Required

attributes.name

string

Required

attributes.strategy

string

Optional, default is no_split

attributes.stock_locations_cutoff

integer

Optional, default is 2

attributes.stock_reservation_cutoff

integer

Optional, default is 3600

attributes.put_stock_transfers_on_hold

boolean

Optional, default is 'false'

attributes.manual_stock_decrement

boolean

Optional, default is 'false'

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

Example

The following request creates a new inventory model:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/inventory_models' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "inventory_models",
    "attributes": {
      "name": "EU Inventory Model"
    }
  }
}'

Last updated