Skip to content

E-shop Soul

Request

The merchant's E-shop Soul profile, the brand voice set in the administration: shop segment, target audience, tone of voice, differentiation, benefits, and rules the texts must never break. AI clients use it to write texts in the shop's voice. When the merchant has the profile turned off, enabled is false and every text field is null. An unfilled field is null too. Each field holds at most 500 characters. Not related to the Soul template in /api/eshop/design.

Security
shoptetAccessToken or shoptetPrivateApiToken
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/eshop/soul \
  -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": { "enabled": true, "shopSegment": "Ručně šité kožené boty na míru", "targetAudience": "Ženy 30 až 50 let, které hledají pohodlnou a nadčasovou obuv", "toneOfVoice": "Osobní a vřelý, bez zbytečného marketingového žargonu", "differentiation": "Každý pár šijeme ručně v naší dílně v Brně", "benefits": "Doprava zdarma nad 1500 Kč, výměna velikosti do 30 dnů", "neverRules": "Nikdy neslibovat doručení do 24 hodin" }, "errors": [ { … } ], "metadata": { "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7" } }