Chilkat Online Tools

VB.NET / Selling Partner API for Orders / get Order Buyer Info

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://sellingpartnerapi-na.amazon.com/orders/v0/orders/:orderId/buyerInfo",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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




Dim AmazonOrderId As String = jResp.StringOf("payload.AmazonOrderId")
Dim BuyerEmail As String = jResp.StringOf("payload.BuyerEmail")
Dim BuyerName As String = jResp.StringOf("payload.BuyerName")
Dim CompanyLegalName As String = jResp.StringOf("payload.BuyerTaxInfo.CompanyLegalName")
Dim PurchaseOrderNumber As String = jResp.StringOf("payload.PurchaseOrderNumber")

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