31 mei 2024
Create shipment
POST
https://api.pack.cloud/v1/organizations/{organizationId}/shipments
Request
Path parameters
organizationIdstring
Payload
brand_idstringrequired
ID of the brand
customer_idstring
ID of the customer
shipping_service_method_idstringrequired
ID of the shipping method
label_typestring
Requested label type, when not provided the default label type for the shipping service is used
Example:pdf
pieces_countinteger
Example:1
referencestringnull
Reference of the shipment
Example:ORD100123
statusstring
Set to requested to start shipment generation
Allowed values:createdrequested
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
The sender address information. If not provided, this is auto filled from the brand settings.
company_namestring
Company name (required when no name provided)
Example:Large Company Ltd
namestring
Contact person name (required when no company name provided)
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2stringnull
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
The return address information. If not provided, this is auto filled from the brand settings.
company_namestring
Company name (required when no name provided)
Example:Large Company Ltd
namestring
Contact person name (required when no company name provided)
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2stringnull
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
The recipient address information
customer_idstringnull
ID of the related customer
company_namestring
Company name (required when no name provided)
Example:Large Company Ltd
namestring
Contact person name (required when no company name provided)
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2stringnull
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
The content of the shipment. Required for customs destinations
quantityinteger
Quantity
descriptionstringnull
Goods description for customs in English
Example:T-shirt
Price per unit
Unit weight of product
country_code_of_originstringnull
Country code of origin
Example:CN
hs_codeintegernull
Harmonized System code of product
Example:96091010
delivery_datestring
handover_datestring
carrier_codestring
carrier_service_point_codestring
integration_service_point_codestring
integration_service_point_typestring
Allowed values:sendcloud
Response
Created
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
Created
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
Created
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
Created
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
Created
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
Created
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
