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 integrationsGET
- Create integrationPOST
- Get integration by idGET
- Update integrationPUT
- Delete integrationDELETE
- Get integration actions by idGET
- Execute integration actionPOST
- Sync integration orders (async)POST
- Sync integration products (async)POST
- Get settings for integrationGET
- Sync integration shipping services (async)POST
- Sync integration product stocks (async)POST
- Get list of rule typesGET
- Get rule typeGET
- Get list of rulesGET
- Create rulePOST
- Get rule by idGET
- Update rulePUT
- Delete ruleDELETE
- Get rule actionsGET
- Create rule actionPOST
- Get rule action by idGET
- Update rule actionPUT
- Delete rule actionDELETE
- Get rule conditionsGET
- Create rule conditionPOST
- Get rule condition by idGET
- Update rule conditionPUT
- Delete rule conditionDELETE
Get order fulfillment
GET
https://api.pack.cloud/v1/organizations/{organizationId}/fulfillments/{fulfillmentId}
Request
Path parameters
organizationIdstring
fulfillmentIdstring
Response
OK
Body
idstring
ID of the fulfillment
referencestringnull
Reference of the fulfillment
statusstring
Status of the fulfillment
Allowed values:calculatingon_holdunscheduledqueuedpendingpickingpickedshipped
release_atstringnull
Available for picking time
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the fulfillment line
quantityinteger
Quantity for product in fulfillment
idstring
ID of the product
namestring
Name of the product
Example:Pencil - Orange
brand_namestringnull
Name of the product brand
Example:General Pencils
codestringnull
Article code / SKU / reference / MPN
Example:PENCO204
Cost price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Regular price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Dimensions of product
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Unit weight of product
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
hs_codeintegernull
Harmonized System code of product
Example:96091010
country_code_of_originstringnull
Country code of origin
Example:CN
descriptionstringnull
Goods description for customs in English
Example:T-shirt
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
typestring
Allowed values:standardvirtual_bundle
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product barcode
barcodestring
Barcode
Example:1234567890
quantityinteger
Quantity
Example:1
idstring
ID of the media
urlstring
URL of the original size media
url_mediumstring
URL of the 500 x 500px cropped media
url_thumbstring
URL of the 100 x 100px cropped media
idstring
ID of the serial number
product_idstring
ID of the linked product
stock_idstringnull
ID of the stock containing this serial number
fulfillment_line_idstringnull
ID of the fulfillment line that shipped this serial number
codestring
The serial number itself
Example:ABC123-XYZ456-789QWE
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
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
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
print_packing_slipboolean
shipping_service_method_idstringnull
Preferred shipping service method id
return_shipping_service_method_idstringnull
Shipping service method id for return shipment to print
shipping_preferences
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
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
codestring
Code of the carrier
Example:postnl
namestring
Name of the carrier
Example:PostNL
logo_urlstringnull
Logo URL
tracking_urlstringnull
Regular tracking URL
idstring
ID of the warehouse
organization_idstring
ID of the organization that owns the warehouse
namestring
Warehouse name
Example:Demo Woerden
timezonestring
Timezone of the warehouse
Example:Europe/Amsterdam
Enabled features for the warehouse
OK
Body
idstring
ID of the fulfillment
referencestringnull
Reference of the fulfillment
statusstring
Status of the fulfillment
Allowed values:calculatingon_holdunscheduledqueuedpendingpickingpickedshipped
release_atstringnull
Available for picking time
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the fulfillment line
quantityinteger
Quantity for product in fulfillment
idstring
ID of the product
namestring
Name of the product
Example:Pencil - Orange
brand_namestringnull
Name of the product brand
Example:General Pencils
codestringnull
Article code / SKU / reference / MPN
Example:PENCO204
Cost price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Regular price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Dimensions of product
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Unit weight of product
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
hs_codeintegernull
Harmonized System code of product
Example:96091010
country_code_of_originstringnull
Country code of origin
Example:CN
descriptionstringnull
Goods description for customs in English
Example:T-shirt
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
typestring
Allowed values:standardvirtual_bundle
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product barcode
barcodestring
Barcode
Example:1234567890
quantityinteger
Quantity
Example:1
idstring
ID of the media
urlstring
URL of the original size media
url_mediumstring
URL of the 500 x 500px cropped media
url_thumbstring
URL of the 100 x 100px cropped media
idstring
ID of the serial number
product_idstring
ID of the linked product
stock_idstringnull
ID of the stock containing this serial number
fulfillment_line_idstringnull
ID of the fulfillment line that shipped this serial number
codestring
The serial number itself
Example:ABC123-XYZ456-789QWE
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
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
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
print_packing_slipboolean
shipping_service_method_idstringnull
Preferred shipping service method id
return_shipping_service_method_idstringnull
Shipping service method id for return shipment to print
shipping_preferences
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
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
codestring
Code of the carrier
Example:postnl
namestring
Name of the carrier
Example:PostNL
logo_urlstringnull
Logo URL
tracking_urlstringnull
Regular tracking URL
idstring
ID of the warehouse
organization_idstring
ID of the organization that owns the warehouse
namestring
Warehouse name
Example:Demo Woerden
timezonestring
Timezone of the warehouse
Example:Europe/Amsterdam
Enabled features for the warehouse
OK
Body
idstring
ID of the fulfillment
referencestringnull
Reference of the fulfillment
statusstring
Status of the fulfillment
Allowed values:calculatingon_holdunscheduledqueuedpendingpickingpickedshipped
release_atstringnull
Available for picking time
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the fulfillment line
quantityinteger
Quantity for product in fulfillment
idstring
ID of the product
namestring
Name of the product
Example:Pencil - Orange
brand_namestringnull
Name of the product brand
Example:General Pencils
codestringnull
Article code / SKU / reference / MPN
Example:PENCO204
Cost price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Regular price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Dimensions of product
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Unit weight of product
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
hs_codeintegernull
Harmonized System code of product
Example:96091010
country_code_of_originstringnull
Country code of origin
Example:CN
descriptionstringnull
Goods description for customs in English
Example:T-shirt
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
typestring
Allowed values:standardvirtual_bundle
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product barcode
barcodestring
Barcode
Example:1234567890
quantityinteger
Quantity
Example:1
idstring
ID of the media
urlstring
URL of the original size media
url_mediumstring
URL of the 500 x 500px cropped media
url_thumbstring
URL of the 100 x 100px cropped media
idstring
ID of the serial number
product_idstring
ID of the linked product
stock_idstringnull
ID of the stock containing this serial number
fulfillment_line_idstringnull
ID of the fulfillment line that shipped this serial number
codestring
The serial number itself
Example:ABC123-XYZ456-789QWE
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
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
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
print_packing_slipboolean
shipping_service_method_idstringnull
Preferred shipping service method id
return_shipping_service_method_idstringnull
Shipping service method id for return shipment to print
shipping_preferences
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
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
codestring
Code of the carrier
Example:postnl
namestring
Name of the carrier
Example:PostNL
logo_urlstringnull
Logo URL
tracking_urlstringnull
Regular tracking URL
idstring
ID of the warehouse
organization_idstring
ID of the organization that owns the warehouse
namestring
Warehouse name
Example:Demo Woerden
timezonestring
Timezone of the warehouse
Example:Europe/Amsterdam
Enabled features for the warehouse
OK
Body
idstring
ID of the fulfillment
referencestringnull
Reference of the fulfillment
statusstring
Status of the fulfillment
Allowed values:calculatingon_holdunscheduledqueuedpendingpickingpickedshipped
release_atstringnull
Available for picking time
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the fulfillment line
quantityinteger
Quantity for product in fulfillment
idstring
ID of the product
namestring
Name of the product
Example:Pencil - Orange
brand_namestringnull
Name of the product brand
Example:General Pencils
codestringnull
Article code / SKU / reference / MPN
Example:PENCO204
Cost price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Regular price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Dimensions of product
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Unit weight of product
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
hs_codeintegernull
Harmonized System code of product
Example:96091010
country_code_of_originstringnull
Country code of origin
Example:CN
descriptionstringnull
Goods description for customs in English
Example:T-shirt
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
typestring
Allowed values:standardvirtual_bundle
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product barcode
barcodestring
Barcode
Example:1234567890
quantityinteger
Quantity
Example:1
idstring
ID of the media
urlstring
URL of the original size media
url_mediumstring
URL of the 500 x 500px cropped media
url_thumbstring
URL of the 100 x 100px cropped media
idstring
ID of the serial number
product_idstring
ID of the linked product
stock_idstringnull
ID of the stock containing this serial number
fulfillment_line_idstringnull
ID of the fulfillment line that shipped this serial number
codestring
The serial number itself
Example:ABC123-XYZ456-789QWE
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
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
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
print_packing_slipboolean
shipping_service_method_idstringnull
Preferred shipping service method id
return_shipping_service_method_idstringnull
Shipping service method id for return shipment to print
shipping_preferences
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
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
codestring
Code of the carrier
Example:postnl
namestring
Name of the carrier
Example:PostNL
logo_urlstringnull
Logo URL
tracking_urlstringnull
Regular tracking URL
idstring
ID of the warehouse
organization_idstring
ID of the organization that owns the warehouse
namestring
Warehouse name
Example:Demo Woerden
timezonestring
Timezone of the warehouse
Example:Europe/Amsterdam
Enabled features for the warehouse
OK
Body
idstring
ID of the fulfillment
referencestringnull
Reference of the fulfillment
statusstring
Status of the fulfillment
Allowed values:calculatingon_holdunscheduledqueuedpendingpickingpickedshipped
release_atstringnull
Available for picking time
shipped_atstringnull
Completed time
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the fulfillment line
quantityinteger
Quantity for product in fulfillment
idstring
ID of the product
namestring
Name of the product
Example:Pencil - Orange
brand_namestringnull
Name of the product brand
Example:General Pencils
codestringnull
Article code / SKU / reference / MPN
Example:PENCO204
Cost price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Regular price of product
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
Dimensions of product
heightnumberrequired
Height
Example:10
lengthnumberrequired
Length
Example:27.5
widthnumberrequired
Width
Example:20
unitstringrequired
Allowed values:cm
Example:cm
Unit weight of product
valuenumberrequired
Value
Example:10
unitstringrequired
All weight data is converted and stored in grams at the moment
Allowed values:gkgozlbs
Example:g
hs_codeintegernull
Harmonized System code of product
Example:96091010
country_code_of_originstringnull
Country code of origin
Example:CN
descriptionstringnull
Goods description for customs in English
Example:T-shirt
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
typestring
Allowed values:standardvirtual_bundle
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
idstring
ID of the product barcode
barcodestring
Barcode
Example:1234567890
quantityinteger
Quantity
Example:1
idstring
ID of the media
urlstring
URL of the original size media
url_mediumstring
URL of the 500 x 500px cropped media
url_thumbstring
URL of the 100 x 100px cropped media
idstring
ID of the serial number
product_idstring
ID of the linked product
stock_idstringnull
ID of the stock containing this serial number
fulfillment_line_idstringnull
ID of the fulfillment line that shipped this serial number
codestring
The serial number itself
Example:ABC123-XYZ456-789QWE
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
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
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
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
print_packing_slipboolean
shipping_service_method_idstringnull
Preferred shipping service method id
return_shipping_service_method_idstringnull
Shipping service method id for return shipment to print
shipping_preferences
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
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
codestring
Code of the carrier
Example:postnl
namestring
Name of the carrier
Example:PostNL
logo_urlstringnull
Logo URL
tracking_urlstringnull
Regular tracking URL
idstring
ID of the warehouse
organization_idstring
ID of the organization that owns the warehouse
namestring
Warehouse name
Example:Demo Woerden
timezonestring
Timezone of the warehouse
Example:Europe/Amsterdam
Enabled features for the warehouse