Pular para o conteúdo principal
POST
Sincronizar loja completa

Autorizações

Authorization
string
header
obrigatório

Token de acesso opaco emitido pela API de autenticação (POST /authentication/v1/oauth/token).

Parâmetros de caminho

merchantId
string<uuid>
obrigatório

Id (UUID) da loja na plataforma. A loja precisa estar autorizada para o aplicativo.

Corpo

application/json
id
string<uuid>

Id da loja.

Exemplo:

"dbc7e35a-c936-4665-9e13-eb55eb8b6824"

lastUpdate
string<date-time>

Data e hora da última alteração da loja.

Exemplo:

"2021-05-27T20:45:10-03:00"

ttl
integer

Tempo de validade dos dados, em segundos. Na leitura, sempre 3600.

Exemplo:

3600

status
enum<string>

Indica se a loja está aberta (AVAILABLE) ou fechada (UNAVAILABLE).

Opções disponíveis:
AVAILABLE,
UNAVAILABLE
Exemplo:

"AVAILABLE"

basicInfo
BasicInfo · object

Informações básicas da loja.

services
Service · object[]

Serviços da loja (entrega e retirada).

paymentMethods
PaymentMethod · object[]

Formas de pagamento. Omitido quando a loja não tem complementos cadastrados.

options
Option · object[]

Complementos. Omitido quando a loja não tem complementos.

optionGroups
Option Group · object[]

Grupos de complementos. Omitido quando a loja não tem grupos.

categories
Category · object[]

Categorias. Omitido quando a loja não tem categorias.

items
Item · object[]

Itens do cardápio. Omitido quando a loja não tem itens.

Resposta

Dados recebidos e processados com sucesso. Sem conteúdo na resposta.