Skip to content

Last credit note changes

Request

Returns the list of credit notes, which were changed. The Endpoint is intended to determine the changes after you have loaded the list of credit notes and you need to know the changes. The guaranteed history of changes is 30 days.

Each credit note is only given in the listing with its last change. For example, if the credit note was modified and then deleted, the listing will only show information about its deletion.

Can be filtered by changeType = edit/delete parameter.

Creation is considered as edit action. So, when there is a new item created, it will be displayed like edit action.

Endpoint supports Paging.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
fromstringrequired

DateTime from which up to the present we are interested in the changes. + in the time zone

Example:from=2018-01-01T01:01:01+02:00
changeTypestring

Returning only edit or delete type changed records

Example:changeType=edit
itemsPerPageinteger

Returned items per page. Default and max value is 20.

Example:itemsPerPage=15
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/credit-notes/changes?from=2018-01-01T01%3A01%3A01%2B02%3A00&changeType=edit&itemsPerPage=15&page=3' \
  -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": {
    "changes": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}