Search intakes
Returns one page of intakes 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.Intake.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/intakes/filter-paginated' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{}'{ "currentPage": 0, "data": [ { "branchId": 0, "cancellationInternalNumber": 0, "colorInteger": 0, "containsProductsOutsideLimit": true, "currency": "str", "dateOfCreation": "2019-08-24T14:15:22Z", "documentStateId": 0, "documentStatus": 0, "driver": "string", "formNumber": "string", "id": 0, "importation": "string", "intendedForCustomerBranchName": "string", "intendedForCustomerName": "string", "intendedForWarehouseCode": "string", "intendedForWarehouseName": "string", "internalNumber": 0, "intrastatCountryOfOriginId": 0, "intrastatIntakeDate": "2019-08-24T14:15:22Z", "intrastatMovementCodeId": 0, "intrastatSenderCountryId": 0, "intrastatTermsOfDeliveryId": 0, "intrastatTransactionId": 0, "intrastatTransportTypeId": 0, "invoice": "string", "isApproved": true, "isCancellation": true, "isCommission": true, "isConfirmed": true, "isInternal": true, "isPairedWithOrderSupplier": true, "isPartialCancellation": true, "isPrinted": true, "isProcessed": true, "isRepricingPrepared": true, "lock": true, "note": "string", "orderSupplierInternalNumber": 0, "partialCancellationInternalNumber": 0, "paymentType": "string", "paymentTypeId": 0, "processedAt": "2019-08-24T14:15:22Z", "processedByUserFullName": "string", "seasonId": 0, "supplierCode": "string", "supplierId": 0, "supplierInvoiceId": 0, "supplierInvoiceInternalNumber": 0, "supplierName": "string", "totalCosts": 0, "totalForeignPrice": 0, "totalMargin": 0, "totalNumberOfItems": 0, "totalNumberOfPieces": 0, "totalPrice": 0, "totalPurchasePrice": 0, "totalPurchasePriceWoVat": 0, "transportType": "string", "transportTypeId": 0, "userFullName": "string", "userId": 0, "userStatus": "string", "userStatusCannotBeProcessed": true, "warehouseName": "string", "warehouseNumber": "string" } ], "hasNextPage": true, "hasPreviousPage": true, "pageSize": 0, "totalCount": 0, "totalPages": 0}Create a intake POST
Creates a intake 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.Intake.Create`.
Get a intake GET
Returns one intake by `documentId`, with its header, items and item variants. Requires `Permissions.Intake.View`.