Create store

Create a store location. Requires a Write key. Within an organization, name is often the brand; use city (or address) to distinguish locations. Payment provider credentials (Zahls) are configured in the dashboard, not via this API.

POST/stores

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Request body

requiredapplication/json

namestringrequired

min length 1

addressstring

zipCodestring

citystring

Human-readable store label within the organization

vatNumberstring

paymentCashboolean

paymentPaytecboolean

paymentZahlsboolean

paymentZahlsOfflineboolean

paymentCashOfflineboolean

showSupplierboolean

hideTextStartboolean

generalMarginnumber

customMessagestring

backgroundImageCartstring | object

Show properties

One of:

string

string

object

srcstring

backgroundImagestring | object

Show properties

One of:

string

string

object

srcstring

backgroundColorstring

backgroundFontColorstring

playSoundboolean

standardSoundstring

adminMailstring

showInfoButtonboolean

showPicturesboolean

showPicturesScaleboolean

deleteCountdownnumber

logoUrlstring

languageMultiboolean

languageMainstring

Allowed:deenfrit

languageSelectorstring[]

translationsobject

Responses

200

Store created

successbooleanrequired

idstringrequired

400

Invalid parameters or body.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

403

Missing, unknown or inactive API key, or a Read key on a write operation.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API key)Remember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST 'https://dashboard.scango.ch/api/v1/stores' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Main store",
  "city": "Zürich",
  "address": "Bahnhofstrasse 1",
  "zipCode": "8001"
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/stores", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Main store\",\n  \"city\": \"Zürich\",\n  \"address\": \"Bahnhofstrasse 1\",\n  \"zipCode\": \"8001\"\n}"
});

import requests

response = requests.post(
    "https://dashboard.scango.ch/api/v1/stores",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Main store\",\n  \"city\": \"Zürich\",\n  \"address\": \"Bahnhofstrasse 1\",\n  \"zipCode\": \"8001\"\n}",
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/stores',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "Main store",
  "city": "Zürich",
  "address": "Bahnhofstrasse 1",
  "zipCode": "8001"
}',
]);

$response = curl_exec($curl);

Response

{
  "success": true,
  "id": "newStoreId"
}

{
  "statusCode": 400,
  "message": "Validation failed for Field: name, Error: Required",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/suppliers"
}

{
  "statusCode": 403,
  "message": "Unknown Error",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/products"
}