Stock balance API Resource

Stock balances identify how many physical units of a product is available in specific warehouses.

POST /warehouse-management/stock-balance/reservations

Creates new or updates existing reservations in the warehouse management system.

Request Parameters
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. This header belongs to the legacy authentication. When authenticating with OAuth, use V-Language-Code instead.
Request Body
media type data type description
application/json array of ReservationRequest The reservations to create or update.
Response Codes
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.

Example

Request
POST /warehouse-management/stock-balance/reservations
Content-Type: application/json
X-Instance-Id: ...
X-Language: ...

                
[ {
  "stockKeepingUnitId" : 12345,
  "priceLookUpNumber" : "...",
  "warehouseId" : 12345,
  "warehouseNumber" : "...",
  "reference" : "...",
  "desiredQuantity" : 12345
} ]
Response
HTTP/1.1 204 No Content

GET /warehouse-management/stock-balance/stock-balances

Searches for stock balances in the system.

Request Parameters
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. This header belongs to the legacy authentication. When authenticating with OAuth, use V-Language-Code instead.     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
priceLookUpNumber query Filter on the price look-up number of stock keeping units.     yes
priceLookupNumber query Filter on the price look-up number of stock keeping units. Deprecated in favor of priceLookUpNumber due to a typo.     yes
priceLookupUnitNumber query Filter on the price look-up number of stock keeping units. Deprecated in favor of priceLookUpNumber due to a typo.     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
warehouseNumber query Filter on the external number of warehouses.     yes
Response Codes
code condition
200 The search was successful.
400 Given input parameters are incorrect, a more descriptive error message is provided in the response body.
Response Body
media type data type description
application/json StockBalanceResult The search result.

Example

Request
GET /warehouse-management/stock-balance/stock-balances
Content-Type: */*
Accept: application/json
X-Instance-Id: ...
X-Language: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "searchId" : "236c000d-70a8-4a6c-beed-36e788c107b9",
  "page" : 1,
  "pagesLeft" : 1,
  "totalHits" : 29,
  "stockBalances" : [ {
    "stockKeepingUnitId" : 619,
    "priceLookUpNumber" : "14114192",
    "europeanArticleNumber" : "14114192",
    "warehouseId" : 1,
    "balance" : 12,
    "availableBalance" : 9,
    "balanceIncoming" : 5,
    "modifiedAt" : "2024-03-21T14:36:43.412+01:00",
    "warehouseNumber" : "W01",
    "estimatedDeliveryDate" : "2024-02-15",
    "estimatedShippingDate" : "2024-10-25"
  }, {
    "stockKeepingUnitId" : 12345,
    "priceLookUpNumber" : "...",
    "europeanArticleNumber" : "...",
    "warehouseId" : 12345,
    "balance" : 12345,
    "availableBalance" : 12345,
    "balanceIncoming" : 12345,
    "modifiedAt" : "...",
    "warehouseNumber" : "...",
    "estimatedDeliveryDate" : "...",
    "estimatedShippingDate" : "..."
  } ]
}

POST /warehouse-management/stock-balance/stock-balances

Creates new or updates existing stock balances in the warehouse management system.

Request Parameters
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. This header belongs to the legacy authentication. When authenticating with OAuth, use V-Language-Code instead.
Request Body
media type data type description
application/json array of StockBalanceUpdate The stock balances to create or update.
Response Codes
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.

Example

Request
POST /warehouse-management/stock-balance/stock-balances
Content-Type: application/json
X-Instance-Id: ...
X-Language: ...

                
[ {
  "stockKeepingUnitId" : 12345,
  "priceLookUpNumber" : "...",
  "warehouseId" : 12345,
  "warehouseNumber" : "...",
  "balance" : 12345,
  "balanceIncoming" : 12345,
  "estimatedShippingDate" : "2024-10-25",
  "estimatedDeliveryDate" : "2024-09-12"
} ]
Response
HTTP/1.1 204 No Content

POST /warehouse-management/stock-balance/stock-balances/_reserve

Runs the order reservation routine for the given stock keeping units or whole products, recomputing reserved/not-reserved balances against open order demand.

Each item identifies either a stockKeepingUnitId or a productId (which targets all of the product's stock keeping units). An optional warehouseId may be given per item to limit the run to a single warehouse. Package (master) articles are not supported.

Note: This run does not re-divide order rows across warehouses. On installs with several active outdelivery warehouses per country, restocking one warehouse will not move order rows already assigned to another warehouse. It also does not trigger ship-from-store processing.

Request Parameters
name type description default constraints
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. This header belongs to the legacy authentication. When authenticating with OAuth, use V-Language-Code instead.    
skipWhenNothingToReserve query If true, the run is skipped for products that have no reserved, incoming-reserved or not-reserved balances. Useful for automated callers that run reservation frequently. Defaults to false. false boolean
Request Body
media type data type description
application/json array of ReservationRunRequest The stock keeping units or products to run reservation for.
Response Codes
code condition
200 The reservation run completed. The body indicates whether any reservation work was performed.
400 Given input parameters are incorrect, a more descriptive error message is provided in the response body.
Response Body
media type data type description
application/json ReservationRunResult

Example

Request
POST /warehouse-management/stock-balance/stock-balances/_reserve
Content-Type: application/json
Accept: application/json
X-Instance-Id: ...
X-Language: ...

                
[ {
  "stockKeepingUnitId" : 619,
  "productId" : 42,
  "warehouseId" : 1
} ]
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "reserved" : true
}