Objetos de la API

Todas las respuestas de la API siguen una estructura coherente. Esta página describe los atributos y patrones comunes con los que te toparás al trabajar con la API de atoship.

Identificadores de objetos

Cada objeto de la API tiene un identificador único. Estos IDs llevan un prefijo que indica el tipo de objeto, lo que permite reconocer cada recurso de un vistazo.

lbl_Etiquetas de envío

adr_Direcciones

trk_Seguimiento

ins_Seguros

clm_Reclamaciones

whk_Webhooks

evt_Eventos

Atributos comunes

La mayoría de los objetos de la API incluyen estos atributos estándar:

idstring

Identificador único del objeto

objectstring

Tipo de objeto (p. ej., "Label", "Address")

created_atdatetime

Marca de tiempo ISO 8601 de cuándo se creó el objeto

updated_atdatetime

Marca de tiempo ISO 8601 de la última modificación del objeto

Paginación

Los endpoints de listado devuelven resultados paginados. Usa parámetros de consulta para controlar la paginación:

pageinteger

Número de página (por defecto: 1)

limitinteger

Elementos por página (por defecto: 20, máx.: 100)

Marcas de tiempo

Todas las marcas de tiempo se devuelven en formato ISO 8601 y en zona horaria UTC:

2025-01-14T10:30:00Z

OBJECT

Estructuras de ejemplo

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	}

Prefijos de ID

lbl_Label

adr_Address

trk_Tracking

ins_Insurance

clm_Claim

whk_Webhook

evt_Event

Parámetros de consulta de paginación

?page=2Número de página

?limit=50Elementos por página

?sort=created_atCampo de ordenación

?order=descDirección de ordenación