Endpoints for managing shipping labels. Labels are printable documents that contain:
- Shipping address information
- Tracking barcodes
- Carrier-specific routing data
- Package details
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.
Request Body
shipmentIdstring · uuid · requiredformatstring · enum · requiredEnum values:PDFPNGZPL
idstring · uuid · readOnlysizestring · enumEnum values:4x66x48.5x11urlstring · uri · readOnlycreatedAtstring · date-time · readOnlyexpiresAtstring · date-time · readOnly
Responses
Label created successfully
shipmentIdstring · uuid · requiredformatstring · enum · requiredEnum values:PDFPNGZPL
idstring · uuid · readOnlysizestring · enumEnum values:4x66x48.5x11urlstring · uri · readOnlycreatedAtstring · date-time · readOnlyexpiresAtstring · date-time · readOnly
Get tracking number
GET
https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io
/labels/{id}/trackingnumber
Retrieves the tracking number associated with a shipping label.
path Parameters
idstring · uuid · requiredThe ID of the shipping label
query Parameters
formatstring · enumThe format of the response
Enum values:basicdetailedcarrier-specificDefault: basiclimitinteger · min: 1 · max: 100Maximum number of tracking events to return
Default: 10carrierstring · enumFilter tracking information by specific carrier
Enum values:UPSUSPSFedExDHLDefault: nullevents_sincestring · date-timeOnly return tracking events after this timestamp
sortstring · enumSort order for tracking events
Enum values:newest_firstoldest_firstDefault: newest_first
Responses
Tracking number retrieved successfully
trackingNumberstring · requiredExample: 1Z999AA1234567890carrierstring · requiredExample: UPS
trackingUrlstring · uriExample: https://www.ups.com/track?tracknum=1Z999AA1234567890
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.
path Parameters
idstring · uuid · requiredThe ID of the shipping label
query Parameters
formatstring · enumThe desired format of the label
Enum values:PDFPNGZPLJPEGTIFFSVGEPSBMPDefault: PDF
Responses
Label retrieved successfully
shipmentIdstring · uuid · requiredformatstring · enum · requiredEnum values:PDFPNGZPL
idstring · uuid · readOnlysizestring · enumEnum values:4x66x48.5x11urlstring · uri · readOnlycreatedAtstring · date-time · readOnlyexpiresAtstring · date-time · readOnly