Real time upload, order and shipment notifications are available through Amazon’s Simple Queue Service (SQS). We encourage you to check out Amazon’s SQS documentation to learn more about how to connect to and process messages from your queue.
Please note that your ValoreBooks API account is private and you are always the only one who has access to your queue.
Your queue:
https://sqs.<queue-region>.amazonaws.com/<queue-identifier>/BuyerNotification<buyer-id>Notifications
These are the different types of notifications that will show up on your queue.
Upload new buy guide results
We have finished processing your upload guide request.
Message Attributes:
| Key | Value | Example | Attribute Data Type |
|---|---|---|---|
| type | bulk-bid-result |
bulk-bid-result |
String |
| status | <PROCESS_RESULT> |
PROCESSED |
String |
| guideFile | <key for the uploaded guide> |
<buyer-id>/bid-upload/20160815guide.csv |
String |
| errorFile | <key for error results, if applicable> |
<buyer-id>/bid-upload/errors/20160815guide.csv |
String |
Possible Status Values:
| Result | Definition |
|---|---|
PROCESSED |
Bulk bid file was processed and all requested bids have been placed. |
PROCESSED WITH ERRORS |
Bulk bid file was processed and all valid bids have been placed. Check the error file for any bids that were not successful. |
PARTIALLY PROCESSED |
Due to a server error the file was partially processed. All bids that were processed prior to the error have been placed. |
NOT PROCESSED |
We were unable to process your guide. Your existing bids have not changed. |
Order notifications
You have won a bid and an order has been placed!
Message Attributes:
| Key | Value | Example | Attribute Data Type |
|---|---|---|---|
| type | order-placed |
order-placed |
String |
| price | <dollar value> |
75.75 |
String |
| isbn | <product ISBN> |
9780321694331 |
String |
| itemId | <ValoreBooks item id> |
1234567 |
String |
| orderId | <ValoreBooks order id> |
345678 |
String |
| quoteDate | <when customer received quote> |
2020-01-01T04:30:00Z |
String (DateTime) |
| 3plItemId | <third party item id> |
234432 |
String |
Shipment notifications
A shipment has been prepared and delivery is in progress.
Message Attributes:
| Key | Value | Example | Attribute Data Type |
|---|---|---|---|
| type | shipment-sent |
shipment-sent |
String |
| shipmentId | <ValoreBooks shipment id> |
109457 |
String |
Invoice/Details File notifications
An invoice file and a details file have been created and are now available for review.
Message Attributes:
| Key | Value | Example | Attribute Data Type |
|---|---|---|---|
| type | invoice-created |
invoice-created |
String |
| invoiceFile | <key for the invoice file> |
<buyer-id>/invoice-files/valorebooks-shipment-invoice-109457-20171130.pdf |
String |
| detailsFile | <key for the details file> |
<buyer-id>/invoice-files/valorebooks-shipment-details-109457-20171130.csv |
String |
Item update notifications
A quoted item has changed status.
Message Attributes:
| Key | Value | Example | Attribute Data Type |
|---|---|---|---|
| type | item-update |
item-update |
String |
| itemId | <ValoreBooks item id> |
1234567 |
String |
| status | <ValoreBooks item updated status> |
in-transit |
String |
| 3plItemId | <third party item id> |
234432 |
String |
Possible Status Values:
| Result | Definition |
|---|---|
pending |
Items that have been placed but have no other activity yet. |
in-transit |
Items that are on their way to our warehouse to be sorted and condition-checked. A pending item changes to an item in-transit as soon as it has been dropped off and scanned in at the shipping carrier. |
accepted |
Items that were received and condition-checked and have passed our quality standards. These items will be held for you at our warehouse until your shipment date. |
rejected |
Items that were either never sent in, or failed to meet our quality standards and have been sent back to the seller. |