Get Shipping Labels

Endpoint

GET /v1/orders/:order_id/shipping_labels

Returns the shipping label PDF for one order. The label is generated on the first request, and later requests with the same settings return the same file.

Request Parameters

order_id is a path parameter. All other parameters are query parameters. Settings you leave out use your default settings from the Biteship dashboard. See Label Settings for the default values.

Parameter	Type	Required	Description
order_id	string	Yes	Biteship order ID
paper_size	string	No	Paper size: a4, 8x10cm, or 10x15cm
template	string	No	Label template: standard
insurance_shown	boolean	No	Show insurance information
insurance_fee_shown	boolean	No	Show the insurance amount
shipping_fee_shown	boolean	No	Show the shipping fee
items_shown	boolean	No	Show the items section
item_description_shown	boolean	No	Show item descriptions
item_sku_shown	boolean	No	Show item SKUs
origin_phone_shown	boolean	No	Show the sender phone
origin_address_shown	boolean	No	Show the sender address
receiver_phone_shown	boolean	No	Show the recipient phone
receiver_address_shown	boolean	No	Show the recipient address
censor_receiver_name	boolean	No	Censor the recipient name

Boolean query parameters are true or false.

Request

curl --request GET \
  --url 'https://api.biteship.com/v1/orders/<<ORDER_ID>>/shipping_labels?paper_size=10x15cm&items_shown=true&censor_receiver_name=true' \
  --header 'authorization: <<YOUR_API_KEY>>'

Response

Field	Type	Description
success	boolean	Whether the request succeeded
code	number	Response code
message	string	Shipping label retrieved successfully or Shipping label created successfully. Both mean success
shipping_label.id	string	Shipping label ID
shipping_label.user_id	string	User ID
shipping_label.order_id	string	Order ID
shipping_label.organization_id	string	Organization ID
shipping_label.template	string	Label template
shipping_label.paper_size	string	Paper size
shipping_label.insurance_shown	boolean	Insurance shown
shipping_label.insurance_fee_shown	boolean	Insurance amount shown
shipping_label.shipping_fee_shown	boolean	Shipping fee shown
shipping_label.items_shown	boolean	Items section shown
shipping_label.item_description_shown	boolean	Item descriptions shown
shipping_label.item_sku_shown	boolean	Item SKUs shown
shipping_label.origin_phone_shown	boolean	Sender phone shown
shipping_label.origin_address_shown	boolean	Sender address shown
shipping_label.receiver_phone_shown	boolean	Recipient phone shown
shipping_label.receiver_address_shown	boolean	Recipient address shown
shipping_label.censor_receiver_name	boolean	Recipient name censored
shipping_label.file_url	string	URL of the label PDF
shipping_label.created_at	string	Creation timestamp
shipping_label.updated_at	string	Last update timestamp

Response

{
  "success": true,
  "code": 20000000,
  "message": "Shipping label retrieved successfully",
  "shipping_label": {
    "id": "69a8f0c2b49b9700925c1f10",
    "user_id": "5f9a1c2e8b3d4a0012345678",
    "order_id": "69946bae0b2c6f002659f21a",
    "organization_id": "5f9a1c2e8b3d4a0012345679",
    "template": "standard",
    "paper_size": "10x15cm",
    "insurance_shown": true,
    "insurance_fee_shown": true,
    "shipping_fee_shown": true,
    "items_shown": true,
    "item_description_shown": true,
    "item_sku_shown": true,
    "origin_phone_shown": true,
    "origin_address_shown": true,
    "receiver_phone_shown": true,
    "receiver_address_shown": true,
    "censor_receiver_name": true,
    "file_url": "https://biteship.s3.ap-southeast-1.amazonaws.com/public/shipping_labels/1772700711941-69946bae0b2c6f002659f21a.pdf",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Rate Limit

You can make up to 20 requests every 10 seconds.

Errors

HTTP	Code	When
400	40002057	The order ID is invalid or the order is not found
422	42200002	Your plan does not include the Shipping Label API. See Plans & limits
429	42900000	Rate limit exceeded
503	50300000	The label for this order is being generated. Retry shortly