Chilkat Online Tools

PowerBuilder / Selling Partner API for Orders / get Order Address

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_AmazonOrderId
string ls_Name
string ls_AddressLine1
string ls_City
string ls_StateOrRegion
string ls_PostalCode
string ls_CountryCode

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.SetRequestHeader("Accept","application/json")

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://sellingpartnerapi-na.amazon.com/orders/v0/orders/:orderId/address",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

// 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

ls_AmazonOrderId = loo_JResp.StringOf("payload.AmazonOrderId")
ls_Name = loo_JResp.StringOf("payload.ShippingAddress.Name")
ls_AddressLine1 = loo_JResp.StringOf("payload.ShippingAddress.AddressLine1")
ls_City = loo_JResp.StringOf("payload.ShippingAddress.City")
ls_StateOrRegion = loo_JResp.StringOf("payload.ShippingAddress.StateOrRegion")
ls_PostalCode = loo_JResp.StringOf("payload.ShippingAddress.PostalCode")
ls_CountryCode = loo_JResp.StringOf("payload.ShippingAddress.CountryCode")


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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}"
    }
  ]
}