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
• Calculate rates
• Get a rate

Labels

• Get labels
• Create a label
• Get a label

Manifests

• Get manifests
• Create a manifest
• Get a manifest

Couriers

• Get all couriers

Cancel Labels

• Get the cancelled labels
• Cancel a label
• Get a cancelled label

Pickups

• Get pickups
• Create a pickup
• Get 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

Specific Shipper Accounts

• Create a FedEx shipper account
• Update a FedEx shipper account

Address Validations (Beta)

• Create an address validation

Locations

• Get locations

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

Get labels

GET /labels

Get labels. This array contains all labels data. Please refer to
label object for label object details.

Request

Security: API Key

Query Parameters

• shipper_account_id: string, Shipper account ID
• status: string, Allowed values: creating, created, cancelling, cancelled, manifesting, manifested, failed
• limit: string, Number of records per page
• created_at_min: string, Start date and time of the record created
• created_at_max: string, End date and time of the record created
• s: string, Partial search of tracking_number or reference
• next_token: string, Next token

Headers

• Content-Type: string, required, Default: application/json

Responses

200

Get labels.

• Body:

{
  "meta": {
    "code": 200,
    "type": "OK",
    "message": "Everything worked as expected."
  },
  "data": {
    "next_token": "string",
    "limit": 0,
    "created_at_min": "string",
    "created_at_max": "string",
    "labels": [
      {
        "id": "3318b97b-150f-4205-840d-a6d966b9e0ea",
        "status": "created",
        "tracking_numbers": [
          "3884930103"
        ],
        "files": {
          "label": {
            "paper_size": "4x8",
            "url": "https://sandbox-download.postmen.com/label/2015-11-27/00000000-0000-0000-0000-000000000000-1441785264309885.pdf",
            "file_type": "pdf"
          },
          "invoice": null,
          "customs_declaration": null,
          "manifest": null
        },
        "rate": {
          "charge_weight": {
            "value": 3.307,
            "unit": "lb"
          },
          "total_charge": {
            "amount": 0,
            "currency": "USD"
          },
          "shipper_account": {
            "id": "00000000-0000-0000-0000-000000000000",
            "slug": "dhl",
            "description": "DHL Sandbox"
          },
          "service_type": "dhl_express_0900",
          "service_name": "DHL Express 0900",
          "pickup_deadline": null,
          "booking_cut_off": null,
          "delivery_date": null,
          "transit_time": null,
          "detailed_charges": [],
          "error_message": null,
          "info_message": null
        },
        "created_at": "2015-09-09T07:54:13.024Z",
        "updated_at": "2015-09-09T07:54:24.569Z",
        "ship_date": "2015-09-09"
      }
    ]
  }
}

Auth

as-api-key: Parameters

• created_at_max
• created_at_min
• limit
• next_token
• s
• shipper_account_id
• status