WinShopAPI docs
ReferenceDocumentsClaimsCustomer

Search customer claims

Returns one page of customer claims matching the filter. 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.ClaimCustomer.View`.

POST
/api/documents/claims/customer/filter-paginated

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Request Body

application/json
  1. 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?integer

1-based page to return. 0 and 1 both mean the first page.

Formatint32
pageSize?integer

Rows per page. Defaults to every matching row, and -1 asks for every row explicitly.

Formatint32

Response Body

application/json
  1. response
currentPage?integer

1-based number of the page in this response.

Formatint32
data?array<>

The rows of this page, shaped by the request's limitFields.

hasNextPage?boolean

True when a page follows this one.

hasPreviousPage?boolean

True when a page precedes this one.

pageSize?integer

Rows per page actually applied, which is 10 when the request asked for a non-positive size.

Formatint32
totalCount?integer

Number of rows matching the filter across every page.

Formatint32
totalPages?integer

Number of pages the whole result set spans at this page size.

Formatint32
curl -X POST 'https://<your-instance>/api/documents/claims/customer/filter-paginated' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{}'
{  "currentPage": 0,  "data": [    {      "address": "string",      "address1": "string",      "branchCity": "string",      "branchId": 0,      "branchName": "string",      "branchNumber": "string",      "city": "string",      "claimState": "string",      "contactUserInOurCompany": "string",      "currency": "str",      "customerCode": "string",      "customerId": 0,      "customerName": "string",      "dateOfClaim": "2019-08-24T14:15:22Z",      "dateOfProcessing": "2019-08-24T14:15:22Z",      "deliveryDate": "2019-08-24T14:15:22Z",      "documentStateId": 0,      "foreignExchangeRate": 0,      "formNumber": "string",      "frameworkOrder": "string",      "id": 0,      "internalNumber": 0,      "isCancellation": true,      "isConfirmed": true,      "isPrinted": true,      "isProcessed": true,      "lastUpdateDate": "2019-08-24T14:15:22Z",      "lock": true,      "name": "string",      "note": "string",      "phoneNumber": "string",      "productCode": "string",      "productName": "string",      "receivingWarehouseId": 0,      "receivingWarehouseName": "string",      "receivingWarehouseNumber": "string",      "solutionMethod": "string",      "supplierName": "string",      "timeOfClaim": "2019-08-24T14:15:22Z",      "totalNumberOfItems": 0,      "totalNumberOfPieces": 0,      "totalPrice": 0,      "totalPriceWoVat": 0,      "totalStockPriceWoVat": 0,      "userId": 0,      "warehouseId": 0,      "warehouseName": "string",      "warehouseNumber": "string"    }  ],  "hasNextPage": true,  "hasPreviousPage": true,  "pageSize": 0,  "totalCount": 0,  "totalPages": 0}

Create a customer claim POST

Creates a customer claim from the header and any items in the body, and returns the stored document (201, `Location` header set). Reserves the next internal document number. Requires `Permissions.ClaimCustomer.Create`.

Get a customer claim GET

Returns one customer claim by `documentId`, with its header, items and item variants. Requires `Permissions.ClaimCustomer.View`.