Skip to main content
Usa la API de Shipments para listar los envíos de una cuenta, obtener uno por su ID o por el pago que cumple, asociar un número de seguimiento a un pago y actualizar el número de seguimiento de un envío existente.

Endpoints

Atributos

string
requerido
ID del envío, con el prefijo ship_.
string
requerido
La cuenta propietaria de este envío, con el prefijo biz_.
string | null
requerido
El transportista detectado para este envío. Es null hasta que una actualización de seguimiento lo identifica.
object[]
requerido
Historial de escaneos del transportista para este envío, del escaneo más antiguo al más reciente. Vacío hasta que el transportista informa su primer escaneo.

Propiedades

string | null
requerido
Dónde registró el transportista el escaneo, como PHILADELPHIA, PA. Es null cuando el transportista no envió ninguno.
string | null
requerido
Descripción del escaneo por parte del transportista, como Departed USPS Regional Facility. Es null cuando el transportista no envió ninguna.
string
requerido
Estado de entrega al que corresponde este escaneo del transportista.Opciones disponibles: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
string | null
requerido
Cuándo registró el transportista el escaneo, como marca de tiempo ISO 8601. Es null cuando el transportista no envió la hora del escaneo.
string
requerido
La fecha y hora en que se creó el envío (ISO 8601).
string
requerido
El pago que cumple este envío, con el prefijo pay_.
string
requerido
El estado de entrega actual de este envío.Opciones disponibles: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
string
requerido
El número de seguimiento asignado por el transportista que se usa para consultar el progreso del envío.
string
requerido
Una URL para el cliente con la que seguir el progreso de este envío.
string
requerido
La fecha y hora en que se actualizó el envío por última vez (ISO 8601).
Shipment