Pricing Inspiration

Get pricing inspiration when given product listing details

This endpoint returns a price prediction range and a list of similar sold items for a product listing. The price prediction is the core of the response. The list of similar sold items is supplementary and best-effort: if the similar sold items lookup is unavailable (for example, a timeout), the endpoint still returns the price prediction with an empty similar_sold_items array rather than failing. Clients should therefore not rely on similar_sold_items always being populated. This endpoint does not require OAuth Scopes and is only valid for specific countries (US and GB).

post/api/v1/pricing/inspiration/

Request

Request body

descriptionstring required

A detailed description of the product. The more detail the better the prediction

countrystring required

The country the product is listed in.

currencystring required

The currency code for the listing.

product_typestring required

The type of product. Find out more in the taxonomy section of the API docs.

departmentstring required

The product department. Find out more in the taxonomy section of the API docs.

conditionstring required

The condition of the product. Find out more in the taxonomy section of the API docs.

brand_namestring required

The canonical brand name of the product.

size_set_idinteger

The size set ID for the given Department and Product Type.

size_idinteger

The size identifier.

colourstring[]

List of colours for the product.

stylestring[]

List of styles for the product.

sourcestring[]

Example request

{
  "description": "A sporty nike t-shirt with abstract patterns",
  "country": "GB",
  "currency": "GBP",
  "product_type": "t-shirts",
  "department": "menswear",
  "condition": "used_like_new",
  "brand_name": "Nike",
  "size_set_id": 52,
  "size_id": 4,
  "colour": [
    "black",
    "white"
  ],
  "style": [
    "casual",
    "sportswear"
  ],
  "source": [
    "vintage"
  ]
}

Response

OK

Example response

{
  "price_prediction": {
    "balanced": "19.00",
    "prediction": "19.00",
    "upper_bound": "22.00",
    "lower_bound": "17.00"
  },
  "similar_sold_items": [
    {
      "brand_name": "Nike",
      "condition": "used_excellent",
      "picture": {
        "height": 1280,
        "url": "https://media-photos-staging.depop.com/b0/18220/5612584_b6795bc34778465293e45647518906d6/P0.jpg",
        "width": 1280
      },
      "sold_price_amount": "50.00",
      "sold_price_currency": "GBP"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.