Skip to main content
POST
/
packages
/
{id}
/
buy-label
Purchase a Shippo shipping label for this package
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"
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

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

Purchased label record

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