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 list of shipments
GET
https://api.pack.cloud/v1/organizations/{organizationId}/shipments
Request
Path parameters
organizationIdstring
Query parameters
filter[brand_id]string
filter[customer_id]string
filter[shipping_service_method_id]string
Response
OK
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
customer_idstringnull
ID of the customer whose shipment is
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
label_typestring
The chosen label type for generation
Example:pdf
referencestringnull
The reference of the shipment
Example:ORD1001
statusstring
The status of the shipment
Example:generated
typestring
Type of shipment
Allowed values:deliveryreturn
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
customer_idstringnull
ID of the customer whose shipment is
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
label_typestring
The chosen label type for generation
Example:pdf
referencestringnull
The reference of the shipment
Example:ORD1001
statusstring
The status of the shipment
Example:generated
typestring
Type of shipment
Allowed values:deliveryreturn
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
customer_idstringnull
ID of the customer whose shipment is
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
label_typestring
The chosen label type for generation
Example:pdf
referencestringnull
The reference of the shipment
Example:ORD1001
statusstring
The status of the shipment
Example:generated
typestring
Type of shipment
Allowed values:deliveryreturn
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
customer_idstringnull
ID of the customer whose shipment is
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
label_typestring
The chosen label type for generation
Example:pdf
referencestringnull
The reference of the shipment
Example:ORD1001
statusstring
The status of the shipment
Example:generated
typestring
Type of shipment
Allowed values:deliveryreturn
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
customer_idstringnull
ID of the customer whose shipment is
barcodestringnull
The barcode that represents the shipment
Example:3STEST1000000
tracking_urlstringnull
The tracking URL provided by shipping provider
label_typestring
The chosen label type for generation
Example:pdf
referencestringnull
The reference of the shipment
Example:ORD1001
statusstring
The status of the shipment
Example:generated
typestring
Type of shipment
Allowed values:deliveryreturn
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25