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

Create parcel. Maximum 2500 parcels per shipment

string

Required. Barcode used by the shipper - Max 20 characters

string

Required. Shipper order number - Max 20 characters

integer

Required. Available courier IDs will be provided

string
enum

Required. ISO 3166-1 alpha-2 country code

string
enum

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

Allowed:
string

Required if ship_to is location_id. Use Get Locations endpoint to get the id of a location.

integer

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

string

Identification number on the provided identification document

string

Required. First name of the receiver of the shipment - Max 40 characters

string

Required. Last name of the receiver of the shipment - Max 30 characters

string

Must be a valid email for the receiver of the shipment, max 50 characters

string

Required. Valid mobile phone number (uses glib phone to validate)

string

Required if ship_to is address - Max 100 characters

string

Max 100 characters

string

Required if ship_to is address - Max 30 characters

string

Required if ship_to is address - Max 30 characters

string

Optional (not all countries use postal codes) - Max 15 characters

string

Required. Decimal

string
enum

Required

Allowed:
string

Max 50 characters

integer

Max 3 digits

integer

Max 4 digits

string
enum

Required. Currency

items
array of objects

Required. Parcel items

items
string

Required. File, max 4 Megabytes

Responses

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