Manage Sales
1. Add Listings To A Sale
/api/sales/:sale_id/listings
You can add up to 25 listings at a time by passing an array of listing_ids.
curl -XPOST -H "Content-Type: application/hal+json" -H "Accept: application/hal+json" -H "Authorization: Bearer [oauth_token]" -H "Accept-Version: 3.0" https://api.reverb.com/api/sales/89472/listings -d '{"listing_ids":["21363","24524"]}'
{"results":[
{
"listing_id":"21363",
"success":true,
"message":"OK"
},
{
"listing_id":"24524",
"success":false,
"message":"You are not authorized to add this listing to a sale." // example error message
}
]}
2. Remove Listings From A Sale
/api/sales/:sale_id/listings
You can remove up to 25 listings at a time by passing an array of listing_ids.
curl -XDELETE -H "Content-Type: application/hal+json" -H "Accept: application/hal+json" -H "Accept-Version: 3.0" -H "Authorization: Bearer [oauth_token]" https://api.reverb.com/api/sales/89472/listings -d '{"listing_ids":["21363","24524"]}'
{"results":[
{
"listing_id":"21363",
"success":true,
"message":"OK"
},
{
"listing_id":"24524",
"success":false,
"message":"You are not authorized to remove this listing from a sale." // example error message
}
]}
3. View All Sales for a Given Listing
/api/listings/:listing_id/sales
Authentication not required; however, an authenticated user may see more information.
curl -XGET -H "Authorization: Bearer [oauth_token]" -H "Accept-Version: 3.0" https://api.reverb.com/api/listings/21363/sales
{
"total":1,
"_links":{},
"sales":[
{
"id":5,
"discount_percent":10,
"discount_code":"10PERCENT",
"max_count_listings_allowed":null,
"starts_at":"2015-12-25T08:00:00-06:00",
"ends_at":"2016-01-22T11:50:50-06:00",
"_links":{
"web":{
"href":"https://reverb.site/sales/feil-group-old-sale"
},
"listings":{
"href":"/api/sales/5/listings"
}
}
}
]
}
4. View All Seller Created Sales
/api/sales/seller
View all of your seller created sales regardless of state. This includes active, ended and upcoming sales created within your account. This does not pull Reverb-sponsored sales, see 5. for details.
curl -XGET -H "Authorization: Bearer [oauth_token]" -H "Accept-Version: 3.0" https://api.reverb.com/api/sales/seller
{
"id": 1234,
"slug": "your_sale_slug_here",
"name": "30% OFF CLEARANCE SALE!",
"code": "SALECODE",
"is_live": true,
"starts_at": "2020-09-24T14:00:00+01:00",
"ends_at": "2021-01-31T00:00:00+00:00",
"summary": "Save 30% at Checkout",
"created_by": "Reverb Superseller",
"_links": {
"self": {
"href": "https://api.reverb.com/api/sales/your_sale_slug_here"
},
"web": {
"href": "https://reverb.com/sales/your_sale_slug_here"
},
"listings": {
"href": "https://api.reverb.com/api/listings?curated_set_id=1234"
}
}
}
5. View All Reverb Sponsored Site-Wide Sales
/api/sales/reverb
View Active Reverb Sponsored Site-Wide Sales.
curl -XGET -H "Authorization: Bearer [oauth_token]" -H "Accept-Version: 3.0" https://api.reverb.com/api/sales/reverb
Response shown below displays when there are no active Reverb sponsored sales.
{
"total": 0,
"current_page": 1,
"total_pages": 1,
"sales": [],
"_links": {}
}
###Notes on Sale Attributes
max_count_listings_allowed
is an Integer denoting how many listings are allowed in a Sale per user. This is typically only set on Reverb Official Sales, and is irrelevant for Seller Sales. Anull
value indicates no threshold.
Updated 8 months ago