GENERAL INFORMATION
This API is used to inform us about the stock that is not available for replenishment. An example would be an allocation put on the stock by a sales order from a sales channel not managed by Wair (for example a B2C E-Commerce order or a B2B sales order still pending fulfilment).
We highly recommend implementing this endpoint with the fullLoad parameter set to true, so you can send the current unavailable stock in one go, without having to track and update previously sent values.
REQUEST
Authentication
Bearer token, information on page POST /Token
Headers
Name | Description | Example |
|---|---|---|
X-Tenant | Tenant code supplied by Wair | “TENANT” |
QueryParameters:
Name | Description | Example |
|---|---|---|
fullLoad | See documentation: Integration core principles | true |
moreRecordsAvailable | See documentation: Integration core principles | false |
Body example:
{
"stockNotForReplenishment": [
{
"id": "guid01",
"locationId": "guid01",
"skuId": "guid01",
"startDateTime": "2025-04-18T07:49:16.578Z",
"endDateTime": "2025-04-18T07:49:16.578Z",
"quantity": 10
}
]
}Additional information:
id = unique id of the unavailable stock. If you decide to send your allocations always with the fullLoad parameter set to true (as recommended), a randomly generated guid will work. Other possible solutions would be to use the unique id of the document which put the allocation on the stock (weborder/sales order), combined with a skuId and possibly a line number to maintain uniqueness.
locationId = this is the id of the (replenishment)location, which needs to match the id that you also send in the POST /Locations endpoint.
skuId = this is the id of sku the allocation is on.
startDateTime = the date/time from where the stock has becomes unavailable for replenishment. This is a mandatory field, but if there is no actual data available in the source system any date in the past is accepted. For example a calculated date/time of yesterday or a hardcoded "1970-01-01T00:00:00.000Z" will do the trick.
endDateTime = when the stock becomes available again. Not a required field, if this is not present in the source system it can be set to null.
quantity = how much stock is unavailable for replenishment.
RESPONSE
StatusCodes:
200 = OK
401 = Unauthorized, which means an expired/missing/invalid token
400 = Bad request, see body of the response to check which validation errors have occured
500 = System error, see body of the response to check which error has occured or contact integration support
Body Example:
No body in the response.