getOrderRegulatedInfo

get https://sellingpartnerapi-na.amazon.com/orders/v0/orders/{orderId}/regulatedInfo

Returns regulated information for the order that you specify.

Usage Plan:

Rate (requests per second)	Burst
0.5	30

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

Responses

Response body

object

payload

object

The order's regulated information along with its verification status.

AmazonOrderId

string

required

An Amazon-defined order identifier, in 3-7-7 format.

RegulatedInformation

object

required

The regulated information collected during purchase and used to verify the order.

RequiresDosageLabel

boolean

required

When true, the order requires attaching a dosage information label when shipped.

RegulatedOrderVerificationStatus

object

required

The verification status of the order, along with associated approval or rejection metadata.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/orders/v0/orders/orderId/regulatedInfo \
3
     --header 'accept: application/json'


xxxxxxxxxx
47
}
1
{
2
  "payload": {
3
    "AmazonOrderId": "string",
4
    "RegulatedInformation": {
5
      "Fields": [
6
        {
7
          "FieldId": "string",
8
          "FieldLabel": "string",
9
          "FieldType": "Text",
10
          "FieldValue": "string"
11
        }
12
      ]
13
    },
14
    "RequiresDosageLabel": true,
15
    "RegulatedOrderVerificationStatus": {
16
      "Status": "Pending",
17
      "RequiresMerchantAction": true,
18
      "ValidRejectionReasons": [
19
        {
20
          "RejectionReasonId": "string",
21
          "RejectionReasonDescription": "string"
22
        }
23
      ],
24
      "RejectionReason": {
25
        "RejectionReasonId": "string",

200Success.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.