Envoie au portail les données de la boutique à partir desquelles les notifications sont composées : activation des versions linguistiques, liste des langues, liste des boutiques (multistore), statuts de commande et statuts de retour. N'envoyez que les éléments que vous souhaitez modifier — les autres restent inchangés. La réponse renvoie toujours les valeurs actuelles de tous les éléments.

## API URL

URL utilisée pour envoyer les requêtes HTTP :

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

> [!NOTE]
> Si la requête n'atteint pas sa destination, renvoyez-la sur le [serveur de secours](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/serveur-de-secours/) `backup1.bulkgate.com`.

## Méthodes HTTP prises en charge

- `POST` - `application/json`

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

## Tableau des paramètres

| NOM DU PARAMÈTRE    | VALEUR                                                       | OBLIGATOIRE | VALEUR PAR DÉFAUT |
|:--------------------|:-------------------------------------------------------------|:------------|:------------------|
| application_id      | [Application ID](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/administration-api/)                | **Oui**     | -                 |
| application_token   | [Jeton d'authentification de l'application](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/tokens-d-api/) | **Oui** | -                |
| language_mutation   | Activation des versions linguistiques — `true` ou `false`    | Non         | Inchangé          |
| languages           | Langues de la boutique — objet `code: nom`                   | Non         | Inchangé          |
| stores              | Boutiques (multistore) — objet `id: nom`                     | Non         | Inchangé          |
| order_status_list   | Statuts de commande — objet `id: nom`                        | Non         | Inchangé          |
| return_status_list  | Statuts de retour — objet `id: nom`                          | Non         | Inchangé          |

Chaque élément envoyé **remplace toute** la liste — les entrées que vous n'y incluez pas disparaissent du portail.

## Comment le portail utilise les éléments

### Versions linguistiques

Si `language_mutation` est activé, les notifications client ont un texte propre à chaque langue de la liste `languages`. Le portail choisit alors le texte selon le paramètre `language` que vous envoyez avec chaque [événement](https://www.bulkgate.com/fr/documentation/eshop-api/eshop-api-vue-d-ensemble/). Lorsque les versions linguistiques sont désactivées, chaque notification client n'a qu'un seul texte et la langue est ignorée. Les notifications administrateur ont toujours un seul texte.

Le code de langue est ce que vous envoyez dans le paramètre `language` — 1 à 16 caractères parmi les lettres, les chiffres et le trait de soulignement, p. ex. `fr` ou `en_us`. Le tiret n'est pas autorisé.

### Boutiques

L'id de la boutique est ce que vous envoyez dans le paramètre `shop_id`. Les notifications se configurent pour chaque boutique séparément. L'id compte 1 à 20 caractères parmi les lettres, les chiffres et le trait de soulignement. Une boutique sans multistore envoie une seule boutique avec l'id `0` — les événements sans `shop_id` lui appartiennent.

Le portail insère le nom de la boutique correspondant au `shop_id` de l'événement dans la variable `<shop_name>`, si vous ne l'envoyez pas vous-même. Si la boutique avec cet id ne figure pas dans la liste, la première boutique de la liste est utilisée.

### Statuts de commande et de retour

Pour chaque statut de la liste, le portail propose, dans les sections **SMS client** et **Administrateur SMS**, une notification de changement de statut. L'id du statut est la valeur que vous envoyez dans la variable `order_status_id` ([changement de statut de la commande](https://www.bulkgate.com/fr/documentation/eshop-api/eshop-api-commandes/)), ou `return_status_id` ([changement de statut du retour](https://www.bulkgate.com/fr/documentation/eshop-api/eshop-api-retours/)). L'id compte 1 à 29 caractères parmi les lettres, les chiffres, le trait de soulignement et le tiret, p. ex. `ready-for-pickup`.

Les listes de statuts peuvent être vides, la liste des langues et celle des boutiques non. Le nom de chaque entrée est un texte non vide de 255 caractères au maximum.

## Exemple de requête

```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": {
    "fr": "Français",
    "en": "English"
  },
  "stores": {
    "0": "BulkGate Shop FR",
    "1": "BulkGate Shop BE"
  },
  "order_status_list": {
    "processing": "En cours de traitement",
    "completed": "Terminée",
    "cancelled": "Annulée"
  }
}
```

La requête ci-dessus ne modifie pas les statuts de retour.

## Réponse

**En cas de succès**, la réponse renvoie les valeurs actuelles de tous les éléments. Les listes sont toujours un objet, même lorsqu'elles sont vides :

```json
{
    "data": {
        "language_mutation": true,
        "languages": {
            "fr": "Français",
            "en": "English"
        },
        "stores": {
            "0": "BulkGate Shop FR",
            "1": "BulkGate Shop BE"
        },
        "order_status_list": {
            "processing": "En cours de traitement",
            "completed": "Terminée",
            "cancelled": "Annulée"
        },
        "return_status_list": {}
    }
}
```

Une requête sans éléments ne modifie rien et renvoie seulement la configuration actuelle.

**En cas d'erreur :**

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

Où :

- **type** et **error** (description de l'erreur) figurent dans le [tableau des types d'erreurs](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/types-d-erreurs-api/)
- **code** représente le code d'erreur HTTP
- **detail** est une information complémentaire sur l'erreur

### Types d'erreurs

Si l'un des éléments ne passe pas la validation, le portail n'enregistre rien.

| TYPE                         | QUAND CELA SE PRODUIT                                                               |
|:-----------------------------|:------------------------------------------------------------------------------------|
| `invalid_languages`          | La liste des langues est vide ou contient un code ou un nom non valide.             |
| `invalid_stores`             | La liste des boutiques est vide ou contient un id ou un nom non valide.             |
| `invalid_order_status_list`  | La liste des statuts de commande contient un id ou un nom non valide.               |
| `invalid_return_status_list` | La liste des statuts de retour contient un id ou un nom non valide.                 |
| `invalid_input_parameters`   | Paramètre inconnu, liste fournie autrement que sous forme d'objet (p. ex. sous forme de texte), ou `language_mutation` qui n'est pas une valeur booléenne. |
| `unknown_identity`           | `application_id` ou `application_token` est absent ou non valide.                  |
