Update a customer order
Updates the customer order header and the items sent in the body. Pass `removeItemsNotInRequest=true` to also delete the items the body leaves out. Requires `Permissions.OrderCustomer.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
int32removeItemsNotInRequest?boolean|nullapplication/json- body
id?|Row id of the document. Read-only; the server assigns it.
Format
int32internalNumber?|Internal document number, unique within the document type and reserved when the document is created. Read-only.
Format
int32items?array<>|The document's items. Null when the document was loaded without them.
branchId?|Format
int32createdAt?|Format
date-timecustomDocumentStateId?|Format
int32customDocumentStateUserId?|Format
int32dateOfOrder?|Format
date-timedateOfTransfer?|Format
date-timedeliveryDate?|Format
date-timedocumentState?|Format
int32driverId?|Format
int32formNumber?|Length
length <= 150isApproved?boolean|nullisCancellation?boolean|nullisConfirmed?boolean|nullisCovered?boolean|nullisEdiImported?boolean|nullisExported?boolean|nullisImported?boolean|nullisLocked?boolean|nullisPrinted?boolean|nullisProcessed?boolean|nulllastModify?|Format
date-timelockOwner?|Length
length <= 80note?string|nullsectorId?|Format
int32timeSpent?|Format
int32totalNumberOfItems?|Format
int32totalNumberOfPieces?|Format
decimaltotalPrice?|Format
decimaltotalPriceWoVat?|Format
decimaltotalStockPriceWoVat?|Format
decimaltransportTypeId?|Format
int32userId?|Format
int32alreadyPaidAmount?|Format
decimalcontractId?|Format
int32countryId?|Format
int32currencyId?|Format
int32customerId?|Format
int32deliveryAddress?string|nulldeliveryAddressId?|Format
int32deliveryPlanId?|Format
int32distributionWarehouseId?|Format
int32eshopSourceId?|Format
int32exchangeRate?|Format
decimalexportedToParentSystem?boolean|nullincreasedOrderControl?boolean|nullisAssembly?boolean|nullisChanged?boolean|nullisEuRetail?boolean|nullisNotificationEnabled?boolean|nullisOrderBinding?boolean|nullisPaid?boolean|nullisPaidInAdvance?boolean|nullisPdp?boolean|nullisUserLocked?boolean|nullnote2?string|nullnote3?string|nullnote4?string|nullorderAppNumber?|Length
length <= 10orderClosingDate?|Format
date-timepackageNumbers?string|nullpaidOnDate?|Format
date-timepassedToProduction?boolean|nullpaymentTypeId?|Format
int32routeId?|Format
int32sourceId?|Format
int32specificationId?|Format
int32stateChanges?array<>|nulltotalForeignPrice?|Format
decimaltotalStockPrice?|Format
decimaluserLockUserId?|Format
int32warehouseId?|Format
int32ediDocument?string|nullimportation?string|nullapplication/json- response
id?|Row id of the document. Read-only; the server assigns it.
Format
int32internalNumber?|Internal document number, unique within the document type and reserved when the document is created. Read-only.
Format
int32items?array<>|The document's items. Null when the document was loaded without them.
branchId?|Format
int32createdAt?|Format
date-timecustomDocumentStateId?|Format
int32customDocumentStateUserId?|Format
int32dateOfOrder?|Format
date-timedateOfTransfer?|Format
date-timedeliveryDate?|Format
date-timedocumentState?|Format
int32driverId?|Format
int32formNumber?|Length
length <= 150isApproved?boolean|nullisCancellation?boolean|nullisConfirmed?boolean|nullisCovered?boolean|nullisEdiImported?boolean|nullisExported?boolean|nullisImported?boolean|nullisLocked?boolean|nullisPrinted?boolean|nullisProcessed?boolean|nulllastModify?|Format
date-timelockOwner?|Length
length <= 80note?string|nullsectorId?|Format
int32timeSpent?|Format
int32totalNumberOfItems?|Format
int32totalNumberOfPieces?|Format
decimaltotalPrice?|Format
decimaltotalPriceWoVat?|Format
decimaltotalStockPriceWoVat?|Format
decimaltransportTypeId?|Format
int32userId?|Format
int32alreadyPaidAmount?|Format
decimalcontractId?|Format
int32countryId?|Format
int32currencyId?|Format
int32customerId?|Format
int32deliveryAddress?string|nulldeliveryAddressId?|Format
int32deliveryPlanId?|Format
int32distributionWarehouseId?|Format
int32eshopSourceId?|Format
int32exchangeRate?|Format
decimalexportedToParentSystem?boolean|nullincreasedOrderControl?boolean|nullisAssembly?boolean|nullisChanged?boolean|nullisEuRetail?boolean|nullisNotificationEnabled?boolean|nullisOrderBinding?boolean|nullisPaid?boolean|nullisPaidInAdvance?boolean|nullisPdp?boolean|nullisUserLocked?boolean|nullnote2?string|nullnote3?string|nullnote4?string|nullorderAppNumber?|Length
length <= 10orderClosingDate?|Format
date-timepackageNumbers?string|nullpaidOnDate?|Format
date-timepassedToProduction?boolean|nullpaymentTypeId?|Format
int32routeId?|Format
int32sourceId?|Format
int32specificationId?|Format
int32stateChanges?array<>|nulltotalForeignPrice?|Format
decimaltotalStockPrice?|Format
decimaluserLockUserId?|Format
int32warehouseId?|Format
int32ediDocument?string|nullimportation?string|nullcurl -X PUT 'https://<your-instance>/api/documents/orders/customer/0' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{ "note": "Updated Note"}'{ "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, "price": 0, "priceWoVat": 0, "quantityBeingCovered": 0, "quantityCovered": 0, "orderSupplierItemVariantId": 0, "orderedQuantity": 0 } ], "barcode": "string", "batchId": 0, "batchTextRawMaterial": "string", "createdAt": "2019-08-24T14:15:22Z", "ediQuantity": 0, "expirationDate": "2019-08-24T14:15:22Z", "foreignCurrencyId": 0, "foreignExchangeRate": 0, "isCancellation": true, "isPartialCancellation": true, "lastModify": "2019-08-24T14:15:22Z", "note": "string", "packagePrice": 0, "price": 0, "priceWoVat": 0, "quantity": 0, "quantityBeingCovered": 0, "quantityCoefficient": 0, "quantityCovered": 0, "quantityWeighed": 0, "recyclingFee": 0, "recyclingFeeId": 0, "royalty": 0, "royaltyId": 0, "setPrice": 0, "stockPrice": 0, "unitId": 0, "userId": 0, "variantId": 0, "vatRate": 0, "contractId": 0, "deliveryDate": "2019-08-24T14:15:22Z", "discount": 0, "dontOrder": true, "foreignCurrency": "string", "foreignPrice": 0, "insuranceId": 0, "insurancePrice": 0, "numberOfPackages": 0, "orderSupplierItemId": 0, "orderedQuantity": 0, "priceWoVatIssued": 0, "quantityIssued": 0, "takeAway": true, "unitIdIssued": 0, "warehouseId": 0, "warehouseSellingPrice": 0, "weight": 0 } ], "branchId": 0, "createdAt": "2019-08-24T14:15:22Z", "customDocumentStateId": 0, "customDocumentStateUserId": 0, "dateOfOrder": "2019-08-24T14:15:22Z", "dateOfTransfer": "2019-08-24T14:15:22Z", "deliveryDate": "2019-08-24T14:15:22Z", "documentState": 0, "driverId": 0, "formNumber": "string", "isApproved": true, "isCancellation": true, "isConfirmed": true, "isCovered": true, "isEdiImported": true, "isExported": true, "isImported": true, "isLocked": true, "isPrinted": true, "isProcessed": true, "lastModify": "2019-08-24T14:15:22Z", "lockOwner": "string", "note": "string", "sectorId": 0, "timeSpent": 0, "totalNumberOfItems": 0, "totalNumberOfPieces": 0, "totalPrice": 0, "totalPriceWoVat": 0, "totalStockPriceWoVat": 0, "transportTypeId": 0, "userId": 0, "alreadyPaidAmount": 0, "contractId": 0, "countryId": 0, "currencyId": 0, "customerId": 0, "deliveryAddress": "string", "deliveryAddressId": 0, "deliveryPlanId": 0, "distributionWarehouseId": 0, "eshopSourceId": 0, "exchangeRate": 0, "exportedToParentSystem": true, "increasedOrderControl": true, "isAssembly": true, "isChanged": true, "isEuRetail": true, "isNotificationEnabled": true, "isOrderBinding": true, "isPaid": true, "isPaidInAdvance": true, "isPdp": true, "isUserLocked": true, "note2": "string", "note3": "string", "note4": "string", "orderAppNumber": "string", "orderClosingDate": "2019-08-24T14:15:22Z", "packageNumbers": "string", "paidOnDate": "2019-08-24T14:15:22Z", "passedToProduction": true, "paymentTypeId": 0, "routeId": 0, "sourceId": 0, "specificationId": 0, "stateChanges": [ { "customDocumentStateId": 0, "customDocumentStateUserId": 0, "dateOfChange": "2019-08-24T14:15:22Z", "id": 0 } ], "totalForeignPrice": 0, "totalStockPrice": 0, "userLockUserId": 0, "warehouseId": 0, "ediDocument": "string", "importation": "string"}Delete a customer order DELETE
Deletes the customer order 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.OrderCustomer.Delete`.
Check whether a customer order 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.OrderCustomer.Delete`.