Amazon Business API for Package Tracking Details

Overview

With the Amazon Business API for Package Tracking Details, you can build tracking applications that help Amazon Business customers get granular tracking details.

Version information

Version : 2025-07-02

Contact information

Contact : AB Support
Contact URL : https://developer-docs.amazon.com/amazon-business/

License information

License : Amazon Software License
License URL : https://aws.amazon.com/asl/

URI scheme

Host : api.business.amazon.com
Schemes : HTTPS

Consumes

application/json

Produces

application/json

External Docs

Description : Learn more about Amazon Business.
URL : https://business.amazon.com

Operations

getPackageTrackingDetails

Paths

GET /ab-tracking/2025-07-02/orders/{orderId}/shipments/{shipmentId}/packages/{packageId}

Operation: getPackageTrackingDetails

Description

Returns detailed tracking information for a package.

Usage Plan:

Rate (requests per second)	Burst
0.5	10

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.

Parameters

Type	Name	Description	Schema	Default
Path	orderId required	The unique identifier of an order.	string	-
Path	shipmentId required	The unique identifier for a shipment whose package tracking details are to be retrieved.	string	-
Path	packageId required	The unique identifier of the package whose tracking details are to be retrieved.	string	-
Query	locale optional	The locale of the request in the form of an IETF language tag. The format is [two-letter language code]-[Two-letter country code], such as en-US for American English. If not specified, the default value will be en-US.	string	`"en-US"`
Query	region required	The region where the customer wants to track the package.	enum (Region)	-

Responses

HTTP Code	Description	Schema
200	The package tracking details were successfully retrieved. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference identifier.	GetPackageTrackingDetailsResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP Code	Description	Schema
400	Request has missing or invalid parameters and cannot be parsed. Headers: `x-amzn-RateLimit-Limit` (string):Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
404	The resource specified does not exist. Headers: `x-amzn-RateLimit-Limit` (string):Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
413	The request size exceeded the maximum accepted size. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
415	The request payload is in an unsupported format. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
429	The frequency of requests was greater than allowed. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
503	Temporary overloading or maintenance of the server. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
504	A gateway timeout occurred. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList

Definitions

GetPackageTrackingDetailsResponse

Response object for the getPackageTrackingDetails operation.

Name	Description	Schema
packageTrackingDetails required	Detailed tracking information for a package.	PackageTrackingDetails

PackageTrackingDetails

Detailed tracking information for a package.

Name	Description	Schema
trackingStatus required	The current tracking status of the package. Possible values: - `ORDERED` : The order has been placed but not yet shipped. - `SHIPPED` : The package has been shipped. - `OUT_FOR_DELIVERY` : The package is out for delivery. - `DELIVERED` : The package has been delivered.	string
localizedDeliveryPromise required	Localized description of the delivery promise.	string
deliveryWindow optional	The time window when the package is expected to be delivered.	TimeWindow
carrierDetails optional	Carrier details of the package.	CarrierDetails
packageTrackingEvents optional	A list of tracking events for the package.	< PackageTrackingEvent > array
packageMilestones optional	A list of milestone events in the package's journey.	< PackageMilestone > array

TimeWindow

A time window with start and end dates.

Name	Description	Schema
startDate optional	The estimated start date in ISO-8601 format.	string (date-time)
endDate required	The estimated end date in ISO-8601 format.	string (date-time)

CarrierDetails

Information about the carrier delivering the package.

Name	Description	Schema
localizedCarrierName optional	The localized name of the carrier delivering the package.	string
carrierTrackingId optional	The tracking identifier assigned by the carrier.	string

PackageTrackingEvent

Package tracking event for the package.

Name	Description	Schema
localizedDescription optional	Localized description of the package tracking event.	string
localizedEventDate optional	Localized event date of the package tracking event in human-readable format.	string
localizedEventTime optional	Localized event time of the package tracking event in human-readable format.	string
location optional	The location where the tracking event occurred.	EventLocation

EventLocation

The location where the tracking event occurred.

Name	Description	Schema
city optional	The city where the tracking event occurred.	string
state optional	The state where the tracking event occurred.	string
country optional	The country where the tracking event occurred.	string

PackageMilestone

Represents a significant event in the package's journey.

Name	Description	Schema
milestoneType required	The identifier of the package milestone event.	enum (MilestoneType)
milestoneWindow required	The time window for the milestone event.	TimeWindow

Error

Error response returned when the request is unsuccessful.

Name	Description	Schema
code required	An error code that identifies the type of error that occurred.	string
message required	A message that describes the error condition.	string
details optional	Additional details that can help the caller understand or fix the issue.	string

ErrorList

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

Name	Description	Schema
errors required	A list of error responses returned when a request is unsuccessful.	< Error > array

Region

The region where the customer wants to track the package.

Type : enum

Value	Description
DE	Germany
FR	France
UK	United Kingdom
IT	Italy
ES	Spain
IN	India
US	United States of America
CA	Canada
MX	Mexico
JP	Japan
AU	Australia

MilestoneType

The identifier of the package milestone event.

Type : enum

Value	Description
DELIVERED	The package has been delivered.
OUT_FOR_DELIVERY	The package is out for delivery.
SHIPPED	The package has been shipped.
ORDERED	The order has been placed but not yet shipped.