API Objects

All API responses follow a consistent structure. This page describes common attributes and patterns you'll encounter when working with the atoship API.

Object Identifiers

Every object in the API has a unique identifier. These IDs are prefixed to indicate the object type, making it easy to identify resources at a glance.

lbl_Shipping Labels

adr_Addresses

trk_Tracking

ins_Insurance

clm_Claims

whk_Webhooks

evt_Events

Common Attributes

Most API objects include these standard attributes:

idstring

Unique identifier for the object

objectstring

Type of object (e.g., "Label", "Address")

created_atdatetime

ISO 8601 timestamp when the object was created

breakdownobject | null

What a rate is made of: items (charge code, display name, amount) that sum to rate to the cent, in currency.basis says where the split came from: carrier — the carrier itemised the price;table— the price was computed from the contracted rate table configured for your account (base rate by weight and zone, plus that tariff's surcharges);estimated — the split was derived from published surcharges. null when no usable itemisation exists — rate is always authoritative.

updated_atdatetime

ISO 8601 timestamp when the object was last modified

Pagination

List endpoints return paginated results. Use query parameters to control pagination:

pageinteger

Page number (default: 1)

limitinteger

Items per page (default: 20, max: 100)

Timestamps

All timestamps are returned in ISO 8601 format in UTC timezone:

2025-01-14T10:30:00Z

OBJECT

Example Structures

1	`{`
2	`"id": "lbl_k7x9m2p4q8r5",`
3	`"object": "Label",`
4	`"status": "purchased",`
5	`"tracking_number": "9400111899223456789012",`
6	`"carrier": "USPS",`
7	`"service": "Priority Mail",`
8	`"rate": 8.95,`
9	`"breakdown": {`
10	`"basis": "carrier",`
11	`"currency": "USD",`
12	`"items": [`
13	`{ "code": "BASE", "name": "Base rate", "amount": 7.60 },`
14	`{ "code": "FUEL", "name": "Fuel surcharge", "amount": 1.35 }`
15	`]`
16	`},`
17	`"currency": "USD",`
18	`"label_url": "https://atoship.com/api/labels/lbl_k7x9m2p4q8r5.pdf",`
19	`"created_at": "2025-01-14T10: 30: 00Z",`
20	`"updated_at": "2025-01-14T10: 30: 00Z"`
21	`}`

ID Prefixes

lbl_Label

adr_Address

trk_Tracking

ins_Insurance

clm_Claim

whk_Webhook

evt_Event

Pagination Query Params

?page=2Page number

?limit=50Items per page

?sort=created_atSort field

?order=descSort direction