Add Customs Clearance Service to Parcel

post

https://async.shipper.aeropost.com/v1/parcel/{parcelId}/clearance

Add customs clearance service and details to an existing parcel.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parcelId

string

required

Body Params

tracking_code

string

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

identification_type

string

enum

Type of identification document. Required for some countries.

Allowed:

identification_number

string

length ≤ 40

Identification document number. Required for some countries.

consignee_id

string

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

value_currency

string

required

Currency of the parcel value (ISO 4217)

cif_value

number

CIF value of the parcel

fob_value

number

FOB value of the parcel

freight_value

number

Freight value of the parcel

insurance_value

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*

line_number

int32

Invoice line number of the item

description

string

required

Item name/description

hs_code

string

required

Harmonized tariff code

origin_country

string

required

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

quantity

int32

required

Quantity of the item

unit_value

number

required

Unit value of the item

total_value

number

required

Total value of the item

unit_weight

int32

Unit weight in grams

product_url

uri

URL to the product page

shipping_value

number

Shipping value of the item

insurance_value

number

Insurance value of the item

item_image_url

uri

URL to an image of the item

Response

204

No Content

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here!