Purchase a Shippo shipping label for this package

Required API key scope: fulfillment:write

Delegates to purchaseLabel in routes/shipping.mjs via buyLabelForPackage canonical helper. Requires a configured Shippo connector for the entity. The purchased label URL and tracking number are saved to fulfillment.package_shipment_labels. Idempotent via Idempotency-Key.

Terminal orders are refused (409 order_not_spendable). If the package’s order has reached a terminal state (cancelled, archived, or expired) Arcus will not spend carrier money against it. A voided order is a cancelled order and is included. Reinstate the order, or create a new order for the shipment. The refusal is evaluated immediately before the carrier is called, so an order cancelled while a label purchase is in flight is still refused.

POST /packages/{id}/buy-label

Purchase a Shippo shipping label for this package

cURL

curl --request POST \
  --url https://api.arcuserp.com/v1/packages/{id}/buy-label \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rate_object_id": "<string>",
  "carrier": "<string>",
  "service_token": "<string>",
  "service_name": "<string>",
  "shipment_object_id": "<string>",
  "parcel_object_id": "<string>",
  "estimated_amount": 123,
  "label_file_type": "PDF"
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "package_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrier": "<string>",
  "service_level": "<string>",
  "tracking_number": "<string>",
  "label_url": "<string>",
  "label_pdf_url": "<string>",
  "purchased_cost": 123,
  "billed_cost": 123,
  "purchased_at": "2023-11-07T05:31:56Z",
  "voided_at": "2023-11-07T05:31:56Z",
  "shipping_cost_analysis": {
    "customer_charged": 123,
    "carrier_cost": 123,
    "delta": 123,
    "threshold": 123,
    "label_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "package_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization · string · header · required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key · string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

id · string<uuid> · required

Body

application/json

rate_object_id · string

carrier · string

service_token · string

service_name · string

shipment_object_id · string

parcel_object_id · string

estimated_amount · number

label_file_type · enum<string> · default: PDF

Available options: PDF, ZPLII, PNG

Response

200

application/json

Purchased label record. NEW-GAP-RERATE-SHIPPING-CHARGE-DELTA-WORKFLOW (2026-05-16): the response now includes a shipping_cost_analysis block when the carrier cost diverges from what the customer was charged for shipping. When suggest_action !== 'absorb', the operator (or a downstream automation) should call POST /packages/{id}/recharge-label to settle the delta.

A shipping label purchased from a carrier (typically Shippo). One label per package. URLs expire 30 days after purchase; persist the PDF locally for long-term retention.

id · string<uuid>

package_id · string<uuid>

carrier · string

service_level · string

tracking_number · string

label_url · string

Carrier-hosted PDF URL (time-limited).

label_pdf_url · string | null

Arcus-archived PDF URL (permanent).

purchased_cost · number

Amount Arcus paid the carrier.

billed_cost · number | null

Amount billed to the customer.

purchased_at · string<date-time> · read-only

voided_at · string<date-time> | null · read-only

shipping_cost_analysis · object | null

Carrier-cost-vs-customer-charged delta. Null when the analysis could not be computed (logged server-side as a non-blocking warning).

Show child attributes