16 oktober 2024
Create shipment
POST
https://api.pack.cloud/v1/warehouses/{warehouseId}/fulfillments/{fulfillmentId}/shipments
Request
Path parameters
warehouseIdstring
fulfillmentIdstring
Payload
pieces_countinteger
Example:1
shipping_service_method_idstringrequired
ID of the shipping method
Response
Created
Body
idstring
ID of the shipment
brand_idstringnull
ID of the chosen brand
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
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
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
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
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
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
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
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
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
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
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
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
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
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
canceled_atstringnull
Time of cancellation
