Generate Book Shipment V2 Request

Request Format JSON XML

API Key

API Password

Book From Quote

If booking from a previous quote, use the QuoteID from the GetQuoteResponse. If supplying shipment details to book order, leave this blank.

Quote ID

Shipment

If not using a QuoteID to book a shipment, fill out the shipment details

Consignment

Item Type

Items are Stackable?

Consignment Summary

Consignment Value

Packages

Package {{ $index + 1 }}

Weight

Length

Width

Height

Commodities

Commodity {{ $index + 1 }}

Commodity Code

Description

Country Of Origin
Country ID
Country Code

Number of Units

Unit Value

Unit Weight

Product Code (optional — used to auto-resolve CPSC declaration from Product Library)

CPSC Declaration (optional)

Required when shipping a CPSC-flagged HTS code to the United States. Set DeclarationOption to 1 (Full Certificate of Conformity), 2 (CPSC Product Registry) or 3 (Exempt / Disclaimer). Option 1 is not available on USPS services. On a successful book, the declaration is saved against the account for future use. If a ProductCode above matches a Product Library entry with a default CPSC declaration set, the declaration will be resolved and saved automatically and these fields may be left blank. Leave all CPSC fields blank if the commodity does not require a declaration.

Declaration Option (1, 2 or 3)

Responsibility Accepted (all options)

Product ID (Options 1 and 2)

CPSC Rule Citation (Option 1)

Date of Manufacture (Option 1)

Place of Manufacture (Option 1)

Date of Most Recent Test (Option 1)

Testing Laboratory (Option 1, optional)

Records Keeper Contact (Option 1)

Certifier ID (Option 2)

Version ID (Option 2)

Disclaimer Type (Option 3 — "A" or "B")

Intended Use Code (Option 3)

Intended Use Description (Option 3)

Collection Address

Forename

Surname

Email Address

Telephone Number

Mobile Number

Company Name

Address Line One

Address Line Two

City

County

Postcode

Country
Country ID
Country Code

Is Address Residential

Delivery Address

Forename

Surname

Email Address

Telephone Number

Mobile Number

Company Name

Address Line One

Address Line Two

City

County

Postcode

Country
Country ID
Country Code

Is Address Residential

Book Details

Service ID

Your Reference

VAT Number

EORI Number

IMEI Number

Signature Required

Insurance

If insurance is not being requested leave this section blank

Cover Value

Excess Value

Fragile Goods

New Condition

Collection

If a collection is not required, leave this section blank

If not applicable or not specifying collection option - leave collection option id blank

Collection Option ID

Collection Date

Ready From