getPackageTrackingDetails

Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.

Usage Plan:

Rate (requests per second)	Burst
2	30

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 have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

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 `getPackageTrackingDetails` operation.

payload

object (PackageTrackingDetails)

optional

Tracking details of package

packageNumber

integer <int32>

required

The package identifier.

trackingNumber

string

optional

The tracking number for the package.

customerTrackingLink

string

optional

Link on swiship.com that allows customers to track the package.

carrierCode

string

optional

The name of the carrier.

carrierPhoneNumber

string

optional

The phone number of the carrier.

carrierURL

string

optional

The URL of the carrier's website.

shipDate

string <date-time>

optional

Date timestamp

estimatedArrivalDate

string <date-time>

optional

Date timestamp

shipToAddress

object (TrackingAddress)

optional

Address information for tracking the package.

currentStatus

enum<string>

optional

The current delivery status of the package.

Allowed values:

IN_TRANSITDELIVEREDRETURNINGRETURNEDUNDELIVERABLEDELAYEDAVAILABLE_FOR_PICKUPCUSTOMER_ACTIONUNKNOWNOUT_FOR_DELIVERYDELIVERY_ATTEMPTEDPICKUP_SUCCESSFULPICKUP_CANCELLEDPICKUP_ATTEMPTEDPICKUP_SCHEDULEDRETURN_REQUEST_ACCEPTEDREFUND_ISSUEDRETURN_RECEIVED_IN_FC

currentStatusDescription

string

optional

Description corresponding to the CurrentStatus value.

signedForBy

string

optional

The name of the person who signed for the package.

additionalLocationInfo

enum<string>

optional

Additional location information.

Allowed values:

AS_INSTRUCTEDCARPORTCUSTOMER_PICKUPDECKDOOR_PERSONFRONT_DESKFRONT_DOORGARAGEGUARDMAIL_ROOMMAIL_SLOTMAILBOXMC_BOYMC_GIRLMC_MANMC_WOMANNEIGHBOROFFICEOUTBUILDINGPATIOPORCHREAR_DOORRECEPTIONISTRECEIVERSECURE_LOCATIONSIDE_DOOR

trackingEvents

array[object (TrackingEvent) {4}]

optional

An array of tracking event information.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

Example

{
    "payload": {
        "packageNumber": 0,
        "trackingNumber": "string",
        "customerTrackingLink": "string",
        "carrierCode": "string",
        "carrierPhoneNumber": "string",
        "carrierURL": "string",
        "shipDate": "2019-08-24T14:15:22Z",
        "estimatedArrivalDate": "2019-08-24T14:15:22Z",
        "shipToAddress": {
            "city": "string",
            "state": "string",
            "country": "string"
        },
        "currentStatus": "IN_TRANSIT",
        "currentStatusDescription": "string",
        "signedForBy": "string",
        "additionalLocationInfo": "AS_INSTRUCTED",
        "trackingEvents": [
            {
                "eventDate": "2019-08-24T14:15:22Z",
                "eventAddress": {
                    "city": "string",
                    "state": "string",
                    "country": "string"
                },
                "eventCode": "EVENT_101",
                "eventDescription": "string"
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

getPackageTrackingDetails

Request

Request samples

Responses