QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
REFERENCE
API Overview
v3
Rates
Get rates
get
Calculate rates
post
Get a rate
get
Labels
Get labels
get
Create a label
post
Get a label
get
Manifests
Get manifests
get
Create a manifest
post
Get a manifest
get
Couriers
Get all couriers
get
Cancel Labels
Get the cancelled labels
get
Cancel a label
post
Get a cancelled label
get
Pickups
Get pickups
get
Create a pickup
post
Get a pickup
get
Cancel Pickups
Get the cancelled pickups
get
Cancel a pickup
post
Get a cancelled pickup
get
Shipper Accounts
Get shipper accounts
get
Create a shipper account
post
Get a shipper account
get
Delete a shipper account
delete
Update a shipper account's information
put
Update a shipper account's credentials
patch
Update a shipper account's settings
patch
Specific Shipper Accounts
Create a FedEx shipper account
post
Update a FedEx shipper account
post
Address Validations (Beta)
Create an address validation
post
Locations
Get locations
get
MODEL
Envelope
Meta
v3
Error
v3
Primitive
Billing
v3
Customs
v3
Shipment
v3
Address
v3
Parcel
v3
Item
v3
Courier
v3
Reference
v3
Money
v3
PaymentMethodAccount
v3
Dimension
v3
Weight
v3
Volume
v3
Aes
v3
NoEei
v3
Resource
Rate
v3
RateRecord
v3
Label
v3
Manifest
v3
ShipperAccount
v3
CancelLabel
v3
AddressValidation (Beta)
v3
Location
v3
Pickup
v3
CancelPickup
v3
Carrier Guide
Supported Carriers
ENUM
Shipper Accounts Credentials
Service Types and Service Options List
All Service Options
Webhook
Webhook Overview
Webhook Specifications
Webhook Signature
Webhook Outgoing IPs
SDK
Java SDK
Node.js SDK
Open Source
phone
email-verifier
Support
Contact Support

Calculate rates

post
/rates

Calculate rates

Request

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

order_id
string

Unique identification of the order. The order_id is only used by certain third-party order platforms. Please contact support for details.

Auth
:
Parameters
:
Body
preparing...