List products

List summaries of the producer's products. Archived products are left out unless archivedOnly is true, and unapproved products unless unapproved is true. Set count to page the results.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

Filter list by wine list id

date-time

List products if any products have been modified since the provided timestamp. Otherwise, return an empty list.

string
Defaults to false

Include unapproved products

string
Defaults to false

Include multi pack products which have no content

string
Defaults to false

Return archived products only if true. Otherwise, return non-archived products only

string
Defaults to false

Return products require membership only

string
Defaults to false

Return products require local delivery or pickup only

string

Case and diacritic in-sensitive search for id, name and sku of the products

string

Filter list by product taxonomy id. Check the taxonomies included in the response

string

Filter list by vintage. Check the vintages included in the response

string

Filter list by varietal id. Check the varietal included in the response

string

Filter list by brand id

string

Include inventory.shipperAmounts in the response (multi-location inventory must be enabled)

string

Sort list by the field

string

Sort direction

string
Defaults to 1

Page number for paginated results

string
Defaults to 0

Number of results per page. Set to 0 for a non-paginated list

string
Defaults to true

When false, include canDelete/canArchive checks (expensive). Default is true to skip these checks.

string
Defaults to true

Include product groups and multipacks containing product groups

string

Filter by one or more product statuses. Sending an empty array returns the default result set

Responses

401

Authentication failed

403

Insufficient permission

404

Not Found

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json