Retrieve an inventory model How to fetch a specific inventory model via API
To fetch a single inventory model, send a GET
request to the /api/inventory_models/:id
endpoint, where id
is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/inventory_models/:id
Example
Request Response
The following request fetches the inventory model identified by the id "xYZkjABcde":
Copy curl - g - X GET \
'https://yourdomain.commercelayer.io/api/inventory_models/xYZkjABcde' \
- H 'Accept: application/vnd.api+json' \
- H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK
status code, returning a single resource object:
Copy {
"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 ,
"manual_stock_decrement" : 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 updated 3 months ago