Create a store

Create a new store entry

Request

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

Request body

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

{
    "baseProduct": "string",
    "createDate": "date-time",
    "customerId": "string",
    "defaultLocale": "string",
    "design": {
        "<key>": {
            "<key>": "string"
        }
    },
    "id": "string",
    "includeTax": "boolean",
    "logo": {
        "<key>": "string"
    },
    "name": "string",
    "saleLocales": [
        "string"
    ]
}

Properties

Name Type Description Additional
baseProduct string

Product id of the store

Optional
createDate date-time Optional
customerId string

Customer id of the store

defaultLocale string

Store default locale

design object

Setting for the cart UI

Optional
design.<key> map of object Optional
design.<key>.<key> map of string Optional
id string Optional
includeTax boolean

Is store including taxes?

logo object

Key/Value - id/URI location of the stored logos

Optional
logo.<key> map of string Optional
name string

Store name

saleLocales[] array of string

Locale where the store is available

Authorisation

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

{
    "baseProduct": "a0253398-b0c5-4c2d-a15f-bd97ea4be60",
    "customerId": "a0253398-b0c5-4c2d-a15f-bd97ea4be60",
    "defaultLocale": "en-US",
    "design": "{\"default\":{\"key\":\"value\",\"key2\":\"value2\"}}",
    "includeTax": true,
    "logo": "{\"logo\",\"http://nexway.com/logo.jpg\"}",
    "name": "Iap",
    "saleLocales": "[\"en-US\",\"fr-FR\"]",
    "status": "ENABLED",
    "updateDate": "1479225750482"
}

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!