You are viewing a section of Superface that will be deprecated in Q4 2023. Until then, you can continue to use it as you have before but we recommend that you migrate to our latest version soon. For more details visit superface.ai/docs/migrate.
Shipment information
delivery-tracking/shipment-info@1.0.12 providers
Retrieve Shipment Status
Get the actual shipment status.
Input
Shipment tracking number
Carrier
Result
Carrier
Shipment tracking number
origin
destination
status
events
Estimated date and time of delivery
1.Choose a provider
2.Use ShipmentInfo with mock in your code
Below instructions are for our Node.js SDK. Use OneService for other languages.
npm i @superfaceai/one-sdk
Structure details
Input (object)
trackingNumber
required
Identifier of shipment
string
carrier
optional
Shipment carrier identification
string
Example
Result (list of objects)
carrier
required
Shipment carrier identification
string
trackingNumber
required
Identifier of shipment
string
origin
required
object
address
required
object
countryCode
optional
A short text string code (ISO 3166-1 alpha-2 country code) specifying the country.
string
postalCode
optional
Text specifying the postal code for an address.
string
addressLocality
optional
Text specifying the name of the locality, for example a city.
string
streetAddress
optional
The street address expressed as free form text. The street address is printed on paper as the first lines below the name.
string
destination
required
object
address
required
object
countryCode
optional
A short text string code (ISO 3166-1 alpha-2 country code) specifying the country.
string
postalCode
optional
Text specifying the postal code for an address.
string
addressLocality
optional
Text specifying the name of the locality, for example a city.
string
streetAddress
optional
The street address expressed as free form text. The street address is printed on paper as the first lines below the name.
string
status
optional
object
timestamp
required
string
statusCode
required
enum
pre_transittransitdeliveredfailureunknown
statusText
required
string
location
optional
object
address
required
object
countryCode
optional
A short text string code (ISO 3166-1 alpha-2 country code) specifying the country.
string
postalCode
optional
Text specifying the postal code for an address.
string
addressLocality
optional
Text specifying the name of the locality, for example a city.
string
streetAddress
optional
The street address expressed as free form text. The street address is printed on paper as the first lines below the name.
string
events
required
list
timestamp
required
string
statusCode
required
enum
pre_transittransitdeliveredfailureunknown
statusText
required
string
location
optional
object
address
required
object
countryCode
optional
A short text string code (ISO 3166-1 alpha-2 country code) specifying the country.
string
postalCode
optional
Text specifying the postal code for an address.
string
addressLocality
optional
Text specifying the name of the locality, for example a city.
string
streetAddress
optional
The street address expressed as free form text. The street address is printed on paper as the first lines below the name.
string
estimatedDeliveryDate
optional
Estimated date and time of delivery
string