We're announcing 🧑‍🚀 inter-galactic shipping ✨ for 3025!
Labels & Stamps API

​Labels (3.0.0)

Endpoints for managing shipping labels. Labels are printable documents that contain:

  • Shipping address information
  • Tracking barcodes
  • Carrier-specific routing data
  • Package details
Endpoint

​Create a shipping label

POST
https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io
/labels

Creates a new shipping label for a shipment.

The generated label will be available for download through the returned URL for 24 hours.

​Create a shipping label › Request Body

  • shipmentId
    string · uuid · required
  • format
    string · enum · required
    Enum values:
    PDF
    PNG
    ZPL
  • id
    string · uuid · readOnly
  • size
    string · enum
    Enum values:
    4x6
    6x4
    8.5x11
  • url
    string · uri · readOnly
  • createdAt
    string · date-time · readOnly
  • expiresAt
    string · date-time · readOnly

​Create a shipping label › Responses

    • shipmentId
      string · uuid · required
    • format
      string · enum · required
      Enum values:
      PDF
      PNG
      ZPL
    • id
      string · uuid · readOnly
    • size
      string · enum
      Enum values:
      4x6
      6x4
      8.5x11
    • url
      string · uri · readOnly
    • createdAt
      string · date-time · readOnly
    • expiresAt
      string · date-time · readOnly

​Invalidate a shipping label

PUT
https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io
/labels/{id}/invalidate

Invalidates a shipping label, making it no longer available for download.

​Invalidate a shipping label › path Parameters

  • id
    string · uuid · required

    The ID of the label to invalidate

​Invalidate a shipping label › Responses

    No response specified

​Get tracking number

GET
https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io
/labels/{id}/trackingnumber

Retrieves the tracking number associated with a shipping label.

​Get tracking number › path Parameters

  • id
    string · uuid · required

    The ID of the shipping label

​Get tracking number › query Parameters

  • format
    string · enum

    The format of the response

    Enum values:
    basic
    detailed
    carrier-specific
  • limit
    integer · min: 1 · max: 100

    Maximum number of tracking events to return

  • carrier
    string · enum

    Filter tracking information by specific carrier

    Enum values:
    UPS
    USPS
    FedEx
    DHL
  • events_since
    string · date-time

    Only return tracking events after this timestamp

  • sort
    string · enum

    Sort order for tracking events

    Enum values:
    newest_first
    oldest_first

​Get tracking number › Responses

    • trackingNumber
      string · required
    • carrier
      string · required
    • trackingUrl
      string · uri

​Get shipping label

GET
https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io
/labels/{id}

Retrieves a shipping label by ID. The label can be requested in different formats.

​Get shipping label › path Parameters

  • id
    string · uuid · required

    The ID of the shipping label

​Get shipping label › query Parameters

  • format
    string · enum

    The desired format of the label

    Enum values:
    PDF
    PNG
    ZPL
    JPEG
    TIFF
    SVG
    EPS
    BMP

​Get shipping label › Responses

    • shipmentId
      string · uuid · required
    • format
      string · enum · required
      Enum values:
      PDF
      PNG
      ZPL
    • id
      string · uuid · readOnly
    • size
      string · enum
      Enum values:
      4x6
      6x4
      8.5x11
    • url
      string · uri · readOnly
    • createdAt
      string · date-time · readOnly
    • expiresAt
      string · date-time · readOnly