Store resource

A store represents a point of sale. It belongs to a customer who could have more than 1 store.

It contains:

  • A name
  • Locales (default and list of available)
  • List of hostnames to access to the store (checkout and enduser portal)
  • Taxes inclusion
  • Some design data ** Layout ** Theme ** Pictures (Store logo, banners, favicon ...)
  • ...

Methods

  • post - Create a store
  • get - Get a store by id
  • get - Get a store by id
  • get - Get a store by hostname
  • put - Update a store

Resource

{
    "bannerInvoice": "string",
    "bannerOrderConfEmail": "string",
    "baseProduct": "string",
    "blackListedCountries": [
        "string"
    ],
    "blackListedPaymentMethods": [
        "string"
    ],
    "createDate": "date-time",
    "createEndUserWithoutSubscription": "boolean",
    "customerId": "string",
    "dbVersion": "int64",
    "defaultCustomerCareEmail": "string",
    "defaultLocale": "string",
    "designs": {
        "checkout": {
            "i18n": "string",
            "layout": "string",
            "theme": "string"
        },
        "endUserPortal": {
            "i18n": "string",
            "layout": "string",
            "theme": "string"
        }
    },
    "fallbackCartCountry": "string",
    "forceGeoipLocalization": "boolean",
    "gtmId": "string",
    "hostnames": [
        "string"
    ],
    "id": "string",
    "localizedCustomerCareEmails": {
        "<key>": "string"
    },
    "logoFavicon": "string",
    "logoStore": "string",
    "modelVersion": "string",
    "name": "string",
    "promoteOneClickPayment": "boolean",
    "saleLocales": [
        "string"
    ],
    "status": "string",
    "theme": "string",
    "updateDate": "date-time"
}

Properties

Name Type Description Additional
bannerInvoice string

Invoice banner

Optional
bannerOrderConfEmail string

Order confirmation banner

Optional
baseProduct string

Product ID of the store

Optional
blackListedCountries[] array of string

List of countries not authorized for this store

Optional
blackListedPaymentMethods[] array of string

List of payment methods not authorized for this store

Optional
createDate date-time Optional
createEndUserWithoutSubscription boolean

Create an end-user whatever the product type bought (Permanent / Subscription)

Optional
customerId string

Customer ID of the store

Optional
dbVersion int64 Optional
defaultCustomerCareEmail string

Customer care email

Optional
defaultLocale string

Store default locale

designs object Designs Optional
designs.checkout object Design Optional
designs.checkout.i18n string

Name of the set of i18n files to use in this context

Optional
designs.checkout.layout string

Name of the layout to use in this context

Optional
designs.checkout.theme string

Name of the theme to use in this context

Optional
designs.endUserPortal object Design Optional
designs.endUserPortal.i18n string

Name of the set of i18n files to use in this context

Optional
designs.endUserPortal.layout string

Name of the layout to use in this context

Optional
designs.endUserPortal.theme string

Name of the theme to use in this context

Optional
fallbackCartCountry string

Fallback cart country

Optional
forceGeoipLocalization boolean

Limit the enduser Country to the geoip localization

Optional
gtmId string

Google Tag Manager ID

Optional
hostnames[] array of string

List of hostnames for accessing the cart and the end-user portal

id string Optional
localizedCustomerCareEmails object

Customer care email by locale

Optional
localizedCustomerCareEmails.<key> map of string Optional
logoFavicon string

Favicon logo

Optional
logoStore string

Store logo

Optional
modelVersion string Optional
name string

Store name

promoteOneClickPayment boolean

Promote one-click payment

Optional
saleLocales[] array of string

Locale where store is available

status string

Store status

Possible values are:

  • ENABLED
  • DISABLED
  • DELETED
  • ORPHANED
Optional
theme string

Deprecated

Optional, read only.
updateDate date-time Optional