Update status of RAP post-purchase items
Marketplace sellers can use the Bulk update item status API to update the status of the item. Sellers can enroll and disenroll the items in the RAP post-purchase using this API.
The API returns the list of items whose status is updated successfully with their Item ID, description, and SKU ID. It also returns a list of items whose status update failed due to some reason with the appropriate error code and description. Sellers can update status of maximum 100 items at once.
Enroll items into post-purchase Review Accelerator Program
To enroll items into the Post-purchase program use the Bulk update item status API with "status": "ENROLL"
Example: Request to enroll items into RAP
{ "status": "ENROLL", "items": [ { "itemId": "2719243" }, { "itemId": "3641243" }, { "itemId": "89459243" } ]
}
Example: Update status of RAP items SUCCESS response
{ "statusCode": 200, "payload": { "success": { "items": [ { "itemId": "2719243", "itemDescription": "View-Master Discovery Kids 3D Marine Life Toy Viewfinder Reel", "sku": "NK-YHT2WL" }, { "itemId": "3641243", "itemDescription": "Strikeforce Men's Flyer Medium and Wide Width Bowling Shoe", "sku": "MY-PHT2YL" }, { "itemId": "89459243", "itemDescription": "Strikeforce Women's Bowling Shoe", "sku": "TR-QHT2OL" } ] } }
}
Example: Update status of RAP items PARTIAL SUCCESS response
{ "statusCode": 200, "payload": { "success": { "items": [ { "itemId": "2719243", "itemDescription": "View-Master Discovery Kids 3D Marine Life Toy Viewfinder Reel", "sku": "NK-YHT2WL" }, { "itemId": "3641243", "itemDescription": "Strikeforce Men's Flyer Medium and Wide Width Bowling Shoe", "sku": "MY-PHT2YL" } ] }, "failure": { "items": [ { "itemId": "89459243", "errorCode": "400.RR.402", "errorDescription": "Invalid Item", "severity": "ERROR", "category": "DATA" } ] } }
}
Example: Update status of RAP items FAILURE response
{ "statusCode": 400, "errors": [ { "code": "400.RR.403", "description": "Request Payload is not in the Expected Format.", "severity": "ERROR", "category": "DATA" } ]
}
Upon success, the API returns the list of items which got successfully enrolled into the program. In case of any errors during enrollment of the items appropriate errors with description are returned in the API response to facilitate client retries.
(Optional) Enroll items into RAP Post-purchase with custom target reviews
You can also specify a custom number of target reviews which you want to be collected through the program for each item during enrollment. The maximum allowed value for custom target reviews is capped at 20 reviews for legal compliance. If a value > 20 is specified for an item in the request, it will be overridden to 20.
Example: Request to enroll items into RAP Post-purchase with custom target reviews
{ "status": "ENROLL", "items": [ { "itemId": "2719243", "targetReviews": 10 }, { "itemId": "3641243", "targetReviews": 20 }, { "itemId": "89459243", "targetReviews": 5 } ]
}
Disenroll items from post-purchase Review Accelerator Program
You may opt out items which are currently enrolled into the Post-purchase program using the Update item status API.
Example: Request to disenroll items from Post-purchase RAP
{ "status": "DISENROLL", "items": [ { "itemId": "2719243" }, { "itemId": "3641243" }, { "itemId": "89459243" } ]
}
Failure scenario error codes
These are the error reason codes available.
Error Reason Code | Description | Severity | Category |
---|---|---|---|
500.RR.501 | Internal server error. Please retry after some time. | ERROR | Internal server error |
500.RR.502 | Invalid ScrollID is passed in the request payload or passed ScrollID is expired. ScrollID is valid for subsequent 5 minutes only. | ERROR | Internal server error |
400.RR.401 | Seller is not enrolled into the program. Please enroll from Seller Center. | ERROR | Authorization |
400.RR.402 | Attribute must match {} but was {}. | ERROR | Invalid request payload |
400.RR.403 | Request payload is not in the expected format. | ERROR | Invalid request payload |
400.RR.404 | Request payload should have less than 100 itemIDs in the payload. | ERROR | Invalid request payload |
400.RR.405 | Invalid item. | ERROR | DATA |
400.RR.406 | Item already enrolled by other seller. | ERROR | DATA |
400.RR.407 | Item already enrolled | ERROR | DATA |
Updated about 1 month ago