Create Parcel

post

https://api.shipper.aeropost.com/api/parcels

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

shipment_id

string

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

shipper_account_number

string

required

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

tracking_code

string

required

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

order_number

string

required

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

bag_number

string

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

courier_id

string

enum

required

See Available courier IDs page, i.e. 7

country_code

string

enum

required

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

ship_to

string

enum

required

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

Allowed:

location_id

int32

Defaults to null

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

identification_type

string

enum

required

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

identification_number

string

required

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

first_name

string

required

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

last_name

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]

phone

string

required

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

address

string

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

address_extra

string

Max 100 characters

city

string

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

region

string

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

postal_code

string

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

delivery_instructions

string

Max 50 characters

delivery_route

string

Max 3 digits, i.e. 412

delivery_zen

string

Max 4 digits, i.e. 4102

package_value_currency

string

enum

required

Currency, i.e. USD

items

array of objects

required

Max 300 items per parcel

items*

invoice

file

required

Max 4 megabytes

consignee_id

file

Jpeg, max 1 megabyte, required for Jamaica

district

string

optional - Max 30 characters, i.e. Alviso

Headers

string

Defaults to application/json

Responses

201201

422422