Skip to main content
Brug Shipments API’et til at vise en kontos forsendelser, hente en efter dens id eller den betaling, den opfylder, knytte et trackingnummer til en betaling og opdatere trackingnummeret på en eksisterende forsendelse.

Endpoints

Attributter

string
påkrævet
Shipment-id med præfikset ship_.
string
påkrævet
Den konto, der ejer denne forsendelse, med præfikset biz_.
string | null
påkrævet
Det fragtfirma, der er registreret for denne forsendelse. Null, indtil en trackingopdatering identificerer det.
object[]
påkrævet
Fragtfirmaets scanningshistorik for denne forsendelse, ældste scanning først. Tom, indtil fragtfirmaet rapporterer sin første scanning.

Egenskaber

string | null
påkrævet
Hvor fragtfirmaet registrerede scanningen, f.eks. PHILADELPHIA, PA. Null, når fragtfirmaet ikke sendte nogen.
string | null
påkrævet
Fragtfirmaets beskrivelse af scanningen, f.eks. Departed USPS Regional Facility. Null, når fragtfirmaet ikke sendte nogen.
string
påkrævet
Den leveringsstatus, som denne scanning fra fragtfirmaet svarer til.Tilgængelige muligheder: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
string | null
påkrævet
Hvornår fragtfirmaet registrerede scanningen, som et ISO 8601-tidsstempel. Null, når fragtfirmaet ikke sendte noget scanningstidspunkt.
string
påkrævet
Det tidspunkt, hvor forsendelsen blev oprettet (ISO 8601).
string
påkrævet
Den betaling, som denne forsendelse opfylder, med præfikset pay_.
string
påkrævet
Forsendelsens aktuelle leveringsstatus.Tilgængelige muligheder: unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error
string
påkrævet
Det trackingnummer, som fragtfirmaet har tildelt, og som bruges til at slå forsendelsens fremskridt op.
string
påkrævet
En URL til kunden, hvor forsendelsens fremskridt kan følges.
string
påkrævet
Det tidspunkt, hvor forsendelsen sidst blev opdateret (ISO 8601).
Shipment