Comment on page
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.POST https://yourdomain.commercelayer.io/api/inventory_models
Body Parameter | Type | Required |
|---|---|---|
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.reference | string | Optional |
attributes.reference_origin | string | Optional |
attributes.metadata | object | Optional |
Request
Response
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"
}
}
}'
On success, the API responds with a
201 Created status code, returning the created resource object:{
"data": {
"id": "xYZkjABcde",
"type": "inventory_models",
"links": {
"self": "https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde"
},
"attributes": {
"name": "EU Inventory Model",
"strategy": "no_split",
"stock_locations_cutoff": 3,
"stock_reservation_cutoff": 3600,
"put_stock_transfers_on_hold": true,
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"inventory_stock_locations": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde/relationships/inventory_stock_locations",
"related": "https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde/inventory_stock_locations"
}
},
"inventory_return_locations": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde/relationships/inventory_return_locations",
"related": "https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde/inventory_return_locations"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde/attachments"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 1mo ago