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
  • format
    string
  • id
    string
    optional
  • size
    string
    optional
  • url
    string
    optional
  • createdAt
    string
    optional
  • expiresAt
    string
    optional

​Create a shipping label › Responses

    • shipmentId
      string
    • format
      string
    • id
      string
      optional
    • size
      string
      optional
    • url
      string
      optional
    • createdAt
      string
      optional
    • expiresAt
      string
      optional

​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
    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
    required

    The ID of the shipping label

​Get tracking number › query Parameters

  • format
    string

    The format of the response

  • limit
    integer

    Maximum number of tracking events to return

  • carrier
    string

    Filter tracking information by specific carrier

  • events_since
    string

    Only return tracking events after this timestamp

  • sort
    string

    Sort order for tracking events

​Get tracking number › Responses

    • trackingNumber
      string
    • carrier
      string
    • trackingUrl
      string
      optional

​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
    required

    The ID of the shipping label

​Get shipping label › query Parameters

  • format
    string

    The desired format of the label

​Get shipping label › Responses

    • shipmentId
      string
    • format
      string
    • id
      string
      optional
    • size
      string
      optional
    • url
      string
      optional
    • createdAt
      string
      optional
    • expiresAt
      string
      optional