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

Files

Files object: the description of 5 different file objects(label, qr_code, invoice, customs_declaration, manifest)

label

object or null

paper_size

string

Allowed values:

4x44x64x6.754x8a4default

url

string

URL of the file

file_type

string

Label file type. (set to "pdf" if not provided)

Allowed values:

pdfzpl

qr_code

object or null

paper_size

string

Allowed value:

1x1

url

string

URL of the file

file_type

string

Allowed value:

png

invoice

object or null

paper_size

string or null

Allowed value:

url

string or null

URL of the file

file_type

string or null

Allowed value:

pdf

customs_declaration

object or null

paper_size

string or null

Allowed value:

url

string or null

URL of the file

file_type

string or null

Allowed value:

pdf

manifest

object or null

paper_size

string or null

Allowed value:

url

string or null

URL of the file

file_type

string or null

Allowed value:

pdf

Example

preparing...