Get Bulk Shipping Labels

Endpoint

GET /v1/bulk_shipping_labels/:bulk_label_id

Returns the status of a bulk label job, and the file_url of the combined PDF once it is completed. Poll this endpoint every few seconds until status is completed or failed.

Status	Description
pending	The job is queued and has not started
processing	Labels are being generated
completed	At least one label was generated. file_url is available. Any order that could not be generated is listed in error_message
failed	No label could be generated. See error_message

Request Parameters

Parameter	Type	Required	Description
bulk_label_id	string	Yes	Bulk label ID from Create Bulk Shipping Labels (path parameter)

Request

curl --request GET \
  --url https://api.biteship.com/v1/bulk_shipping_labels/<<BULK_LABEL_ID>> \
  --header 'authorization: <<YOUR_API_KEY>>'

Response

The response has the same fields as Create Bulk Shipping Labels.

Response

{
  "success": true,
  "code": 20000000,
  "message": "Bulk shipping label retrieved successfully",
  "bulk_label": {
    "id": "69ae6df7b49b9700925c2229",
    "user_id": "5f9a1c2e8b3d4a0012345678",
    "organization_id": "5f9a1c2e8b3d4a0012345679",
    "status": "completed",
    "order_ids": ["69946bae0b2c6f002659f21a", "69946bae0b2c6f002659f21b", "69946bae0b2c6f002659f21c"],
    "settings": {
      "paper_size": "10x15cm",
      "template": "standard",
      "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/bulk/1773039096530-69ae6df7b49b9700925c2229.pdf",
    "error_message": null,
    "processed_count": 3,
    "order_count": 3,
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Errors

HTTP	Code	When
404	40400000	The bulk label is not found