Return Items API
Use these APIs to manage your returns on ValoreBooks.
Routes
https://test.valorebooks.com/buyback/return (qa)
https://api.valorebooks.com/buyback/return (production)
POST
Return one or more buyback items
Parameters
Name
Located in
Description
Type
Content-Type
header
String
shipmentId
body
Shipment ID associated with the items you are returning
Number
items
body
Contains information about items that you would like to return. The maximum number of items per call is 100.
List
id
items
ID of the item you want to return
Number
reason
items
Course Cancelation, Damaged, Incorrect Titles, Missing, Overstock, or Potential Counterfeit (case-insensitive)
String
Request Examples
Returning several items
{
"shipmentId": 123,
"items": [
{
"id": 456,
"reason": "Damaged"
},
{
"id": 789,
"reason": "Missing"
}
]
}
Responses
200
Your items have been successfully returned.
[
{
"refundId": 654,
"itemId": 456,
"price": 20.00
},
{
"refundId": 655,
"itemId": 789,
"price": 25.00
}
]
400
There was an error with your request
Item id `{itemId}` in the list of return items is missing or invalid.
List of return items `{items}` is missing or invalid.
List of return items is too long.
A refund already exists for item id `{itemId}`.
Return reason `{reason}` for item id `{itemId}` is invalid.
The amount refunded for the shipment is already over the limit by ${amount}.
The amount being refunded for the shipment is over the limit by ${amount}. Please remove at least this amount to complete your return.
500
An internal error occurred
403
Your AWS credentials are not correct
No buyer found with given credentials.
404
Could not find a shipment for the shipment ID or an item for one of the item IDs.
Shipment cannot be found.
No item exists for id `{itemId}` and shipment id `{shipmentId}`.
POST Return one or more buyback items
Parameters
Name | Located in | Description | Type |
---|---|---|---|
Content-Type | header | String | |
shipmentId | body | Shipment ID associated with the items you are returning | Number |
items | body | Contains information about items that you would like to return. The maximum number of items per call is 100. | List |
id | items | ID of the item you want to return | Number |
reason | items | Course Cancelation, Damaged, Incorrect Titles, Missing, Overstock, or Potential Counterfeit (case-insensitive) | String |
Request Examples
Returning several items
{
"shipmentId": 123,
"items": [
{
"id": 456,
"reason": "Damaged"
},
{
"id": 789,
"reason": "Missing"
}
]
}
Responses
200 Your items have been successfully returned.
[
{
"refundId": 654,
"itemId": 456,
"price": 20.00
},
{
"refundId": 655,
"itemId": 789,
"price": 25.00
}
]
400 There was an error with your request
Item id `{itemId}` in the list of return items is missing or invalid.
List of return items `{items}` is missing or invalid.
List of return items is too long.
A refund already exists for item id `{itemId}`.
Return reason `{reason}` for item id `{itemId}` is invalid.
The amount refunded for the shipment is already over the limit by ${amount}.
The amount being refunded for the shipment is over the limit by ${amount}. Please remove at least this amount to complete your return.
500 An internal error occurred
403 Your AWS credentials are not correct
No buyer found with given credentials.
404 Could not find a shipment for the shipment ID or an item for one of the item IDs.
Shipment cannot be found.
No item exists for id `{itemId}` and shipment id `{shipmentId}`.