Update a intake item
Replaces one item of the intake, identified by `itemId`, and recalculates the document totals. Requires `Permissions.Intake.Update`.
PUT
Bearerheader
AuthorizationBearer <token>OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.
documentId*integerFormat
int32itemId*integerFormat
int32application/json- body
id?|Row id of the item. Read-only; the server assigns it.
Format
int32internalNumber?|Internal number of the document this item belongs to. Read-only.
Format
int32item?|Format
int32productId?|Id of the product this item sells or moves. Required.
Format
int32variants?array<>|The item's size/colour breakdown. Null when the item has none.
barcode?|Length
length <= 50batchId?|Format
int32costs?|Format
decimalcountryOfOriginId?|Format
int32createdAt?|Format
date-timedateOfExchangeRate?|Format
date-timeexpirationDate?|Format
date-timeforeignCurrencyId?|Format
int32foreignExchangeRate?|Format
decimalforeignPurchasePriceWoVat?|Format
decimalguid?|Format
guidisCancellation?boolean|nullisExported?boolean|nullisPartialCancellation?boolean|nulllastModify?|Format
date-timelocationId?|Format
int32minQuantity?|Format
decimalnote?string|nullnote2?string|nullnumberOfPackages?|Format
decimaloptQuantity?|Format
decimalorderInternalNumber?|Format
int32orderItemId?|Format
int32packagePrice?|Format
decimalposId?|Format
int32purchasePriceWoVat?|Format
decimalpurchasePriceWoVatReceived?|Format
decimalquantity?|Format
decimalquantityBeforeProcessing?|Format
decimalquantityCoefficient?|Format
decimalquantityReceived?|Format
decimalquantityWeighed?|Format
decimalrecyclingFee?|Format
decimalrecyclingFeeId?|Format
int32referencePrice?|Format
decimalreferencePurchasePrice?|Format
decimalroyalty?|Format
decimalroyaltyId?|Format
int32setPrice?|Format
decimalstockPrice?|Format
decimalstockPriceBeforeProcessing?|Format
decimalsupplierProductCode?|Length
length <= 50unitId?|Format
int32unitIdReceived?|Format
int32userId?|Format
int32variantId?|Format
int32vatRate?|Format
decimalapplication/json- response
id?|Row id of the item. Read-only; the server assigns it.
Format
int32internalNumber?|Internal number of the document this item belongs to. Read-only.
Format
int32item?|Format
int32productId?|Id of the product this item sells or moves. Required.
Format
int32variants?array<>|The item's size/colour breakdown. Null when the item has none.
barcode?|Length
length <= 50batchId?|Format
int32costs?|Format
decimalcountryOfOriginId?|Format
int32createdAt?|Format
date-timedateOfExchangeRate?|Format
date-timeexpirationDate?|Format
date-timeforeignCurrencyId?|Format
int32foreignExchangeRate?|Format
decimalforeignPurchasePriceWoVat?|Format
decimalguid?|Format
guidisCancellation?boolean|nullisExported?boolean|nullisPartialCancellation?boolean|nulllastModify?|Format
date-timelocationId?|Format
int32minQuantity?|Format
decimalnote?string|nullnote2?string|nullnumberOfPackages?|Format
decimaloptQuantity?|Format
decimalorderInternalNumber?|Format
int32orderItemId?|Format
int32packagePrice?|Format
decimalposId?|Format
int32purchasePriceWoVat?|Format
decimalpurchasePriceWoVatReceived?|Format
decimalquantity?|Format
decimalquantityBeforeProcessing?|Format
decimalquantityCoefficient?|Format
decimalquantityReceived?|Format
decimalquantityWeighed?|Format
decimalrecyclingFee?|Format
decimalrecyclingFeeId?|Format
int32referencePrice?|Format
decimalreferencePurchasePrice?|Format
decimalroyalty?|Format
decimalroyaltyId?|Format
int32setPrice?|Format
decimalstockPrice?|Format
decimalstockPriceBeforeProcessing?|Format
decimalsupplierProductCode?|Length
length <= 50unitId?|Format
int32unitIdReceived?|Format
int32userId?|Format
int32variantId?|Format
int32vatRate?|Format
decimalcurl -X PUT 'https://<your-instance>/api/documents/intakes/0/items/0' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{ "items": [ { "productId": 5, "purchasePriceWoVatReceived": 250, "quantityReceived": 100, "vatRate": 21 } ], "supplierId": 1, "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, "orderSupplierItemVariantId": 0, "price": 0, "price1": 0, "price10": 0, "price10WoVat": 0, "price11": 0, "price11WoVat": 0, "price12": 0, "price12WoVat": 0, "price13": 0, "price13WoVat": 0, "price14": 0, "price14WoVat": 0, "price15": 0, "price15WoVat": 0, "price1WoVat": 0, "price2": 0, "price2WoVat": 0, "price3": 0, "price3WoVat": 0, "price4": 0, "price4WoVat": 0, "price5": 0, "price5WoVat": 0, "price6": 0, "price6WoVat": 0, "price7": 0, "price7WoVat": 0, "price8": 0, "price8WoVat": 0, "price9": 0, "price9WoVat": 0, "priceWoVat": 0 } ], "barcode": "string", "batchId": 0, "costs": 0, "countryOfOriginId": 0, "createdAt": "2019-08-24T14:15:22Z", "dateOfExchangeRate": "2019-08-24T14:15:22Z", "expirationDate": "2019-08-24T14:15:22Z", "foreignCurrencyId": 0, "foreignExchangeRate": 0, "foreignPurchasePriceWoVat": 0, "guid": "string", "isCancellation": true, "isExported": true, "isPartialCancellation": true, "lastModify": "2019-08-24T14:15:22Z", "locationId": 0, "minQuantity": 0, "note": "string", "note2": "string", "numberOfPackages": 0, "optQuantity": 0, "orderInternalNumber": 0, "orderItemId": 0, "packagePrice": 0, "posId": 0, "purchasePriceWoVat": 0, "purchasePriceWoVatReceived": 0, "quantity": 0, "quantityBeforeProcessing": 0, "quantityCoefficient": 0, "quantityReceived": 0, "quantityWeighed": 0, "recyclingFee": 0, "recyclingFeeId": 0, "referencePrice": 0, "referencePurchasePrice": 0, "royalty": 0, "royaltyId": 0, "setPrice": 0, "stockPrice": 0, "stockPriceBeforeProcessing": 0, "supplierProductCode": "string", "unitId": 0, "unitIdReceived": 0, "userId": 0, "variantId": 0, "vatRate": 0}Check whether intake 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.Intake.Delete`.
Delete a intake 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.Intake.Delete`.