Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation

Deprecation Notice:

Amazon Marketplace Web Service (MWS) will no longer be available after March 31, 2024. All MWS developers must migrate to Selling Partner API (SP-API) to avoid service disruptions. Refer to the Migration Hub for more information.

Amazon MWS Documentation

GetPackageTrackingDetails

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

Description

The GetPackageTrackingDetails operation returns delivery tracking information for a package in an outbound shipment, based on the PackageNumber that you specify. This operation returns the current tracking status of the package as well as a list of tracking events.

Availability

This operation is available in all marketplaces except Brazil.

Throttling

The GetPackageTrackingDetails operation has a maximum request quota of 30 and a restore rate of two requests every second. For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.

Request parameters

Name Description Required Values
PackageNumber Unencrypted package identifier returned by the GetFulfillmentOrder operation. Yes Type: xs:int

Response elements

Name Description
PackageNumber The package identifier.

Type: xs:int

TrackingNumber The tracking number for the package.

Type: xs:string

CarrierCode The name of the carrier.

Type: xs:string

CarrierPhoneNumber The phone number of the carrier.

Type: xs:string

CarrierURL The URL of the carrier’s website.

Type: xs:string

ShipDate The shipping date for the package.

Type: xs:dateTime

ShipToAddress The destination city for the package.

Type: TrackingAddress

CurrentStatus The current delivery status of the package.

CurrentStatus values:

  • IN_TRANSIT - In transit to the destination address.
  • DELIVERED - Delivered to the destination address.
  • RETURNING - In the process of being returned to Amazon's fulfillment network.
  • RETURNED - Returned to Amazon's fulfillment network.
  • UNDELIVERABLE - Undeliverable because package was lost or destroyed.
  • DELAYED - Delayed.
  • AVAILABLE_FOR_PICKUP - Available for pickup.
  • CUSTOMER_ACTION - Requires customer action.

Type: xs:string

SignedForBy The name of the person who signed for the package.

Type: xs:string

EstimatedArrivalDate The estimated arrival date.

Type: xs:dateTime

TrackingEvents A list of tracking events.

Type: List of TrackingEvent

AdditionalLocationInfo Additional location information.

AdditionalLocationInfo values:

  • AS_INSTRUCTED - As instructed.
  • CARPORT - Carport.
  • CUSTOMER_PICKUP - Picked up by customer.
  • DECK - Deck.
  • DOOR_PERSON - Resident.
  • FRONT_DESK - Front desk.
  • FRONT_DOOR - Front door.
  • GARAGE - Garage.
  • GUARD - Residential guard.
  • MAIL_ROOM - Mail room.
  • MAIL_SLOT - Mail slot.
  • MAILBOX - Mailbox.
  • MC_BOY - Delivered to male child.
  • MC_GIRL - Delivered to female child.
  • MC_MAN - Delivered to male adult.
  • MC_WOMAN - Delivered to female adult.
  • NEIGHBOR - Delivered to neighbor.
  • OFFICE - Office.
  • OUTBUILDING - Outbuilding.
  • PATIO - Patio.
  • PORCH - Porch.
  • REAR_DOOR - Rear door.
  • RECEPTIONIST - Receptionist.
  • RECEIVER - Resident.
  • SECURE_LOCATION - Secure location.
  • SIDE_DOOR - Side door.

Type: xs:string

Examples

Example query request

For information about standard request requirements, see Required request parameters.

Show example code Hide example code

http://mws.amazonservices.com/FulfillmentOutboundShipment/2010-10-01/
  ?Action=GetPackageTrackingDetails
  &Version=2010-10-01
  &AWSAccessKeyId=AKIAJGUEXAMPLEE2NVUA
  &MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Signature=ZRA9DR5rveSuz%2F1D18AHvoipg2BAev8yblPQ1BbEbfU%3D
  &Timestamp=2010-10-01T02:40:36Z
  &SellerId=A2NKEXAMPLEF53
  &PackageNumber=42343

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0"?>
<GetPackageTrackingDetailsResponse xmlns="http://mws.amazonaws.com/
    FulfillmentOutboundShipment/2010-10-01/">
    <GetPackageTrackingDetailsResult>
        <PackageNumber>42343</PackageNumber>
        <TrackingNumber>3A18351E0390447173</TrackingNumber>
        <CarrierCode>UPS</CarrierCode>
        <CarrierPhoneNumber>206-000-0000</CarrierPhoneNumber>
        <CarrierURL>http://www.ups.com/</CarrierURL>
        <ShipDate>2012-03-09T10:27:10Z</ShipDate>
        <ShipToAddress>
            <City>Seattle</City>
            <State>WA</State>
            <Country>US</Country>
        </ShipToAddress>
        <CurrentStatus>DELIVERED</CurrentStatus>
        <SignedForBy>John</SignedForBy>
        <EstimatedArrivalDate>2012-03-09T10:00:00Z</EstimatedArrivalDate>
        <TrackingEvents>
            <member>
                <EventDate>2012-03-09T08:48:53Z</EventDate>
                <EventAddress>
                    <City>Reno</City>
                    <State>NV</State>
                    <Country>US</Country>
                </EventAddress>
                <EventCode>EVENT_202</EventCode>
            </member>
            <member>
                <EventDate>2012-03-10T10:27:10Z</EventDate>
                <EventAddress>
                    <City>Seattle</City>
                    <State>WA</State>
                    <Country>US</Country>
                </EventAddress>
                <EventCode>EVENT_301</EventCode>
            </member>
        </TrackingEvents>
        <AdditionalLocationInfo>FRONT_DESK</AdditionalLocationInfo>
    </GetPackageTrackingDetailsResult>
    <ResponseMetaData>
        <RequestId>5e5e5694-8e76-11df-929f-87c80302f8f6</RequestId>
    </ResponseMetaData>
</GetPackageTrackingDetailsResponse>

↑ Top