openapi: 3.0.0

servers:

- url: https://api.reverb.com/api

x-hasEquivalentPaths: true

info:

contact:

email: [email protected]

name: Reverb API

url: https://www.reverb-api.com

description: reverb

license:

name: Apache 2.0

url: http://www.apache.org/licenses/LICENSE-2.0.html

termsOfService: https://reverb.com/page/terms

title: reverb

version: "3.0"

x-apisguru-categories:

- ecommerce

x-logo:

url: https://d1g5417jjjo7sf.cloudfront.net/assets/top-level/reverb-logo-d2c75af0b020521f0bc5e90c883a13b5.svg

x-origin:

- format: openapi

url: https://s3.amazonaws.com/swagger.reverb.com/swagger.json

version: "3.0"

x-providerName: reverb.com

externalDocs:

url: https://dev.reverb.com/

paths:

/articles:

get:

parameters:

- in: query

name: page

required: false

schema:

default: 1

type: integer

- in: query

name: per_page

required: false

schema:

default: 24

type: integer

- in: query

name: offset

required: false

schema:

type: integer

- description: What's being searched for

in: query

name: query

required: false

schema:

type: string

- description: Number of featured articles to exclude

in: query

name: exclude_featured

required: false

schema:

type: integer

responses:

default:

description: Unexpected error

tags:

- articles

/articles/categories:

get:

description: List of all article categories

responses:

default:

description: Unexpected error

summary: List of all article categories

tags:

- articles

/categories:

get:

description: List of supported product categories

responses:

default:

description: Unexpected error

summary: List of supported product categories

tags:

- categories

/categories/flat:

get:

responses:

default:

description: Unexpected error

tags:

- categories

/categories/taxonomy:

get:

description: Full taxonomy tree of categories including middle categories

responses:

default:

description: Unexpected error

summary: Full taxonomy tree of categories including middle categories

tags:

- categories

"/categories/{product_type}/{category}":

get:

description: Get subcategory details

parameters:

- in: path

name: product_type

required: true

schema:

type: string

- in: path

name: category

required: true

schema:

type: string

responses:

default:

description: Unexpected error

summary: Get subcategory details

tags:

- categories

"/categories/{uuid}":

get:

description: Get category details

parameters:

- in: path

name: uuid

required: true

schema:

type: string

responses:

default:

description: Unexpected error

summary: Get category details

tags:

- categories

/comparison_shopping_pages:

get:

description: Returns a set of comparison shopping pages based on the current params

responses:

default:

description: Unexpected error

summary: Returns a set of comparison shopping pages based on the current params

tags:

- comparison_shopping_pages

/comparison_shopping_pages/find:

get:

description: Show comparison shopping page

parameters:

- description: ID of the comparison shopping page

in: query

name: id

required: false

schema:

type: string

- description: Slug of the comparison shopping page

in: query

name: slug

required: false

schema:

type: string

responses:

default:

description: Unexpected error

summary: Show comparison shopping page

tags:

- comparison_shopping_pages

"/comparison_shopping_pages/{id}":

get:

parameters:

- in: path

name: id

required: true

schema:

type: string

responses:

default:

description: Unexpected error

tags:

- comparison_shopping_pages

"/comparison_shopping_pages/{id}/listings":

get:

description: Return new or used listings for a comparison shopping page

parameters:

- in: path

name: id

required: true

schema:

type: string

- description: Condition of the listing

in: query

name: condition

required: true

schema:

type: string

- in: query

name: page

required: false

schema:

default: 1

type: integer

- in: query

name: per_page

required: false

schema:

default: 24

type: integer

- in: query

name: offset

required: false

schema:

type: integer

responses:

default:

description: Unexpected error

summary: Return new or used listings for a comparison shopping page

tags:

- comparison_shopping_pages

"/comparison_shopping_pages/{id}/reviews":

get:

description: View reviews of a comparison shopping page

parameters:

- in: path

name: id

required: true

schema:

type: string

responses:

default:

description: Unexpected error

summary: View reviews of a comparison shopping page

tags:

- comparison_shopping_pages

"/conversations/{conversation_id}/offer":

post:

description: Make an offer to the other participant in the conversation

parameters:

- in: path

name: conversation_id

required: true

schema:

type: string

requestBody:

$ref: "#/components/requestBodies/Body"

responses:

default:

description: Unexpected error

security:

- oauth2:

- write_offers

summary: Make an offer to the other participant in the conversation

tags:

- conversations

"/conversations/{id}/offer":

post:

description: Make an offer to the other participant in the conversation

parameters:

- in: path

name: id

required: true

