The Rest API is deprecated and will be removed in the future. We recommend using the GraphQL API instead. Some endpoints may not be available anymore.
Get order by id
GET
https://api.pack.cloud/v1/organizations/{organizationId}/orders/{orderId}
Request
Path parameters
organizationIdstring
orderIdstring
Response
OK
Body
idstring
ID of the order
brand_idstring
ID of the brand
customer_idstringnull
ID of the customer whose order is
integration_idstringnull
ID of the integration
integration_referencestringnull
Order id/reference at integration
quantity_orderedinteger
Quantity that is ordered
quantity_allocatedinteger
Quantity that is allocated to a fulfillment
quantity_shippedinteger
Quantity that is shipped (already)
quantity_unallocatedinteger
Quantity that is not (yet) allocated to a fulfillment
referencestring
Reference of the order
Shipping cost paid by customer
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
canceled_atstringnull
Cancellation time, if canceled
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
shipping_preferences
updatableboolean
OK
Body
idstring
ID of the order
brand_idstring
ID of the brand
customer_idstringnull
ID of the customer whose order is
integration_idstringnull
ID of the integration
integration_referencestringnull
Order id/reference at integration
quantity_orderedinteger
Quantity that is ordered
quantity_allocatedinteger
Quantity that is allocated to a fulfillment
quantity_shippedinteger
Quantity that is shipped (already)
quantity_unallocatedinteger
Quantity that is not (yet) allocated to a fulfillment
referencestring
Reference of the order
Shipping cost paid by customer
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
canceled_atstringnull
Cancellation time, if canceled
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
shipping_preferences
updatableboolean
OK
Body
idstring
ID of the order
brand_idstring
ID of the brand
customer_idstringnull
ID of the customer whose order is
integration_idstringnull
ID of the integration
integration_referencestringnull
Order id/reference at integration
quantity_orderedinteger
Quantity that is ordered
quantity_allocatedinteger
Quantity that is allocated to a fulfillment
quantity_shippedinteger
Quantity that is shipped (already)
quantity_unallocatedinteger
Quantity that is not (yet) allocated to a fulfillment
referencestring
Reference of the order
Shipping cost paid by customer
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
canceled_atstringnull
Cancellation time, if canceled
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
shipping_preferences
updatableboolean
OK
Body
idstring
ID of the order
brand_idstring
ID of the brand
customer_idstringnull
ID of the customer whose order is
integration_idstringnull
ID of the integration
integration_referencestringnull
Order id/reference at integration
quantity_orderedinteger
Quantity that is ordered
quantity_allocatedinteger
Quantity that is allocated to a fulfillment
quantity_shippedinteger
Quantity that is shipped (already)
quantity_unallocatedinteger
Quantity that is not (yet) allocated to a fulfillment
referencestring
Reference of the order
Shipping cost paid by customer
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
canceled_atstringnull
Cancellation time, if canceled
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
shipping_preferences
updatableboolean
OK
Body
idstring
ID of the order
brand_idstring
ID of the brand
customer_idstringnull
ID of the customer whose order is
integration_idstringnull
ID of the integration
integration_referencestringnull
Order id/reference at integration
quantity_orderedinteger
Quantity that is ordered
quantity_allocatedinteger
Quantity that is allocated to a fulfillment
quantity_shippedinteger
Quantity that is shipped (already)
quantity_unallocatedinteger
Quantity that is not (yet) allocated to a fulfillment
referencestring
Reference of the order
Shipping cost paid by customer
statusstring
Status of the order
Allowed values:createdexpectedunallocatedallocatedcanceledpartially_shippedshipped
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
canceled_atstringnull
Cancellation time, if canceled
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
shipping_preferences
updatableboolean