Create a store

Request

POST https://api.nexway.store/stores

Request body

The request body takes a complete Store resource, containing the following writable properties:

{
    "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"
    ],
    "theme": "string"
}

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

theme string

theme name

Optional

Authorisation

You need to have a valid JWT to access to this API. Please read JWT Authentication.

This request requires the use of one of following authorisation methods: OAuth2.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Success

success
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Failure

Example

{
    "bannerInvoice": "https://mywebsite.com/images/banner_invoice.png",
    "bannerOrderConfEmail": "https://mywebsite.com/images/banner_orderconfemail.png",
    "customerId": "15654398-42c5-d54d-a15f-baf454s2354",
    "defaultLocale": "en-US",
    "hostnames": [
        "mystore.nexway.store"
    ],
    "includeTax": true,
    "logoFavicon": "https://mywebsite.com/images/logo_favicon.png",
    "logoStore": "https://mywebsite.com/images/logo_store.png",
    "name": "My First Store",
    "saleLocales": [
        "en-US",
        "fr-FR"
    ],
    "status": "ENABLED",
    "theme": "Black theme"
}

Explore this API

store

store

Request Content-Type
Response Content-Type

Choose an authorisation method:

Access Token Access token to be used for request
Try it out!