Skip to content

Update of credit note item

Request

Updates credit note item. It's not possible to change productType property and it's not possible to update credit note item of another type then product or product-set.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
codestringrequired

credit note code (number)

Example:2018000012
idintegerrequired

credit note item id. Can be found in field data.creditNote.items.itemId in Credit note detail.

Example:198
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobject, non-emptyrequired
curl -i -X PATCH \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/credit-notes/2018000012/item/198 \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "amount": "1.000",
      "price": "125.00",
      "includingVat": true,
      "vatRate": "21.00"
    }
  }'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "creditNoteItem": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}