List of remarks for the order

Request

The endpoint shows the order history which is displayed in Shoptet administration in the

“History” tab, in the order detail. Thus they are the most important system actions that have affected the order (they cannot be

changed by the user) and then the notes added by the e-shop, primarily intended as messages between several employees,

which may be needed to coordinate the order processing (these can be entered and deleted by the user).

Security

shoptetAccessToken or shoptetPrivateApiToken

Path

codestringrequired

Order code

Example:2018000067

Query

systemboolean

allows filtering only system/non-system remarks

Example:system=true

Headers

Content-Typestringrequired

Default:"application/json"

curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/orders/2018000067/history?system=true' \
  -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": {
    "orderHistory": [ … ]
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}