Create Parcel

A parcel is a package that will be tendered to a end customer through Aeroposts network.

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

Required if you use standard flow. id from an opened shipment, i.e. 9ba59065-7d0d-4062-a05a-7b6b7d7791d2

string
required

The shipper account, provided by Aeropost - Max 10 digits, i.e. 129010

string
required

Barcode used by the shipper - Max 40 characters, i.e. TESTSCL10MAR202004

string
required

Shipper order number - Max 20 characters, i.e. 105-9053675-4890605

string

Bag number - digits, letters and hyphens allowed, 5 to 20 characters

string
enum
required

See Available courier IDs page, i.e. 7

string
enum
required

ISO 3166-1 alpha-2 - See Available country codes page

string
enum
required

Available values are location_id and address. If location_id is chosen, address will be ignored and vise versa

Allowed:
int32
Defaults to null

Use Get Locations endpoint to get the id of a location, i.e. 18

string
enum
required

For the purpose of clearing customs and delivery, a valid identity document reference is required. See Valid Identity document page.

string
required

Identification number on the provided identification document, i.e. 123954

string
required

First name of the receiver of the shipment - Max 40 characters, i.e. Pablo

string
required

Last name of the receiver of the shipment - Max 30 characters, i.e. Martinez

string
required
Defaults to required

Must be a valid email for the receiver of the shipment, max 50 characters, i.e. [email protected]

string
required

Valid mobile phone number (uses glib phone to validate), i.e. +1-212-456-7890

string

required if ship_to is address - Max 100 characters, i.e. Av. 30, 4

string

Max 100 characters

string

required if ship_to is address - Max 30 characters, i.e. San Jose

string

required if ship_to is address - Max 30 characters, i.e. Cartago

string

Optional (not all countries use postal codes) - Max 15 characters, i.e. 30301

string

Max 50 characters

string

Max 3 digits, i.e. 412

string

Max 4 digits, i.e. 4102

string
enum
required

Currency, i.e. USD

items
array of objects
required

Max 300 items per parcel

items*
file
required

Max 4 megabytes

file

Jpeg, max 1 megabyte, required for Jamaica

string

optional - Max 30 characters, i.e. Alviso

Headers
string
Defaults to application/json
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json