WHwhatnot
Merchandising

Update a product's merchandising

Set a product's sale format, the shows it appears in, and whether it is reserved for live, in one call. Omitted fields are left unchanged. A buy-it-now product that is not reserved for live is listed on the seller's profile shop. A draft product is published by the first call that sets the sale format, sets reserve_for_live, or adds it to shows. Publishing needs every variant priced, inventory, a description, an image, a value for each required category attribute and, in markets that require them, a dimension profile with dimensions. Anything missing is returned together in errors. Requires write:merchandising.

post/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.

Request body

transaction_type'buy_it_now' | 'auction'

The sale formats a merchandising call can set.

reserve_for_liveboolean nullable

Whether the product is held for live shows only. Auctions are always reserved for live, so this is rejected as false when transaction_type is auction in the same request, and ignored for a product that is already an auction. A buy-it-now product is purchasable on the seller's profile shop only when this is not true. When omitted, the product's current choice is kept. A draft buy-it-now product with no choice yet is treated as false when transaction_type is set, which publishes it to the profile shop. Switching to auction records the product as reserved for live, so switching back to buy-it-now keeps it off the profile shop until this is sent as false.

Example request

{
  "reserve_for_live": false,
  "shows": {
    "show_ids": [
      "0b6f3c1e-8a52-4d2e-9f7a-3c5d1e2f4a6b"
    ],
    "strategy": "ADD"
  },
  "transaction_type": "buy_it_now"
}

Response

Successful Response

product_idstring required

The product that was merchandised.

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.

Example response

{
  "product_id": "12345",
  "reserved_for_live": false,
  "transaction_type": "buy_it_now"
}

Changes

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