Skip to content

Update order gift settings

Request

Method updates order gift settings. Every item in request body is optional, but at least one setting is required.

Security
shoptetAccessToken or shoptetPrivateApiToken
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobjectrequired
curl -i -X PATCH \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/orders/gifts/settings \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "stockDependent": false,
      "wholesaleGiftsEnabled": true,
      "productGifts": "per-amount"
    }
  }'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "stockDependent": false,
    "wholesaleGiftsEnabled": true,
    "productGifts": "per-amount"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}