QUICKSTART

API Quick Start

OAuth

Getting Started

CHANGELOG

REFERENCE

Rates

Calculate rates

Labels

Manifests

Create a manifest

Couriers

Get all couriers

Cancel Labels

Get the cancelled labels

Get a cancelled label

Pickups

Create a pickup

Cancel Pickups

Get the cancelled pickups

Cancel a pickup

Get a cancelled pickup

Shipper Accounts

Get shipper accounts

Create a shipper account

Get a shipper account

Delete a shipper account

Update a shipper account's information

Update a shipper account's credentials

Update a shipper account's settings

Address Validations (Beta)

Create an address validation

Locations

MODEL

Envelope

Primitive

PaymentMethodAccount

Resource

AddressValidation (Beta)

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

Open Source

Support

Contact Support

Get labels

get

/labels

Get labels.

This array contains all labels data. Please refer to [label](../model/resource/label.v3.json) object for label object details.

Request

Security: API Key

Query Parameters

shipper_account_id

string

Shipper account ID

status

string

Label status

Allowed values:

creatingcreatedcancellingcancelledmanifestingmanifestedfailed

limit

string

Number of records per page

created_at_min

string

Start date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, default: 24hrs ago)

created_at_max

string

End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, default: NOW())

s

string

Partial search of tracking_number or reference

next_token

string

Next token

Headers

Content-Type

string

required

Content-Type

Default:

application/json

Example:

application/json

Auth

:

Parameters

:

:

:

:

:

:

:

: