store

Returns information and settings about the store.

Request

HTTP POST
/api/v10/storefront.store

Response

{
  "status" : "ok",
  "store" : {
    "country" : "GB", // country of the store (ISO code) - string(2)
    "currency" : "GBP", // currency of store's prices (ISO code) -  string(3)
    "domain" : "www.store.com", // domain of the store - string
    "indexItemURL" : false, // indicates whether the URL of the items can be indexes - bool
    "language" : { // primary language of the store
      "code" : "en", // code (ISO code) - string(2)
      "locale" : "en-GB", // locale (ISO code) - string(5)
      "currency" : "GBP", // currency (ISO code) - string(3)
      "change" : 1.08827 // change against the store's currency - decimal[10,5](0…)
    },
    "languages" : [ { // languages of the store
      "code" : "en", // code (ISO code) - string(2)
      "locale" : "en-GB", // locale (ISO code) - string(5)
      "currency" : "GBP", // currency (ISO code) - string(3)
      "change" : 1.08827 // change against the store's currency - decimal[10,5](0…)
    }, … ],
    "paranoidSEO" : false, // indicates whether use paranoid SEO in pages - bool
    "registration" : { // registration restrictions
      "acceptTerms" : true, // indicates whether customers should accept terms - bool
      "billingCountries" : [ "GB", "IT", … ], // countries to which the store can bill - string(2)
      "extraRequiredFields" : [ "PersonalCodePrivate", …  ], // extra required fields for registration, can contains "PersonalCodePrivate", "PersonalCodeCompany", "CompanyCode2", "PhoneNumber", "FaxNumber" and "MobileNumber" - string
      "loginApproval" : false, // indicates whether admin approval for login is required after sign up - bool
      "onlyCompanies" : false, // indicates whether only companies can register and order - bool
      "privacyProcessings" : [ { // privacy processings on which the customer can or must provide consent for sign up
        "id" : 12, // identifier - int(1…255)
        "title" : "Terms and Conditions", // title - string(0…60)
        "description" : "", // description - string(0…1000)
        "detailsPage" : 12, // details page (id) (can be null) - int(1…)
        "lawfulBase" : "Consent", // lawful base, can be "Consent", "Contract", "LegalObligation", "LegitimateInterest" or "Other" - string
        "isConsentRequired" : true // indicates if the consent for this processing is required  - bool
      }, … ],
      "requiredFor" : "Order", // indicates what sign up is required for, can be "Order", "ViewPrices" "ViewCatalog" or "ViewSite" (can be null) - string
      "verifyEmail" : false // indicates whether verify the customer email before sign up - bool
    },
    "similarProducts" : { // similar and accessory product settings for the product page
      "columns" : 4, // columns, can be 1, 2, 3, 4 or 6 - int
      "imageSize" : "Small", // image size, can be "Small" or "Medium" - string
      "showDescription" : false // indicates if the description is displayed - bool
    }
  }
}