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"
}
'

import requests

url = "https://api.arcuserp.com/v1/packages/{id}/buy-label"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.arcuserp.com/v1/packages/{id}/buy-label', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/packages/{id}/buy-label",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/packages/{id}/buy-label"

	payload := strings.NewReader("{\n  \"rate_object_id\": \"<string>\",\n  \"carrier\": \"<string>\",\n  \"service_token\": \"<string>\",\n  \"service_name\": \"<string>\",\n  \"shipment_object_id\": \"<string>\",\n  \"parcel_object_id\": \"<string>\",\n  \"estimated_amount\": 123,\n  \"label_file_type\": \"PDF\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/packages/{id}/buy-label")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rate_object_id\": \"<string>\",\n  \"carrier\": \"<string>\",\n  \"service_token\": \"<string>\",\n  \"service_name\": \"<string>\",\n  \"shipment_object_id\": \"<string>\",\n  \"parcel_object_id\": \"<string>\",\n  \"estimated_amount\": 123,\n  \"label_file_type\": \"PDF\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/packages/{id}/buy-label")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rate_object_id\": \"<string>\",\n  \"carrier\": \"<string>\",\n  \"service_token\": \"<string>\",\n  \"service_name\": \"<string>\",\n  \"shipment_object_id\": \"<string>\",\n  \"parcel_object_id\": \"<string>\",\n  \"estimated_amount\": 123,\n  \"label_file_type\": \"PDF\"\n}"

response = http.request(request)
puts response.read_body

{
  "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,
    "suggest_action": "recharge",
    "threshold": 123,
    "label_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "package_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123",
  "order_status": "cancelled",
  "order_number": "<string>"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Fulfillment

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 --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"
}
'

import requests

url = "https://api.arcuserp.com/v1/packages/{id}/buy-label"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.arcuserp.com/v1/packages/{id}/buy-label', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/packages/{id}/buy-label",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/packages/{id}/buy-label"

	payload := strings.NewReader("{\n  \"rate_object_id\": \"<string>\",\n  \"carrier\": \"<string>\",\n  \"service_token\": \"<string>\",\n  \"service_name\": \"<string>\",\n  \"shipment_object_id\": \"<string>\",\n  \"parcel_object_id\": \"<string>\",\n  \"estimated_amount\": 123,\n  \"label_file_type\": \"PDF\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/packages/{id}/buy-label")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rate_object_id\": \"<string>\",\n  \"carrier\": \"<string>\",\n  \"service_token\": \"<string>\",\n  \"service_name\": \"<string>\",\n  \"shipment_object_id\": \"<string>\",\n  \"parcel_object_id\": \"<string>\",\n  \"estimated_amount\": 123,\n  \"label_file_type\": \"PDF\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/packages/{id}/buy-label")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rate_object_id\": \"<string>\",\n  \"carrier\": \"<string>\",\n  \"service_token\": \"<string>\",\n  \"service_name\": \"<string>\",\n  \"shipment_object_id\": \"<string>\",\n  \"parcel_object_id\": \"<string>\",\n  \"estimated_amount\": 123,\n  \"label_file_type\": \"PDF\"\n}"

response = http.request(request)
puts response.read_body

{
  "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,
    "suggest_action": "recharge",
    "threshold": 123,
    "label_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "package_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123",
  "order_status": "cancelled",
  "order_number": "<string>"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

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

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. 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.

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

Overview

All Endpoints

Purchase a Shippo shipping label for this package

Authorizations

Headers

Path Parameters

Body

Response