Skip to content

Creation of credit note item

Request

Creates a new credit note item to an existing credit, only billing or shipping item types are allowed.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
codestringrequired

credit note code (number)

Example:2018000012
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobjectrequired
curl -i -X POST \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/credit-notes/2018000012/item \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "itemType": "billing",
      "amount": "1.000",
      "name": "Item name",
      "price": "100.00",
      "priceRatio": "0.7800",
      "includingVat": true,
      "vatRate": "21.00",
      "remark": "item note",
      "additionalField": "additional info"
    }
  }'

Responses

OK

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