WHwhatnot
Merchandising

Get a product's merchandising

Get how and where a product is currently being sold: its sale format, whether it is reserved for live, and whether it is assigned to any upcoming or live show. A buy-it-now product that is not reserved for live is listed for sale on the seller's profile shop. List the assigned shows at GET /merchandising/products/{product_id}/shows. Requires read:merchandising.

get/merchandising/products/{product_id}

Request

  • Base URL
    https://api.whatnot.com/seller-api/rest/v2
  • URL
    https://api.whatnot.com/seller-api/rest/v2/merchandising/products/{product_id}
  • Auth
    OAuth 2
    Authorization code: https://api.whatnot.com/seller-api/rest/oauth/authorize
    Token URL: https://api.whatnot.com/seller-api/rest/oauth/token

Path parameters

product_idstring required

The product's ID.

Response

Successful Response

transaction_type'buy_it_now' | 'auction' | 'giveaway' required

The public, user-facing transaction type values.

reserved_for_liveboolean required

Whether the product is sold only in live shows. Auctions are always reserved for live. A buy-it-now product that is not reserved for live is listed for sale on the seller's profile shop.

active_in_showsboolean required

Whether the product is assigned to at least one upcoming or live show. List the shows at GET /merchandising/products/{product_id}/shows.

Example response

{
  "active_in_shows": true,
  "reserved_for_live": false,
  "transaction_type": "buy_it_now"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.