API Reference

Create Parcel with Customs Clearance Service

post
https://async.shipper.aeropost.com/v1/clearance

Create a new parcel with customs clearance service.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
required
length ≤ 50

External reference

string
string

Bundle ID. Arbitrary identification to group parcels

string
required

Carrier tracking code. If ommitted, a new tracking code will be generated.

string
required

ISO 3166-1 alpha-2 country code

string
required
length ≤ 40

First name of the consignee.

string
required
length ≤ 30

Last name of the consignee

int32

Weight in grams

string
enum

Type of identification document. Required for some countries.

Allowed:
string
length ≤ 40

Identification document number. Required for some countries.

string

Scanned copy of the consignee's identification document (JPEG ≤1 MB). Required for some countries.

string
required

Currency of the parcel value (ISO 4217)

number

CIF value of the parcel

number

FOB value of the parcel

number

Freight value of the parcel

number

Insurance value of the parcel

items
array of objects
required
length between 1 and 300

List of items in the parcel. Items can not be added or removed after parcel creation.

items*
int32

Invoice line number of the item

string
required

Item name/description

string
required

Harmonized tariff code

string
required

Country of origin (ISO 3166-1 alpha-2)

int32
required

Quantity of the item

number
required

Unit value of the item

number
required

Total value of the item

int32

Unit weight in grams

uri

URL to the product page

number

Shipping value of the item

number

Insurance value of the item

uri

URL to an image of the item

Response

Updated 14 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago