Skip to main content
GET
/
packages
List packages
curl --request GET \
  --url https://api.arcuserp.com/v1/packages \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "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>",
      "status": "packing",
      "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",
      "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"
    }
  ],
  "has_more": true
}

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.

Query Parameters

order_id
string<uuid>
status
enum<string>
Available options:
open,
fulfilled,
voided
location_id
string<uuid>
expand[]
enum<string>[]
Available options:
data.items,
data.items.product,
data.label,
data.tracking_events,
data.order

Response

Paginated package list

object
enum<string>
Available options:
list
data
object[]
has_more
boolean