Get a smart listing

GET

api

{team_slug}

{app_slug}

smart-listings

{listing_id}

Error

A valid request URL is required to generate request examples

{
  "data": {
    "created_at": "<string>",
    "id": "<string>",
    "rules": [
      {
        "operator": "less-than",
        "target": "stock",
        "id": "<string>",
        "target_id": "<string>",
        "value_float": 123,
        "value_list": [
          "<string>"
        ],
        "value_string": "<string>"
      }
    ],
    "slug": "<string>",
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Authorizations

Authorization

string

header

required

Management API token, sent as Authorization: Bearer <token>.

Path Parameters

app_slug

string

required

App slug

team_slug

string

required

Team slug

listing_id

string

required

id for the smart-listing to fetch

Response

smart-listing returned successfully

data

object

Show child attributes

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

Error

A valid request URL is required to generate request examples

{
  "data": {
    "created_at": "<string>",
    "id": "<string>",
    "rules": [
      {
        "operator": "less-than",
        "target": "stock",
        "id": "<string>",
        "target_id": "<string>",
        "value_float": 123,
        "value_list": [
          "<string>"
        ],
        "value_string": "<string>"
      }
    ],
    "slug": "<string>",
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Management API

Shopper API

Customers API

Digital Assets Management API

Authorizations

Path Parameters

Response