Carrega para o portal os dados da loja a partir dos quais as notificações são compostas: a ativação das versões linguísticas, a lista de idiomas, a lista de lojas (multistore), os estados das encomendas e os estados das devoluções. Envie apenas os itens que pretende alterar — os restantes ficam como estão. A resposta devolve sempre os valores atuais de todos os itens.

## URL da API

URL utilizado para enviar pedidos HTTP:

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

> [!NOTE]
> Se o pedido não chegar ao destino, repita-o no [servidor de reserva](https://www.bulkgate.com/pt/documentacao/administracao-da-api/servidor-de-reserva/) `backup1.bulkgate.com`.

## Métodos HTTP suportados

- `POST` - `application/json`

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

## Tabela de parâmetros

| NOME DO PARÂMETRO   | VALOR                                                        | OBRIGATÓRIO | VALOR PREDEFINIDO |
|:--------------------|:-------------------------------------------------------------|:------------|:------------------|
| application_id      | [ID da aplicação](https://www.bulkgate.com/pt/documentacao/administracao-da-api/administracao-de-apis/)               | **Sim**     | -                 |
| application_token   | [Token de autenticação da aplicação](https://www.bulkgate.com/pt/documentacao/administracao-da-api/tokens-de-api/)    | **Sim**     | -                 |
| language_mutation   | Ativação das versões linguísticas — `true` ou `false`        | Não         | Sem alteração     |
| languages           | Idiomas da loja — objeto `código: nome`                      | Não         | Sem alteração     |
| stores              | Lojas (multistore) — objeto `id: nome`                       | Não         | Sem alteração     |
| order_status_list   | Estados das encomendas — objeto `id: nome`                   | Não         | Sem alteração     |
| return_status_list  | Estados das devoluções — objeto `id: nome`                   | Não         | Sem alteração     |

Cada lista enviada **substitui a lista inteira** — os itens que não enviar desaparecem do portal.

## Como o portal utiliza os itens

### Versões linguísticas

Com `language_mutation` ativado, as notificações ao cliente têm um texto próprio para cada idioma da lista `languages`. O portal escolhe então o texto de acordo com o parâmetro `language` que envia com cada [evento](https://www.bulkgate.com/pt/documentacao/eshop-api/eshop-api-visao-geral/). Com as versões linguísticas desativadas, cada notificação ao cliente tem um único texto e o idioma é ignorado. As notificações aos administradores têm sempre um único texto.

O código do idioma é o que envia no parâmetro `language` — 1 a 16 caracteres entre letras, algarismos e o carácter de sublinhado, por exemplo `pt` ou `pt_br`. O hífen não é permitido.

### Lojas

O id da loja é o que envia no parâmetro `shop_id`. As notificações configuram-se para cada loja separadamente. O id tem 1 a 20 caracteres entre letras, algarismos e o carácter de sublinhado. Uma loja sem multistore envia uma única loja com o id `0` — os eventos sem `shop_id` pertencem precisamente a ela.

O portal insere o nome da loja correspondente ao `shop_id` do evento na variável `<shop_name>`, se não a enviar. Quando a lista não contém nenhuma loja com esse id, é utilizada a primeira loja da lista.

### Estados das encomendas e das devoluções

Para cada estado da lista, o portal oferece nas secções **SMS do cliente** e **SMS Admin** uma notificação de alteração de estado. O id do estado é o valor que envia na variável `order_status_id` ([alteração do estado da encomenda](https://www.bulkgate.com/pt/documentacao/eshop-api/eshop-api-encomendas/)) ou `return_status_id` ([alteração do estado da devolução](https://www.bulkgate.com/pt/documentacao/eshop-api/eshop-api-devolucoes/)). O id tem 1 a 29 caracteres entre letras, algarismos, o carácter de sublinhado e o hífen, por exemplo `ready-for-pickup`.

As listas de estados podem estar vazias, as listas de idiomas e de lojas não. O nome de cada item é um texto não vazio com, no máximo, 255 caracteres.

## Exemplo de pedido

```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": {
    "pt": "Português",
    "en": "English"
  },
  "stores": {
    "0": "Loja BulkGate PT",
    "1": "Loja BulkGate ES"
  },
  "order_status_list": {
    "processing": "Em processamento",
    "completed": "Concluída",
    "cancelled": "Cancelada"
  }
}
```

O pedido acima não altera os estados das devoluções.

## Resposta

**Em caso de sucesso**, devolve os valores atuais de todos os itens. As listas são sempre um objeto, mesmo quando estão vazias:

```json
{
    "data": {
        "language_mutation": true,
        "languages": {
            "pt": "Português",
            "en": "English"
        },
        "stores": {
            "0": "Loja BulkGate PT",
            "1": "Loja BulkGate ES"
        },
        "order_status_list": {
            "processing": "Em processamento",
            "completed": "Concluída",
            "cancelled": "Cancelada"
        },
        "return_status_list": {}
    }
}
```

Um pedido sem itens não altera nada e devolve apenas as definições atuais.

**Em caso de erro:**

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

Em que:

- **type** e **error** (descrição do erro) encontram-se na [tabela de tipos de erros](https://www.bulkgate.com/pt/documentacao/administracao-da-api/tipos-de-erro-api/)
- **code** representa o código de erro HTTP
- **detail** contém informações adicionais sobre o erro

### Tipos de erros

Quando algum item não passa na validação, o portal não guarda nada.

| TIPO                         | QUANDO OCORRE                                                                       |
|:-----------------------------|:------------------------------------------------------------------------------------|
| `invalid_languages`          | A lista de idiomas está vazia ou contém um código ou nome inválido.                 |
| `invalid_stores`             | A lista de lojas está vazia ou contém um id ou nome inválido.                       |
| `invalid_order_status_list`  | A lista de estados das encomendas contém um id ou nome inválido.                    |
| `invalid_return_status_list` | A lista de estados das devoluções contém um id ou nome inválido.                    |
| `invalid_input_parameters`   | Parâmetro desconhecido, lista indicada de outra forma que não um objeto (por exemplo, como texto) ou `language_mutation` que não é um valor booleano. |
| `unknown_identity`           | Falta `application_id` ou `application_token`, ou não são válidos.                  |
