Stock balances identify how many physical units of a product is available in specific warehouses.
Creates new or updates existing reservations in the warehouse management system.
name | type | description |
---|---|---|
X-Instance-Id | header | Identifies the merchant instance, required for all API calls. |
X-Language | header | Specifies the requested language of a resource, for example sv . If not present, this will default to a pre-configured language, most commonly en . |
media type | data type | description |
---|---|---|
application/json | array of ReservationRequest | The reservations to create or update. |
code | condition |
---|---|
204 | The reservations were successfully created or updated. |
400 | Given input parameters are incorrect, a more descriptive error message is provided in the response body. |
media type | data type | description |
---|---|---|
application/json | object |
POST /warehouse-management/stock-balance/reservations
Content-Type: application/json
Accept: application/json
X-Instance-Id: ...
X-Language: ...
[ {
"stockKeepingUnitId" : 12345,
"priceLookupUnitNumber" : "...",
"warehouseId" : 12345,
"reference" : "...",
"desiredQuantity" : 12345
} ]
HTTP/1.1 204 No Content
Content-Type: application/json
...
Searches for stock balances in the system.
name | type | description | default | constraints | multivalued |
---|---|---|---|---|---|
X-Instance-Id | header | Identifies the merchant instance, required for all API calls. | no | ||
X-Language | header | Specifies the requested language of a resource, for example sv . If not present, this will default to a pre-configured language, most commonly en . |
no | ||
europeanArticleNumber | query | Filter on the European article number of stock keeping units. | yes | ||
modifiedAfter | query | Filter on last modification date. Useful for getting delta-changes. More details. | no | ||
page | query | The page to search for. | 1 | int | no |
priceLookupUnitNumber | query | Filter on the price lookup unit number of stock keeping units. | yes | ||
resultsPerPage | query | The number of results per page. Must be a value between 1 and 200 . |
int | no | |
searchId | query | The search ID to use for continued pages. Not usable together with any of the filters. More details. | no | ||
stockKeepingUnitId | query | Filter on the internal identifier of stock keeping units. | int | yes | |
warehouseId | query | Filter on warehouse by their internal number. | int | yes |
code | condition |
---|---|
200 | The search was successful. |
400 | Given input parameters are incorrect, a more descriptive error message is provided in the response body. |
media type | data type | description |
---|---|---|
application/json | StockBalanceResult | The search result. |
GET /warehouse-management/stock-balance/stock-balances
Content-Type: */*
Accept: application/json
X-Instance-Id: ...
X-Language: ...
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"searchId" : "...",
"page" : 12345,
"totalHits" : 12345,
"pagesLeft" : 12345,
"stockBalances" : [ {
"stockKeepingUnitId" : 12345,
"priceLookupUnitNumber" : "...",
"europeanArticleNumber" : "...",
"warehouseId" : 12345,
"balance" : 12345,
"availableBalance" : 12345,
"modifiedAt" : "2024-03-21T14:36:43.412+01:00"
}, {
"stockKeepingUnitId" : 12345,
"priceLookupUnitNumber" : "...",
"europeanArticleNumber" : "...",
"warehouseId" : 12345,
"balance" : 12345,
"availableBalance" : 12345,
"modifiedAt" : "..."
} ]
}
Creates new or updates existing stock balances in the warehouse management system.
name | type | description |
---|---|---|
X-Instance-Id | header | Identifies the merchant instance, required for all API calls. |
X-Language | header | Specifies the requested language of a resource, for example sv . If not present, this will default to a pre-configured language, most commonly en . |
media type | data type | description |
---|---|---|
application/json | array of StockBalanceUpdate | The stock balances to create or update. |
code | condition |
---|---|
204 | The stock balances were successfully created or updated. |
400 | Given input parameters are incorrect, a more descriptive error message is provided in the response body. |
media type | data type | description |
---|---|---|
application/json | object |
POST /warehouse-management/stock-balance/stock-balances
Content-Type: application/json
Accept: application/json
X-Instance-Id: ...
X-Language: ...
[ {
"stockKeepingUnitId" : 12345,
"priceLookupUnitNumber" : "...",
"warehouseId" : 12345,
"balance" : 12345
} ]
HTTP/1.1 204 No Content
Content-Type: application/json
...