Skip to content

Update remarks for the order

Request

The endpoint enables the remarks and additional fields (index 1 - 6) to be updated for the order. Within a call, the update

of more data can be called for.

The individual data object keys are not optional. Only the key values, which are included in the data object, will be updated.

If "customerRemark", "trackingNumber", "eshopRemark" have a value of NULL, the originally saved value will be deleted.

For additional fields ("additionalFields” key) only the fields included in this field are updated.

If the key value is "text" for NULL additional field, the originally saved text in this field will be deleted.

If the non-existing key is entered, or the call is erroneous in another way, no item is updated.

Please note that trackingNumber cannot be longer than 32 characters.

Please note that additionalField with index 1, 2 & 3 cannot be longer than 255 characters.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
codestringrequired
Example:2018000012
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobject, non-emptyrequired
curl -i -X PATCH \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/orders/2018000012/notes \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "customerRemark": "Deliver to mailing addres",
      "trackingNumber": "DR1234567890E",
      "additionalFields": [
        {
          "index": 1,
          "text": "Text of additional field no. 1"
        },
        {
          "index": 2,
          "text": "Text of additional field no. 2"
        },
        {
          "index": 3,
          "text": "Text of additional field no. 3"
        },
        {
          "index": 4,
          "text": "Text of additional field no. 4"
        },
        {
          "index": 5,
          "text": "Text of additional field no. 5"
        },
        {
          "index": 6,
          "text": "Text of additional field no. 6"
        }
      ],
      "eshopRemark": "In stock from 20.1. 2019"
    }
  }'

Responses

OK

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