InventoryOrders

Export an Inventory Order

This endpoint queues an export of an inventory order for the given site.

get/inventory/orders/{orderId}/queue

Path parameters

orderIdstring uuid required

Identifier of the inventory order whose queued job status is being fetched. Queue endpoints return progress for async operations (sending, receiving, exporting); poll until the job completes.

Query parameters

site_idstring uuid required

Filter the InventoryOrder by site.

brand_idsstring[]

A comma-separated list of brand IDs to retrieve inventory order items for.

category_idsstring[]

A comma-separated list of category IDs to retrieve inventory order items for.

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.