Retrieve a reserved stock
How to fetch a specific reserved stock via API
To fetch a single reserved stock, send a
GET request to the /api/reserved_stocks/:id endpoint, where id is the ID of the resource that you want to retrieve.GET https://yourdomain.commercelayer.io/api/reserved_stocks/:id
Request
Response
The following request fetches the reserved stock identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/reserved_stocks/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:{
"data": {
"id": "xYZkjABcde",
"type": "reserved_stocks",
"links": {
"self": "https://yourdomain.commercelayer.io/api/reserved_stocks/xYZkjABcde"
},
"attributes": {
"quantity": 100,
"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": {
"stock_item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/reserved_stocks/xYZkjABcde/relationships/stock_item",
"related": "https://yourdomain.commercelayer.io/api/reserved_stocks/xYZkjABcde/stock_item"
}
},
"sku": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/reserved_stocks/xYZkjABcde/relationships/sku",
"related": "https://yourdomain.commercelayer.io/api/reserved_stocks/xYZkjABcde/sku"
}
},
"stock_reservations": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/reserved_stocks/xYZkjABcde/relationships/stock_reservations",
"related": "https://yourdomain.commercelayer.io/api/reserved_stocks/xYZkjABcde/stock_reservations"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 4mo ago