FulfillmentPackages

Upload Label

Upload a shipping label for a package

Requirements

  • Package must not already have a shipping label
  • Label file size must not exceed 10MB
  • For FULFILLMENT_ORDER packages: You must own the fulfillment order lock (provide lock_owner)
  • For WORK_ORDER and STANDALONE packages: No lock ownership required

Supported Formats

Upload shipping labels in these formats:

  • PDF: Most common format for shipping labels
  • PNG: High-quality image format
  • JPG/JPEG: Compressed image format

File Encoding

Provide the label file as base64-encoded content in the request body.

POST
/shipos/packages/{package_id}/upload-label
x-access-token<token>

In: header

Path Parameters

package_id*string

UUID of the package to upload label for

Request Body

application/json

Request type for uploading a package label

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/shipos/packages/string/upload-label" \  -H "Content-Type: application/json" \  -d '{    "data": {      "tracking_number": "string",      "base64_content": "string"    }  }'
{  "success": true,  "shipping_label_id": "string",  "tracking_number": "string",  "message": "string"}