Shipment information
delivery-tracking/shipment-info@1.1.12 providers
Retrieve Shipment Status
Get the current shipment status.
Input
Shipment tracking number
Carrier
Result
Carrier
Status
Origin
Shipment tracking number
Destination
Events
Estimated delivery date
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
Copied!
const { SuperfaceClient } = require('@superfaceai/one-sdk');
// You can manage tokens here: https://superface.ai/insights
const sdk = new SuperfaceClient({ sdkAuthToken: '<< Login to get your token >>' });
async function run() {
// Load the profile
const profile = await sdk.getProfile('delivery-tracking/shipment-info@1.1.1');
// Use the profile
const result = await profile
.getUseCase('ShipmentInfo')
.perform({
trackingNumber: '00340434292135100148'
}, {
provider: 'mock'
});
// Handle the result
try {
const data = result.unwrap();
console.log(data);
} catch (error) {
console.error(error);
}
}
run();Copied!
Structure details
Input (object)
trackingNumber
required
The identifier of shipment.
string
carrier
optional
The shipment carrier identification to narrow down the results.
string
Example
{
"trackingNumber": "00340434292135100148"
}Copied!
Result (list of objects)
carrier
required
The name of the carrier responsible for delivery.
string
status
required
The latest shipment event.
object
timestamp
required
The date and time in ISO 8601 format of the event.
string
statusCode
required
The shipment status of the event.
enum
pre_transittransitdeliveredfailureunknown
statusText
required
A description of the current shipment status.
string
location
optional
The location of the shipment.
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
origin
required
A postal address with the origin of the shipment.
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
trackingNumber
required
The identifier of shipment.
string
destination
required
A postal shipping address.
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
A list of delivery tracking events.
list
timestamp
required
The date and time in ISO 8601 format of the event.
string
statusCode
required
The shipment status of the event.
enum
pre_transittransitdeliveredfailureunknown
statusText
required
A description of the current shipment status.
string
location
optional
The location of the shipment.
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
required
Estimated date and time of delivery.
string
Example
[
{
"carrier": "shippo",
"destination": {
"address": {
"addressLocality": "Chicago",
"countryCode": "US",
"postalCode": "60611"
}
},
"estimatedDeliveryDate": "2021-11-08T07:03:30.944Z",
"events": [
{
"statusCode": "unknown",
"statusText": "The carrier has received the electronic shipment information.",
"timestamp": "2021-11-01T19:54:08.906Z"
}
],
"origin": {
"address": {
"addressLocality": "San Francisco",
"countryCode": "US",
"postalCode": "94103"
}
},
"status": {
"location": {
"address": {
"addressLocality": "Chicago",
"countryCode": "US",
"postalCode": "60611"
}
},
"statusCode": "delivered",
"statusText": "Your shipment has been delivered.",
"timestamp": "2021-11-03T23:54:08.906Z"
},
"trackingNumber": "00340434292135100148"
}
]Copied!