v1

latestOpenAPI 3.0.32026-07-13180201815.5 KB
Products

Retrieve a Product List from a query.

Endpoint example:

https://api.jumpseller.com/v1/products/search.json?query=test&fields=name,description 
get/products/search.json

Query parameters

localestring string

Locale code of the translation

querystring string required

Text to query for the Product

fields'sku' | 'barcode' | 'brand' | 'name' | 'description' | 'variants' | 'option_name' | 'custom_fields' | 'custom_fields_selects' string

Comma separated values of the fields to query for the Product

status'available' | 'not-available' | 'disabled' | 'featured' string

Product Status to query for the Product

categoriesstring string

Comma separated values of the Category IDs to query for the Product

Response

An array of products