Skip to content

List of all remarks

Request

Using this endpoint, you can get list of all remarks with detailed info of each remark asynchronously.

See how Asynchronous requests work on our developer's portal.

Response will be in jsonlines format with each remark taking one line of output file.

One remark in response has the same format as an item in List of remarks for order and is extended with orderCode field, which identifies the relation to the order. See Order history snapshot schema for more details.

Use orderCodes request parameter to get the list of specific orders remarks. Order codes are separated by a comma. Please note that this parameter accepts max. 50 order codes in request parameter.

Result file is compressed using GZIP.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
orderCodesstring

Define the output set of orders remarks. Use max. 50 order codes separated by a comma.

Example:orderCodes=2025000004,2025000002,2017000038,2017000025,2015000248
creationTimeFromstring

date and time of remark creation - lower limit

Example:creationTimeFrom=2025-06-23T14:17:00+02:00
creationTimeTostring

date and time of remark creation - upper limit

Example:creationTimeTo=2025-07-01T14:17:00+02:00
userIdstring

identification of change originator, either user’s e-mail, or system process identifier

Examples:
User email
userId=john.doe@example.com
Process identifier
userId=api.service-21@fenix.myshoptet.com
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/orders/history/snapshot?orderCodes=2025000004%2C2025000002%2C2017000038%2C2017000025%2C2015000248&creationTimeFrom=2025-06-23T14%3A17%3A00%2B02%3A00&creationTimeTo=2025-07-01T14%3A17%3A00%2B02%3A00&userId=john.doe%40example.com' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

Accepted

Bodyapplication/json; charset=utf-8
dataobject
errorsArray of objects or null(Errors)
metadataobject(Metadata)
Response
{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}