Overview

Shipping Label API Introduction

The Shipping Label API generates a ready-to-print PDF label for your Biteship orders. Use it for one order at a time, or for up to 50 orders combined into one PDF.

Endpoints

GET     /v1/orders/:order_id/shipping_labels
POST    /v1/bulk_shipping_labels
GET     /v1/bulk_shipping_labels/:bulk_label_id

The Shipping Label API requires Grow or higher. See Plans & limits. You can still download labels from the Biteship dashboard on every plan.

Single or Bulk

Use case	Endpoint
Print a label for one order	Get Shipping Labels returns a file_url for the PDF right away.
Print labels for many orders in one file	Create Bulk Shipping Labels starts the job, then Get Bulk Shipping Labels returns the file_url once it is done.

To see what is printed on a label, see Label Example.

Label Settings

Every endpoint accepts the same label settings. All of them are optional. For each setting, Biteship uses the first value it finds:

1. The value in your request.
2. Your default settings in the Biteship dashboard.
3. The default value below.

Setting	Type	Default	Description
paper_size	string	10x15cm	Paper size: a4, 8x10cm, or 10x15cm
template	string	standard	Label template. Currently only standard
insurance_shown	boolean	true	Show insurance information
insurance_fee_shown	boolean	true	Show the insurance amount. If false while insurance is shown, the label prints YES instead of the amount
shipping_fee_shown	boolean	true	Show the shipping fee
items_shown	boolean	true	Show the items section
item_description_shown	boolean	true	Show item descriptions
item_sku_shown	boolean	true	Show item SKUs
origin_phone_shown	boolean	true	Show the sender phone
origin_address_shown	boolean	true	Show the sender address
receiver_phone_shown	boolean	true	Show the recipient phone
receiver_address_shown	boolean	true	Show the recipient address
censor_receiver_name	boolean	true	Censor the recipient name

A label is a snapshot of the order at the time it was first generated. Later requests for the same order with the same settings return the same file.