Skip to main content
Utilisez l’API Shipments pour lister les expéditions d’un compte, en récupérer une par son ID ou par le paiement qu’elle honore, associer un numéro de suivi à un paiement et mettre à jour le numéro de suivi d’une expédition existante.

Endpoints

Attributs

string
requis
ID de l’expédition, préfixé par ship_.
string
requis
Le compte propriétaire de cette expédition, préfixé par biz_.
string | null
requis
Le transporteur détecté pour cette expédition. Null jusqu’à ce qu’une mise à jour de suivi l’identifie.
object[]
requis
Historique des scans du transporteur pour cette expédition, du plus ancien au plus récent. Vide jusqu’à ce que le transporteur signale son premier scan.

Propriétés

string | null
requis
Lieu où le transporteur a enregistré le scan, par exemple PHILADELPHIA, PA. Null si le transporteur n’en a envoyé aucun.
string | null
requis
Description du scan par le transporteur, par exemple Departed USPS Regional Facility. Null si le transporteur n’en a envoyé aucune.
string
requis
Statut de livraison correspondant à ce scan du transporteur.Options disponibles : unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
string | null
requis
Date à laquelle le transporteur a enregistré le scan, sous forme d’horodatage ISO 8601. Null si le transporteur n’a envoyé aucune heure de scan.
string
requis
Date et heure de création de l’expédition (ISO 8601).
string
requis
Le paiement honoré par cette expédition, préfixé par pay_.
string
requis
Le statut de livraison actuel de cette expédition.Options disponibles : unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
string
requis
Le numéro de suivi attribué par le transporteur, utilisé pour consulter la progression de l’expédition.
string
requis
Une URL destinée au client pour suivre la progression de cette expédition.
string
requis
Date et heure de la dernière mise à jour de l’expédition (ISO 8601).
Shipment