Chilkat Online Tools

Ruby / Selling Partner API for Orders / update Verification Status

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "regulatedOrderVerificationStatus": {
#     "status": "Rejected",
#     "externalReviewerId": "laborum anim et",
#     "rejectionReasonId": "dolore sit in"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("regulatedOrderVerificationStatus.status","Rejected")
json.UpdateString("regulatedOrderVerificationStatus.externalReviewerId","laborum anim et")
json.UpdateString("regulatedOrderVerificationStatus.rejectionReasonId","dolore sit in")

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://sellingpartnerapi-na.amazon.com/orders/v0/orders/:orderId/regulatedInfo",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 204)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Response Body:" + "\n";
    print resp.bodyStr() + "\n";
    print "Failed." + "\n";

    exit
end

print "Success." + "\n";

Curl Command

curl -X PATCH
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "regulatedOrderVerificationStatus": {
    "status": "Rejected",
    "externalReviewerId": "laborum anim et",
    "rejectionReasonId": "dolore sit in"
  }
}'
https://sellingpartnerapi-na.amazon.com/orders/v0/orders/:orderId/regulatedInfo

Postman Collection Item JSON

{
  "name": "update Verification Status",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"regulatedOrderVerificationStatus\": {\n    \"status\": \"Rejected\",\n    \"externalReviewerId\": \"laborum anim et\",\n    \"rejectionReasonId\": \"dolore sit in\"\n  }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/orders/v0/orders/:orderId/regulatedInfo",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "orders",
        "v0",
        "orders",
        ":orderId",
        "regulatedInfo"
      ],
      "variable": [
        {
          "key": "orderId",
          "value": "incididunt ea cillum",
          "description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
        }
      ]
    },
    "description": "Updates (approves or rejects) the verification status of an order containing regulated products.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\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": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"regulatedOrderVerificationStatus\": {\n    \"status\": \"Rejected\",\n    \"externalReviewerId\": \"laborum anim et\",\n    \"rejectionReasonId\": \"dolore sit in\"\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/regulatedInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "regulatedInfo"
          ],
          "variable": [
            {
              "key": "orderId",
              "value": "incididunt ea cillum",
              "description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "text",
      "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": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Request has missing or invalid parameters and cannot be parsed.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"regulatedOrderVerificationStatus\": {\n    \"status\": \"Rejected\",\n    \"externalReviewerId\": \"laborum anim et\",\n    \"rejectionReasonId\": \"dolore sit in\"\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/regulatedInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "regulatedInfo"
          ],
          "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  \"errors\": [\n    {\n      \"code\": \"qui et\",\n      \"message\": \"\",\n      \"details\": \"incididunt id qui\"\n    },\n    {\n      \"code\": \"cupidatat amet laboris\",\n      \"message\": \"dolore sunt\",\n      \"details\": \"sint aute\"\n    }\n  ]\n}"
    },
    {
      "name": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"regulatedOrderVerificationStatus\": {\n    \"status\": \"Rejected\",\n    \"externalReviewerId\": \"laborum anim et\",\n    \"rejectionReasonId\": \"dolore sit in\"\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/regulatedInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "regulatedInfo"
          ],
          "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  \"errors\": [\n    {\n      \"code\": \"qui et\",\n      \"message\": \"\",\n      \"details\": \"incididunt id qui\"\n    },\n    {\n      \"code\": \"cupidatat amet laboris\",\n      \"message\": \"dolore sunt\",\n      \"details\": \"sint aute\"\n    }\n  ]\n}"
    },
    {
      "name": "The resource specified does not exist.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"regulatedOrderVerificationStatus\": {\n    \"status\": \"Rejected\",\n    \"externalReviewerId\": \"laborum anim et\",\n    \"rejectionReasonId\": \"dolore sit in\"\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/regulatedInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "regulatedInfo"
          ],
          "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  \"errors\": [\n    {\n      \"code\": \"qui et\",\n      \"message\": \"\",\n      \"details\": \"incididunt id qui\"\n    },\n    {\n      \"code\": \"cupidatat amet laboris\",\n      \"message\": \"dolore sunt\",\n      \"details\": \"sint aute\"\n    }\n  ]\n}"
    },
    {
      "name": "The request size exceeded the maximum accepted size.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"regulatedOrderVerificationStatus\": {\n    \"status\": \"Rejected\",\n    \"externalReviewerId\": \"laborum anim et\",\n    \"rejectionReasonId\": \"dolore sit in\"\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/regulatedInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "regulatedInfo"
          ],
          "variable": [
            {
              "key": "orderId",
              "value": "incididunt ea cillum",
              "description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
            }
          ]
        }
      },
      "status": "Request Entity Too Large",
      "code": 413,
      "_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  \"errors\": [\n    {\n      \"code\": \"qui et\",\n      \"message\": \"\",\n      \"details\": \"incididunt id qui\"\n    },\n    {\n      \"code\": \"cupidatat amet laboris\",\n      \"message\": \"dolore sunt\",\n      \"details\": \"sint aute\"\n    }\n  ]\n}"
    },
    {
      "name": "The request payload is in an unsupported format.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"regulatedOrderVerificationStatus\": {\n    \"status\": \"Rejected\",\n    \"externalReviewerId\": \"laborum anim et\",\n    \"rejectionReasonId\": \"dolore sit in\"\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/regulatedInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "regulatedInfo"
          ],
          "variable": [
            {
              "key": "orderId",
              "value": "incididunt ea cillum",
              "description": "(Required) An orderId is an Amazon-defined order identifier, in 3-7-7 format."
            }
          ]
        }
      },
      "status": "Unsupported Media Type",
      "code": 415,
      "_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  \"errors\": [\n    {\n      \"code\": \"qui et\",\n      \"message\": \"\",\n      \"details\": \"incididunt id qui\"\n    },\n    {\n      \"code\": \"cupidatat amet laboris\",\n      \"message\": \"dolore sunt\",\n      \"details\": \"sint aute\"\n    }\n  ]\n}"
    },
    {
      "name": "The frequency of requests was greater than allowed.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"regulatedOrderVerificationStatus\": {\n    \"status\": \"Rejected\",\n    \"externalReviewerId\": \"laborum anim et\",\n    \"rejectionReasonId\": \"dolore sit in\"\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/regulatedInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "regulatedInfo"
          ],
          "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-RequestId",
          "value": "incididunt ea cillum",
          "description": "Unique request reference identifier."
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"qui et\",\n      \"message\": \"\",\n      \"details\": \"incididunt id qui\"\n    },\n    {\n      \"code\": \"cupidatat amet laboris\",\n      \"message\": \"dolore sunt\",\n      \"details\": \"sint aute\"\n    }\n  ]\n}"
    },
    {
      "name": "An unexpected condition occurred that prevented the server from fulfilling the request.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"regulatedOrderVerificationStatus\": {\n    \"status\": \"Rejected\",\n    \"externalReviewerId\": \"laborum anim et\",\n    \"rejectionReasonId\": \"dolore sit in\"\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/regulatedInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "regulatedInfo"
          ],
          "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-RequestId",
          "value": "incididunt ea cillum",
          "description": "Unique request reference identifier."
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"qui et\",\n      \"message\": \"\",\n      \"details\": \"incididunt id qui\"\n    },\n    {\n      \"code\": \"cupidatat amet laboris\",\n      \"message\": \"dolore sunt\",\n      \"details\": \"sint aute\"\n    }\n  ]\n}"
    },
    {
      "name": "Temporary overloading or maintenance of the server.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"regulatedOrderVerificationStatus\": {\n    \"status\": \"Rejected\",\n    \"externalReviewerId\": \"laborum anim et\",\n    \"rejectionReasonId\": \"dolore sit in\"\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/orders/v0/orders/:orderId/regulatedInfo",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            "v0",
            "orders",
            ":orderId",
            "regulatedInfo"
          ],
          "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-RequestId",
          "value": "incididunt ea cillum",
          "description": "Unique request reference identifier."
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"qui et\",\n      \"message\": \"\",\n      \"details\": \"incididunt id qui\"\n    },\n    {\n      \"code\": \"cupidatat amet laboris\",\n      \"message\": \"dolore sunt\",\n      \"details\": \"sint aute\"\n    }\n  ]\n}"
    }
  ]
}