schema:

type: string

requestBody:

$ref: "#/components/requestBodies/Body3"

responses:

default:

description: Unexpected error

security:

- oauth2:

- write_offers

summary: Make an offer to the other participant in the conversation

tags:

- conversations

/countries:

get:

description: Retrieve a list of country codes with corresponding subregions

responses:

default:

description: Unexpected error

summary: Retrieve a list of country codes with corresponding subregions

tags:

- countries

/csps:

get:

description: Returns a set of comparison shopping pages based on the current params

responses:

default:

description: Unexpected error

summary: Returns a set of comparison shopping pages based on the current params

tags:

- csps

/csps/categories:

get:

responses:

default:

description: Unexpected error

tags:

- csps

/csps/find:

get:

description: Show comparison shopping page

parameters:

- description: ID of the comparison shopping page

in: query

name: id

required: false

schema:

type: string

- description: Slug of the comparison shopping page

in: query

name: slug

required: false

schema:

type: string

responses:

default:

description: Unexpected error

summary: Show comparison shopping page

tags:

- csps

"/csps/{id}":

get:

parameters:

- in: path

name: id

required: true

schema:

type: string

responses:

default:

description: Unexpected error

tags:

- csps

"/curated_sets/{slug}":

get:

parameters:

- in: path

name: slug

required: true

schema:

type: string

responses:

default:

description: Unexpected error

tags:

- curated_sets

/currencies/display:

get:

description: List of supported display currencies for browsing listings

responses:

default:

description: Unexpected error

summary: List of supported display currencies for browsing listings

tags:

- currencies

/currencies/listing:

get:

description: List of supported listing currencies for shops

responses:

default:

description: Unexpected error

summary: List of supported listing currencies for shops

tags:

- currencies

"/feedback/{feedback_id}":

get:

description: Feedback details

parameters:

- in: path

name: feedback_id

required: true

schema:

type: string

responses:

default:

description: Unexpected error

summary: Feedback details

tags:

- feedback

"/handpicked/{slug}":

get:

description: Get results from a handpicked collection

parameters:

- in: path

name: slug

required: true

schema:

type: string

- description: Search query.

in: query

name: query

required: false

schema:

type: string

- description: Maximum current auction price

in: query

name: auction_price_max

required: false

schema:

format: float

type: number

- description: Category slug from /api/categories

in: query

name: category

required: false

schema:

type: string

- description: Product type slug from /api/categories

in: query

name: product_type

required: false

schema:

type: string

- description: "Condition: all,new,b-stock,used,non-functioning,all-but-new,poor,fair,good,very-good,excellent,mint"

explode: false

in: query

name: conditions

required: false

schema:

items:

type: string

type: array

style: form

- description: "Decade: e.g. 1970s, early 70s"

in: query

name: decade

required: false

schema:

type: string

- description: Visual finish of the item, common for guitars

in: query

name: finish

required: false

schema:

type: string

- description: Handmade items only

in: query

name: handmade

required: false

schema:

type: boolean

- description: City where item is located

in: query

name: item_city

required: false

schema:

type: string

- description: DEPRECATED - Country code where item is located

in: query

name: item_country

required: false

schema:

type: string

- description: Country code where item is located

in: query

name: item_region

required: false

schema:

type: string

- description: State or region code where item is located

in: query

name: item_state

required: false

schema:

type: string

- description: Make(s)/brand of item (e.g. Fender). Can take a single value or an array.

explode: false

in: query

name: make

required: false

schema:

items:

type: string

type: array

style: form

- description: Model of item (e.g. Stratocaster)

in: query

name: model

required: false

schema:

type: string

- description: Search term negation. If you want to exclude a term, add it here

in: query

name: must_not

required: false

schema:

type: string

- description: Maximum price of search results (USD)

in: query

name: price_max

required: false

schema:

format: float

type: number

- description: Minimum price of search results (USD)

in: query

name: price_min

required: false

schema:

format: float

type: number

- description: The currency to be used for the price filters

in: query

name: currency

required: false

schema:

type: string

- description: Maximum year of manufacture

in: query

name: year_max

required: false

schema:

type: integer

- description: Minumum year of manufacture

in: query

name: year_min

required: false

schema:

type: integer

- description: If true, include only items that accept gift cards

in: query

name: accepts_gift_cards

required: false

schema:

type: boolean

- description: If true, include only items by Reverb Preferred Sellers

in: query

name: preferred_seller

required: false

schema:

type: boolean

- description: Slug of shop to search

in: query

name: shop

required: false

schema:

type: string

- description: ID of shop to search

in: query

name: shop_id

