Components

PackResponse

Returns advice on how-to-pack a set of items into different packages and shipments

PropertyTypeDescription
pack
object
errors
description
string
nullable
error
Error message returned by API
required
code
string
required
one of:
not_found
invalid_request
unauthorized
internal
carrier
message
string
required
source
string
nullable
id
string
Universally Unique Identifier.
uuid
non_packed_items
A specification of a product that can be packed into a container.
required
height
integer
The height in CMs.
required
value 1...
length
integer
The length in CMs.
required
value 1...
width
integer
The width of a shipment or product in CMs.
required
value 1...
object
required
description
string
A human readable description of the item
ean
string
EAN Code of product (European Article Number)
\A[0-9]{8,13}\z
external_id
string
Identifier unique to the item
hs_code
string
HS Code of product (Harmonized Commodity Description and Coding System)
\A[0-9]{6,10}\z
reference
string
Custom reference code to identify your shipments or orders
\A[[:alnum:]\-_\\/\.]+\z
length 1...255
sku
string
SKU Code of product
\A[[:alnum:] \-_]+\z
value_in_cents
integer
The total value in cents.
required
value 1...
weight
integer
The weight or a product or shipment in grams.
required
value 1...
packed_containers
Specifies a container where items will be shipped in. A container with items can be converted into a Shipment.
required
height
integer
The height in CMs.
required
value 1...
length
integer
The length in CMs.
required
value 1...
width
integer
The width of a shipment or product in CMs.
required
value 1...
object
required
kind
string
The type of container that is used to put the items in
required
one of:
document
package
pallet
letterbox
packing_instructions
required
item
A specification of a product that can be packed into a container.
required
required
height
integer
The height in CMs.
required
value 1...
length
integer
The length in CMs.
required
value 1...
width
integer
The width of a shipment or product in CMs.
required
value 1...
object
required
description
string
A human readable description of the item
ean
string
EAN Code of product (European Article Number)
\A[0-9]{8,13}\z
external_id
string
Identifier unique to the item
hs_code
string
HS Code of product (Harmonized Commodity Description and Coding System)
\A[0-9]{6,10}\z
reference
string
Custom reference code to identify your shipments or orders
\A[[:alnum:]\-_\\/\.]+\z
length 1...255
sku
string
SKU Code of product
\A[[:alnum:] \-_]+\z
value_in_cents
integer
The total value in cents.
required
value 1...
weight
integer
The weight or a product or shipment in grams.
required
value 1...
step
integer
The step of when to pack this item
reference
string
required
value_in_cents
integer
The total value in cents.
required
value 1...
weight
integer
The weigth of the box in grams
required
value 1...
price_in_cents
object
Overview of price difference when applying PuzzlPack. The prices are in cents.
shipment_blueprints
A data structure which can be used to create shipment(s) through our OrderAPI based on the results from PuzzlePack.
object
required
currency
string
Currency used for rates and shipments.
one of:
EUR
description
string
Text field that may contain multiple lines and unicode characters.
\A^[\p{L}\p{N}\p{P}\p{Z}\n]+\z
nullable
length 1...2700
height
integer
The height in CMs.
value 1...
length
integer
The length in CMs.
value 1...
order_lines
description
string
The description/name of the item
required
\A^[\p{L}\p{N}\p{P}\p{Z}\n]+\z
nullable
length 1...2700
ean
string
EAN Code of product (European Article Number)
\A[0-9]{8,13}\z
hs_code
string
HS Code of product (Harmonized Commodity Description and Coding System)
\A[0-9]{6,10}\z
meta
object
This is an additional free format structured field that will give you the possibility to manage your booking process. Maps and lists are supported.
origin_country_code
string
ISO country code.
required
\A[A-Z]{2}\z
length 2...2
quantity
integer
The number of items for a product in an order line.
required
value 1...
sku
string
SKU Code of product
\A[[:alnum:] \-_]+\z
value
integer
The total value in cents.
required
value 1...
weight
integer
The weight or a product or shipment in grams.
required
value 1...
receiver_address
Schema used to specify an address for a newly created shipment.
required
required
address2
string
Address2 address field.
\A[[:alnum:] .,&'\-]+\z
length 1...255
business_name
string
Name of business for address. If this name is supplied, it will indicate that the address type is business. If left empty, it indicates that the address type is a consumer.
\A[[:alnum:] .,&!'\-]+\z
length 1...255
city
string
City of address.
required
\A[[:alnum:] .,&'\-]+\z
length 2...30
country_code
string
ISO country code.
required
\A[A-Z]{2}\z
length 2...2
email_address
string
Email address compatible with RFC 5322.
\A[\w+\-\.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z
length 3...320
eori_number
string
Economic Operators Registration and Identification number that is required by businesses to ship internationally.
length 3...17
family_name
string
Also known as last name. Refers to the name of the contact person to whom the address belongs.
\A[[:alnum:] -]+\z
length 1...30
given_name
string
Also known as first name. Refers to the personal name of the contact person to whom the address belongs.
\A[[:alnum:] -]+\z
length 1...30
house_number
string
House number in an address. May also contain house number extensions.
required
\A[[:alnum:] \-]+\z
length 1...14
id
string
Unique ID for an address. Can be a ID of an existing sender_address or a unique ID of a parcelshop. In all other cases this ID is empty.
length 1...64
phone_number
string
Phone number that may consist of a country code.
\A[[:digit:] \-+()]+\z
length 2...30
state_code
string
State code for an address. The state code should be applicable for the country. So NY (New York) for country_code US (United States) or YT (Yukon) for country_code CA (Canada)
\A[A-Z]{2,3}\z
length 2...3
street_name
string
Street name is an identifying name given to a street or road.
required
\A[[:alnum:] .,&'\-]+\z
length 2...55
vat
string
Value-added tax identification number or VAT identification number (VATIN).
nullable
length 3...14
zip_code
string
The zipcode of an address.
required
\A[[:alnum:] -]+\z
length 1...10
reference
string
Custom reference code to identify your shipments or orders
\A[[:alnum:]\-_\\/\.]+\z
length 1...255
sender_address
Schema used to specify an address for a newly created shipment.
required
required
address2
string
Address2 address field.
\A[[:alnum:] .,&'\-]+\z
length 1...255
business_name
string
Name of business for address. If this name is supplied, it will indicate that the address type is business. If left empty, it indicates that the address type is a consumer.
\A[[:alnum:] .,&!'\-]+\z
length 1...255
city
string
City of address.
required
\A[[:alnum:] .,&'\-]+\z
length 2...30
country_code
string
ISO country code.
required
\A[A-Z]{2}\z
length 2...2
email_address
string
Email address compatible with RFC 5322.
\A[\w+\-\.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z
length 3...320
eori_number
string
Economic Operators Registration and Identification number that is required by businesses to ship internationally.
length 3...17
family_name
string
Also known as last name. Refers to the name of the contact person to whom the address belongs.
\A[[:alnum:] -]+\z
length 1...30
given_name
string
Also known as first name. Refers to the personal name of the contact person to whom the address belongs.
\A[[:alnum:] -]+\z
length 1...30
house_number
string
House number in an address. May also contain house number extensions.
required
\A[[:alnum:] \-]+\z
length 1...14
id
string
Unique ID for an address. Can be a ID of an existing sender_address or a unique ID of a parcelshop. In all other cases this ID is empty.
length 1...64
phone_number
string
Phone number that may consist of a country code.
\A[[:digit:] \-+()]+\z
length 2...30
state_code
string
State code for an address. The state code should be applicable for the country. So NY (New York) for country_code US (United States) or YT (Yukon) for country_code CA (Canada)
\A[A-Z]{2,3}\z
length 2...3
street_name
string
Street name is an identifying name given to a street or road.
required
\A[[:alnum:] .,&'\-]+\z
length 2...55
vat
string
Value-added tax identification number or VAT identification number (VATIN).
nullable
length 3...14
zip_code
string
The zipcode of an address.
required
\A[[:alnum:] -]+\z
length 1...10
type
string
Indicates the type of shipment.
one of:
document
package
pallet
letterbox
value
integer
The total value in cents.
value 1...
weight
integer
The weight or a product or shipment in grams.
value 1...
width
integer
The width of a shipment or product in CMs.
value 1...