WinShopAPI docs
ReferenceDocumentsClaimsInternal

Update a internal claim item

Replaces one item of the internal claim, identified by `itemId`, and recalculates the document totals. Requires `Permissions.ClaimInternal.Update`.

PUT
/api/documents/claims/internal/{documentId}/items/{itemId}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

documentId*integer
Formatint32
itemId*integer
Formatint32

Request Body

application/json
  1. body
id?|

Row id of the item. Read-only; the server assigns it.

Formatint32
internalNumber?|

Internal number of the document this item belongs to. Read-only.

Formatint32
item?|
Formatint32
productId?|

Id of the product this item sells or moves. Required.

Formatint32
variants?array<>|

The item's size/colour breakdown. Null when the item has none.

barcode?|
Lengthlength <= 50
batchId?|
Formatint32
claimReason?|
Formatint32
createdAt?|
Formatdate-time
faultDescription?string|null
faultTypId?|
Formatint32
lastModify?|
Formatdate-time
note?string|null
packagePrice?|
Formatdecimal
quantity?|
Formatdecimal
quantityCoefficient?|
Formatdecimal
recyclingFee?|
Formatdecimal
recyclingFeeId?|
Formatint32
royalty?|
Formatdecimal
royaltyId?|
Formatint32
serviceId?|
Formatint32
solutionDescription?string|null
solutionTypeId?|
Formatint32
statusId?|
Formatint32
stockPrice?|
Formatdecimal
unitId?|
Formatint32
userId?|
Formatint32
variantId?|
Formatint32
vatRate?|
Formatdecimal
claimPrice?|
Formatdecimal
price?|
Formatdecimal
priceWoVat?|
Formatdecimal
priceWoVatIssued?|
Formatdecimal
purchasePriceWoVat?|
Formatdecimal
quantity1?|
Formatdecimal
quantityIssued?|
Formatdecimal
quantityReceived?|
Formatdecimal
unitIdIssued?|
Formatint32

Response Body

response?unknownapplication/octet-stream
curl -X PUT 'https://<your-instance>/api/documents/claims/internal/0/items/0' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{}'
null

Check whether internal claim 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.ClaimInternal.Delete`.

Delete a internal claim 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.ClaimInternal.Delete`.