Stock Query

Operations related to stock availability checking

Check Stock Availability on Selected Locations

get

Check if all requested SKUs can be fulfilled from the specified stock locations. This endpoint is optimized for basket/cart validation scenarios where you need to verify that all items in a basket can be fulfilled from specific stock locations.

Key Features:

• Supports multiple SKUs and multiple stock locations

• Checks available stock after considering reservations

• Returns fulfillment status per stock location

• Supports filtering by ERP codes or tags

• Optimized with bulk queries for performance

Business Logic:

• For each stock location, checks if ALL requested SKUs are available

• Available stock = Total stock - Reserved stock

• Returns true only if ALL SKUs can be fulfilled from that location

• Considers quantity requirements (duplicate SKUs in the list)

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Query parameters

skustring[] · min: 1 · max: 100Required

Product SKU(s) to check availability for. Can be specified multiple times for multiple products. Duplicate SKUs are counted as quantity requirements.

Example: {"summary":"Single SKU","value":["ABC123"]}

erp_codestring[] · max: 50Optional

ERP code(s) of specific stock locations to check. Can be specified multiple times. If not provided, all active stock locations will be considered.

Example: {"summary":"Single Location","value":["WH001"]}

tagstring[] · max: 20Optional

Tag name(s) to filter stock locations by tags. Can be specified multiple times. Only stock locations with matching tags will be considered.

Example: {"summary":"Single Tag","value":["fast-delivery"]}

Responses

200

Stock availability check completed successfully. Returns fulfillment status for each stock location.

application/json

Other propertiesbooleanOptional

True if the stock location can fulfill ALL requested SKUs, false otherwise

400

Bad Request - Invalid parameters or no valid stock locations found

application/json

422

Unprocessable Entity - Request validation failed

application/json

500

Internal Server Error - Unexpected server error occurred

application/json

get

/query-stock-availability

HTTPcURLJavaScriptPython

GET /api/v1/oms/query-stock-availability?sku=text HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "WH001": true,
  "WH002": true,
  "STORE01": true
}