Skip to main content
GET
Check inventory

Authorizations

Authorization
string
header
required

Access token

Path Parameters

order_number
string
required

Order number

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]{1,128}$

Query Parameters

fulfillment_type
enum<string>

Optional. The fulfillment type to evaluate inventory against. If not provided, the inventory will be checked for the fulfillment_type of the shipment.

Available options:
delivery,
collect-in-store
shipment_number
string

Optional. The shipment number to check inventory for. If not provided, the inventory will be checked for the unscheduled shipment of the order.

Response

OK

message
string
required
success
boolean
required
content
object
required