required: false

schema:

type: string

- description: "Type of listing: auctions,offers"

in: query

name: listing_type

required: false

schema:

type: string

- description: Limit search to items that ship to this country code

in: query

name: ships_to

required: false

schema:

type: string

- description: If true, exclude auctions

in: query

name: exclude_auctions

required: false

schema:

type: boolean

- description: If true, only show items that can be purchased with a payment plan

in: query

name: accepts_payment_plans

required: false

schema:

type: boolean

- description: Minimum number of watchers (used to find popular items)

in: query

name: watchers_count_min

required: false

schema:

type: integer

- description: Listing ID negation. If you want to exclude a listing, add it here.

explode: false

in: query

name: not_ids

required: false

schema:

items:

type: string

type: array

style: form

- description: Only items that offer local pickup

in: query

name: local_pickup

required: false

schema:

type: boolean

- in: query

name: page

required: false

schema:

default: 1

type: integer

- in: query

name: per_page

required: false

schema:

default: 24

type: integer

- in: query

name: offset

required: false

schema:

type: integer

responses:

default:

description: Unexpected error

summary: Get results from a handpicked collection

tags:

- handpicked

/listing_conditions:

get:

description: List of supported product conditions

responses:

default:

description: Unexpected error

summary: List of supported product conditions

tags:

- listing_conditions

/listings:

get:

description: Default search of listings includes only used & handmade. Add a filter to view all listings or use the /listings/all endpoint.

parameters:

- description: Search query.

in: query

name: query

required: false

schema:

type: string

- description: Maximum current auction price

in: query

name: auction_price_max

required: false

schema:

format: float

type: number

- description: Category slug from /api/categories

in: query

name: category

required: false

schema:

type: string

- description: Product type slug from /api/categories

in: query

name: product_type

required: false

schema:

type: string

- description: "Condition: all,new,b-stock,used,non-functioning,all-but-new,poor,fair,good,very-good,excellent,mint"

explode: false

in: query

name: conditions

required: false

schema:

items:

type: string

type: array

style: form

- description: "Decade: e.g. 1970s, early 70s"

in: query

name: decade

required: false

schema:

type: string

- description: Visual finish of the item, common for guitars

in: query

name: finish

required: false

schema:

type: string

- description: Handmade items only

in: query

name: handmade

required: false

schema:

type: boolean

- description: City where item is located

in: query

name: item_city

required: false

schema:

type: string

- description: DEPRECATED - Country code where item is located

in: query

name: item_country

required: false

schema:

type: string

- description: Country code where item is located

in: query

name: item_region

required: false

schema:

type: string

- description: State or region code where item is located

in: query

name: item_state

required: false

schema:

type: string

- description: Make(s)/brand of item (e.g. Fender). Can take a single value or an array.

explode: false

in: query

name: make

required: false

schema:

items:

type: string

type: array

style: form

- description: Model of item (e.g. Stratocaster)

in: query

name: model

required: false

schema:

type: string

- description: Search term negation. If you want to exclude a term, add it here

in: query

name: must_not

required: false

schema:

type: string

- description: Maximum price of search results (USD)

in: query

name: price_max

required: false

schema:

format: float

type: number

- description: Minimum price of search results (USD)

in: query

name: price_min

required: false

schema:

format: float

type: number

- description: The currency to be used for the price filters

in: query

name: currency

required: false

schema:

type: string

- description: Maximum year of manufacture

in: query

name: year_max

required: false

schema:

type: integer

- description: Minumum year of manufacture

in: query

name: year_min

required: false

schema:

type: integer

- description: If true, include only items that accept gift cards

in: query

name: accepts_gift_cards

required: false

schema:

type: boolean

- description: If true, include only items by Reverb Preferred Sellers

in: query

name: preferred_seller

required: false

schema:

type: boolean

- description: Slug of shop to search

in: query

name: shop

required: false

schema:

type: string

- description: ID of shop to search

in: query

name: shop_id

required: false

schema:

type: string

- description: "Type of listing: auctions,offers"

in: query

name: listing_type

required: false

schema:

type: string

- description: Limit search to items that ship to this country code

in: query

name: ships_to

required: false

schema:

type: string

- description: If true, exclude auctions

in: query

name: exclude_auctions

required: false

schema:

type: boolean

- description: If true, only show items that can be purchased with a payment plan

in: query

name: accepts_payment_plans

required: false

schema:

type: boolean

- description: Minimum number of watchers (used to find popular items)

in: query

name: watchers_count_min

required: false

schema:

type: integer

- description: Listing ID negation. If you want to exclude a listing, add it here.

