Calculate rates - AfterShip Shipping API

Request

Security: API Key

Headers

Content-Type

string

required

Content-Type

Default:

application/json

Example:

application/json

Body

Calculate rates

async

boolean

enable async mode or not (set to false if not provided)

is_document

boolean

If the shipment is document type. (set to false if not provided)

ship_date

string

Ship Date in YYYY-MM-DD, if not provided, will be today of the shipper account timezone

shipper_accounts

array[object]

id

string

shipment

Shipment

Shipment object: the description of shipment information

refer to [shipment](../model/resource/label.v3.json) object.

tax_total

Money

The money object is used to represent the currency amount.

ship_from

Address

required

Address object: the description of address information

ship_from_display

Address

Address object: An optional address object that lets you customize the ship from details shown on the shipping label.
This is only for visual display and won't change actual shipping routes or carrier operations.
Supported slug: purolator,canada-post

ship_to

Address

required

Address object: the description of address information

parcels

array[Parcel]

required

Parcels of shipment

return_to

Address

Address object: the description of address information

delivery_instructions

string

Instructions to aid in prompt delivery of the shipment.

expected_delivery_date

string

Expected Delivery Date in YYYY-MM-DD