Update a delivery note item
Replaces one item of the delivery note, identified by `itemId`, and recalculates the document totals. 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*integerint32itemId*integerint32application/json- body
id?|Row id of the item. Read-only; the server assigns it.
int32internalNumber?|Internal number of the document this item belongs to. Read-only.
int32item?|int32productId?|Id of the product this item sells or moves. Required.
int32variants?array<>|The item's size/colour breakdown. Null when the item has none.
barcode?|length <= 50batchId?|int32createdAt?|date-timediscount?|decimalexchangeRate?|decimalforeignCurrency?|length <= 3foreignCurrencyId?|int32guid?|guidisCancellation?boolean|nullisPartialCancellation?boolean|nulllastModify?|date-timelocationId?|int32note?string|nullorderInternalNumber?|int32orderInternetItemId?|int32orderItemId?|int32packageId?|int32packagePrice?|decimalprice?|decimalpriceWoVat?|decimalpriceWoVatIssued?|decimalpromotionId?|int32quantity?|decimalquantityCoefficient?|decimalquantityIssued?|decimalrecyclingFee?|decimalrecyclingFeeId?|int32referencePrice?|decimalreservationItemId?|int32retailPrice?|decimalroyalty?|decimalroyaltyId?|int32setPrice?|decimalstockPrice?|decimaltotalForeignPrice?|decimalunitId?|int32unitIdIssued?|int32userId?|int32variantId?|int32vatRate?|decimalwarehouseSellingPrice?|decimalweight?|decimalbatchIdRawMaterial?|Batch of raw material the item was produced from.
int32batchTextRawMaterial?|Raw-material batch as free text, for batches not held as rows.
currencyId?|Currency this item's prices are expressed in.
int32dateOfIntakeInternal?|When the goods behind this item were taken into stock.
date-timeexpirationDate?|Expiry date of the goods on this item.
date-timeisScrap?|True when the item leaves as scrap rather than as saleable goods.
numberOfPackages?|How many packages this item ships in.
decimalssccId?|SSCC shipping container this item is packed into.
int32application/json- response
id?|Row id of the item. Read-only; the server assigns it.
int32internalNumber?|Internal number of the document this item belongs to. Read-only.
int32item?|int32productId?|Id of the product this item sells or moves. Required.
int32variants?array<>|The item's size/colour breakdown. Null when the item has none.
barcode?|length <= 50batchId?|int32createdAt?|date-timediscount?|decimalexchangeRate?|decimalforeignCurrency?|length <= 3foreignCurrencyId?|int32guid?|guidisCancellation?boolean|nullisPartialCancellation?boolean|nulllastModify?|date-timelocationId?|int32note?string|nullorderInternalNumber?|int32orderInternetItemId?|int32orderItemId?|int32packageId?|int32packagePrice?|decimalprice?|decimalpriceWoVat?|decimalpriceWoVatIssued?|decimalpromotionId?|int32quantity?|decimalquantityCoefficient?|decimalquantityIssued?|decimalrecyclingFee?|decimalrecyclingFeeId?|int32referencePrice?|decimalreservationItemId?|int32retailPrice?|decimalroyalty?|decimalroyaltyId?|int32setPrice?|decimalstockPrice?|decimaltotalForeignPrice?|decimalunitId?|int32unitIdIssued?|int32userId?|int32variantId?|int32vatRate?|decimalwarehouseSellingPrice?|decimalweight?|decimalbatchIdRawMaterial?|Batch of raw material the item was produced from.
int32batchTextRawMaterial?|Raw-material batch as free text, for batches not held as rows.
currencyId?|Currency this item's prices are expressed in.
int32dateOfIntakeInternal?|When the goods behind this item were taken into stock.
date-timeexpirationDate?|Expiry date of the goods on this item.
date-timeisScrap?|True when the item leaves as scrap rather than as saleable goods.
numberOfPackages?|How many packages this item ships in.
decimalssccId?|SSCC shipping container this item is packed into.
int32curl -X PUT 'https://<your-instance>/api/documents/expedition/delivery-notes/0/items/0' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{ "customerId": 1, "items": [ { "price": 302.5, "priceWoVat": 250, "productId": 5, "quantityIssued": 100, "unitIdIssued": 1, "vatRate": 21 } ], "warehouseId": 2}'{ "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}Check whether delivery note items can be deleted GET
Advisory pre-flight for `DELETE {documentId}/items`. `blockingReasons` holds `ITEMS_BLOCKED` when at least one id in `itemIds` is still referenced elsewhere. At most 1000 ids per call. Requires `Permissions.DeliveryNotes.Delete`.
Delete a delivery note item variant DELETE
Deletes one variant row (a size/colour breakdown) of an item and recalculates the document totals. Call the matching `check-delete` endpoint first to find out whether the delete is allowed. Requires `Permissions.DeliveryNotes.Delete`.