QUICKSTART

OAuth

Overview

Getting Started

Scope List

CHANGELOG

REFERENCE

Rates

Labels

Manifests

Couriers

Shipper Accounts

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

Cancel Labels

Get the canceled labels

Address Validations (Beta)

Create an address validation

post

MODEL

Envelope

Calculate rates

post

/rates

Calculate rates

Request

Security: API Key

Headers

Content-Type

string

required

Content-Type

Default:

application/json

Example:

application/json

Body

Calculate rates

async

boolean

shipper_accounts

array[object]

string

shipment

Shipment

Shipment object: the description of shipment information

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

ship_from

Address

required

Address object: the description of address information

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.

Auth

Parameters

Body

preparing...