Créer un magasin

Créer un point de vente. Nécessite une clé Write. Dans une organisation, name est souvent la marque ; utilisez city (ou l’adresse) pour distinguer les emplacements. Les identifiants du prestataire de paiement (Zahls) se configurent dans le tableau de bord, pas via cette API.

POST/stores

Autorisation

AuthorizationJeton Bearer (clé API) · headerobligatoire

Clé API de l’organisation.

Corps de la requête

obligatoireapplication/json

namestringobligatoire

min length 1

addressstring

zipCodestring

citystring

Libellé lisible du magasin au sein de l’organisation

vatNumberstring

paymentCashboolean

paymentPaytecboolean

paymentZahlsboolean

paymentZahlsOfflineboolean

paymentCashOfflineboolean

showSupplierboolean

hideTextStartboolean

generalMarginnumber

customMessagestring

backgroundImageCartstring | object

Afficher les propriétés

Un parmi:

string

string

object

srcstring

backgroundImagestring | object

Afficher les propriétés

Un parmi:

string

string

object

srcstring

backgroundColorstring

backgroundFontColorstring

playSoundboolean

standardSoundstring

adminMailstring

showInfoButtonboolean

showPicturesboolean

showPicturesScaleboolean

deleteCountdownnumber

logoUrlstring

languageMultiboolean

languageMainstring

Autorisé:deenfrit

languageSelectorstring[]

translationsobject

Réponses

200

Magasin créé

successbooleanobligatoire

idstringobligatoire

400

Paramètres ou corps invalides.

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

403

Clé API absente, inconnue ou inactive, ou clé Read sur une opération d’écriture.

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

Essayer

Serveur

URL de baseURL de base personnaliséeRemplace le serveur sélectionné si renseignée.

Autorisation

Jeton Bearer (clé API)Mémoriser sur cet appareilUtiliser mes valeurs dans les exemples

Bodyapplication/json

Corps de la requête

Requête

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": "Magasin principal",
  "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\": \"Magasin principal\",\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\": \"Magasin principal\",\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": "Magasin principal",
  "city": "Zürich",
  "address": "Bahnhofstrasse 1",
  "zipCode": "8001"
}',
]);

$response = curl_exec($curl);

Réponse

{
  "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"
}