Skip to content

Get order gift settings

Request

There are order gift setting, which influence general behaviour.

  • The behavior of the gifts - set if gifts are dependent on each product or whole order (stock dependent/independent)
  • Offer to wholesale customers - define if customer with wholesale module have gifts offer available
  • Gift to whole order or each product
Security
shoptetAccessToken or shoptetPrivateApiToken
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  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'

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"
  }
}