getOrderRegulatedInfo

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

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the `getOrderRegulatedInfo` operation.

payload

object (OrderRegulatedInfo)

optional

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 (RegulatedInformation)

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 (RegulatedOrderVerificationStatus)

required

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

errors

array[object (Error) {3}]

optional

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

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

optional

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

Example

{
    "payload": {
        "AmazonOrderId": "string",
        "RegulatedInformation": {
            "Fields": [
                {
                    "FieldId": "string",
                    "FieldLabel": "string",
                    "FieldType": "Text",
                    "FieldValue": "string"
                }
            ]
        },
        "RequiresDosageLabel": true,
        "RegulatedOrderVerificationStatus": {
            "Status": "Pending",
            "RequiresMerchantAction": true,
            "ValidRejectionReasons": [
                {
                    "RejectionReasonId": "string",
                    "RejectionReasonDescription": "string"
                }
            ],
            "RejectionReason": {
                "RejectionReasonId": "string",
                "RejectionReasonDescription": "string"
            },
            "ReviewDate": "string",
            "ExternalReviewerId": "string",
            "ValidVerificationDetails": [
                {
                    "VerificationDetailType": "string",
                    "ValidVerificationStatuses": [
                        "Pending"
                    ]
                }
            ]
        }
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses