# Eshop info 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 parameter (see Section on demand. If you state the parameter within the URL, information about the image cut will also be part of the response. For more information about the chapter Product images. Value | Section --------|------ orderAdditionalFields | The 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. orderStatuses | The order statuses, as defined for this e-shop. paymentMethods | Payment methods, as defined for this e-shop. shippingMethods | Transportation options, as defined for this e-shop. imageCuts | The information on image cuts (various sizes of the same image) countries | Informations about eshop supported countries (name, validation atterns, ...) cashDesk | Informations about eshop cash desk configuration Endpoint: GET /api/eshop Version: 1.0.0 Security: shoptetAccessToken, shoptetPrivateApiToken ## Query parameters: - `include` (string) Sections to include Example: "orderAdditionalFields,orderStatuses,paymentMethods,shippingMethods,imageCuts,countries,cashDesk" ## Header parameters: - `Content-Type` (string, required) ## Response 200 fields (application/json): - `data` (object, required) - `data.contactInformation` (object, required) - `data.contactInformation.eshopId` (integer, required) e-shop ID - `data.contactInformation.eshopName` (string, required) name of the e-shop - `data.contactInformation.eshopCategory` (string,null, required) category of the e-shop - `data.contactInformation.url` (string, required) e-shop domain. Please note that domain can change, so it is recommended to register webhook and update the domain in your system if needed. - `data.contactInformation.eshopTitle` (string, required) name of the store - `data.contactInformation.eshopSubtitle` (string,null, required) subtitle of the store - `data.contactInformation.contactPerson` (string,null, required) contact person (e-shop owner) - `data.contactInformation.email` (string,null, required) contact person email - `data.contactInformation.phone` (string,null, required) contact person phone - `data.contactInformation.mobilePhone` (string,null, required) contact person mobile phone - `data.contactInformation.skypeAccount` (string,null, required) contact person skype account - `data.contactInformation.contactPhotoUrl` (string,null, required) contact person photo URL - `data.billingInformation` (object) - `data.billingInformation.billingName` (string,null, required) trade company / e-shop owner - `data.billingInformation.company` (object) company invoicing informations - `data.billingInformation.company.companyId` (string,null, required) Company registration number. - `data.billingInformation.company.vatId` (string,null, required) VAT identification number. - `data.billingInformation.company.taxId` (string,null, required) TAX identification number. For Czech address, taxId is same as vatId. - `data.billingInformation.address` (object, required) invoicing address - `data.billingInformation.address.streetAddress` (string,null, required) street, including house and landmark numbers - `data.billingInformation.address.city` (string,null, required) city or town - `data.billingInformation.address.zip` (string,null, required) ZIP or postal code. - `data.billingInformation.country` (object, required) country of invoicing address - `data.billingInformation.country.countryCode` (string, required) international 2-character country code - `data.billingInformation.country.countryName` (string, required) country name - `data.billingInformation.registration` (string,null, required) reference tag - `data.billingInformation.evNumber` (string,null) Hungarian sole trader registration number. Only for Hungary with enabled module, otherwise, it is null. - `data.billingInformation.phone` (string,null, required) main company telephone - `data.billingInformation.email` (string, required) Main company e-mail. Use this email as a primary one for communication with e-shop. - `data.billingInformation.billingEmail` (string,null, required) invoicing e-mail - `data.settings` (object, required) - `data.settings.vatPayer` (boolean, required) flag, whether the e-shop is a VAT payer - `data.settings.cashDeskOnly` (boolean, required) flag, whether the e-shop is operated exclusively in cash desk mode - `data.settings.trackStockClaims` (boolean, required) flag, activate stock claim count - `data.settings.maxProductAmount` (integer, required) maximum number of products allowed - `data.settings.maxEmailAmount` (integer, required) maximum number of e-mails allowed - `data.settings.defaultPricelist` (object, required) default pricelist - `data.settings.defaultPricelist.id` (integer, required) price list identifier - `data.settings.defaultPricelist.name` (string, required) price list name - `data.settings.eshopLanguage` (string, required) default language code of the e-shop - `data.settings.timezone` (string, required) e-shop timezone - `data.settings.dateFormat` (string, required) eshop date format - `data.settings.timeFormat` (string, required) eshop time format - `data.settings.internals` (string, required) e-shop language internals - shows eshop internal language settings, that can change some behavior like EET, vat/tax, ... - `data.settings.exchangeRateFlip` (boolean, required) rate flipping - `data.settings.negativeStockAmount` (string, required) determines if negative stock buying is allowed. Possible values: , (no, but still show product), (no, show product, hide in navigation), (no, hide product) Enum: "allowed", "no-show-product", "no-hide-navigation", "no-hide-product" - `data.settings.oss` (boolean) Determines if eshop has the OSS (One stop shop) tax mode enabled, this affects behavior of VAT rates in the order. - `data.currencies` (array, required) - `data.currencies.code` (string, required) currency (ISO format 3 characters) - `data.currencies.title` (string, required) currency name - `data.currencies.isDefault` (boolean, required) flag, whether this is the default shop currency - `data.currencies.isDefaultAdmin` (boolean, required) flag, whether this is the default administration currency - `data.currencies.isDefaultDocuments` (boolean, required) flag, whether this is the default documents (invoicing) currency - `data.currencies.isVisible` (boolean, required) flag, whether the currency is visible in the e-shop - `data.currencies.exchangeRate` (string, required) currency exchange rate. According to the currency administration settings, the exchange rate is updated regularly according to the Czech National Bank rate, or is fixed. - `data.currencies.priority` (integer, required) currency priority - `data.currencies.display` (object, required) - `data.currencies.display.text` (string, required) currency symbol - `data.currencies.display.location` (string, required) position of currency symbol, possible values are (left) and (right) Enum: "left", "right" - `data.currencies.display.decimalsSeparator` (string, required) currency display decimal separator - `data.currencies.display.thousandsSeparator` (string,null, required) currency display thousands separator - `data.currencies.priceDecimalPlaces` (integer, required) number of decimal places - `data.currencies.documentPriceDecimalPlaces` (integer, required) number of decimal places - `data.currencies.rounding` (string, required) way of rounding, possible values are (none), (up), (down) and (math) Enum: "none", "up", "down", "math" - `data.currencies.minimalOrderValue` (string,null, required) minimal order value - `data.currencies.bankAccount` (object, required) - `data.currencies.bankAccount.accountNumber` (string,null, required) account number - `data.currencies.bankAccount.iban` (string,null, required) IBAN - `data.currencies.bankAccount.bic` (string,null, required) BIC - `data.taxClasses` (array, required) - `data.taxClasses.title` (string, required) descriptive name of tax rate - `data.taxClasses.rates` (array, required) the list of tax rate zones - `data.taxClasses.rates.zone` (string, required) zone name - `data.taxClasses.rates.vatRate` (string, required) VAT rate - `data.taxClasses.isDefault` (boolean, required) flag, whether the default VAT rate is for e-shop - `data.activeModules` (array, required) - `data.activeModules.title` (string, required) module descriptive name - `data.activeModules.name` (string, required) module identifier - `data.urls` (array, required) e-shop significant URLs. Please note that domain can change, so it is recommended to register webhook and update the domain in your system if needed. - `data.urls.ident` (string, required) URL identifier - `data.urls.url` (string, required) URL (correct form based on e-shop and administration) - `data.socialNetworks` (object) - `data.socialNetworks.facebookUrl` (string,null, required) Facebook profile URL. - `data.socialNetworks.facebookText` (string,null, required) visible text of the Facebook profile link. - `data.socialNetworks.twitterAccount` (string,null, required) Twitter profile name. - `data.socialNetworks.instagramAccount` (string,null, required) Instagram profile name. - `data.orderAdditionalFields` (array) - `data.orderAdditionalFields.index` (integer, required) field number in the order listed in the e-shop administration. Starts from 1. - `data.orderAdditionalFields.label` (string, required) field label - `data.orderStatuses` (object) order statuses, must be requested using - `data.orderStatuses.statuses` (array, required) - `data.orderStatuses.statuses.id` (integer, required) order status identifier. System statuses are negative numbers, user positive. - `data.orderStatuses.statuses.order` (integer, required) status order according to administration numbering. - `data.orderStatuses.statuses.name` (string, required) name of the status, as named in the administration. - `data.orderStatuses.statuses.markAsPaid` (boolean, required) flag, whether the order payment flag is set with this status. - `data.orderStatuses.defaultStatus` (integer, required) default status of new orders. - `data.paymentMethods` (object) - `data.paymentMethods.retail` (object, required) - `data.paymentMethods.retail.methods` (array, required) list of available retail payment methods. - `data.paymentMethods.retail.methods.guid` (string, required) payment method identifier - `data.paymentMethods.retail.methods.order` (integer, required) order of method as set in e-shop administration. - `data.paymentMethods.retail.methods.name` (string, required) payment method caption (customizable in administration) - `data.paymentMethods.retail.methods.visible` (boolean, required) flag, whether the payment method is offered to customers. - `data.paymentMethods.retail.defaultPayment` (string,null, required) default payment method - `data.paymentMethods.wholesale` (object, required) available payment methods for wholesale - `data.paymentMethods.wholesale.methods` (array, required) - `data.paymentMethods.wholesaleActive` (boolean, required) flag, whether wholesale payment methods are activated in administration - `data.shippingMethods` (object) available transport options, must be requested using - `data.shippingMethods.wholesale` (object, required) - `data.shippingMethods.wholesale.defaultShipping` (string,null, required) default shipping method - `data.shippingMethods.wholesaleActive` (boolean, required) flag, whether wholesale shipping methods are activated in administration - `data.imageCuts` (array) the information on image cuts must be requested using - `data.imageCuts.name` (string, required) cut name - `data.imageCuts.width` (integer,null, required) image width in given cut ( for original image - cuts ) - `data.imageCuts.height` (integer,null, required) image height in given cut ( for original image - cuts ) - `data.imageCuts.urlPath` (string, required) URL path to images in given cut, including end slash - `data.imageCuts.cdnPath` (string, required) Cdn URL path to images in given cut, including end slash - `data.languages` (array) supported languages in eshop - `data.languages.code` (string) language code - `data.languages.currencyCode` (string,null) default currency of language - `data.languages.dateFormat` (string) date format for this language - `data.languages.timeFormat` (string) time format for this language - `data.languages.isVisible` (boolean) whether language is selectable in e-shop - `data.languages.isDefault` (boolean) whether language is default - `data.languages.priority` (integer,null) ordering property - `data.trial` (boolean) flag, whether the e-shop is in trial mode - `data.countries` (array) the information on countries must be requested using - `data.countries.companyIdPattern` (string,null, required) Validation pattern for company id - `data.countries.companyIdExample` (string,null, required) Example of company id - `data.countries.zipCodePattern` (string,null, required) Validation pattern for zip code - `data.cashDesk` (object) eshop cash desk configuration - `data.cashDesk.defaultOrderStatusId` (integer,null, required) default status of order after cash desk payment - `errors` (array,null, required) - `errors.errorCode` (string, required) Short text error identification - `errors.message` (string, required) Descriptive error message - `errors.instance` (string, required) Identification of the entity referenced