Update a internal transfer
Updates the internal transfer header and the items sent in the body. Pass `removeItemsNotInRequest=true` to also delete the items the body leaves out. Requires `Permissions.InternalTransfer.Update`.
BearerAuthorizationBearer <token>OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.
documentId*integerint32removeItemsNotInRequest?boolean|nullapplication/json- body
id?|Row id of the document. Read-only; the server assigns it.
int32internalNumber?|Internal document number, unique within the document type and reserved when the document is created. Read-only.
int32items?array<>|The document's items. Null when the document was loaded without them.
cancellationInternalNumber?|int32createdAt?|date-timecustomerId?|int32dateOfAccountingPosting?|date-timedateOfCreation?|date-timedateOfProcessing?|date-timedateOfTransfer?|date-timedeliveryDate?|date-timedocumentStateId?|int32documentStateUserId?|int32formNumber?|length <= 150guid?|guidisCancellation?boolean|nullisConfirmed?boolean|nullisExported?boolean|nullisImported?boolean|nullisLocked?boolean|nullisPartialCancellation?boolean|nullisPrinted?boolean|nullisPrinter?boolean|nullisProcessed?boolean|nulllastModify?|date-timelockOwner?|length <= 80note?string|nullnote2?string|nullnumberOfPackages?|int32orderInternalNumber?|int32orderText?|length <= 50packageNumbers?string|nullpalletNumber?|int32partialCancellationInternalNumber?|int32processedByUserId?|int32routeId?|int32totalDiscount?|decimaltotalNumberOfItems?|int32totalNumberOfPieces?|decimaltotalPrice?|decimaltotalPriceWoVat?|decimaltotalStockPriceWoVat?|decimaltransportDriverId?|int32transportTypeId?|int32userId?|int32warehouseFromId?|int32warehouseToId?|int32application/json- response
id?|Row id of the document. Read-only; the server assigns it.
int32internalNumber?|Internal document number, unique within the document type and reserved when the document is created. Read-only.
int32items?array<>|The document's items. Null when the document was loaded without them.
cancellationInternalNumber?|int32createdAt?|date-timecustomerId?|int32dateOfAccountingPosting?|date-timedateOfCreation?|date-timedateOfProcessing?|date-timedateOfTransfer?|date-timedeliveryDate?|date-timedocumentStateId?|int32documentStateUserId?|int32formNumber?|length <= 150guid?|guidisCancellation?boolean|nullisConfirmed?boolean|nullisExported?boolean|nullisImported?boolean|nullisLocked?boolean|nullisPartialCancellation?boolean|nullisPrinted?boolean|nullisPrinter?boolean|nullisProcessed?boolean|nulllastModify?|date-timelockOwner?|length <= 80note?string|nullnote2?string|nullnumberOfPackages?|int32orderInternalNumber?|int32orderText?|length <= 50packageNumbers?string|nullpalletNumber?|int32partialCancellationInternalNumber?|int32processedByUserId?|int32routeId?|int32totalDiscount?|decimaltotalNumberOfItems?|int32totalNumberOfPieces?|decimaltotalPrice?|decimaltotalPriceWoVat?|decimaltotalStockPriceWoVat?|decimaltransportDriverId?|int32transportTypeId?|int32userId?|int32warehouseFromId?|int32warehouseToId?|int32curl -X PUT 'https://<your-instance>/api/documents/internal-transfers/0' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{ "items": [ { "price": 605, "priceWoVat": 500, "productId": 5, "quantityIssued": 10, "unitIdIssued": 1, "vatRate": 21 }, { "priceWoVatIssued": 800, "productId": 5, "quantityIssued": 99, "unitIdIssued": 5, "vatRate": 21 }, { "price": 2418.79, "priceWoVat": 1999, "productId": 4, "variants": [ { "colorId": 1, "dimensionId": 0, "lengthId": 0, "quantity": 1, "sizeId": 2 }, { "colorId": 2, "dimensionId": 0, "lengthId": 0, "quantity": 2, "sizeId": 3 } ], "vatRate": 21 } ], "note": "Restock of branch warehouse", "warehouseFromId": 2, "warehouseToId": 3}'{ "id": 0, "internalNumber": 0, "items": [ { "id": 0, "internalNumber": 0, "item": 0, "productId": 0, "variants": [ { "colorId": 0, "dimensionId": 0, "id": 0, "itemId": 0, "lengthId": 0, "quantity": 0, "sizeId": 0, "orderItemVariantId": 0, "price": 0, "priceWoVat": 0 } ], "barcode": "string", "batchId": 0, "batchTextRawMaterial": "string", "createdAt": "2019-08-24T14:15:22Z", "damageTypeId": 0, "guid": "string", "isExported": true, "lastModify": "2019-08-24T14:15:22Z", "locationId": 0, "note": "string", "numberOfPackages": 0, "orderInternalNumber": 0, "orderItemId": 0, "originWarehouseStockPrice": 0, "packagePrice": 0, "price": 0, "priceWoVat": 0, "priceWoVatIssued": 0, "quantity": 0, "quantityCoefficient": 0, "quantityIssued": 0, "recyclingFee": 0, "recyclingFeeId": 0, "referencePrice": 0, "royalty": 0, "royaltyId": 0, "setPrice": 0, "ssccId": 0, "stockPrice": 0, "unitId": 0, "unitIdIssued": 0, "userId": 0, "variantId": 0, "vatRate": 0, "warehouseDestination": "str", "warehouseOrigin": "str", "weight": 0 } ], "cancellationInternalNumber": 0, "createdAt": "2019-08-24T14:15:22Z", "customerId": 0, "dateOfAccountingPosting": "2019-08-24T14:15:22Z", "dateOfCreation": "2019-08-24T14:15:22Z", "dateOfProcessing": "2019-08-24T14:15:22Z", "dateOfTransfer": "2019-08-24T14:15:22Z", "deliveryDate": "2019-08-24T14:15:22Z", "documentStateId": 0, "documentStateUserId": 0, "formNumber": "string", "guid": "string", "isCancellation": true, "isConfirmed": true, "isExported": true, "isImported": true, "isLocked": true, "isPartialCancellation": true, "isPrinted": true, "isPrinter": true, "isProcessed": true, "lastModify": "2019-08-24T14:15:22Z", "lockOwner": "string", "note": "string", "note2": "string", "numberOfPackages": 0, "orderInternalNumber": 0, "orderText": "string", "packageNumbers": "string", "palletNumber": 0, "partialCancellationInternalNumber": 0, "processedByUserId": 0, "routeId": 0, "totalDiscount": 0, "totalNumberOfItems": 0, "totalNumberOfPieces": 0, "totalPrice": 0, "totalPriceWoVat": 0, "totalStockPriceWoVat": 0, "transportDriverId": 0, "transportTypeId": 0, "userId": 0, "warehouseFromId": 0, "warehouseToId": 0}Delete a internal transfer DELETE
Deletes the internal transfer together with its items and item variants. Cannot be undone. Call `GET {documentId}/check-delete` first to find out whether the delete is allowed. Requires `Permissions.InternalTransfer.Delete`.
Check whether a internal transfer can be deleted GET
Advisory pre-flight for `DELETE {documentId}`. `canBeDeleted` is false when `blockingReasons` holds `HEADER_BLOCKED` or `ITEMS_BLOCKED`. The delete re-checks inside its own transaction, so a positive answer here is an indication rather than a guarantee. Requires `Permissions.InternalTransfer.Delete`.