Skip to main content
Gebruik de Shipments API om de zendingen van een account weer te geven, er een op te halen via het ID of de betaling die ermee wordt afgehandeld, een trackingnummer aan een betaling te koppelen en het trackingnummer van een bestaande zending bij te werken.

Endpoints

Attributen

string
vereist
Shipment-ID, met prefix ship_.
string
vereist
Het account dat eigenaar is van deze zending, met prefix biz_.
string | null
vereist
De vervoerder die voor deze zending is gedetecteerd. Null totdat een trackingupdate de vervoerder identificeert.
object[]
vereist
Scangeschiedenis van de vervoerder voor deze zending, oudste scan eerst. Leeg totdat de vervoerder de eerste scan meldt.

Eigenschappen

string | null
vereist
Waar de vervoerder de scan heeft geregistreerd, zoals PHILADELPHIA, PA. Null als de vervoerder niets heeft doorgegeven.
string | null
vereist
Beschrijving van de scan door de vervoerder, zoals Departed USPS Regional Facility. Null als de vervoerder niets heeft doorgegeven.
string
vereist
Leveringsstatus waaraan deze scan van de vervoerder is gekoppeld.Beschikbare opties: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
string | null
vereist
Wanneer de vervoerder de scan heeft geregistreerd, als ISO 8601-tijdstempel. Null als de vervoerder geen scantijd heeft doorgegeven.
string
vereist
De datum en tijd waarop de zending is aangemaakt (ISO 8601).
string
vereist
De betaling die met deze zending wordt afgehandeld, met prefix pay_.
string
vereist
De huidige leveringsstatus van deze zending.Beschikbare opties: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
string
vereist
Het door de vervoerder toegewezen trackingnummer waarmee de voortgang van de zending wordt opgezocht.
string
vereist
Een URL voor de klant om de voortgang van deze zending te volgen.
string
vereist
De datum en tijd waarop de zending voor het laatst is bijgewerkt (ISO 8601).
Shipment