Products
List or search products in a store
get/api/v1/products
Request
- Base URL: https://api.firework.com
- URL: https://api.firework.com/api/v1/products
- Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: products:read)
Query parameters
business_store_idstring required
business store ID
searchstring
Full-text search term (omit to list all)
brandstring
Filter to products with this brand (case-insensitive exact match); omit to not filter by brand
afterstring
Opaque cursor for the next page (from pagination.cursor or links.next); ascending order.
beforestring
Opaque cursor for the previous page; descending order.
page_sizeinteger
Page size (default 10, max 100)
Response
Paginated products
Changes
No recorded changes to this operation across all 1 revision of this API.