Chilkat Online Tools

SQL Server / Selling Partner API for Orders / get Order Buyer Info

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
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.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
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://sellingpartnerapi-na.amazon.com/orders/v0/orders/:orderId/buyerInfo', @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
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.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",
    --     "BuyerEmail": "user@example.com",
    --     "BuyerName": "John Smith",
    --     "BuyerTaxInfo": {
    --       "CompanyLegalName": "Company Name"
    --     },
    --     "PurchaseOrderNumber": "1234567890123"
    --   }
    -- }

    -- 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 @BuyerEmail nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @BuyerEmail OUT, 'payload.BuyerEmail'
    DECLARE @BuyerName nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @BuyerName OUT, 'payload.BuyerName'
    DECLARE @CompanyLegalName nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @CompanyLegalName OUT, 'payload.BuyerTaxInfo.CompanyLegalName'
    DECLARE @PurchaseOrderNumber nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @PurchaseOrderNumber OUT, 'payload.PurchaseOrderNumber'

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

Postman Collection Item JSON

{
  "name": "get Order Buyer Info",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/orders/v0/orders/:orderId/buyerInfo",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "orders",
        "v0",
        "orders",
        ":orderId",
        "buyerInfo"
      ],
      "variable": [
        {
          "key": "orderId",
          "value": "incididunt ea cillum",
          "description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
        }
      ]
    },
    "description": "Returns buyer information 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/buyerInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "buyerInfo"
          ],
          "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    \"BuyerEmail\": \"user@example.com\",\n    \"BuyerName\": \"John Smith\",\n    \"BuyerTaxInfo\": {\n      \"CompanyLegalName\": \"Company Name\"\n    },\n    \"PurchaseOrderNumber\": \"1234567890123\"\n  }\n}"
    },
    {
      "name": "Request has missing or invalid parameters and cannot be parsed.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/buyerInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "buyerInfo"
          ],
          "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\": \"dolore ullamco commodo in dolor\",\n    \"BuyerEmail\": \"commodo sed ut in\",\n    \"BuyerName\": \"ad sed amet\",\n    \"BuyerCounty\": \"Ut ex ut nostrud\",\n    \"BuyerTaxInfo\": {\n      \"CompanyLegalName\": \"nostrud\",\n      \"TaxingRegion\": \"Lorem in ut culpa ut\",\n      \"TaxClassifications\": [\n        {\n          \"Name\": \"velit\",\n          \"Value\": \"ut in consequat Duis voluptate\"\n        },\n        {\n          \"Name\": \"amet\",\n          \"Value\": \"eiusmod exercitation velit\"\n        }\n      ]\n    },\n    \"PurchaseOrderNumber\": \"incididunt occaecat nisi sunt\"\n  },\n  \"errors\": [\n    {\n      \"code\": \"sunt qui anim esse\",\n      \"message\": \"aute pariatur\",\n      \"details\": \"ipsum do\"\n    },\n    {\n      \"code\": \"eu \",\n      \"message\": \"tempor esse id ipsum Lorem\",\n      \"details\": \"eu nulla ad in\"\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/buyerInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "buyerInfo"
          ],
          "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\": \"dolore ullamco commodo in dolor\",\n    \"BuyerEmail\": \"commodo sed ut in\",\n    \"BuyerName\": \"ad sed amet\",\n    \"BuyerCounty\": \"Ut ex ut nostrud\",\n    \"BuyerTaxInfo\": {\n      \"CompanyLegalName\": \"nostrud\",\n      \"TaxingRegion\": \"Lorem in ut culpa ut\",\n      \"TaxClassifications\": [\n        {\n          \"Name\": \"velit\",\n          \"Value\": \"ut in consequat Duis voluptate\"\n        },\n        {\n          \"Name\": \"amet\",\n          \"Value\": \"eiusmod exercitation velit\"\n        }\n      ]\n    },\n    \"PurchaseOrderNumber\": \"incididunt occaecat nisi sunt\"\n  },\n  \"errors\": [\n    {\n      \"code\": \"sunt qui anim esse\",\n      \"message\": \"aute pariatur\",\n      \"details\": \"ipsum do\"\n    },\n    {\n      \"code\": \"eu \",\n      \"message\": \"tempor esse id ipsum Lorem\",\n      \"details\": \"eu nulla ad in\"\n    }\n  ]\n}"
    },
    {
      "name": "The resource specified does not exist.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/buyerInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "buyerInfo"
          ],
          "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\": \"dolore ullamco commodo in dolor\",\n    \"BuyerEmail\": \"commodo sed ut in\",\n    \"BuyerName\": \"ad sed amet\",\n    \"BuyerCounty\": \"Ut ex ut nostrud\",\n    \"BuyerTaxInfo\": {\n      \"CompanyLegalName\": \"nostrud\",\n      \"TaxingRegion\": \"Lorem in ut culpa ut\",\n      \"TaxClassifications\": [\n        {\n          \"Name\": \"velit\",\n          \"Value\": \"ut in consequat Duis voluptate\"\n        },\n        {\n          \"Name\": \"amet\",\n          \"Value\": \"eiusmod exercitation velit\"\n        }\n      ]\n    },\n    \"PurchaseOrderNumber\": \"incididunt occaecat nisi sunt\"\n  },\n  \"errors\": [\n    {\n      \"code\": \"sunt qui anim esse\",\n      \"message\": \"aute pariatur\",\n      \"details\": \"ipsum do\"\n    },\n    {\n      \"code\": \"eu \",\n      \"message\": \"tempor esse id ipsum Lorem\",\n      \"details\": \"eu nulla ad in\"\n    }\n  ]\n}"
    },
    {
      "name": "The frequency of requests was greater than allowed.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/buyerInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "buyerInfo"
          ],
          "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\": \"dolore ullamco commodo in dolor\",\n    \"BuyerEmail\": \"commodo sed ut in\",\n    \"BuyerName\": \"ad sed amet\",\n    \"BuyerCounty\": \"Ut ex ut nostrud\",\n    \"BuyerTaxInfo\": {\n      \"CompanyLegalName\": \"nostrud\",\n      \"TaxingRegion\": \"Lorem in ut culpa ut\",\n      \"TaxClassifications\": [\n        {\n          \"Name\": \"velit\",\n          \"Value\": \"ut in consequat Duis voluptate\"\n        },\n        {\n          \"Name\": \"amet\",\n          \"Value\": \"eiusmod exercitation velit\"\n        }\n      ]\n    },\n    \"PurchaseOrderNumber\": \"incididunt occaecat nisi sunt\"\n  },\n  \"errors\": [\n    {\n      \"code\": \"sunt qui anim esse\",\n      \"message\": \"aute pariatur\",\n      \"details\": \"ipsum do\"\n    },\n    {\n      \"code\": \"eu \",\n      \"message\": \"tempor esse id ipsum Lorem\",\n      \"details\": \"eu nulla ad in\"\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/buyerInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "buyerInfo"
          ],
          "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\": \"dolore ullamco commodo in dolor\",\n    \"BuyerEmail\": \"commodo sed ut in\",\n    \"BuyerName\": \"ad sed amet\",\n    \"BuyerCounty\": \"Ut ex ut nostrud\",\n    \"BuyerTaxInfo\": {\n      \"CompanyLegalName\": \"nostrud\",\n      \"TaxingRegion\": \"Lorem in ut culpa ut\",\n      \"TaxClassifications\": [\n        {\n          \"Name\": \"velit\",\n          \"Value\": \"ut in consequat Duis voluptate\"\n        },\n        {\n          \"Name\": \"amet\",\n          \"Value\": \"eiusmod exercitation velit\"\n        }\n      ]\n    },\n    \"PurchaseOrderNumber\": \"incididunt occaecat nisi sunt\"\n  },\n  \"errors\": [\n    {\n      \"code\": \"sunt qui anim esse\",\n      \"message\": \"aute pariatur\",\n      \"details\": \"ipsum do\"\n    },\n    {\n      \"code\": \"eu \",\n      \"message\": \"tempor esse id ipsum Lorem\",\n      \"details\": \"eu nulla ad in\"\n    }\n  ]\n}"
    },
    {
      "name": "Temporary overloading or maintenance of the server.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/buyerInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "buyerInfo"
          ],
          "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\": \"dolore ullamco commodo in dolor\",\n    \"BuyerEmail\": \"commodo sed ut in\",\n    \"BuyerName\": \"ad sed amet\",\n    \"BuyerCounty\": \"Ut ex ut nostrud\",\n    \"BuyerTaxInfo\": {\n      \"CompanyLegalName\": \"nostrud\",\n      \"TaxingRegion\": \"Lorem in ut culpa ut\",\n      \"TaxClassifications\": [\n        {\n          \"Name\": \"velit\",\n          \"Value\": \"ut in consequat Duis voluptate\"\n        },\n        {\n          \"Name\": \"amet\",\n          \"Value\": \"eiusmod exercitation velit\"\n        }\n      ]\n    },\n    \"PurchaseOrderNumber\": \"incididunt occaecat nisi sunt\"\n  },\n  \"errors\": [\n    {\n      \"code\": \"sunt qui anim esse\",\n      \"message\": \"aute pariatur\",\n      \"details\": \"ipsum do\"\n    },\n    {\n      \"code\": \"eu \",\n      \"message\": \"tempor esse id ipsum Lorem\",\n      \"details\": \"eu nulla ad in\"\n    }\n  ]\n}"
    }
  ]
}