Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://sellingpartnerapi-na.amazon.com/orders/v0/orders/:orderId/address",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "payload": {
// "AmazonOrderId": "902-3159896-1390916",
// "ShippingAddress": {
// "Name": "Michigan address",
// "AddressLine1": "1 cross st",
// "City": "Canton",
// "StateOrRegion": "MI",
// "PostalCode": "48817",
// "CountryCode": "US"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcAmazonOrderId = loJResp.StringOf("payload.AmazonOrderId")
lcName = loJResp.StringOf("payload.ShippingAddress.Name")
lcAddressLine1 = loJResp.StringOf("payload.ShippingAddress.AddressLine1")
lcCity = loJResp.StringOf("payload.ShippingAddress.City")
lcStateOrRegion = loJResp.StringOf("payload.ShippingAddress.StateOrRegion")
lcPostalCode = loJResp.StringOf("payload.ShippingAddress.PostalCode")
lcCountryCode = loJResp.StringOf("payload.ShippingAddress.CountryCode")
release loHttp
release loSbResponseBody
release loJResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/orders/v0/orders/:orderId/address
Postman Collection Item JSON
{
"name": "get Order Address",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/orders/v0/orders/:orderId/address",
"host": [
"{{baseUrl}}"
],
"path": [
"orders",
"v0",
"orders",
":orderId",
"address"
],
"variable": [
{
"key": "orderId",
"value": "incididunt ea cillum",
"description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
}
]
},
"description": "Returns the shipping address for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 20 |\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](doc:usage-plans-and-rate-limits-in-the-sp-api)."
},
"response": [
{
"name": "Success.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/orders/v0/orders/:orderId/address",
"host": [
"{{baseUrl}}"
],
"path": [
"orders",
"v0",
"orders",
":orderId",
"address"
],
"variable": [
{
"key": "orderId",
"value": "incididunt ea cillum",
"description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "incididunt ea cillum",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "incididunt ea cillum",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"AmazonOrderId\": \"902-3159896-1390916\",\n \"ShippingAddress\": {\n \"Name\": \"Michigan address\",\n \"AddressLine1\": \"1 cross st\",\n \"City\": \"Canton\",\n \"StateOrRegion\": \"MI\",\n \"PostalCode\": \"48817\",\n \"CountryCode\": \"US\"\n }\n }\n}"
},
{
"name": "Request has missing or invalid parameters and cannot be parsed.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/orders/v0/orders/:orderId/address",
"host": [
"{{baseUrl}}"
],
"path": [
"orders",
"v0",
"orders",
":orderId",
"address"
],
"variable": [
{
"key": "orderId",
"value": "incididunt ea cillum",
"description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "incididunt ea cillum",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "incididunt ea cillum",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"AmazonOrderId\": \"esse veniam\",\n \"ShippingAddress\": {\n \"Name\": \"cillum cul\",\n \"AddressLine1\": \"aliqua ipsum do laborum\",\n \"AddressLine2\": \"occaecat sint ut quis\",\n \"AddressLine3\": \"dolor Ut\",\n \"City\": \"laboris amet Duis fugiat\",\n \"County\": \"ut amet Ut ut\",\n \"District\": \"voluptate minim\",\n \"StateOrRegion\": \"eu aliqua id consequat\",\n \"Municipality\": \"id\",\n \"PostalCode\": \"Ut consectetur\",\n \"CountryCode\": \"ad commodo\",\n \"Phone\": \"ea reprehenderit\",\n \"AddressType\": \"Residential\"\n }\n },\n \"errors\": [\n {\n \"code\": \"in\",\n \"message\": \"enim\",\n \"details\": \"ad do\"\n },\n {\n \"code\": \"pariatur eiusmod cupidatat Except\",\n \"message\": \"cillum minim eiusmod ipsum nostrud\",\n \"details\": \"incididunt pariatur aute\"\n }\n ]\n}"
},
{
"name": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/orders/v0/orders/:orderId/address",
"host": [
"{{baseUrl}}"
],
"path": [
"orders",
"v0",
"orders",
":orderId",
"address"
],
"variable": [
{
"key": "orderId",
"value": "incididunt ea cillum",
"description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RequestId",
"value": "incididunt ea cillum",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"AmazonOrderId\": \"esse veniam\",\n \"ShippingAddress\": {\n \"Name\": \"cillum cul\",\n \"AddressLine1\": \"aliqua ipsum do laborum\",\n \"AddressLine2\": \"occaecat sint ut quis\",\n \"AddressLine3\": \"dolor Ut\",\n \"City\": \"laboris amet Duis fugiat\",\n \"County\": \"ut amet Ut ut\",\n \"District\": \"voluptate minim\",\n \"StateOrRegion\": \"eu aliqua id consequat\",\n \"Municipality\": \"id\",\n \"PostalCode\": \"Ut consectetur\",\n \"CountryCode\": \"ad commodo\",\n \"Phone\": \"ea reprehenderit\",\n \"AddressType\": \"Residential\"\n }\n },\n \"errors\": [\n {\n \"code\": \"in\",\n \"message\": \"enim\",\n \"details\": \"ad do\"\n },\n {\n \"code\": \"pariatur eiusmod cupidatat Except\",\n \"message\": \"cillum minim eiusmod ipsum nostrud\",\n \"details\": \"incididunt pariatur aute\"\n }\n ]\n}"
},
{
"name": "The resource specified does not exist.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/orders/v0/orders/:orderId/address",
"host": [
"{{baseUrl}}"
],
"path": [
"orders",
"v0",
"orders",
":orderId",
"address"
],
"variable": [
{
"key": "orderId",
"value": "incididunt ea cillum",
"description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "incididunt ea cillum",
"description": "Your rate limit (requests per second) for this operation."
},
{
"key": "x-amzn-RequestId",
"value": "incididunt ea cillum",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"AmazonOrderId\": \"esse veniam\",\n \"ShippingAddress\": {\n \"Name\": \"cillum cul\",\n \"AddressLine1\": \"aliqua ipsum do laborum\",\n \"AddressLine2\": \"occaecat sint ut quis\",\n \"AddressLine3\": \"dolor Ut\",\n \"City\": \"laboris amet Duis fugiat\",\n \"County\": \"ut amet Ut ut\",\n \"District\": \"voluptate minim\",\n \"StateOrRegion\": \"eu aliqua id consequat\",\n \"Municipality\": \"id\",\n \"PostalCode\": \"Ut consectetur\",\n \"CountryCode\": \"ad commodo\",\n \"Phone\": \"ea reprehenderit\",\n \"AddressType\": \"Residential\"\n }\n },\n \"errors\": [\n {\n \"code\": \"in\",\n \"message\": \"enim\",\n \"details\": \"ad do\"\n },\n {\n \"code\": \"pariatur eiusmod cupidatat Except\",\n \"message\": \"cillum minim eiusmod ipsum nostrud\",\n \"details\": \"incididunt pariatur aute\"\n }\n ]\n}"
},
{
"name": "The frequency of requests was greater than allowed.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/orders/v0/orders/:orderId/address",
"host": [
"{{baseUrl}}"
],
"path": [
"orders",
"v0",
"orders",
":orderId",
"address"
],
"variable": [
{
"key": "orderId",
"value": "incididunt ea cillum",
"description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "incididunt ea cillum",
"description": "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."
},
{
"key": "x-amzn-RequestId",
"value": "incididunt ea cillum",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"AmazonOrderId\": \"esse veniam\",\n \"ShippingAddress\": {\n \"Name\": \"cillum cul\",\n \"AddressLine1\": \"aliqua ipsum do laborum\",\n \"AddressLine2\": \"occaecat sint ut quis\",\n \"AddressLine3\": \"dolor Ut\",\n \"City\": \"laboris amet Duis fugiat\",\n \"County\": \"ut amet Ut ut\",\n \"District\": \"voluptate minim\",\n \"StateOrRegion\": \"eu aliqua id consequat\",\n \"Municipality\": \"id\",\n \"PostalCode\": \"Ut consectetur\",\n \"CountryCode\": \"ad commodo\",\n \"Phone\": \"ea reprehenderit\",\n \"AddressType\": \"Residential\"\n }\n },\n \"errors\": [\n {\n \"code\": \"in\",\n \"message\": \"enim\",\n \"details\": \"ad do\"\n },\n {\n \"code\": \"pariatur eiusmod cupidatat Except\",\n \"message\": \"cillum minim eiusmod ipsum nostrud\",\n \"details\": \"incididunt pariatur aute\"\n }\n ]\n}"
},
{
"name": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/orders/v0/orders/:orderId/address",
"host": [
"{{baseUrl}}"
],
"path": [
"orders",
"v0",
"orders",
":orderId",
"address"
],
"variable": [
{
"key": "orderId",
"value": "incididunt ea cillum",
"description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "incididunt ea cillum",
"description": "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."
},
{
"key": "x-amzn-RequestId",
"value": "incididunt ea cillum",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"AmazonOrderId\": \"esse veniam\",\n \"ShippingAddress\": {\n \"Name\": \"cillum cul\",\n \"AddressLine1\": \"aliqua ipsum do laborum\",\n \"AddressLine2\": \"occaecat sint ut quis\",\n \"AddressLine3\": \"dolor Ut\",\n \"City\": \"laboris amet Duis fugiat\",\n \"County\": \"ut amet Ut ut\",\n \"District\": \"voluptate minim\",\n \"StateOrRegion\": \"eu aliqua id consequat\",\n \"Municipality\": \"id\",\n \"PostalCode\": \"Ut consectetur\",\n \"CountryCode\": \"ad commodo\",\n \"Phone\": \"ea reprehenderit\",\n \"AddressType\": \"Residential\"\n }\n },\n \"errors\": [\n {\n \"code\": \"in\",\n \"message\": \"enim\",\n \"details\": \"ad do\"\n },\n {\n \"code\": \"pariatur eiusmod cupidatat Except\",\n \"message\": \"cillum minim eiusmod ipsum nostrud\",\n \"details\": \"incididunt pariatur aute\"\n }\n ]\n}"
},
{
"name": "Temporary overloading or maintenance of the server.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/orders/v0/orders/:orderId/address",
"host": [
"{{baseUrl}}"
],
"path": [
"orders",
"v0",
"orders",
":orderId",
"address"
],
"variable": [
{
"key": "orderId",
"value": "incididunt ea cillum",
"description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
}
]
}
},
"status": "Service Unavailable",
"code": 503,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-amzn-RateLimit-Limit",
"value": "incididunt ea cillum",
"description": "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."
},
{
"key": "x-amzn-RequestId",
"value": "incididunt ea cillum",
"description": "Unique request reference identifier."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"payload\": {\n \"AmazonOrderId\": \"esse veniam\",\n \"ShippingAddress\": {\n \"Name\": \"cillum cul\",\n \"AddressLine1\": \"aliqua ipsum do laborum\",\n \"AddressLine2\": \"occaecat sint ut quis\",\n \"AddressLine3\": \"dolor Ut\",\n \"City\": \"laboris amet Duis fugiat\",\n \"County\": \"ut amet Ut ut\",\n \"District\": \"voluptate minim\",\n \"StateOrRegion\": \"eu aliqua id consequat\",\n \"Municipality\": \"id\",\n \"PostalCode\": \"Ut consectetur\",\n \"CountryCode\": \"ad commodo\",\n \"Phone\": \"ea reprehenderit\",\n \"AddressType\": \"Residential\"\n }\n },\n \"errors\": [\n {\n \"code\": \"in\",\n \"message\": \"enim\",\n \"details\": \"ad do\"\n },\n {\n \"code\": \"pariatur eiusmod cupidatat Except\",\n \"message\": \"cillum minim eiusmod ipsum nostrud\",\n \"details\": \"incididunt pariatur aute\"\n }\n ]\n}"
}
]
}
