Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
scope parameter of the token request.
| Scope | Description |
|---|---|
read:integration | View your integrations |
write:integration | Connect and manage integrations |
read:order | View your orders |
write:order | Import and process your orders |
write:product | Manage your product catalog |
| Scope | Description |
|---|---|
write:carrier | Configure carriers and contracts |
read:operational-settings | View your warehouses, shipping lanes, and other operational settings |
write:operational-settings | Manage your warehouses, shipping lanes, and other operational settings |
read:parcel | View your shipments and their tracking status |
write:parcel | Create, announce, and cancel shipments |
read:price | View shipping prices |
read:shipping-rule | View your shipping rules |
write:shipping-rule | Create and manage shipping rules |
| Scope | Description |
|---|---|
read:return | View your returns |
write:return | Create and manage returns |
read:return-settings | View your return settings |
write:return-settings | Configure your return settings |
| Scope | Description |
|---|---|
read:pickup | View carrier pickups and the options available for scheduling them |
write:pickup | Schedule and manage carrier pickups |
| Scope | Description |
|---|---|
read:tracking-message | View your tracking notifications |
write:tracking-message | Manage your tracking notifications |
read:tracking-page | View your tracking page |
write:tracking-page | Customize your tracking page |
| Scope | Description |
|---|---|
read:brand | View your brands |
write:brand | Manage your brands |
| Scope | Description |
|---|---|
read:analytics | View your shipping analytics |
| Scope | Description |
|---|---|
read:invoice | View your invoices |
| Scope | Description |
|---|---|
read:notification | View your notifications |
write:notification | Manage your notifications |
read:user | Read your basic account information |
| Scope | Description |
|---|---|
read:organization | View organization settings |
write:organization | Change organization settings |
| Scope | Description |
|---|---|
read:audit-log | View your account’s audit log |
| Scope | Description |
|---|---|
read:support-ticket | View your support tickets |
write:support-ticket | Manage your support tickets |
| Scope | Description |
|---|---|
read:event-subscription | View your event subscriptions |
write:event-subscription | Create and manage your event subscriptions |