31 mei 2024
Create order
POST
https://api.pack.cloud/v1/organizations/{organizationId}/orders
Request
Path parameters
organizationIdstring
Payload
brand_idstringrequired
ID of the brand
customer_idstring
ID of the customer
referencestringnull
Reference of the order
Example:ORD100123
Shipping cost paid by customer
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
customs_invoice_numberstringnull
Invoice number for customs
Example:#1234
customs_shipment_typestringnull
Shipment export type for customs
Allowed values:documentsgiftreturned_goodssale_goodssample
The billing 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 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
quantity_orderedintegerrequired
Quantity that is ordered
product_idstringrequired
ID of the product that is ordered
namestringrequired
Name of the product ordered
Price per item
Price per item including VAT
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
Response
Created
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
Created
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
Created
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
Created
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
Created
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
Created
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
