Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://sellingpartnerapi-na.amazon.com/orders/v0/orders/:orderId/address', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @AmazonOrderId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AmazonOrderId OUT, 'payload.AmazonOrderId'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'payload.ShippingAddress.Name'
DECLARE @AddressLine1 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AddressLine1 OUT, 'payload.ShippingAddress.AddressLine1'
DECLARE @City nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @City OUT, 'payload.ShippingAddress.City'
DECLARE @StateOrRegion nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @StateOrRegion OUT, 'payload.ShippingAddress.StateOrRegion'
DECLARE @PostalCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @PostalCode OUT, 'payload.ShippingAddress.PostalCode'
DECLARE @CountryCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CountryCode OUT, 'payload.ShippingAddress.CountryCode'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
