Create Parcel

post

https://async.shipper.aeropost.com/v1/parcel

Create a new parcel.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

address

string

required

length ≤ 100

Street address.

address_extra

string

length ≤ 100

Additional address information

region

string

required

length ≤ 30

Region or state. Refer to SLA agreement for valid values.

city

string

required

length ≤ 30

City. Refer to SLA agreement for valid values.

district

string

required

length ≤ 30

District. Refer to SLA agreement for valid values.

postal_code

string

length ≤ 15

Postal code

latitude

number

Latitude coordinate

longitude

number

Longitude coordinate

phone

string

required

Phone number of the consignee. Must be a valid E.164 number in accordance with Google's libphonenumber.

ship_to

string

enum

required

Destination type

Allowed:

content_description

string

required

length ≤ 255

Description of the parcel's content

number_of_pieces

int32

required

Number of pieces in the parcel

declared_value

number

Declared value of the parcel

services

integer

enum

required

Indicates the type of service(s) applied to the parcel.

Value	Meaning
1	Customs Clearance
2	Last-Mile
3	Both

Allowed:

reference

string

required

length ≤ 50

External reference

bundle_id

string

Bundle ID. Arbitrary identification to group parcels

tracking_code

string

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

country_code

string

required

ISO 3166-1 alpha-2 country code

consignee_name

string

required

length ≤ 70

Full name of the consignee

weight

number

required

Weight of the parcel

weight_unit

string

enum

required

Weight unit of the parcel

Allowed:

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Parcel Created Successfully