Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$queryParams = new CkJsonObject();
$queryParams->UpdateString('trackingId','<string>');
$queryParams->UpdateString('carrierId','<string>');
$http->SetRequestHeader('x-amzn-shipping-business-id','AmazonShipping_US');
$http->SetRequestHeader('Accept','application/json');
// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://sellingpartnerapi-eu.amazon.com/shipping/v2/tracking',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "payload": {
// "eventHistory": [
// {
// "eventCode": "Rejected",
// "eventTime": "<dateTime>",
// "location": {
// "stateOrRegion": "<string>",
// "city": "<string>",
// "countryCode": "<string>",
// "postalCode": "<string>"
// }
// },
// {
// "eventCode": "Lost",
// "eventTime": "<dateTime>",
// "location": {
// "stateOrRegion": "<string>",
// "city": "<string>",
// "countryCode": "<string>",
// "postalCode": "<string>"
// }
// }
// ],
// "promisedDeliveryDate": "<dateTime>",
// "summary": {
// "status": "Rejected"
// },
// "trackingId": "<string>",
// "alternateLegTrackingId": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$PromisedDeliveryDate = $jResp->stringOf('payload.promisedDeliveryDate');
$Status = $jResp->stringOf('payload.summary.status');
$TrackingId = $jResp->stringOf('payload.trackingId');
$AlternateLegTrackingId = $jResp->stringOf('payload.alternateLegTrackingId');
$i = 0;
$count_i = $jResp->SizeOfArray('payload.eventHistory');
while ($i < $count_i) {
$jResp->put_I($i);
$eventCode = $jResp->stringOf('payload.eventHistory[i].eventCode');
$eventTime = $jResp->stringOf('payload.eventHistory[i].eventTime');
$StateOrRegion = $jResp->stringOf('payload.eventHistory[i].location.stateOrRegion');
$City = $jResp->stringOf('payload.eventHistory[i].location.city');
$CountryCode = $jResp->stringOf('payload.eventHistory[i].location.countryCode');
$PostalCode = $jResp->stringOf('payload.eventHistory[i].location.postalCode');
$i = $i + 1;
}
?>
Curl Command
curl -G -d "trackingId=%3Cstring%3E"
-d "carrierId=%3Cstring%3E"
-H "x-amzn-shipping-business-id: AmazonShipping_US"
-H "Accept: application/json"
https://sellingpartnerapi-eu.amazon.com/shipping/v2/tracking
Postman Collection Item JSON
{
"name": "get Tracking",
"request": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
},
"description": "Returns tracking information for a purchased shipment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)."
},
"response": [
{
"name": "Success.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"eventHistory\": [\n {\n \"eventCode\": \"Rejected\",\n \"eventTime\": \"<dateTime>\",\n \"location\": {\n \"stateOrRegion\": \"<string>\",\n \"city\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"postalCode\": \"<string>\"\n }\n },\n {\n \"eventCode\": \"Lost\",\n \"eventTime\": \"<dateTime>\",\n \"location\": {\n \"stateOrRegion\": \"<string>\",\n \"city\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"postalCode\": \"<string>\"\n }\n }\n ],\n \"promisedDeliveryDate\": \"<dateTime>\",\n \"summary\": {\n \"status\": \"Rejected\"\n },\n \"trackingId\": \"<string>\",\n \"alternateLegTrackingId\": \"<string>\"\n }\n}"
},
{
"name": "Request has missing or invalid parameters and cannot be parsed.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The resource specified does not exist.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The request size exceeded the maximum accepted size.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
}
},
"status": "Request Entity Too Large",
"code": 413,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The request payload is in an unsupported format.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
}
},
"status": "Unsupported Media Type",
"code": 415,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The frequency of requests was greater than allowed.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Temporary overloading or maintenance of the server.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.",
"key": "x-amzn-shipping-business-id",
"value": "AmazonShipping_US"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipping/v2/tracking?trackingId=<string>&carrierId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"shipping",
"v2",
"tracking"
],
"query": [
{
"key": "trackingId",
"value": "<string>",
"description": "(Required) A carrier-generated tracking identifier originally returned by the purchaseShipment operation."
},
{
"key": "carrierId",
"value": "<string>",
"description": "(Required) A carrier identifier originally returned by the getRates operation for the selected rate."
}
]
}
},
"status": "Service Unavailable",
"code": 503,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
}
]
}
