Update a delivery note
Updates the delivery note header and the items sent in the body. Pass `removeItemsNotInRequest=true` to also delete the items the body leaves out. Requires `Permissions.DeliveryNotes.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.
branchId?|int32cancellationInternalNumber?|int32createdAt?|date-timecustomerId?|int32dateOfAccountingPosting?|date-timedateOfOrder?|date-timedateOfProcessing?|date-timedateOfTransfer?|date-timedeliveryDate?|date-timedocumentStateId?|int32formNumber?|length <= 150guid?|guidisCancellation?boolean|nullisConfirmed?boolean|nullisExported?boolean|nullisImported?boolean|nullisLocked?boolean|nullisPartialCancellation?boolean|nullisPrinted?boolean|nullisProcessed?boolean|nulllastModify?|date-timelockOwner?|length <= 80note?string|nullorderInternalNumber?|int32orderText?|length <= 50partialCancellationInternalNumber?|int32processedByUserId?|int32reasonForIssuanceOfGoodsId?|int32routeId?|int32totalDiscount?|decimaltotalNumberOfItems?|int32totalNumberOfPieces?|decimaltotalPrice?|decimaltotalPriceWoVat?|decimaltotalStockPrice?|decimaltotalStockPriceWoVat?|decimaltransportDriverId?|int32transportTypeId?|int32userId?|int32warehouseId?|int32checkedAtDate?|When the consignment was checked before despatch; null while it has not been.
date-timecontractId?|Contract this delivery note is booked against.
int32countryId?|Country whose VAT rules apply to this document.
int32currencyId?|Currency the document totals are expressed in, from the Currencies item list.
int32customerAuthorizedPersonId?|Person authorised by the customer to receive these goods.
int32deliveryAddressId?|Delivery address for this consignment; see the order delivery-address endpoints.
int32documentStateUserId?|User-defined document state, from the instance's own state list.
int32foreignExchangeRate?|Rate used to convert the foreign currency into the instance's home currency.
decimalinvoiceHeaderId?|Invoice this delivery note was billed on, once one exists.
int32isEuRetail?|True when the sale is EU retail, which changes how VAT is applied.
isPaid?|True once the document has been paid.
isPdp?|True when the domestic reverse charge applies, so VAT is accounted for by the customer.
note2?|Second free-text note on the document header.
numberOfPackages?|How many packages the consignment consists of.
int32packageNumbers?|Carrier package or tracking numbers for this consignment.
palletNumber?|Number of the pallet the consignment ships on.
int32paymentTypeId?|Payment method, from the payment-types item list.
int32priceId?|Price level the items were priced at, from the instance's price types.
int32proFormaInvoice?|True when the document is billed as a pro-forma invoice.
shouldBeInvoiced?|True when this delivery note is meant to be invoiced later.
signatureOfTheCustomer?|Customer's signature captured on delivery, as raw image bytes.
vatRateBasic?|Basic VAT rate applied on this document, as a percentage.
decimalvatRateReduced?|Reduced VAT rate applied on this document, as a percentage.
decimalvatRateSuperReduced?|Super-reduced VAT rate applied on this document, as a percentage.
decimalapplication/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.
branchId?|int32cancellationInternalNumber?|int32createdAt?|date-timecustomerId?|int32dateOfAccountingPosting?|date-timedateOfOrder?|date-timedateOfProcessing?|date-timedateOfTransfer?|date-timedeliveryDate?|date-timedocumentStateId?|int32formNumber?|length <= 150guid?|guidisCancellation?boolean|nullisConfirmed?boolean|nullisExported?boolean|nullisImported?boolean|nullisLocked?boolean|nullisPartialCancellation?boolean|nullisPrinted?boolean|nullisProcessed?boolean|nulllastModify?|date-timelockOwner?|length <= 80note?string|nullorderInternalNumber?|int32orderText?|length <= 50partialCancellationInternalNumber?|int32processedByUserId?|int32reasonForIssuanceOfGoodsId?|int32routeId?|int32totalDiscount?|decimaltotalNumberOfItems?|int32totalNumberOfPieces?|decimaltotalPrice?|decimaltotalPriceWoVat?|decimaltotalStockPrice?|decimaltotalStockPriceWoVat?|decimaltransportDriverId?|int32transportTypeId?|int32userId?|int32warehouseId?|int32checkedAtDate?|When the consignment was checked before despatch; null while it has not been.
date-timecontractId?|Contract this delivery note is booked against.
int32countryId?|Country whose VAT rules apply to this document.
int32currencyId?|Currency the document totals are expressed in, from the Currencies item list.
int32customerAuthorizedPersonId?|Person authorised by the customer to receive these goods.
int32deliveryAddressId?|Delivery address for this consignment; see the order delivery-address endpoints.
int32documentStateUserId?|User-defined document state, from the instance's own state list.
int32foreignExchangeRate?|Rate used to convert the foreign currency into the instance's home currency.
decimalinvoiceHeaderId?|Invoice this delivery note was billed on, once one exists.
int32isEuRetail?|True when the sale is EU retail, which changes how VAT is applied.
isPaid?|True once the document has been paid.
isPdp?|True when the domestic reverse charge applies, so VAT is accounted for by the customer.
note2?|Second free-text note on the document header.
numberOfPackages?|How many packages the consignment consists of.
int32packageNumbers?|Carrier package or tracking numbers for this consignment.
palletNumber?|Number of the pallet the consignment ships on.
int32paymentTypeId?|Payment method, from the payment-types item list.
int32priceId?|Price level the items were priced at, from the instance's price types.
int32proFormaInvoice?|True when the document is billed as a pro-forma invoice.
shouldBeInvoiced?|True when this delivery note is meant to be invoiced later.
signatureOfTheCustomer?|Customer's signature captured on delivery, as raw image bytes.
vatRateBasic?|Basic VAT rate applied on this document, as a percentage.
decimalvatRateReduced?|Reduced VAT rate applied on this document, as a percentage.
decimalvatRateSuperReduced?|Super-reduced VAT rate applied on this document, as a percentage.
decimalcurl -X PUT 'https://<your-instance>/api/documents/expedition/delivery-notes/0' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{ "note": "Updated delivery notes"}'{ "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, "orderCustomerItemVariantId": 0, "orderInternetItemVariantId": 0, "price": 0, "priceWoVat": 0, "reservationItemVariantId": 0 } ], "barcode": "string", "batchId": 0, "createdAt": "2019-08-24T14:15:22Z", "discount": 0, "exchangeRate": 0, "foreignCurrency": "str", "foreignCurrencyId": 0, "guid": "string", "isCancellation": true, "isPartialCancellation": true, "lastModify": "2019-08-24T14:15:22Z", "locationId": 0, "note": "string", "orderInternalNumber": 0, "orderInternetItemId": 0, "orderItemId": 0, "packageId": 0, "packagePrice": 0, "price": 0, "priceWoVat": 0, "priceWoVatIssued": 0, "promotionId": 0, "quantity": 0, "quantityCoefficient": 0, "quantityIssued": 0, "recyclingFee": 0, "recyclingFeeId": 0, "referencePrice": 0, "reservationItemId": 0, "retailPrice": 0, "royalty": 0, "royaltyId": 0, "setPrice": 0, "stockPrice": 0, "totalForeignPrice": 0, "unitId": 0, "unitIdIssued": 0, "userId": 0, "variantId": 0, "vatRate": 0, "warehouseSellingPrice": 0, "weight": 0, "batchIdRawMaterial": 0, "batchTextRawMaterial": "string", "currencyId": 0, "dateOfIntakeInternal": "2019-08-24T14:15:22Z", "expirationDate": "2019-08-24T14:15:22Z", "isScrap": true, "numberOfPackages": 0, "ssccId": 0 } ], "branchId": 0, "cancellationInternalNumber": 0, "createdAt": "2019-08-24T14:15:22Z", "customerId": 0, "dateOfAccountingPosting": "2019-08-24T14:15:22Z", "dateOfOrder": "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, "formNumber": "string", "guid": "string", "isCancellation": true, "isConfirmed": true, "isExported": true, "isImported": true, "isLocked": true, "isPartialCancellation": true, "isPrinted": true, "isProcessed": true, "lastModify": "2019-08-24T14:15:22Z", "lockOwner": "string", "note": "string", "orderInternalNumber": 0, "orderText": "string", "partialCancellationInternalNumber": 0, "processedByUserId": 0, "reasonForIssuanceOfGoodsId": 0, "routeId": 0, "totalDiscount": 0, "totalNumberOfItems": 0, "totalNumberOfPieces": 0, "totalPrice": 0, "totalPriceWoVat": 0, "totalStockPrice": 0, "totalStockPriceWoVat": 0, "transportDriverId": 0, "transportTypeId": 0, "userId": 0, "warehouseId": 0, "checkedAtDate": "2019-08-24T14:15:22Z", "contractId": 0, "countryId": 0, "currencyId": 0, "customerAuthorizedPersonId": 0, "deliveryAddressId": 0, "documentStateUserId": 0, "foreignExchangeRate": 0, "invoiceHeaderId": 0, "isEuRetail": true, "isPaid": true, "isPdp": true, "note2": "string", "numberOfPackages": 0, "packageNumbers": "string", "palletNumber": 0, "paymentTypeId": 0, "priceId": 0, "proFormaInvoice": true, "shouldBeInvoiced": true, "signatureOfTheCustomer": "string", "vatRateBasic": 0, "vatRateReduced": 0, "vatRateSuperReduced": 0}Delete a delivery note DELETE
Deletes the delivery note 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.DeliveryNotes.Delete`.
Check whether a delivery note 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.DeliveryNotes.Delete`.