Provide additional verification details about a regulated order
Learn how to provide additional verification details about a regulated order.
Learn how to provide additional verification details about a regulated order.
Prerequisites
To complete this tutorial, you need:
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
- The Direct-to-Consumer Delivery (Restricted) role assigned to your developer profile.
- The Direct-to-Consumer Delivery (Restricted) role selected in the app registration page for your application.
Step 1. Check if an order supports verification details and is in a valid status
Call the getOrderRegulatedInfo
operation. If the order supports verification details, the ValidVerificationDetails
array appears in the response and displays the following:
VerificationDetailType
: The detail type for the order.ValidVerificationStatuses
: Displays the order status (for example,Approved
orDenied
).
Response example
In this example, the order supports the prescriptionDetail
verification detail type:
{
"payload": {
"AmazonOrderId": "205-2554781-3212354",
"RequiresDosageLabel": true,
"RegulatedInformation": {
"Fields": [
{
"FieldLabel": "Species",
"FieldId": "petsSpecies",
"FieldValue": "Cat",
"FieldType": "Text"
}
]
},
"RegulatedOrderVerificationStatus": {
"Status": "Approved",
"RequiresMerchantAction": false,
"ValidRejectionReasons": [
{
"RejectionReasonId": "shield_pom_v_reject_pregnant_only",
"RejectionReasonDescription": "Not suitable for pregnant pet"
}
],
"ValidVerificationDetails": [
{
"VerificationDetailType": "prescriptionDetail",
"ValidVerificationStatuses": [
"Approved"
]
}
]
}
}
}
In the preceding example, you can include prescriptionDetail
in your call because the following conditions are met:
RegulatedOrderVerificationStatus
contains aStatus
ofApproved
. IfRegulatedOrderVerificationStatus
isPending
orRejected
, calls to theupdateVerificationStatus
operation will fail.ValidVerificationDetails
includesprescriptionDetail
as theVerificationDetailType
and the correspondingValidVerificationStatuses
isApproved
.
Step 2. Update the verification details for a regulated order
Call the updateVerificationStatus
operation.
Request example
This example shows updates to verificationDetails
:
PATCH https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/205-1725759-9209952/regulatedInfo
{
"regulatedOrderVerificationStatus": {
"externalReviewerId": "reviewer1234",
"verificationDetails": {
"prescriptionDetail":
{
"prescriptionId": "Rx-1234",
"expirationDate": "2024-01-01T00:00:00Z",
"writtenQuantity": 2,
"totalRefillsAuthorized": 10,
"usageInstructions": "Take one per day by mouth with food",
"refillsRemaining": 10,
"clinicId": "ABC-1234"
}
}
}
}
This example shows updates to verificationDetails
and status
(Amazon applies the status update first):
PATCH https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/205-1725759-9209952/regulatedInfo
{
"regulatedOrderVerificationStatus": {
"status": "Approved",
"externalReviewerId": "reviewer1234",
"verificationDetails": {
"prescriptionDetail":
{
"prescriptionId": "Rx-1234",
"expirationDate": "2024-01-01T00:00:00Z",
"writtenQuantity": 2,
"totalRefillsAuthorized": 10,
"usageInstructions": "Take one per day by mouth with food",
"refillsRemaining": 10,
"clinicId": "ABC-1234"
}
}
}
}
List of verificationDetails
that Amazon supports
verificationDetails
that Amazon supportsprescriptionDetails
prescriptionDetails
prescriptionDetails
contains support for US regulated products and must include the prescription information from the customer's clinic. This information is only available if the order status is Approved
.
Updated about 4 hours ago