Market Data

Shop Details

Retrieve detailed information about a retailer/shop by ID, or search for shops by name.

post/shop_details

Request

  • Base URL: https://external-api.wine-labs.com
  • URL: https://external-api.wine-labs.com/shop_details
  • Auth: none declared

Request body

user_idstring uuid required

Authorized user identifier used for authentication and rate limiting.

retailer_idnumber

The retailer ID to look up. Required when not using search mode.

querystring

Search query for shop names (minimum 3 characters). When provided, activates search mode.

limitnumber

Maximum results returned in search mode.

offsetnumber

Pagination offset for search mode.

Response

Response highlights:

  • retailer_id: unique retailer identifier.
  • shop_type: type of shop (merchant, grocery, wine_shop).
  • shop_name: name of the shop/retailer.
  • shop_country: country where the shop is located.
  • shop_state: state/region where the shop is located.
  • offers_count: number of wine offers available from this retailer.
  • shop_price_rating: price competitiveness rating (higher = better prices).
  • shop_diversity_rating: inventory diversity rating (higher = more diverse selection).
  • In search mode: returns results[] array of shop details.

Notes:

  • Either retailer_id or query must be provided.
object required

Changes

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