explode: false

in: query

name: not_ids

required: false

schema:

items:

type: string

type: array

style: form

- description: Only items that offer local pickup

in: query

name: local_pickup

required: false

schema:

type: boolean

- in: query

name: page

required: false

schema:

default: 1

type: integer

- in: query

name: per_page

required: false

schema:

default: 24

type: integer

- in: query

name: offset

required: false

schema:

type: integer

responses:

default:

description: Unexpected error

summary: Default search of listings includes only used & handmade. Add a filter to view all listings or use the /listings/all endpoint.

tags:

- listings

post:

description: Create a listing

requestBody:

content:

application/json:

schema:

properties:

categories:

items:

properties:

uuid:

description: UUID of the category for this listing.

type: string

type: object

type: array

condition:

description: Condition

properties:

uuid:

description: Condition UUID

enum:

- fbf35668-96a0-4baa-bcde-ab18d6b1b329

- 6a9dfcad-600b-46c8-9e08-ce6e5057921e

- 98777886-76d0-44c8-865e-bb40e669e934

- f7a3f48c-972a-44c6-b01a-0cd27488d3f6

- ae4d9114-1bd7-4ec5-a4ba-6653af5ac84d

- df268ad1-c462-4ba6-b6db-e007e23922ea

- ac5b9c1e-dc78-466d-b0b3-7cf712967a48

- 6db7df88-293b-4017-a1c1-cdb5e599fa1a

- 9225283f-60c2-4413-ad18-1f5eba7a856f

- 7c3f45de-2ae0-4c81-8400-fdb6b1d74890

type: string

required:

- uuid

type: object

description:

description: Product description. Please keep formatting to a minimum.

type: string

exclusive_channel:

description: Currently for users of seller sites only, this allows you to have a listing available only to your seller site by setting this to 'seller_site'

enum:

- seller_site

- reverb

- none

type: string

finish:

description: Finish, e.g. 'Sunburst'

type: string

has_inventory:

description: Set true if selling more than one

type: boolean

inventory:

description: Number of items available for sale. Reverb will increment and decrement automatically.

type: integer

location:

properties:

country_code:

description: "Ex: US"

type: string

locality:

description: "Ex: Chicago"

type: string

region:

description: "Ex: IL"

type: string

type: object

make:

description: "ex: Fender, Gibson"

type: string

model:

description: "ex: Stratocaster, SG"

type: string

multi_item:

description: Specifies if the listing is a bundle of multiple individual items

type: boolean

offers_enabled:

description: "Whether the listing accepts negotiated offers (default: true)"

type: boolean

origin_country_code:

description: "Country of origin/manufacture, ISO code (e.g: US)"

type: string

photos:

description: "An array of image URLs. Ex: ['http://my.site.com/image.jpg']"

items:

type: string

type: array

preorder_info:

description: Create or update a preorder listing. Requires opt-in. Please contact [email protected] if you would like to activate this feature.

properties:

lead_time:

description: The amount of time before the item will be ready to ship. When lead_time is submitted it is converted into days and added to the current date to produce `estimated_ship_date` in the response body of the request.

type: integer

lead_time_unit:

description: The unit of time which lead_time is measured in

enum:

- days

- weeks

type: string

ship_date:

description: "The date the item will be available to ship. In the response body of the request, `estimated_ship_date`, will be the same as ship_date. Date must be ISO8601 format - e.g: 2015-04-09T10:52:23-00:00."

type: string

required:

- lead_time_unit

type: object

price:

properties:

amount:

description: The amount of money being expressed, as a POSIX-compliant decimal number

type: string

currency:

description: The currency the money will be expressed in

enum:

- USD

- CAD

- EUR

- GBP

- AUD

- JPY

- NZD

- MXN

type: string

required:

- amount

- currency

type: object

prop_65_warning:

description: If your listing contains chemicals that are required to be reported under California Prop 65, please provide your warning statement. We will add the required 'Warning' label and link to California's information page, so you only need to provide the body of the warning. For more information, see https://www.p65warnings.ca.gov/new-proposition-65-warnings

type: string

publish:

description: Publish your listing if draft

type: boolean

seller:

properties:

paypal_email:

type: string

type: object

seller_cost:

description: Cost of goods in your currency as a POSIX-compliant decimal number (internal use only, not shown to buyers)

type: string

shipping:

properties:

local:

description: True if you offer local pickup

type: boolean

rates:

description: List of shipping rates. Set to null to clear rates.

items:

properties:

rate:

properties:

amount:

description: The amount of money being expressed, as a POSIX-compliant decimal number

type: string