Amazon SP API

updateVerificationStatus

Exception

PATCH

/orders/v0/orders/{orderId}/regulatedInfo

Orders

Last modified:2024-11-29 11:51:10

Maintainer:Sarath S

Updates (approves or rejects) the verification status of an order containing regulated products.

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.

Request

Path Params

orderId

string

required

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

Example:

902-3159896-1390916

Body Params application/json

The request body for the `updateVerificationStatus` operation.

regulatedOrderVerificationStatus

object (UpdateVerificationStatusRequestBody)

required

The updated values of the VerificationStatus field.

status

enum<string>

optional

The verification status of the order.

Allowed values:

PendingApprovedRejectedExpiredCancelled

externalReviewerId

string

required

The identifier of the order's regulated information reviewer.

rejectionReasonId

string

optional

The unique identifier of the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected.

verificationDetails

object (VerificationDetails)

optional

Additional information related to the verification of a regulated order.

Example

{
    "regulatedOrderVerificationStatus": {
        "status": "Pending",
        "externalReviewerId": "string",
        "rejectionReasonId": "string",
        "verificationDetails": {
            "prescriptionDetail": {
                "prescriptionId": "string",
                "expirationDate": "2019-08-24T14:15:22Z",
                "writtenQuantity": 1,
                "totalRefillsAuthorized": 0,
                "refillsRemaining": 0,
                "clinicId": "string",
                "usageInstructions": "string"
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://sandbox.sellingpartnerapi-na.amazon.com/orders/v0/orders/902-3159896-1390916/regulatedInfo' \
--header 'Content-Type: application/json' \
--data-raw '{
    "regulatedOrderVerificationStatus": {
        "status": "Pending",
        "externalReviewerId": "string",
        "rejectionReasonId": "string",
        "verificationDetails": {
            "prescriptionDetail": {
                "prescriptionId": "string",
                "expirationDate": "2019-08-24T14:15:22Z",
                "writtenQuantity": 1,
                "totalRefillsAuthorized": 0,
                "refillsRemaining": 0,
                "clinicId": "string",
                "usageInstructions": "string"
            }
        }
    }
}'

Responses

🟢204No Content

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

object {0}

Example

{}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

getOrderRegulatedInfo

confirmShipment