This method allows to get the amount of items reserved and their available quantity.
Use
Method | Url |
---|---|
GET | /restful/ghost/orders/dropshipping/locked/ |
Request Headers
This method works using JSON or XML format, set the following headers to choose the format you want to use:
Key | Value |
---|---|
Accept | application/xml or application/json |
Content-type | application/xml or application/json |
Authentication
Remember to authenticate properly, using HTTP Basic Authentication with your API-Key as username and your password.
Response Body
The response body contains a list of the model in the reservation. Each model has three attributes:
- stock_id : the numerical id of the model
- locked : the amount of locked quantity
- available : the amount of model still available.
Example XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root order_id="1000">
<model stock_id="3" locked="11" available="5" />
<model stock_id="5" locked="33" available="2" />
< model stock_id="29" locked="5" available="1" />
<model stock_id="55" locked="2" available="11" />
<model stock_id="120" locked="1" available="120" />
<model stock_id="133" locked="9" available="0" />
</root>
Example JSON Response
{
"models": [
{
"stock_id": 1578,
"locked": 2,
"available": 0
},
{
"stock_id": 1567,
"locked": 1,
"available": 0
}
],
"order_id": 0
}