Skip to main content
POST
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
smart-listings
/
preview
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "app_id": "<string>",
      "attributes": [
        {
          "template_id": "<string>",
          "template_name": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "category_slugs": [
        "<string>"
      ],
      "custom_fields": {},
      "id": "<string>",
      "image_urls": [
        "<string>"
      ],
      "prices": [
        {
          "amount": 123,
          "currency": "<string>",
          "on_sale": true
        }
      ],
      "product_id": "<string>",
      "product_name": "<string>",
      "total_stock": 123,
      "variant_name": "<string>",
      "variant_number": "<string>",
      "warehouse_stocks": [
        {
          "stock": 123,
          "warehouse_id": "<string>"
        }
      ]
    }
  ],
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Body

application/json

smart-listing configuration

​
rules
object[]
required
​
slug
string
required

Response

All product-variants affected by the listing rules

​
data
object[]
​
details
string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

​
success
boolean