List orders
/v1/organizations/{orgId}/ordersAuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
AuthorizationBearer token (Vault TEST service token) · headerrequiredCustomer- and resource-bound service grant, rechecked on every call. Existing Live opening-feed authority remains narrow; ordinary Test business requests refuse until shared Test composition is available.
AuthorizationBearer token (Vault organization API key) · headerrequiredOrganization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.
orgIdstringrequiredcursorstringlimitintegercustomerLabelstringqstringMatches part of the order number or, for Live orders, part of the recipient name. Email addresses, street addresses, SKUs and tracking numbers are not searched.
statusstringon_holdreadyshippedcanceledunknownSuccess
dataobject[]requiredShow propertiesHide properties
objectcustomerLabelstring | nullrequiredidstringrequiredkindstringrequiredordinaryredemptionreshipship_backreceiptobjectrequiredShow propertiesHide properties
operationIdstring | nullrequiredrecordedAtstringrequiredvisibleOrderNumberstring | nullrequiredcurrentobject | nullrequiredShow propertiesHide properties
insuranceobject | nullShow propertiesHide properties
insuredbooleanrequiredWhether the order asks the warehouse to insure its one parcel. False is the explicit no-additional-insurance choice.
insuredValueobject | nullrequiredDeclared value to insure, independent of goods and customs values. Null when not insured.
Show propertiesHide properties
amountstringrequiredcurrencystringrequirednulllabelobject | nullrequiredNull until the warehouse buys the one label for this order, or when the order has more than one active shipment.
Show propertiesHide properties
insuredboolean | nullrequiredWhether the warehouse's label reports additional coverage. Null when the label does not report it.
insuredValueobject | nullrequiredShow propertiesHide properties
amountstringrequiredcurrencystringrequirednullproviderstring | nullrequiredShow propertiesHide properties
stringnullnullproviderstring | nullrequiredCoverage provider. carrier is the carrier's declared-value coverage.
Show propertiesHide properties
stringnullnullrequestedDeliveryConfirmationstring | nullShow propertiesHide properties
stringnullorderDatestring | nullrequiredproviderOrderNumberstring | nullrequiredrecipientNamestring | nullrequiredstatusstringrequiredon_holdreadyshippedcanceledunknowntrackingobject[]requiredShow propertiesHide properties
objectdeliveryConfirmationstring | nullShow propertiesHide properties
stringnullcarrierstring | nullrequirednumberstringrequiredshipDatestring | nullrequiredparcelEvidenceobjectShow propertiesHide properties
allParcelsCollectedboolean | nullrequiredcoveragestringrequiredcompleteincompletemembershipObservedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullstatestringrequiredconfirmedpendingincompletestaleunavailableunknownparcelsobject[]requiredShow propertiesHide properties
objectidstringrequiredcarrierstring | nullrequirednumberstringrequiredstatestringrequiredconfirmedpendingunavailableunknowneventobject | nullrequiredShow propertiesHide properties
detailCodestringrequiredoccurredAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullreportedAtstring | nullrequirednulldetailCodestring | nullrequiredobservedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullestablishedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullrefreshstringrequiredcurrentunavailableunknownstalesimulatedbooleanrequireditemsobject[]Show propertiesHide properties
objectdeclaredUnitValuestring | nullnamestring | nullrequiredproductIdstring | nullquantityinteger | nullrequiredShow propertiesHide properties
integernullskustring | nullrequiredunitPricestring | nullrecipientobject | nullShow propertiesHide properties
citystring | nullrequiredcompanystring | nullrequiredcountrystring | nullrequiredemailstring | nullrequirednamestring | nullrequiredphonestring | nullrequiredpostalCodestring | nullrequiredstatestring | nullrequiredstreet1string | nullrequiredstreet2string | nullrequirednullnullmetaobjectrequiredShow propertiesHide properties
requestIdstringrequirednextCursorstring | nullrequiredpreviousCursorstring | nullrequiredError
errorobjectrequiredShow propertiesHide properties
codestringrequiredforbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired