Nahrá do portálu údaje o obchode, z ktorých sa skladajú notifikácie: zapnutie jazykových mutácií, zoznam jazykov, zoznam obchodov (multistore), stavy objednávok a stavy vratiek. Pošlite len položky, ktoré chcete zmeniť — ostatné zostanú, ako sú. Odpoveď vždy vracia aktuálne hodnoty všetkých položiek.

## API URL

Adresa URL používaná na odosielanie HTTP požiadaviek:

```url
https://portal.bulkgate.com/api/1.0/eshop/setup
```

> [!NOTE]
> Ak sa požiadavka nedostane k cieľu, zopakujte ju na [záložnom serveri](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/zalozny-server/) `backup1.bulkgate.com`.

## Podporované HTTP metódy

- `POST` - `application/json`

```http
POST /api/1.0/eshop/setup HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
```

## Tabuľka s parametrami

| NÁZOV PARAMETRA     | HODNOTA                                                      | POVINNÝ | PREDVOLENÁ HODNOTA |
|:--------------------|:-------------------------------------------------------------|:--------|:-------------------|
| application_id      | [Aplikačný identifikátor](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/administracia-api/)       | **Áno** | -                  |
| application_token   | [Aplikačný overovací token](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/api-tokeny/)             | **Áno** | -                  |
| language_mutation   | Zapnutie jazykových mutácií — `true` alebo `false`           | Nie     | Bez zmeny          |
| languages           | Jazyky obchodu — objekt `kód: názov`                         | Nie     | Bez zmeny          |
| stores              | Obchody (multistore) — objekt `id: názov`                    | Nie     | Bez zmeny          |
| order_status_list   | Stavy objednávok — objekt `id: názov`                        | Nie     | Bez zmeny          |
| return_status_list  | Stavy vratiek — objekt `id: názov`                           | Nie     | Bez zmeny          |

Každá poslaná položka zoznam **nahradí celý** — položky, ktoré v ňom nepošlete, z portálu zmiznú.

## Ako portál položky použije

### Jazykové mutácie

Zapnuté `language_mutation` znamená, že zákaznícke notifikácie majú vlastný text pre každý jazyk zo zoznamu `languages`. Portál potom text vyberá podľa parametra `language`, ktorý posielate s každou [udalosťou](https://www.bulkgate.com/sk/dokumentacia/eshop-api/eshop-api-prehlad/). Pri vypnutých mutáciách má každá zákaznícka notifikácia jediný text a jazyk sa ignoruje. Administrátorské notifikácie majú jeden text vždy.

Kód jazyka je to, čo posielate v parametri `language` — 1 až 16 znakov z písmen, číslic a podčiarkovníka, napr. `sk` alebo `en_us`. Pomlčka nie je povolená.

### Obchody

Id obchodu je to, čo posielate v parametri `shop_id`. Notifikácie sa nastavujú pre každý obchod zvlášť. Id má 1 až 20 znakov z písmen, číslic a podčiarkovníka. Obchod bez multistore pošle jediný obchod s id `0` — udalosti bez `shop_id` patria práve jemu.

Názov obchodu podľa `shop_id` udalosti portál dosadzuje do premennej `<shop_name>`, ak ju nepošlete sami. Keď obchod s daným id v zozname nie je, použije sa prvý obchod zo zoznamu.

### Stavy objednávok a vratiek

Pre každý stav zo zoznamu ponúkne portál v sekciách **Zákaznícke SMS** a **Administrátorské SMS** notifikáciu zmeny stavu. Id stavu je hodnota, ktorú posielate v premennej `order_status_id` ([zmena stavu objednávky](https://www.bulkgate.com/sk/dokumentacia/eshop-api/eshop-api-objednavky/)), resp. `return_status_id` ([zmena stavu vratky](https://www.bulkgate.com/sk/dokumentacia/eshop-api/eshop-api-vratky/)). Id má 1 až 29 znakov z písmen, číslic, podčiarkovníka a pomlčky, napr. `ready-for-pickup`.

Zoznamy stavov smú byť prázdne, zoznam jazykov a obchodov nie. Názov každej položky je neprázdny text s najviac 255 znakmi.

## Príklad požiadavky

```http-json
POST /api/1.0/eshop/setup HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json

{
  "application_id": 451,
  "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
  "language_mutation": true,
  "languages": {
    "sk": "Slovenčina",
    "en": "English"
  },
  "stores": {
    "0": "BulkGate Shop SK",
    "1": "BulkGate Shop CZ"
  },
  "order_status_list": {
    "processing": "Spracováva sa",
    "completed": "Vybavená",
    "cancelled": "Zrušená"
  }
}
```

Požiadavka vyššie nezmení stavy vratiek.

## Odpoveď

**V prípade úspechu** vracia aktuálne hodnoty všetkých položiek. Zoznamy sú vždy objekt, aj keď sú prázdne:

```json
{
    "data": {
        "language_mutation": true,
        "languages": {
            "sk": "Slovenčina",
            "en": "English"
        },
        "stores": {
            "0": "BulkGate Shop SK",
            "1": "BulkGate Shop CZ"
        },
        "order_status_list": {
            "processing": "Spracováva sa",
            "completed": "Vybavená",
            "cancelled": "Zrušená"
        },
        "return_status_list": {}
    }
}
```

Požiadavka bez položiek nič nemení a len vráti aktuálne nastavenia.

**V prípade chyby:**

```json
{
    "type": "invalid_languages",
    "code": 400,
    "error": "Invalid languages",
    "detail": "Invalid identifier 'cs-CZ'."
}
```

Kde:

- **type** a **error** (popis chyby) nájdete v [tabuľke typov chýb](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/typy-chyb-api/)
- **code** je HTTP kód chyby
- **detail** je doplňujúca informácia o chybe

### Typy chýb

Keď niektorá položka neprejde kontrolou, portál neuloží nič.

| TYP                          | KEDY NASTANE                                                                        |
|:-----------------------------|:------------------------------------------------------------------------------------|
| `invalid_languages`          | Zoznam jazykov je prázdny alebo obsahuje neplatný kód či názov.                     |
| `invalid_stores`             | Zoznam obchodov je prázdny alebo obsahuje neplatné id či názov.                     |
| `invalid_order_status_list`  | Zoznam stavov objednávok obsahuje neplatné id či názov.                             |
| `invalid_return_status_list` | Zoznam stavov vratiek obsahuje neplatné id či názov.                                |
| `invalid_input_parameters`   | Neznámy parameter, zoznam zadaný inak než ako objekt (napr. ako text) alebo `language_mutation`, ktoré nie je pravdivostná hodnota. |
| `unknown_identity`           | Chýba `application_id` alebo `application_token`, prípadne nie sú platné.          |
