Skip to content

Eshop

General information about the e-shop settings.

Operations

Eshop info

Request

Information about queried e-shop (defined by token). Returns the contact data and e-shop settings.

This endpoint has several sections, which are only sent when requested in the include parameter (see Section on demand.

If you state the include=imageCuts parameter within the URL, information about the image cut will also be part of the response. For more information about the chapter Product images.

Please note that languages section has meaning only if module foreign languages (Cizí jazyky) is enabled on current eshop. Otherwise you have to follow "eshopLanguage" attribute.

ValueSection
orderAdditionalFieldsThe order can contain up to six additional fields, which can be freely used by the e-shop for its individual needs. The field names can be defined in administration and this section returns their names.
orderStatusesThe order statuses, as defined for this e-shop.
paymentMethodsPayment methods, as defined for this e-shop.
shippingMethodsTransportation options, as defined for this e-shop.
imageCutsThe information on image cuts (various sizes of the same image)
countriesInformations about eshop supported countries (name, validation atterns, ...)
cashDeskInformations about eshop cash desk configuration
Security
shoptetAccessToken or shoptetPrivateApiToken
Query
includestring

Sections to include

Example:include=orderAdditionalFields,orderStatuses,paymentMethods,shippingMethods,imageCuts,countries,cashDesk
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/eshop?include=orderAdditionalFields%2CorderStatuses%2CpaymentMethods%2CshippingMethods%2CimageCuts%2Ccountries%2CcashDesk' \
  -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": {
    "contactInformation": { … },
    "billingInformation": { … },
    "settings": { … },
    "currencies": [ … ],
    "taxClasses": [ … ],
    "activeModules": [ … ],
    "urls": [ … ],
    "socialNetworks": { … },
    "orderAdditionalFields": [ … ],
    "orderStatuses": { … },
    "paymentMethods": { … },
    "shippingMethods": { … },
    "imageCuts": [ … ],
    "languages": [ … ],
    "trial": false,
    "countries": [ … ],
    "cashDesk": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}