Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("sellerSku","<string>");
$queryParams->UpdateString("marketplaceId","<string>");
$queryParams->UpdateString("sellerFulfillmentOrderId","<string>");
$queryParams->UpdateString("language","<string>");
$http->SetRequestHeader("Accept","application/json");
# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://sellingpartnerapi-na.amazon.com/fba/outbound/2020-07-01/returnReasonCodes",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "payload": {
# "reasonCodeDetails": [
# {
# "description": "<string>",
# "returnReasonCode": "<string>",
# "translatedDescription": "<string>"
# },
# {
# "description": "<string>",
# "returnReasonCode": "<string>",
# "translatedDescription": "<string>"
# }
# ]
# },
# "errors": [
# {
# "code": "<string>",
# "message": "<string>",
# "details": "<string>"
# },
# {
# "code": "<string>",
# "message": "<string>",
# "details": "<string>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$i = 0;
$count_i = $jResp->SizeOfArray("payload.reasonCodeDetails");
while ($i < $count_i) {
$jResp->put_I($i);
$description = $jResp->stringOf("payload.reasonCodeDetails[i].description");
$returnReasonCode = $jResp->stringOf("payload.reasonCodeDetails[i].returnReasonCode");
$translatedDescription = $jResp->stringOf("payload.reasonCodeDetails[i].translatedDescription");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("errors");
while ($i < $count_i) {
$jResp->put_I($i);
$code = $jResp->stringOf("errors[i].code");
$message = $jResp->stringOf("errors[i].message");
$details = $jResp->stringOf("errors[i].details");
$i = $i + 1;
}
Curl Command
curl -G -d "sellerSku=%3Cstring%3E"
-d "marketplaceId=%3Cstring%3E"
-d "sellerFulfillmentOrderId=%3Cstring%3E"
-d "language=%3Cstring%3E"
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/fba/outbound/2020-07-01/returnReasonCodes
Postman Collection Item JSON
{
"name": "list Return Reason Codes",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/outbound/2020-07-01/returnReasonCodes?sellerSku=<string>&marketplaceId=<string>&sellerFulfillmentOrderId=<string>&language=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"outbound",
"2020-07-01",
"returnReasonCodes"
],
"query": [
{
"key": "sellerSku",
"value": "<string>",
"description": "(Required) The seller SKU for which return reason codes are required."
},
{
"key": "marketplaceId",
"value": "<string>",
"description": "The marketplace for which the seller wants return reason codes."
},
{
"key": "sellerFulfillmentOrderId",
"value": "<string>",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes."
},
{
"key": "language",
"value": "<string>",
"description": "(Required) The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into."
}
]
},
"description": "Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\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 than 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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/outbound/2020-07-01/returnReasonCodes?sellerSku=<string>&marketplaceId=<string>&sellerFulfillmentOrderId=<string>&language=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"outbound",
"2020-07-01",
"returnReasonCodes"
],
"query": [
{
"key": "sellerSku",
"value": "<string>",
"description": "(Required) The seller SKU for which return reason codes are required."
},
{
"key": "marketplaceId",
"value": "<string>",
"description": "The marketplace for which the seller wants return reason codes."
},
{
"key": "sellerFulfillmentOrderId",
"value": "<string>",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes."
},
{
"key": "language",
"value": "<string>",
"description": "(Required) The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into."
}
]
}
},
"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 \"reasonCodeDetails\": [\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n },\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n }\n ]\n },\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": "Request has missing or invalid parameters and cannot be parsed.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/outbound/2020-07-01/returnReasonCodes?sellerSku=<string>&marketplaceId=<string>&sellerFulfillmentOrderId=<string>&language=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"outbound",
"2020-07-01",
"returnReasonCodes"
],
"query": [
{
"key": "sellerSku",
"value": "<string>",
"description": "(Required) The seller SKU for which return reason codes are required."
},
{
"key": "marketplaceId",
"value": "<string>",
"description": "The marketplace for which the seller wants return reason codes."
},
{
"key": "sellerFulfillmentOrderId",
"value": "<string>",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes."
},
{
"key": "language",
"value": "<string>",
"description": "(Required) The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into."
}
]
}
},
"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 \"payload\": {\n \"reasonCodeDetails\": [\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n },\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n }\n ]\n },\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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/outbound/2020-07-01/returnReasonCodes?sellerSku=<string>&marketplaceId=<string>&sellerFulfillmentOrderId=<string>&language=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"outbound",
"2020-07-01",
"returnReasonCodes"
],
"query": [
{
"key": "sellerSku",
"value": "<string>",
"description": "(Required) The seller SKU for which return reason codes are required."
},
{
"key": "marketplaceId",
"value": "<string>",
"description": "The marketplace for which the seller wants return reason codes."
},
{
"key": "sellerFulfillmentOrderId",
"value": "<string>",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes."
},
{
"key": "language",
"value": "<string>",
"description": "(Required) The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into."
}
]
}
},
"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 \"payload\": {\n \"reasonCodeDetails\": [\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n },\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n }\n ]\n },\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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/outbound/2020-07-01/returnReasonCodes?sellerSku=<string>&marketplaceId=<string>&sellerFulfillmentOrderId=<string>&language=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"outbound",
"2020-07-01",
"returnReasonCodes"
],
"query": [
{
"key": "sellerSku",
"value": "<string>",
"description": "(Required) The seller SKU for which return reason codes are required."
},
{
"key": "marketplaceId",
"value": "<string>",
"description": "The marketplace for which the seller wants return reason codes."
},
{
"key": "sellerFulfillmentOrderId",
"value": "<string>",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes."
},
{
"key": "language",
"value": "<string>",
"description": "(Required) The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into."
}
]
}
},
"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 \"payload\": {\n \"reasonCodeDetails\": [\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n },\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n }\n ]\n },\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 specified resource does not exist.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/outbound/2020-07-01/returnReasonCodes?sellerSku=<string>&marketplaceId=<string>&sellerFulfillmentOrderId=<string>&language=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"outbound",
"2020-07-01",
"returnReasonCodes"
],
"query": [
{
"key": "sellerSku",
"value": "<string>",
"description": "(Required) The seller SKU for which return reason codes are required."
},
{
"key": "marketplaceId",
"value": "<string>",
"description": "The marketplace for which the seller wants return reason codes."
},
{
"key": "sellerFulfillmentOrderId",
"value": "<string>",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes."
},
{
"key": "language",
"value": "<string>",
"description": "(Required) The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into."
}
]
}
},
"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 \"payload\": {\n \"reasonCodeDetails\": [\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n },\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n }\n ]\n },\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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/outbound/2020-07-01/returnReasonCodes?sellerSku=<string>&marketplaceId=<string>&sellerFulfillmentOrderId=<string>&language=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"outbound",
"2020-07-01",
"returnReasonCodes"
],
"query": [
{
"key": "sellerSku",
"value": "<string>",
"description": "(Required) The seller SKU for which return reason codes are required."
},
{
"key": "marketplaceId",
"value": "<string>",
"description": "The marketplace for which the seller wants return reason codes."
},
{
"key": "sellerFulfillmentOrderId",
"value": "<string>",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes."
},
{
"key": "language",
"value": "<string>",
"description": "(Required) The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into."
}
]
}
},
"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 \"payload\": {\n \"reasonCodeDetails\": [\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n },\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n }\n ]\n },\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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/outbound/2020-07-01/returnReasonCodes?sellerSku=<string>&marketplaceId=<string>&sellerFulfillmentOrderId=<string>&language=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"outbound",
"2020-07-01",
"returnReasonCodes"
],
"query": [
{
"key": "sellerSku",
"value": "<string>",
"description": "(Required) The seller SKU for which return reason codes are required."
},
{
"key": "marketplaceId",
"value": "<string>",
"description": "The marketplace for which the seller wants return reason codes."
},
{
"key": "sellerFulfillmentOrderId",
"value": "<string>",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes."
},
{
"key": "language",
"value": "<string>",
"description": "(Required) The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into."
}
]
}
},
"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 \"payload\": {\n \"reasonCodeDetails\": [\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n },\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n }\n ]\n },\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": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/fba/outbound/2020-07-01/returnReasonCodes?sellerSku=<string>&marketplaceId=<string>&sellerFulfillmentOrderId=<string>&language=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"fba",
"outbound",
"2020-07-01",
"returnReasonCodes"
],
"query": [
{
"key": "sellerSku",
"value": "<string>",
"description": "(Required) The seller SKU for which return reason codes are required."
},
{
"key": "marketplaceId",
"value": "<string>",
"description": "The marketplace for which the seller wants return reason codes."
},
{
"key": "sellerFulfillmentOrderId",
"value": "<string>",
"description": "The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes."
},
{
"key": "language",
"value": "<string>",
"description": "(Required) The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into."
}
]
}
},
"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 \"payload\": {\n \"reasonCodeDetails\": [\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n },\n {\n \"description\": \"<string>\",\n \"returnReasonCode\": \"<string>\",\n \"translatedDescription\": \"<string>\"\n }\n ]\n },\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}"
}
]
}
