getTracking - Amazon SP API

Returns tracking information for a purchased shipment.

Usage Plan:

Rate (requests per second)	Burst
80	100

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Query Params

trackingId

string

required

A carrier-generated tracking identifier originally returned by the purchaseShipment operation.

carrierId

string

required

A carrier identifier originally returned by the getRates operation for the selected rate.

Example:

Header Params

x-amzn-shipping-business-id

enum<string>

optional

Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

Allowed values:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the getTracking operation.

payload

object (GetTrackingResult)

optional

The payload for the getTracking operation.

trackingId

string

required

The shipment tracking identifier provided by the carrier.

alternateLegTrackingId

string

required

The carrier generated reverse identifier for a returned package in a purchased shipment.

eventHistory

array[object (Event) {3}]

required

A list of tracking events.

promisedDeliveryDate

string <date-time>

required

The date and time by which the shipment is promised to be delivered.

summary

object (TrackingSummary)

required

The tracking summary.

Example

{
    "trackingId": "23AA47DE2B3B6",
    "alternateLegTrackingId": "null",
    "eventHistory": [
        {
            "eventCode": "ReadyForReceive",
            "location": {
                "postalCode": "4883493",
                "countryCode": "CC"
            },
            "eventTime": "2019-12-11T07:09:05.513Z"
        }
    ],
    "promisedDeliveryDate": "2019-12-12T13:09:05.513Z",
    "summary": {
        "status": "PreTransit"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable