Insertion of remark to order

Request

This endpoint may be used to add the user remark into the order history.

For example the payment gateway may give the payment identification at its side, or

add the remarks during the process of payment or order processing. The remarks

are displayed in administration, in the “History” tab, in the order detail,

together with main system changes of the order.

Security

shoptetAccessToken or shoptetPrivateApiToken

Path

codestringrequired

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/orders/2018000012/history \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "text": "Transported from Jičín, will be here on Wednesday",
      "type": "comment"
    }
  }'

Responses

Created

Bodyapplication/json

dataobject or null

errorsArray of objects or null(Errors)

metadataobject(Metadata)

Response

{
  "data": {},
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}