Skip to main content

List Source Allocations

GET 

/api/walmart/:integrationInstance/wfs/inbound-shipments/:shipment/allocations

Paginated source-stock reservations (inventory allocations) for this inbound — the source-warehouse reservations created when the inbound was made so the earmarked stock can't be oversold. Scoped to all shipments sharing the inbound order (split inbounds), plus any reservations handed off to a materialized Warehouse Transfer.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Filters:

  • filter[status]: exact allocation status (e.g. allocated, cancelled, fulfilled).
  • filter[warehouse_id]: exact source warehouse id.
  • filter[search]: allocation id (when numeric) or product SKU / name.

Sorts (via sort): id, quantity, status, created_at. Prefix with - for descending. Default -id.

Pagination: page, per_page (default 10).

Request

Responses

OK

Response Headers
    Content-Type