Skip to main content
POST
List shopping products with merchant URLs

Headers

x-project-id
string
required

Project ID to specify the project context

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 200
page
integer
default:1
Required range: x >= 1

Body

application/json
entityIds
string[]

Filter by brand entity IDs.

Example:
productIds
string[]

Filter by product IDs.

Example:

Search by raw product name (partial match, case-insensitive).

Example:

"iPhone"

externalId
string

Filter by exact external ID.

Example:

"product-123-abc"

mappingStatus
enum<string>[]

Filter by product-mapping status. "unknown" = a brand is assigned but no specific product; "not_matched" = neither a brand nor a product. Omit to return all items.

Available options:
unknown,
not_matched
Example:

Response

page
object
required
results
object[]