Created
October 6, 2015 15:05
-
-
Save paranoidminotaur/dad2e2883468bc40729b to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "title": "reverb", | |
| "description": "reverb", | |
| "termsOfService": "https://reverb.com/page/terms", | |
| "contact": { | |
| "name": "Reverb API", | |
| "email": "[email protected]", | |
| "url": "https://dev.reverb.com" | |
| }, | |
| "license": { | |
| "name": "Apache 2.0", | |
| "url": "http://www.apache.org/licenses/LICENSE-2.0.html" | |
| }, | |
| "version": "2.0" | |
| }, | |
| "host": "reverb.com", | |
| "basePath": "/api", | |
| "schemes": [ | |
| "https" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "paths": { | |
| "/accounts": { | |
| "post": { | |
| "tags": [ | |
| "accounts" | |
| ], | |
| "summary": "Create an account.", | |
| "description": "Create an account.", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "email", | |
| "password", | |
| "first_name", | |
| "last_name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "email": { | |
| "description": "Email address.", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "description": "Password (at least 8 characters).", | |
| "type": "string" | |
| }, | |
| "first_name": { | |
| "description": "First Name", | |
| "type": "string" | |
| }, | |
| "last_name": { | |
| "description": "Last Name", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/articles/{slug}/related-listings": { | |
| "get": { | |
| "tags": [ | |
| "articles" | |
| ], | |
| "summary": "Find listings related to an article", | |
| "description": "Find listings related to an article", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/auth/email": { | |
| "post": { | |
| "tags": [ | |
| "auth" | |
| ], | |
| "summary": "Login by email/password", | |
| "description": "Login by email/password", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "email", | |
| "password" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "email": { | |
| "description": "Email address.", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "description": "Password", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/auth/facebook": { | |
| "post": { | |
| "tags": [ | |
| "auth" | |
| ], | |
| "summary": "Login by facebook token", | |
| "description": "Login by facebook token", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "fb_token" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "fb_token": { | |
| "description": "Facebook access token.", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/auth/forgot_password": { | |
| "post": { | |
| "tags": [ | |
| "auth" | |
| ], | |
| "summary": "Send a password reset email", | |
| "description": "Send a password reset email", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "email" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/auth/logout": { | |
| "put": { | |
| "tags": [ | |
| "auth" | |
| ], | |
| "summary": "Logout (primarily for mobile clients)", | |
| "description": "Logout (primarily for mobile clients)", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "device_type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "device_token": { | |
| "type": "string" | |
| }, | |
| "device_type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/autosuggest": { | |
| "get": { | |
| "tags": [ | |
| "autosuggest" | |
| ], | |
| "summary": "Autosuggest terms for searches", | |
| "description": "Autosuggest terms for searches", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/categories": { | |
| "get": { | |
| "tags": [ | |
| "categories" | |
| ], | |
| "summary": "List of supported product categories", | |
| "description": "List of supported product categories", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/categories/{product_type}": { | |
| "get": { | |
| "tags": [ | |
| "categories" | |
| ], | |
| "summary": "Get category details", | |
| "description": "Get category details", | |
| "parameters": [ | |
| { | |
| "name": "product_type", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/categories/{product_type}/{category}": { | |
| "get": { | |
| "tags": [ | |
| "categories" | |
| ], | |
| "summary": "Get subcategory details", | |
| "description": "Get subcategory details", | |
| "parameters": [ | |
| { | |
| "name": "product_type", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "category", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/collections": { | |
| "get": { | |
| "tags": [ | |
| "collections" | |
| ], | |
| "summary": "List of curated collections", | |
| "description": "List of curated collections", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/collections/{slug}": { | |
| "get": { | |
| "tags": [ | |
| "collections" | |
| ], | |
| "summary": "Collection details", | |
| "description": "Collection details", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/conversations/{id}/offer": { | |
| "post": { | |
| "tags": [ | |
| "conversations" | |
| ], | |
| "summary": "Make an offer to the other participant in the conversation", | |
| "description": "Make an offer to the other participant in the conversation", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "price" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "price": { | |
| "description": "Offer price", | |
| "type": "string" | |
| }, | |
| "shipping_price": { | |
| "description": "Shipping price (sellers only)", | |
| "type": "string" | |
| }, | |
| "message": { | |
| "description": "Message to include with counter offer", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/feedback/{feedback_id}": { | |
| "get": { | |
| "tags": [ | |
| "feedback" | |
| ], | |
| "summary": "Feedback details", | |
| "description": "Feedback details", | |
| "parameters": [ | |
| { | |
| "name": "feedback_id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/handpicked/{slug}": { | |
| "get": { | |
| "tags": [ | |
| "handpicked" | |
| ], | |
| "summary": "Get results from a handpicked collection", | |
| "description": "Get results from a handpicked collection", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "query", | |
| "in": "query", | |
| "description": "Search query.", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "auction_price_max", | |
| "in": "query", | |
| "description": "Maximum current auction price", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| { | |
| "name": "category", | |
| "in": "query", | |
| "description": "Category slug from /api/categories", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "product_type", | |
| "in": "query", | |
| "description": "Product type slug from /api/categories", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "condition", | |
| "in": "query", | |
| "description": "Condition name", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "decade", | |
| "in": "query", | |
| "description": "Decade: e.g. 1970s, early 70s", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "finish", | |
| "in": "query", | |
| "description": "Visual finish of the item, common for guitars", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "handmade", | |
| "in": "query", | |
| "description": "Handmade items only", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "item_city", | |
| "in": "query", | |
| "description": "City where item is located", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "item_country", | |
| "in": "query", | |
| "description": "Country code where item is located", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "item_state", | |
| "in": "query", | |
| "description": "State or region code where item is located", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "make", | |
| "in": "query", | |
| "description": "Make/brand of item (e.g. Fender)", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "model", | |
| "in": "query", | |
| "description": "Model of item (e.g. Stratocaster)", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "must_not", | |
| "in": "query", | |
| "description": "Search term negation. If you want to exclude a term, add it here", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "price_max", | |
| "in": "query", | |
| "description": "Maximum price of search results (USD)", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| { | |
| "name": "price_min", | |
| "in": "query", | |
| "description": "Minimum price of search results (USD)", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| { | |
| "name": "year_max", | |
| "in": "query", | |
| "description": "Maximum year of manufacture", | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "year_min", | |
| "in": "query", | |
| "description": "Minumum year of manufacture", | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "accepts_gift_cards", | |
| "in": "query", | |
| "description": "If true, include only items that accept gift cards", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "preferred_seller", | |
| "in": "query", | |
| "description": "If true, include only items by Reverb Preferred Sellers", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "listing_type", | |
| "in": "query", | |
| "description": "Type of listing", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "ships_to", | |
| "in": "query", | |
| "description": "Limit search to items that ship to this country code", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "exclude_auctions", | |
| "in": "query", | |
| "description": "If true, don't return any auctions", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "accepts_payment_plans", | |
| "in": "query", | |
| "description": "If true, only show items that can be purchased with a payment plan", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "state", | |
| "in": "query", | |
| "description": "State of listing", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "watchers_count_min", | |
| "in": "query", | |
| "description": "Minimum number of watchers (used to find popular items)", | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 1 | |
| }, | |
| { | |
| "name": "per_page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 24 | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/listings/all": { | |
| "get": { | |
| "tags": [ | |
| "listings" | |
| ], | |
| "summary": "All listings including used, handmade, and brand new", | |
| "description": "All listings including used, handmade, and brand new", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "in": "query", | |
| "description": "Search query.", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "auction_price_max", | |
| "in": "query", | |
| "description": "Maximum current auction price", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| { | |
| "name": "category", | |
| "in": "query", | |
| "description": "Category slug from /api/categories", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "product_type", | |
| "in": "query", | |
| "description": "Product type slug from /api/categories", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "condition", | |
| "in": "query", | |
| "description": "Condition name", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "decade", | |
| "in": "query", | |
| "description": "Decade: e.g. 1970s, early 70s", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "finish", | |
| "in": "query", | |
| "description": "Visual finish of the item, common for guitars", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "handmade", | |
| "in": "query", | |
| "description": "Handmade items only", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "item_city", | |
| "in": "query", | |
| "description": "City where item is located", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "item_country", | |
| "in": "query", | |
| "description": "Country code where item is located", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "item_state", | |
| "in": "query", | |
| "description": "State or region code where item is located", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "make", | |
| "in": "query", | |
| "description": "Make/brand of item (e.g. Fender)", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "model", | |
| "in": "query", | |
| "description": "Model of item (e.g. Stratocaster)", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "must_not", | |
| "in": "query", | |
| "description": "Search term negation. If you want to exclude a term, add it here", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "price_max", | |
| "in": "query", | |
| "description": "Maximum price of search results (USD)", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| { | |
| "name": "price_min", | |
| "in": "query", | |
| "description": "Minimum price of search results (USD)", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| { | |
| "name": "year_max", | |
| "in": "query", | |
| "description": "Maximum year of manufacture", | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "year_min", | |
| "in": "query", | |
| "description": "Minumum year of manufacture", | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "accepts_gift_cards", | |
| "in": "query", | |
| "description": "If true, include only items that accept gift cards", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "preferred_seller", | |
| "in": "query", | |
| "description": "If true, include only items by Reverb Preferred Sellers", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "listing_type", | |
| "in": "query", | |
| "description": "Type of listing", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "ships_to", | |
| "in": "query", | |
| "description": "Limit search to items that ship to this country code", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "exclude_auctions", | |
| "in": "query", | |
| "description": "If true, don't return any auctions", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "accepts_payment_plans", | |
| "in": "query", | |
| "description": "If true, only show items that can be purchased with a payment plan", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "state", | |
| "in": "query", | |
| "description": "State of listing", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "watchers_count_min", | |
| "in": "query", | |
| "description": "Minimum number of watchers (used to find popular items)", | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 1 | |
| }, | |
| { | |
| "name": "per_page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 24 | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/listings": { | |
| "get": { | |
| "tags": [ | |
| "listings" | |
| ], | |
| "summary": "Default search of listings includes only used & handmade. Add a filter to view all listings or use the /listings/all endpoint.", | |
| "description": "Default search of listings includes only used & handmade. Add a filter to view all listings or use the /listings/all endpoint.", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "in": "query", | |
| "description": "Search query.", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "auction_price_max", | |
| "in": "query", | |
| "description": "Maximum current auction price", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| { | |
| "name": "category", | |
| "in": "query", | |
| "description": "Category slug from /api/categories", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "product_type", | |
| "in": "query", | |
| "description": "Product type slug from /api/categories", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "condition", | |
| "in": "query", | |
| "description": "Condition name", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "decade", | |
| "in": "query", | |
| "description": "Decade: e.g. 1970s, early 70s", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "finish", | |
| "in": "query", | |
| "description": "Visual finish of the item, common for guitars", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "handmade", | |
| "in": "query", | |
| "description": "Handmade items only", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "item_city", | |
| "in": "query", | |
| "description": "City where item is located", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "item_country", | |
| "in": "query", | |
| "description": "Country code where item is located", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "item_state", | |
| "in": "query", | |
| "description": "State or region code where item is located", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "make", | |
| "in": "query", | |
| "description": "Make/brand of item (e.g. Fender)", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "model", | |
| "in": "query", | |
| "description": "Model of item (e.g. Stratocaster)", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "must_not", | |
| "in": "query", | |
| "description": "Search term negation. If you want to exclude a term, add it here", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "price_max", | |
| "in": "query", | |
| "description": "Maximum price of search results (USD)", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| { | |
| "name": "price_min", | |
| "in": "query", | |
| "description": "Minimum price of search results (USD)", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| { | |
| "name": "year_max", | |
| "in": "query", | |
| "description": "Maximum year of manufacture", | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "year_min", | |
| "in": "query", | |
| "description": "Minumum year of manufacture", | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "accepts_gift_cards", | |
| "in": "query", | |
| "description": "If true, include only items that accept gift cards", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "preferred_seller", | |
| "in": "query", | |
| "description": "If true, include only items by Reverb Preferred Sellers", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "listing_type", | |
| "in": "query", | |
| "description": "Type of listing", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "ships_to", | |
| "in": "query", | |
| "description": "Limit search to items that ship to this country code", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "exclude_auctions", | |
| "in": "query", | |
| "description": "If true, don't return any auctions", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "accepts_payment_plans", | |
| "in": "query", | |
| "description": "If true, only show items that can be purchased with a payment plan", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "state", | |
| "in": "query", | |
| "description": "State of listing", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "watchers_count_min", | |
| "in": "query", | |
| "description": "Minimum number of watchers (used to find popular items)", | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 1 | |
| }, | |
| { | |
| "name": "per_page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 24 | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "listings" | |
| ], | |
| "summary": "Create a listing", | |
| "description": "Create a listing", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "make": { | |
| "description": "ex: Fender, Gibson", | |
| "type": "string" | |
| }, | |
| "model": { | |
| "description": "ex: Stratocaster, SG", | |
| "type": "string" | |
| }, | |
| "publish": { | |
| "description": "Publish your listing if draft", | |
| "type": "boolean" | |
| }, | |
| "product_type": { | |
| "description": "Top level category slug. Ex: electric-guitar, acoustic-guitar. Full list: /api/categories", | |
| "type": "string" | |
| }, | |
| "categories": { | |
| "description": "Array of up to two additional categories. Must be children of product_type.", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "non_returnable": { | |
| "description": "Product is sold as-is and cannot be returned", | |
| "type": "boolean" | |
| }, | |
| "photos": { | |
| "description": "An array of image URLs. Ex: ['http://my.site.com/image.jpg']", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "condition": { | |
| "description": "Condition name (Brand New, Very good, etc)", | |
| "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" | |
| }, | |
| "description": { | |
| "description": "Product description. Please keep formatting to a minimum.", | |
| "type": "string" | |
| }, | |
| "finish": { | |
| "description": "Finish, e.g. 'Sunburst'", | |
| "type": "string" | |
| }, | |
| "price": { | |
| "description": "Asking price in USD", | |
| "type": "string" | |
| }, | |
| "title": { | |
| "description": "Title of your listing", | |
| "type": "string" | |
| }, | |
| "year": { | |
| "description": "Supports many formats. Ex: 1979, mid-70s, late 90s", | |
| "type": "string" | |
| }, | |
| "sku": { | |
| "description": "Unique identifier for product", | |
| "type": "string" | |
| }, | |
| "offers_enabled": { | |
| "description": "Whether the listing accepts negotiated offers (default: true)", | |
| "type": "boolean" | |
| }, | |
| "location": { | |
| "type": "object", | |
| "properties": { | |
| "locality": { | |
| "description": "Ex: Chicago", | |
| "type": "string" | |
| }, | |
| "region": { | |
| "description": "Ex: IL", | |
| "type": "string" | |
| }, | |
| "country_code": { | |
| "description": "Ex: US", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "shipping": { | |
| "type": "object", | |
| "properties": { | |
| "local": { | |
| "description": "True if you offer local pickup", | |
| "type": "boolean" | |
| }, | |
| "us": { | |
| "description": "True if the product ships within the US. International sellers are required to ship to US at this time.", | |
| "type": "boolean" | |
| }, | |
| "us_rate": { | |
| "description": "Shipping rate to ship within the US in USD", | |
| "type": "string" | |
| }, | |
| "rates": { | |
| "description": "List of shipping rates", | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "region_type": { | |
| "description": "[everywhere_else,country,subregion,superregion]", | |
| "type": "string" | |
| }, | |
| "region_code": { | |
| "description": "Country code or subregion/superregion code. Full list of codes at /api/shipping/regions", | |
| "type": "string" | |
| }, | |
| "rate": { | |
| "description": "Shipping rate in USD", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "seller": { | |
| "type": "object", | |
| "properties": { | |
| "paypal_email": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/listings/{id}/offer": { | |
| "post": { | |
| "tags": [ | |
| "listings" | |
| ], | |
| "summary": "Make an offer to the seller of a listing", | |
| "description": "Make an offer to the seller of a listing", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "price" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "price": { | |
| "description": "Offer price", | |
| "type": "string" | |
| }, | |
| "shipping_price": { | |
| "description": "Shipping price (sellers only)", | |
| "type": "string" | |
| }, | |
| "message": { | |
| "description": "Message to include with counter offer", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/listings/{listing_id}/conversations": { | |
| "post": { | |
| "tags": [ | |
| "listings" | |
| ], | |
| "summary": "Start a conversation with a seller", | |
| "description": "Start a conversation with a seller", | |
| "parameters": [ | |
| { | |
| "name": "listing_id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "body" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "body": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/listings/{slug}": { | |
| "get": { | |
| "tags": [ | |
| "listings" | |
| ], | |
| "summary": "Listing details", | |
| "description": "Listing details", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "listings" | |
| ], | |
| "summary": "Update a listing", | |
| "description": "Update a listing", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "publish": { | |
| "description": "Publish your listing if draft", | |
| "type": "boolean" | |
| }, | |
| "make": { | |
| "description": "ex: Fender, Gibson", | |
| "type": "string" | |
| }, | |
| "model": { | |
| "description": "ex: Stratocaster, SG", | |
| "type": "string" | |
| }, | |
| "product_type": { | |
| "description": "Top level category slug. Ex: electric-guitar, acoustic-guitar. Full list: /api/categories", | |
| "type": "string" | |
| }, | |
| "categories": { | |
| "description": "Array of up to two additional categories. Must be children of product_type.", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "non_returnable": { | |
| "description": "Product is sold as-is and cannot be returned", | |
| "type": "boolean" | |
| }, | |
| "photos": { | |
| "description": "An array of image URLs. Ex: ['http://my.site.com/image.jpg']", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "condition": { | |
| "description": "Condition name (Brand New, Very good, etc)", | |
| "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" | |
| }, | |
| "description": { | |
| "description": "Product description. Please keep formatting to a minimum.", | |
| "type": "string" | |
| }, | |
| "finish": { | |
| "description": "Finish, e.g. 'Sunburst'", | |
| "type": "string" | |
| }, | |
| "price": { | |
| "description": "Asking price in USD", | |
| "type": "string" | |
| }, | |
| "title": { | |
| "description": "Title of your listing", | |
| "type": "string" | |
| }, | |
| "year": { | |
| "description": "Supports many formats. Ex: 1979, mid-70s, late 90s", | |
| "type": "string" | |
| }, | |
| "sku": { | |
| "description": "Unique identifier for product", | |
| "type": "string" | |
| }, | |
| "offers_enabled": { | |
| "description": "Whether the listing accepts negotiated offers (default: true)", | |
| "type": "boolean" | |
| }, | |
| "location": { | |
| "type": "object", | |
| "properties": { | |
| "locality": { | |
| "description": "Ex: Chicago", | |
| "type": "string" | |
| }, | |
| "region": { | |
| "description": "Ex: IL", | |
| "type": "string" | |
| }, | |
| "country_code": { | |
| "description": "Ex: US", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "shipping": { | |
| "type": "object", | |
| "properties": { | |
| "local": { | |
| "description": "True if you offer local pickup", | |
| "type": "boolean" | |
| }, | |
| "us": { | |
| "description": "True if the product ships within the US. International sellers are required to ship to US at this time.", | |
| "type": "boolean" | |
| }, | |
| "us_rate": { | |
| "description": "Shipping rate to ship within the US in USD", | |
| "type": "string" | |
| }, | |
| "rates": { | |
| "description": "List of shipping rates", | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "region_type": { | |
| "description": "[everywhere_else,country,subregion,superregion]", | |
| "type": "string" | |
| }, | |
| "region_code": { | |
| "description": "Country code or subregion/superregion code. Full list of codes at /api/shipping/regions", | |
| "type": "string" | |
| }, | |
| "rate": { | |
| "description": "Shipping rate in USD", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "seller": { | |
| "type": "object", | |
| "properties": { | |
| "paypal_email": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "listings" | |
| ], | |
| "summary": "Delete a draft listing. Cannot be used on non-drafts.", | |
| "description": "Delete a draft listing. Cannot be used on non-drafts.", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/listings/{slug}/edit": { | |
| "get": { | |
| "tags": [ | |
| "listings" | |
| ], | |
| "summary": "Edit listing.", | |
| "description": "Edit listing.", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/listings/{slug}/flag": { | |
| "post": { | |
| "tags": [ | |
| "listings" | |
| ], | |
| "summary": "Flag a listing for inappropriate content or fraud", | |
| "description": "Flag a listing for inappropriate content or fraud", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "reason" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "reason": { | |
| "description": "Valid reasons: 'Sexuality/nudity', 'Hateful or inappropriate speech', 'Item not as described or potential fraud', 'Trademark infringement', 'Other'", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/account": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get account details", | |
| "description": "Get account details", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/conversations": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get a list of your conversations", | |
| "description": "Get a list of your conversations", | |
| "parameters": [ | |
| { | |
| "name": "search", | |
| "in": "query", | |
| "description": "Query string to search conversations by", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "unread_only", | |
| "in": "query", | |
| "description": "Show unread conversations only", | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 1 | |
| }, | |
| { | |
| "name": "per_page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 24 | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Start a conversation", | |
| "description": "Start a conversation", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "body" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "recipient_id": { | |
| "description": "The id of the user you are trying to contact", | |
| "type": "integer" | |
| }, | |
| "listing_id": { | |
| "description": "The id of the listing being discussed", | |
| "type": "integer" | |
| }, | |
| "body": { | |
| "description": "The body of the message", | |
| "type": "string" | |
| }, | |
| "cloudinary_photos": { | |
| "description": "An array of cloudinary data hashes (Reverb internal use only).", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/conversations/{conversation_id}/messages": { | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Send a message", | |
| "description": "Send a message", | |
| "parameters": [ | |
| { | |
| "name": "conversation_id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "body" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "body": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/conversations/{id}": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Display conversation details with messages in natural time order (oldest to newest)", | |
| "description": "Display conversation details with messages in natural time order (oldest to newest)", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Mark a conversation read/unread", | |
| "description": "Mark a conversation read/unread", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "read": { | |
| "description": "Should the conversation be marked as read", | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/counts": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get your actionable status counts", | |
| "description": "Get your actionable status counts", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/feed": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get listings from your feed", | |
| "description": "Get listings from your feed", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/feedback/received": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "List of received feedback", | |
| "description": "List of received feedback", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/feedback/sent": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "List of sent feedback", | |
| "description": "List of sent feedback", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/follows/brands/{slug}": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow status for a brand", | |
| "description": "Follow status for a brand", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow a brand", | |
| "description": "Follow a brand", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Unfollow a brand", | |
| "description": "Unfollow a brand", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/follows/categories/{category}/{subcategory}": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow status for a subcategory", | |
| "description": "Follow status for a subcategory", | |
| "parameters": [ | |
| { | |
| "name": "category", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "subcategory", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow a subcategory", | |
| "description": "Follow a subcategory", | |
| "parameters": [ | |
| { | |
| "name": "category", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "subcategory", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Unfollow a subcategory", | |
| "description": "Unfollow a subcategory", | |
| "parameters": [ | |
| { | |
| "name": "category", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "subcategory", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/follows/categories/{slug}": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow status for a category", | |
| "description": "Follow status for a category", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow a category", | |
| "description": "Follow a category", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Unfollow a category", | |
| "description": "Unfollow a category", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/follows/collections/{slug}": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow status for a collection", | |
| "description": "Follow status for a collection", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow a collection", | |
| "description": "Follow a collection", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Unfollow a collection", | |
| "description": "Unfollow a collection", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/follows": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "See what the user is following", | |
| "description": "See what the user is following", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/follows/handpicked/{slug}": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow status for a handpicked collection", | |
| "description": "Follow status for a handpicked collection", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow a handpicked collection", | |
| "description": "Follow a handpicked collection", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Unfollow a handpicked collection", | |
| "description": "Unfollow a handpicked collection", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/follows/search": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow status for a search", | |
| "description": "Follow status for a search", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow a search", | |
| "description": "Follow a search", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "query": { | |
| "description": "Search query.", | |
| "type": "string" | |
| }, | |
| "auction_price_max": { | |
| "description": "Maximum current auction price", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "category": { | |
| "description": "Category slug from /api/categories", | |
| "type": "string" | |
| }, | |
| "product_type": { | |
| "description": "Product type slug from /api/categories", | |
| "type": "string" | |
| }, | |
| "condition": { | |
| "description": "Condition name", | |
| "type": "string" | |
| }, | |
| "decade": { | |
| "description": "Decade: e.g. 1970s, early 70s", | |
| "type": "string" | |
| }, | |
| "finish": { | |
| "description": "Visual finish of the item, common for guitars", | |
| "type": "string" | |
| }, | |
| "handmade": { | |
| "description": "Handmade items only", | |
| "type": "boolean" | |
| }, | |
| "item_city": { | |
| "description": "City where item is located", | |
| "type": "string" | |
| }, | |
| "item_country": { | |
| "description": "Country code where item is located", | |
| "type": "string" | |
| }, | |
| "item_state": { | |
| "description": "State or region code where item is located", | |
| "type": "string" | |
| }, | |
| "make": { | |
| "description": "Make/brand of item (e.g. Fender)", | |
| "type": "string" | |
| }, | |
| "model": { | |
| "description": "Model of item (e.g. Stratocaster)", | |
| "type": "string" | |
| }, | |
| "must_not": { | |
| "description": "Search term negation. If you want to exclude a term, add it here", | |
| "type": "string" | |
| }, | |
| "price_max": { | |
| "description": "Maximum price of search results (USD)", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "price_min": { | |
| "description": "Minimum price of search results (USD)", | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "year_max": { | |
| "description": "Maximum year of manufacture", | |
| "type": "integer" | |
| }, | |
| "year_min": { | |
| "description": "Minumum year of manufacture", | |
| "type": "integer" | |
| }, | |
| "accepts_gift_cards": { | |
| "description": "If true, include only items that accept gift cards", | |
| "type": "boolean" | |
| }, | |
| "preferred_seller": { | |
| "description": "If true, include only items by Reverb Preferred Sellers", | |
| "type": "boolean" | |
| }, | |
| "listing_type": { | |
| "description": "Type of listing", | |
| "type": "string" | |
| }, | |
| "ships_to": { | |
| "description": "Limit search to items that ship to this country code", | |
| "type": "string" | |
| }, | |
| "exclude_auctions": { | |
| "description": "If true, don't return any auctions", | |
| "type": "boolean" | |
| }, | |
| "accepts_payment_plans": { | |
| "description": "If true, only show items that can be purchased with a payment plan", | |
| "type": "boolean" | |
| }, | |
| "state": { | |
| "description": "State of listing", | |
| "type": "string" | |
| }, | |
| "watchers_count_min": { | |
| "description": "Minimum number of watchers (used to find popular items)", | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/follows/shops/{slug}": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow status for a shop", | |
| "description": "Follow status for a shop", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Follow a shop", | |
| "description": "Follow a shop", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Unfollow a shop", | |
| "description": "Unfollow a shop", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/follows/{follow_id}": { | |
| "delete": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Delete a follow", | |
| "description": "Delete a follow", | |
| "parameters": [ | |
| { | |
| "name": "follow_id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/listings/drafts": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Retrieve a list your draft listings", | |
| "description": "Retrieve a list your draft listings", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/listings": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Retrieve a list of live listings for the seller. To search all listings specify state=all", | |
| "description": "Retrieve a list of live listings for the seller. To search all listings specify state=all", | |
| "parameters": [ | |
| { | |
| "name": "state", | |
| "in": "query", | |
| "description": "Available: [\"all\", \"draft\", \"ended\", \"live\", \"ordered\", \"sold_out\", \"suspended\", \"seller_unavailable\"]. Defaults to 'live'", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/listings/negotiations": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get a list of active negotiations as a seller", | |
| "description": "Get a list of active negotiations as a seller", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 1 | |
| }, | |
| { | |
| "name": "per_page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 24 | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/listings/{slug}/state/end": { | |
| "put": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "End a listing", | |
| "description": "End a listing", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "reason" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "reason": { | |
| "description": "The reason this listing is being ended. Valid reasons: [\"not_sold\", \"reverb_sale\"].", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/lists": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get a list of your lists (wishlist, watch list, etc)", | |
| "description": "Get a list of your lists (wishlist, watch list, etc)", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/negotiations/buying": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get a list of active negotiations as a buyer", | |
| "description": "Get a list of active negotiations as a buyer", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 1 | |
| }, | |
| { | |
| "name": "per_page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 24 | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/negotiations/{id}/accept": { | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Accept an offer", | |
| "description": "Accept an offer", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "message": { | |
| "description": "Message to include with accepted offer", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/negotiations/{id}/counter": { | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Counter an offer", | |
| "description": "Counter an offer", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "price" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "price": { | |
| "description": "Offer price", | |
| "type": "string" | |
| }, | |
| "shipping_price": { | |
| "description": "Shipping price (sellers only)", | |
| "type": "string" | |
| }, | |
| "message": { | |
| "description": "Message to include with counter offer", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/negotiations/{id}/decline": { | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Decline an offer", | |
| "description": "Decline an offer", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "message": { | |
| "description": "Message to include with declined offer", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/negotiations/{id}": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get offer details", | |
| "description": "Get offer details", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/awaiting_feedback": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "List of orders that need feedback", | |
| "description": "List of orders that need feedback", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/buying/all": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Returns all orders, newest first.", | |
| "description": "Returns all orders, newest first.", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/buying/unpaid": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Returns unpaid orders, newest first.", | |
| "description": "Returns unpaid orders, newest first.", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/buying/{id}": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Returns order details for a buyer", | |
| "description": "Returns order details for a buyer", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/buying/{id}/mark_received": { | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Marks an order as received by the buyer", | |
| "description": "Marks an order as received by the buyer", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/selling/all": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get all seller orders, newest first.", | |
| "description": "Get all seller orders, newest first.", | |
| "parameters": [ | |
| { | |
| "name": "created_start_date", | |
| "in": "query", | |
| "description": "Filter by date created in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "created_end_date", | |
| "in": "query", | |
| "description": "Filter by date created in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "updated_start_date", | |
| "in": "query", | |
| "description": "Filter by date modified in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "updated_end_date", | |
| "in": "query", | |
| "description": "Filter by date modified in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 1 | |
| }, | |
| { | |
| "name": "per_page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 24 | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/selling/awaiting_shipment": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get seller orders awaiting shipment, newest first.", | |
| "description": "Get seller orders awaiting shipment, newest first.", | |
| "parameters": [ | |
| { | |
| "name": "created_start_date", | |
| "in": "query", | |
| "description": "Filter by date created in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "created_end_date", | |
| "in": "query", | |
| "description": "Filter by date created in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "updated_start_date", | |
| "in": "query", | |
| "description": "Filter by date modified in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "updated_end_date", | |
| "in": "query", | |
| "description": "Filter by date modified in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 1 | |
| }, | |
| { | |
| "name": "per_page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 24 | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/selling/unpaid": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get unpaid seller orders, newest first.", | |
| "description": "Get unpaid seller orders, newest first.", | |
| "parameters": [ | |
| { | |
| "name": "created_start_date", | |
| "in": "query", | |
| "description": "Filter by date created in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "created_end_date", | |
| "in": "query", | |
| "description": "Filter by date created in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "updated_start_date", | |
| "in": "query", | |
| "description": "Filter by date modified in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "updated_end_date", | |
| "in": "query", | |
| "description": "Filter by date modified in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 1 | |
| }, | |
| { | |
| "name": "per_page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 24 | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/selling/{id}": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Returns order details for a seller", | |
| "description": "Returns order details for a seller", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/selling/{id}/mark_picked_up": { | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Marks an order as picked up", | |
| "description": "Marks an order as picked up", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "date": { | |
| "description": "Date the item was picked up.", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/orders/selling/{id}/ship": { | |
| "post": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Marks an order as shipped", | |
| "description": "Marks an order as shipped", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "provider", | |
| "tracking_number", | |
| "send_notification" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "date": { | |
| "description": "Date the item was shipped", | |
| "type": "string" | |
| }, | |
| "provider": { | |
| "description": "Shipping provider: One of UPS, USPS, FedEx, DHL, Canada Post, Other", | |
| "type": "string" | |
| }, | |
| "tracking_number": { | |
| "description": "Tracking number provided by the shipping provider", | |
| "type": "string" | |
| }, | |
| "send_notification": { | |
| "description": "Should we send an email notification to the buyer", | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/payments/selling": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get payments", | |
| "description": "Get payments", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 1 | |
| }, | |
| { | |
| "name": "per_page", | |
| "in": "query", | |
| "type": "integer", | |
| "default": 24 | |
| }, | |
| { | |
| "name": "created_start_date", | |
| "in": "query", | |
| "description": "Filter by date created in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "created_end_date", | |
| "in": "query", | |
| "description": "Filter by date created in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "updated_start_date", | |
| "in": "query", | |
| "description": "Filter by date modified in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "updated_end_date", | |
| "in": "query", | |
| "description": "Filter by date modified in ISO8601 format - e.g: 2015-04-09T10:52:23-00:00", | |
| "type": "string" | |
| }, | |
| { | |
| "name": "order_id", | |
| "in": "query", | |
| "description": "Look up payments by order id", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/viewed_listings": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get a list of your recently viewed listings.", | |
| "description": "Get a list of your recently viewed listings.", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/wishlist": { | |
| "get": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Get a list of wishlisted items", | |
| "description": "Get a list of wishlisted items", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/my/wishlist/{id}": { | |
| "put": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Add a listing to your wishlist", | |
| "description": "Add a listing to your wishlist", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "my" | |
| ], | |
| "summary": "Remove a listing from your wishlist", | |
| "description": "Remove a listing from your wishlist", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/orders/{order_id}/feedback/buyer": { | |
| "get": { | |
| "tags": [ | |
| "orders" | |
| ], | |
| "summary": "Feedback details for an order's buyer", | |
| "description": "Feedback details for an order's buyer", | |
| "parameters": [ | |
| { | |
| "name": "order_id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "orders" | |
| ], | |
| "summary": "Add feedback about an order's buyer", | |
| "description": "Add feedback about an order's buyer", | |
| "parameters": [ | |
| { | |
| "name": "order_id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "rating": { | |
| "description": "Number 1-5; Higher is better", | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/orders/{order_id}/feedback/seller": { | |
| "get": { | |
| "tags": [ | |
| "orders" | |
| ], | |
| "summary": "Feedback details for an order's seller", | |
| "description": "Feedback details for an order's seller", | |
| "parameters": [ | |
| { | |
| "name": "order_id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "orders" | |
| ], | |
| "summary": "Add feedback about an order's seller", | |
| "description": "Add feedback about an order's seller", | |
| "parameters": [ | |
| { | |
| "name": "order_id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "rating": { | |
| "description": "Number 1-5; Higher is better", | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/priceguide": { | |
| "get": { | |
| "tags": [ | |
| "priceguide" | |
| ], | |
| "summary": "Search the Price Guide", | |
| "description": "Search the Price Guide", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "in": "query", | |
| "description": "Search query.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shipping/providers": { | |
| "get": { | |
| "tags": [ | |
| "shipping" | |
| ], | |
| "summary": "List of supported shipping providers", | |
| "description": "List of supported shipping providers", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shipping/regions": { | |
| "get": { | |
| "tags": [ | |
| "shipping" | |
| ], | |
| "summary": "Get a list of shipping regions", | |
| "description": "Get a list of shipping regions", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shop/billing/card/braintree": { | |
| "post": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Create a credit card to be used for billing", | |
| "description": "Create a credit card to be used for billing", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "braintree_payment_method_nonce" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "braintree_payment_method_nonce": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shop": { | |
| "get": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Get your own shop details", | |
| "description": "Get your own shop details", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Update your shop profile", | |
| "description": "Update your shop profile", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "payment_policy": { | |
| "type": "string" | |
| }, | |
| "return_policy": { | |
| "type": "string" | |
| }, | |
| "shipping_policy": { | |
| "type": "string" | |
| }, | |
| "website": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "type": "object", | |
| "properties": { | |
| "street_address": { | |
| "type": "string" | |
| }, | |
| "extended_address": { | |
| "type": "string" | |
| }, | |
| "locality": { | |
| "type": "string" | |
| }, | |
| "region": { | |
| "type": "string" | |
| }, | |
| "postal_code": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shop/payment_methods/direct_checkout": { | |
| "get": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Get direct checkout settings", | |
| "description": "Get direct checkout settings", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Add direct checkout account", | |
| "description": "Add direct checkout account", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "name_on_account", | |
| "bank_account_number", | |
| "routing_number", | |
| "bank_account_type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "name_on_account": { | |
| "type": "string" | |
| }, | |
| "bank_account_number": { | |
| "type": "string" | |
| }, | |
| "routing_number": { | |
| "type": "string" | |
| }, | |
| "bank_account_type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Disable direct checkout as an accepted payment method", | |
| "description": "Disable direct checkout as an accepted payment method", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shop/payment_methods": { | |
| "get": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Get accepted payment methods", | |
| "description": "Get accepted payment methods", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shop/payment_methods/paypal": { | |
| "get": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Get your paypal profile", | |
| "description": "Get your paypal profile", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Add paypal account", | |
| "description": "Add paypal account", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "email", | |
| "first_name", | |
| "last_name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "first_name": { | |
| "type": "string" | |
| }, | |
| "last_name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Disable paypal as an accepted payment method", | |
| "description": "Disable paypal as an accepted payment method", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shop/vacation": { | |
| "get": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Returns shop vacation status", | |
| "description": "Returns shop vacation status", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Enable vacation mode. All listings will be unavailable until vacation mode is turned off.", | |
| "description": "Enable vacation mode. All listings will be unavailable until vacation mode is turned off.", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "shop" | |
| ], | |
| "summary": "Disable vacation mode. All listings will be re-enabled.", | |
| "description": "Disable vacation mode. All listings will be re-enabled.", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shops/{slug}/feedback/buyer": { | |
| "get": { | |
| "tags": [ | |
| "shops" | |
| ], | |
| "summary": "Get seller's feedback as a buyer", | |
| "description": "Get seller's feedback as a buyer", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shops/{slug}/feedback": { | |
| "get": { | |
| "tags": [ | |
| "shops" | |
| ], | |
| "summary": "Get seller's feedback", | |
| "description": "Get seller's feedback", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shops/{slug}/feedback/seller": { | |
| "get": { | |
| "tags": [ | |
| "shops" | |
| ], | |
| "summary": "Get seller's feedback as a seller", | |
| "description": "Get seller's feedback as a seller", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/shops/{slug}": { | |
| "get": { | |
| "tags": [ | |
| "shops" | |
| ], | |
| "summary": "Get details on a shop.", | |
| "description": "Get details on a shop.", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/wants": { | |
| "get": { | |
| "tags": [ | |
| "wants" | |
| ], | |
| "summary": "A list of wanted items by the user", | |
| "description": "A list of wanted items by the user", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/wants/{id}": { | |
| "put": { | |
| "tags": [ | |
| "wants" | |
| ], | |
| "summary": "Mark an item wanted. Returns 204 on success or 412 on failure.", | |
| "description": "Mark an item wanted. Returns 204 on success or 412 on failure.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "wants" | |
| ], | |
| "summary": "Unmark an item wanted. Returns 204.", | |
| "description": "Unmark an item wanted. Returns 204.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/webhooks/registrations": { | |
| "get": { | |
| "tags": [ | |
| "webhooks" | |
| ], | |
| "summary": "Get webhook registrations", | |
| "description": "Get webhook registrations", | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "webhooks" | |
| ], | |
| "summary": "Register a webhook", | |
| "description": "Register a webhook", | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "body", | |
| "description": "the content of the request", | |
| "schema": { | |
| "required": [ | |
| "url", | |
| "topic" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| }, | |
| "topic": { | |
| "description": "Valid values: listings/update, orders/create", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| }, | |
| "/webhooks/registrations/{id}": { | |
| "get": { | |
| "tags": [ | |
| "webhooks" | |
| ], | |
| "summary": "Get details of a webhook registration", | |
| "description": "Get details of a webhook registration", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "webhooks" | |
| ], | |
| "summary": "Remove a webhook", | |
| "description": "Remove a webhook", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "Unexpected error" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment