curl --request POST \
  --url https://api.arcuserp.com/v1/packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "carrier_service": "ups_ground",
  "items": [
    {
      "order_item_id": "11111111-2222-3333-4444-555555555555",
      "quantity": 2,
      "serial_numbers": [
        "SN001",
        "SN002"
      ]
    },
    {
      "order_item_id": "22222222-3333-4444-5555-666666666666",
      "quantity": 1
    }
  ],
  "buy_label": true,
  "rate_object_id": "SHIPPO_RATE_OBJECT_ID",
  "fulfill_after_label": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "package",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "package_number": "<string>",
  "weight_lb": 123,
  "length_in": 123,
  "width_in": 123,
  "height_in": 123,
  "carrier": "<string>",
  "service_level": "<string>",
  "tracking_number": "<string>",
  "tracking_url": "<string>",
  "ship_cost": 123,
  "billed_ship_cost": 123,
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "insurance_amount_override": 123,
  "insurance": {
    "active": true,
    "bought": true,
    "amount": 123,
    "currency": "<string>",
    "fee_estimate": 123,
    "provider": "<string>",
    "covered_items": [
      "<string>"
    ],
    "covered_item_count": 123
  },
  "shipped_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

{
  "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

Create a new package on an order

Creates a new shipment package for an order, optionally seeding it with line items from the order. Specify the order_id, box dimensions and weight, and carrier preferences. The package starts in status: draft; call POST /packages/{id}/print-label to purchase a shipping label. Requires fulfillment:write scope.

Revision acknowledgment gate (HTTP 409 revision_unacknowledged). If the parent order was revised after the customer received their copy and the customer has not yet acknowledged the new total, this endpoint returns HTTP 409 with code: revision_unacknowledged. Lift the gate via POST /v1/orders/{id}/customer-acknowledge-revision, or bypass with ?override=true / {"skip_revision_ack": true} in the body (requires orders.revision_override permission).

POST

packages

curl --request POST \
  --url https://api.arcuserp.com/v1/packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "carrier_service": "ups_ground",
  "items": [
    {
      "order_item_id": "11111111-2222-3333-4444-555555555555",
      "quantity": 2,
      "serial_numbers": [
        "SN001",
        "SN002"
      ]
    },
    {
      "order_item_id": "22222222-3333-4444-5555-666666666666",
      "quantity": 1
    }
  ],
  "buy_label": true,
  "rate_object_id": "SHIPPO_RATE_OBJECT_ID",
  "fulfill_after_label": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "package",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "package_number": "<string>",
  "weight_lb": 123,
  "length_in": 123,
  "width_in": 123,
  "height_in": 123,
  "carrier": "<string>",
  "service_level": "<string>",
  "tracking_number": "<string>",
  "tracking_url": "<string>",
  "ship_cost": 123,
  "billed_ship_cost": 123,
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "insurance_amount_override": 123,
  "insurance": {
    "active": true,
    "bought": true,
    "amount": 123,
    "currency": "<string>",
    "fee_estimate": 123,
    "provider": "<string>",
    "covered_items": [
      "<string>"
    ],
    "covered_item_count": 123
  },
  "shipped_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

{
  "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

Body

application/json

order_id

string<uuid>

required

Required. Parent sales order UUID. Must be a confirmed sales order.

box_product_id

string<uuid>

Product record for the box. Drives dimensions + PackPilot category matching.

length

number

Length in inches.

width

number

Width in inches.

height

number

Height in inches.

weight

number

Weight in lbs.

notes

string

metadata

object

carrier_service

string

Compound carrier+service string (e.g. 'ups_ground', 'fedex_priority_overnight'). Mapped to carrier+service fields automatically. Alternative to passing carrier+service separately.

Example:

"ups_ground"

carrier

string

Carrier code (e.g. 'ups', 'fedex', 'usps'). Use carrier_service for combined form.

service

string

Service level (e.g. 'ground', 'priority_overnight'). Use carrier_service for combined form.

items

object[]

Inline line items to add to the package. Added atomically with the package creation.

Show child attributes

buy_label

boolean

default:false

If true, purchase a Shippo label immediately after package creation. Requires rate_object_id. If label purchase fails, the package is still created and returned in the error body.

rate_object_id

string

Required with buy_label=true. Shippo rate object ID from GET /v1/packages/:id/rates.

fulfill_after_label

boolean

default:false

If true, fulfill the package immediately after label purchase. Posts GL fulfillment entries (DR COGS/CR Inventory, DR AR/CR Revenue), decrements inventory, queues shipment notification. Only fires when buy_label=true AND label purchase succeeds.

label_file_type

enum<string>

default:PDF

Label format for Shippo. PDF is the default.

Available options:

PDF,

PNG,

ZPLII

Response

Created package (hydrated with items, and label/fulfillment data if inline operations ran)

A shipment / box created during fulfillment. One package contains many package items (line item splits) and at most one shipment label.

string<uuid>

object

enum<string>

Available options:

package

entity_id

string<uuid>

read-only

order_id

string<uuid>

package_number

string

read-only

Sequential per entity.

status

enum<string>

read-only

Available options:

packing,

packed,

labeled,

shipped,

delivered,

returned,

void

weight_lb

number | null

length_in

number | null

width_in

number | null

height_in

number | null

carrier

string | null

e.g. ups, usps, fedex, dhl.

service_level

string | null

e.g. ground, priority, 2day.

tracking_number

string | null

tracking_url

string | null

ship_cost

number | null

billed_ship_cost

number | null

Cost billed to customer (vs purchased cost).

location_id

string<uuid> | null

insurance_amount_override

number | null

Manual override of the auto-computed Shippo-insurance declared value. When set, overrides the value derived from products flagged apply_freight_insurance.

insurance

object | null

read-only

Auto-insurance summary. null when no package item opts in and there is no override / entity threshold. bought: true after a label has been purchased (amount = the value actually insured at Shippo); bought: false projects what the next label purchase will insure.

Show child attributes

shipped_at

string<date-time> | null

read-only

delivered_at

string<date-time> | null

read-only

metadata

object | null

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

List packages Retrieve a single package