Home > @vsf-enterprise/epcc-api > GetProductsParams
# GetProductsParams interface
Parameters to get products.
Signature:
export interface GetProductsParams
# Properties
Property | Type | Description |
---|---|---|
filter? | CatalogFilter | (Optional) Filtering operators |
limit? | number | (Optional) The maximum number of records per page for this response. You can set this value up to 100. |
locale? | string | (Optional) Locale for product data localization. |
offset? | number | (Optional) The current offset by number of records, not pages. Offset is zero-based. |
sort? | string | (Optional) Sort results that are returned from the API. |
withInventory? | boolean | (Optional) Flag for requesting stock data too. |