Skip to content

Credit note detail

Request

Additional information about one credit note.

This endpoint has several sections, which are only sent when requested in the include parameter (see Section on demand).

ValueSection
surchargeParametersItem surcharge parameters
Security
shoptetAccessToken or shoptetPrivateApiToken
Path
codestringrequired
Example:0000000002
Query
includestring

Sections to include

Example:include=surchargeParameters
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/credit-notes/0000000002?include=surchargeParameters' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

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"
  }
}