Search products in the price list
Returns one page of price-list rows matching the filter — the catalogue view of products with their selling prices. Body is a `PaginationRequest` — see the *Filtering & pagination* concept in the developer docs. Sortable and limitable fields depend on the instance's data-grid view. Requires `Permissions.PriceList.View`.
BearerAuthorizationBearer <token>OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.
application/json- body
filter?Endpoint-specific filter. Every field is optional; the ones you set are combined with AND.
limitFields?array<string>|Names of the fields to return; omit it for all of them. Which fields exist depends on the instance's data-grid view.
orderBy?array<string>|Sort order, one entry per level, each written as Field or Field desc. Which fields can be sorted on depends on the instance's data-grid view.
pageNumber?integer1-based page to return. 0 and 1 both mean the first page.
int32pageSize?integerRows per page. Defaults to every matching row, and -1 asks for every row explicitly.
int32application/json- response
currentPage?integer1-based number of the page in this response.
int32data?array<>The rows of this page, shaped by the request's limitFields.
hasNextPage?booleanTrue when a page follows this one.
hasPreviousPage?booleanTrue when a page precedes this one.
pageSize?integerRows per page actually applied, which is 10 when the request asked for a non-positive size.
int32totalCount?integerNumber of rows matching the filter across every page.
int32totalPages?integerNumber of pages the whole result set spans at this page size.
int32curl -X POST 'https://<your-instance>/api/products/filter-paginated' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{}'{ "currentPage": 0, "data": [ { "allStoresTotal": 0, "barcode": "string", "baseVatRateId": 0, "createdAt": "2019-08-24T14:15:22Z", "groupCode": "string", "groupId": 0, "groupName": "string", "isColorAndSize": true, "isInactive": true, "isService": true, "isbn": "string", "lastModify": "2019-08-24T14:15:22Z", "manufacturersBrandName": "string", "margin1": 0, "margin10": 0, "margin11": 0, "margin12": 0, "margin13": 0, "margin14": 0, "margin15": 0, "margin2": 0, "margin3": 0, "margin4": 0, "margin5": 0, "margin6": 0, "margin7": 0, "margin8": 0, "margin9": 0, "modelName": "string", "photoUrl": "string", "plu": 0, "price1": 0, "price10": 0, "price10WoVat": 0, "price11": 0, "price11WoVat": 0, "price12": 0, "price12WoVat": 0, "price13": 0, "price13WoVat": 0, "price14": 0, "price14WoVat": 0, "price15": 0, "price15WoVat": 0, "price1WoVat": 0, "price2": 0, "price2WoVat": 0, "price3": 0, "price3WoVat": 0, "price4": 0, "price4WoVat": 0, "price5": 0, "price5WoVat": 0, "price6": 0, "price6WoVat": 0, "price7": 0, "price7WoVat": 0, "price8": 0, "price8WoVat": 0, "price9": 0, "price9WoVat": 0, "productCode": "string", "productId": 0, "productName": "string", "purchasePrice": 0, "sapMaterialNumber": "string", "seasonCode": "string", "seasonId": 0, "seasonName": "string", "stockPrice": 0, "subGroupCode": "string", "subGroupId": 0, "subGroupName": "string", "supplierCode": "string", "supplierId": 0, "supplierName": "string", "supplierProductCode": "string", "supplierPromoForeignPurchaseCurrency": "string", "supplierPromoForeignPurchasePrice": 0, "supplierPromoFromDate": "2019-08-24T14:15:22Z", "supplierPromoPurchasePrice": 0, "supplierPromoToDate": "2019-08-24T14:15:22Z", "supplierPurchaseCurrency": "string", "supplierPurchaseUnitName": "string", "themeCode": "string", "themeId": 0, "themeName": "string", "unitId": 0, "unitName": "string", "userFullName": "string", "vatRate": 0 } ], "hasNextPage": true, "hasPreviousPage": true, "pageSize": 0, "totalCount": 0, "totalPages": 0}