WinShopAPI docs

Update a internal transfer item

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

PUT
/api/documents/internal-transfers/{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
batchTextRawMaterial?string|null
createdAt?|
Formatdate-time
damageTypeId?|
Formatint32
guid?|
Formatguid
isExported?boolean|null
lastModify?|
Formatdate-time
locationId?|
Formatint32
note?string|null
numberOfPackages?|
Formatdecimal
orderInternalNumber?|
Formatint32
orderItemId?|
Formatint32
originWarehouseStockPrice?|
Formatdecimal
packagePrice?|
Formatdecimal
price?|
Formatdecimal
priceWoVat?|
Formatdecimal
priceWoVatIssued?|
Formatdecimal
quantity?|
Formatdecimal
quantityCoefficient?|
Formatdecimal
quantityIssued?|
Formatdecimal
recyclingFee?|
Formatdecimal
recyclingFeeId?|
Formatint32
referencePrice?|
Formatdecimal
royalty?|
Formatdecimal
royaltyId?|
Formatint32
setPrice?|
Formatdecimal
ssccId?|
Formatint32
stockPrice?|
Formatdecimal
unitId?|
Formatint32
unitIdIssued?|
Formatint32
userId?|
Formatint32
variantId?|
Formatint32
vatRate?|
Formatdecimal
warehouseDestination?|
Lengthlength <= 3
warehouseOrigin?|
Lengthlength <= 3
weight?|
Formatdecimal

Response Body

application/json
  1. response
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
batchTextRawMaterial?string|null
createdAt?|
Formatdate-time
damageTypeId?|
Formatint32
guid?|
Formatguid
isExported?boolean|null
lastModify?|
Formatdate-time
locationId?|
Formatint32
note?string|null
numberOfPackages?|
Formatdecimal
orderInternalNumber?|
Formatint32
orderItemId?|
Formatint32
originWarehouseStockPrice?|
Formatdecimal
packagePrice?|
Formatdecimal
price?|
Formatdecimal
priceWoVat?|
Formatdecimal
priceWoVatIssued?|
Formatdecimal
quantity?|
Formatdecimal
quantityCoefficient?|
Formatdecimal
quantityIssued?|
Formatdecimal
recyclingFee?|
Formatdecimal
recyclingFeeId?|
Formatint32
referencePrice?|
Formatdecimal
royalty?|
Formatdecimal
royaltyId?|
Formatint32
setPrice?|
Formatdecimal
ssccId?|
Formatint32
stockPrice?|
Formatdecimal
unitId?|
Formatint32
unitIdIssued?|
Formatint32
userId?|
Formatint32
variantId?|
Formatint32
vatRate?|
Formatdecimal
warehouseDestination?|
Lengthlength <= 3
warehouseOrigin?|
Lengthlength <= 3
weight?|
Formatdecimal
curl -X PUT 'https://<your-instance>/api/documents/internal-transfers/0/items/0' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{  "id": 2,  "note": "Quantity adjusted after recount",  "quantityIssued": 8}'
{  "id": 0,  "internalNumber": 0,  "item": 0,  "productId": 0,  "variants": [    {      "colorId": 0,      "dimensionId": 0,      "id": 0,      "itemId": 0,      "lengthId": 0,      "quantity": 0,      "sizeId": 0,      "orderItemVariantId": 0,      "price": 0,      "priceWoVat": 0    }  ],  "barcode": "string",  "batchId": 0,  "batchTextRawMaterial": "string",  "createdAt": "2019-08-24T14:15:22Z",  "damageTypeId": 0,  "guid": "string",  "isExported": true,  "lastModify": "2019-08-24T14:15:22Z",  "locationId": 0,  "note": "string",  "numberOfPackages": 0,  "orderInternalNumber": 0,  "orderItemId": 0,  "originWarehouseStockPrice": 0,  "packagePrice": 0,  "price": 0,  "priceWoVat": 0,  "priceWoVatIssued": 0,  "quantity": 0,  "quantityCoefficient": 0,  "quantityIssued": 0,  "recyclingFee": 0,  "recyclingFeeId": 0,  "referencePrice": 0,  "royalty": 0,  "royaltyId": 0,  "setPrice": 0,  "ssccId": 0,  "stockPrice": 0,  "unitId": 0,  "unitIdIssued": 0,  "userId": 0,  "variantId": 0,  "vatRate": 0,  "warehouseDestination": "str",  "warehouseOrigin": "str",  "weight": 0}