Search web-shop orders
Returns one page of web-shop orders 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.OrderInternet.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/documents/orders/internet/filter-paginated' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{}'{ "currentPage": 0, "data": [ { "address1": "string", "alreadyPaidAmount": 0, "branchId": 0, "branchName": "string", "city": "string", "contactAddressEmail": "string", "contactAddressPhone": "string", "contactUserInOurCompany": "string", "createdAt": "2019-08-24T14:15:22Z", "currency": "str", "customDocumentStateColor": 0, "customDocumentStateName": "string", "customerCode": "string", "customerId": 0, "customerName": "string", "dateOfOrder": "2019-08-24T14:15:22Z", "deliveryAddressId": 0, "deliveryDate": "2019-08-24T14:15:22Z", "deliveryTime": "2019-08-24T14:15:22Z", "documentState": 0, "eshopSourceId": 0, "foreignExchangeRate": 0, "formNumber": "string", "id": 0, "internalNumber": 0, "isCancellation": true, "isConfirmed": true, "isCovered": true, "isExported": true, "isImported": true, "isNotificationEnabled": true, "isPaid": true, "isPrinted": true, "isProcessed": true, "note": "string", "note2": "string", "note3": "string", "note4": "string", "paidOnDate": "2019-08-24T14:15:22Z", "paymentType": "string", "paymentTypeId": 0, "quantityBeingCoveredPercentage": 0, "quantityCoveredPercentage": 0, "remoteSaleCurrency": "str", "remoteSaleExchangeRate": 0, "remoteSaleTotalPrice": 0, "routeName": "string", "sectorId": 0, "timeOfOrder": "2019-08-24T14:15:22Z", "totalForeignPrice": 0, "totalNumberOfItems": 0, "totalNumberOfPieces": 0, "totalPrice": 0, "totalPriceWoVat": 0, "transportPrice": 0, "transportType": "string", "transportTypeId": 0, "userId": 0, "warehouseID": 0, "warehouseName": "string", "warehouseNumber": "string" } ], "hasNextPage": true, "hasPreviousPage": true, "pageSize": 0, "totalCount": 0, "totalPages": 0}Create a web-shop order POST
Creates a web-shop order 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.OrderInternet.Create`.
Get a web-shop order GET
Returns one web-shop order by `documentId`, with its header, items and item variants. Requires `Permissions.OrderInternet.View`.