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 hostname
  • put - Update a store

Resource

{
    "bannerInvoice": "string",
    "bannerOrderConfEmail": "string",
    "baseProduct": "string",
    "createDate": "date-time",
    "customerId": "string",
    "defaultLocale": "string",
    "hostnames": [
        "string"
    ],
    "id": "string",
    "includeTax": "boolean",
    "logoFavicon": "string",
    "logoStore": "string",
    "name": "string",
    "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
createDate date-time Optional
customerId string

Customer id of the store

defaultLocale string

Store default locale

hostnames[] array of string

List of hostnames to access to the cart and enduser portal

id string Optional
includeTax boolean

Is store including taxes?

logoFavicon string

Favicon logo

Optional
logoStore string

Store logo

Optional
name string

Store name

saleLocales[] array of string

Locale where the store is available

status string

Store status

Possible values are:

  • ENABLED
  • DISABLED
  • DELETED
  • ORPHANED
Optional, read only.
theme string

theme name

Optional
updateDate date-time Optional, read only.