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

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	"currency": "USD",
10	"label_url": "https://atoship.com/api/labels/lbl_k7x9m2p4q8r5.pdf",
11	"created_at": "2025-01-14T10: 30: 00Z",
12	"updated_at": "2025-01-14T10: 30: 00Z"
13	}

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