Skip to main content
GET
TypeScript

Autorizaciones

Authorization
string
header
requerido

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

shipment:basic:read

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

The shipment id (ship_), or the payment id (pay_) it fulfills.

Respuesta

shipment retrieved

account_id
string
requerido

The account that owns this shipment, prefixed biz_.

Ejemplo:

"biz_xxxxxxxxxxxxxx"

carrier
string | null
requerido

The shipping carrier detected for this shipment. Null until a tracking update identifies it.

Ejemplo:

"ups"

checkpoints
object[]
requerido
created_at
string
requerido

The datetime the shipment was created (ISO 8601).

Ejemplo:

"2026-01-01T12:00:00.000Z"

id
string
requerido

Shipment ID, prefixed ship_.

Ejemplo:

"ship_xxxxxxxxxxxxxx"

payment_id
string
requerido

The payment this shipment fulfills, prefixed pay_.

Ejemplo:

"pay_xxxxxxxxxxxxxx"

status
enum<string>
requerido

The current delivery status of this shipment.

Opciones disponibles:
unknown,
pre_transit,
in_transit,
out_for_delivery,
delivered,
available_for_pickup,
return_to_sender,
failure,
cancelled,
error
Ejemplo:

"in_transit"

tracking_number
string
requerido

The carrier-assigned tracking number used to look up shipment progress.

Ejemplo:

"1Z999AA10123456784"

tracking_url
string
requerido

A customer-facing URL to track this shipment's progress.

Ejemplo:

"https://track.aftership.com/xxxxxxxxxxxxxxxxxx"

updated_at
string
requerido

The datetime the shipment was last updated (ISO 8601).

Ejemplo:

"2026-01-01T12:00:00.000Z"