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

Get a label

get
/labels/{id}

Get a label.

Request

Path Parameters

id
string
required

Label id

Headers

Content-Type
string
required

Content-Type

Default:
application/json
Example:
application/json

Responses

200

OK

Body

meta
Meta

Meta data object.

Example:
{"code":200,"type":"OK","message":"Everything worked as expected."}
code
integer
required

Code of Meta

message
string
required

Message of Meta

details
array[Error]

Details of Meta

retryable
boolean

Whether this request will be retryable or not

data
Label

Label object: the description of label object

This array contains service_options object. Please refer to [all service options](../../docs/enum/all-service-options.md) and [service options list](../../docs/enum/service-options-lists.md) for details. This array contains reference data. Please refer to [reference](../model/premitive/reference.v3.json) object for label object details.
id
string

Label ID

status
string
Allowed values:
creatingcreatedcancellingcancelledmanifestingmanifestedfailed
ship_date
string
tracking_numbers
array[string]
carrier_references
array[object]
files
Files

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

rate
Rate

Rate object: the description of rate information

created_at
string

A formatted date.

updated_at
string

A formatted date.

references
array[string] or null

Reference information for a label

shipper_account
Reference

Reference object: the description of reference information

service_type
string

Service Types

order_number
string

A user-defined order number used to identify an order.

service_options
array[object]

This array contains service_options object. Please refer to all service options and service types and service options list for details.

order_id
string

Unique identification of the order.

custom_fields
object

Custom fields that accept an object with string field.Show all...

carrier_redirect_link
string or null

Delivery instructions (delivery date or address) can be modified by visiting the link if supported by a carrier.

Auth
:
Parameters
:
:
Response Example
{
  "meta": {
    "code": 200,
    "type": "OK",
    "message": "Everything worked as expected."
  },
  "data": {
    "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"
  }
}