Detalhes da loja

GET /merchant/v3/{merchantId} devolve tudo o que a DeliveryVip sabe sobre a loja: dados cadastrais, endereço, serviços de entrega e retirada, formas de pagamento e o catálogo completo. Use para conferir o estado atual antes de sincronizar, ou para montar o catálogo no seu sistema pela primeira vez.

Requisição

curl 'https://api.deliveryvip.com.br/merchant/v3/{merchantId}' \
  --header 'Authorization: Bearer {token}'

const response = await fetch(`https://api.deliveryvip.com.br/merchant/v3/${merchantId}`, {
  headers: { Authorization: `Bearer ${token}` },
})
const merchant = await response.json()

response = requests.get(
    f"https://api.deliveryvip.com.br/merchant/v3/{merchant_id}",
    headers={"Authorization": f"Bearer {token}"},
)
merchant = response.json()

Status	Quando
`200 OK`	A loja foi encontrada. O corpo traz os campos abaixo.
`401 Unauthorized`	Token ausente, expirado ou inválido.
`404 Not Found`	O `merchantId` não existe ou a loja não autorizou o seu app.

Estrutura da loja

Estrutura do merchant: informações básicas, serviços, formas de pagamento e catálogo — Estrutura do merchant

Campos opcionais sem valor são omitidos da resposta, não enviados como null. O mesmo vale para as listas do catálogo: uma loja sem produtos não traz a chave items.

uuid

obrigatório

Identificador da loja. É o merchantId usado nas rotas.

datetime

obrigatório

Última alteração no cadastro da loja, com fuso horário (por exemplo 2023-09-26T18:29:16-03:00).

integer

obrigatório

Sugestão de intervalo, em segundos, para consultar a loja de novo. Hoje é sempre 3600.

string

obrigatório

AVAILABLE quando a loja está aberta, UNAVAILABLE quando está fechada.

object

obrigatório

Dados cadastrais da loja.

Mostrar propriedades

string

Nome fantasia.

string

CNPJ ou CPF, só com dígitos.

string

Razão social.

string

Descrição da loja. Só vem quando preenchida.

string[]

E-mails de contato. Só vem quando a loja tem e-mail e e-mail do responsável cadastrados.

object

Só vem quando a loja tem telefone.

Mostrar propriedades

string

Telefone comercial no formato E.164.

datetime

Data de cadastro da loja.

object

Endereço da loja.

Mostrar propriedades

string

Sigla do país.

string

Sigla do estado.

string

Cidade.

string

Bairro.

string

Rua.

string

Número.

string

Complemento. Só vem quando preenchido.

string

Ponto de referência. Só vem quando preenchido.

string

CEP.

string

Endereço completo em uma linha.

object

latitude e longitude da loja.

object[]

obrigatório

Sempre dois itens: um DELIVERY e um TAKEOUT.

Mostrar propriedades

string

AVAILABLE se a loja aceita o serviço, UNAVAILABLE se não.

string

DELIVERY (entrega) ou TAKEOUT (retirada).

integer

Tempo do serviço, em minutos.

object[]

Formas de pagamento, ordenadas por index.

Mostrar propriedades

uuid

Identificador da forma de pagamento.

integer

Posição na lista.

string

Nome exibido ao cliente.

string

CASH, CREDIT, DEBIT, PIX, MEAL_VOUCHER, FOOD_VOUCHER ou OTHER.

string

Código no seu sistema. Só vem quando preenchido.

string

AVAILABLE ou UNAVAILABLE.

object[]

Opções do catálogo, em ordem alfabética.

Mostrar propriedades

uuid

Identificador da opção.

string

Nome da opção.

string

Descrição. Só vem quando preenchida.

string

Código no seu sistema. Só vem quando preenchido.

string

AVAILABLE ou UNAVAILABLE.

object

Só vem quando a opção tem imagem.

Mostrar propriedades

string

Endereço da imagem.

string

MD5 do arquivo em Base64. Compare com o checksum da sua imagem para saber se precisa enviá-la de novo.

object[]

Grupos de opções, em ordem alfabética.

Mostrar propriedades

uuid

Identificador do grupo.

string

Nome do grupo.

string

Código no seu sistema. Só vem quando preenchido.

string

AVAILABLE ou UNAVAILABLE.

uuid[]

IDs das opções que fazem parte do grupo.

object[]

Categorias, ordenadas por index.

Mostrar propriedades

uuid

Identificador da categoria.

integer

Posição no cardápio.

string

Nome da categoria.

string

Descrição. Só vem quando preenchida.

string

Código no seu sistema. Só vem quando preenchido.

string

AVAILABLE ou UNAVAILABLE.

object[]

Produtos, ordenados por index.

Mostrar propriedades

uuid

Identificador do produto.

integer

Posição dentro da categoria.

string

Nome do produto.

string

Descrição. Só vem quando preenchida.

string

Código no seu sistema. Só vem quando preenchido.

string

AVAILABLE ou UNAVAILABLE.

string

Código de barras EAN. Só vem quando preenchido.

Onde o produto é vendido: DELIVERY (entrega), TAKEOUT (retirada) e INDOOR (consumo no local).Quando o produto tem DELIVERY e TAKEOUT, a lista inclui também o valor agregado DELIVERY_TAKEOUT, mantido por retrocompatibilidade. Baseie-se nos tipos individuais e ignore o agregado.

object

Mostrar propriedades

number

Preço atual.

number

Preço original. Quando é maior que value, o produto está em promoção.

string

Sempre BRL.

uuid

Categoria do produto.

object

url e checksum da imagem, como em options. Só vem quando o produto tem imagem.

object[]

Modificadores do produto, ordenados por index. Só vem quando o produto tem modificadores.

Mostrar propriedades

uuid

Identificador do modificador.

integer

Posição no produto.

string

Pergunta exibida ao cliente, por exemplo “Escolha os sabores”.

string

Código no seu sistema. Só vem quando preenchido.

string

AVAILABLE ou UNAVAILABLE.

string

Como o preço das opções escolhidas é calculado: ADDITION, APPORTIONMENT ou HIGHEST. Veja as regras de preço.

integer

Mínimo de opções que o cliente precisa escolher.

integer

Máximo de opções que o cliente pode escolher. 0 significa sem limite.

object[]

Grupos de opções do modificador.

Mostrar propriedades

uuid

ID do grupo de opções.

integer

Posição do grupo no modificador.

object[]

Opções do grupo neste modificador, com preço próprio.

Mostrar propriedades

uuid

ID da opção.

integer

Posição da opção.

string

AVAILABLE ou UNAVAILABLE.

object

value, originalValue e currency da opção neste modificador.

Exemplo de resposta completa

200 OK

{
  "id": "8c64a3f9-65d7-4e3b-9a2d-7c85bc3b3a17",
  "lastUpdate": "2023-09-26T18:29:16-03:00",
  "ttl": 3600,
  "status": "AVAILABLE",
  "basicInfo": {
    "name": "Pizzaria Exemplo",
    "document": "12345678000190",
    "corporateName": "Pizzaria Exemplo LTDA",
    "contactEmails": ["contato@exemplo.com.br"],
    "contactPhones": { "commercialNumber": "+5511999999999" },
    "createdAt": "2022-01-10T09:00:00-03:00",
    "address": {
      "country": "BR",
      "state": "SP",
      "city": "São Paulo",
      "district": "Moema",
      "street": "Avenida Exemplo",
      "number": "100",
      "postalCode": "04000-000",
      "formattedAddress": "Avenida Exemplo, 100 - Moema, São Paulo - SP",
      "coordinates": {
        "latitude": -23.6,
        "longitude": -46.66
      }
    }
  },
  "services": [
    { "status": "AVAILABLE", "serviceType": "DELIVERY", "serviceTime": 15 },
    { "status": "AVAILABLE", "serviceType": "TAKEOUT", "serviceTime": 15 }
  ],
  "paymentMethods": [
    {
      "id": "41678b1b-1902-4f34-b7b0-e2271e93283c",
      "index": 1,
      "name": "Visa - Crédito",
      "mode": "CREDIT",
      "externalCode": "13",
      "status": "AVAILABLE"
    }
  ],
  "options": [
    {
      "id": "c6f193a1-93ea-4aa6-af50-8cc6ed40fb7e",
      "name": "Calabresa",
      "description": "Molho de tomate, mussarela e calabresa",
      "externalCode": "152",
      "status": "AVAILABLE",
      "image": {
        "url": "https://exemplo.com/calabresa.jpg",
        "checksum": "9fOMBLAAaCVVpx03oiViRQ=="
      }
    }
  ],
  "optionGroups": [
    {
      "id": "b4a8a52e-2dd8-4d94-a198-2e68a7ee2d68",
      "name": "Sabores tradicionais",
      "externalCode": "2",
      "status": "AVAILABLE",
      "optionIds": ["c6f193a1-93ea-4aa6-af50-8cc6ed40fb7e"]
    }
  ],
  "categories": [
    {
      "id": "d37d1183-d544-4d15-a067-0f0ad38f7680",
      "index": 1,
      "name": "Pizzas",
      "status": "AVAILABLE"
    }
  ],
  "items": [
    {
      "id": "a3a74a38-9b1d-4c6f-8c53-63eafcdac477",
      "index": 1,
      "name": "Pizza Gigante",
      "description": "Até 4 sabores",
      "externalCode": "104",
      "status": "AVAILABLE",
      "menu": ["DELIVERY", "TAKEOUT", "INDOOR", "DELIVERY_TAKEOUT"],
      "price": { "value": 50.0, "originalValue": 50.0, "currency": "BRL" },
      "categoryId": "d37d1183-d544-4d15-a067-0f0ad38f7680",
      "image": {
        "url": "https://exemplo.com/pizza.jpg",
        "checksum": "9fOMBLAAaCVVpx03oiViRQ=="
      },
      "modifiers": [
        {
          "id": "5a451f76-9e48-49e5-9a62-181bfc6b1a92",
          "index": 1,
          "name": "Escolha os sabores",
          "status": "AVAILABLE",
          "rule": "HIGHEST",
          "minPermitted": 1,
          "maxPermitted": 4,
          "optionGroups": [
            {
              "optionGroupId": "b4a8a52e-2dd8-4d94-a198-2e68a7ee2d68",
              "index": 1,
              "options": [
                {
                  "optionId": "c6f193a1-93ea-4aa6-af50-8cc6ed40fb7e",
                  "index": 1,
                  "status": "AVAILABLE",
                  "price": { "value": 0.0, "originalValue": 0.0, "currency": "BRL" }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Status e horários da loja

Para saber só se a loja está aberta e quais são os horários de atendimento, use GET /merchant/v3/{merchantId}/status. A resposta é bem menor que a da loja completa.

curl 'https://api.deliveryvip.com.br/merchant/v3/{merchantId}/status' \
  --header 'Authorization: Bearer {token}'

string

obrigatório

AVAILABLE (aberta) ou UNAVAILABLE (fechada).

object[]

obrigatório

Um item com o id da loja e serviceHours[].weekHours[]: cada faixa traz dayOfWeek (por exemplo ["MONDAY"]) e timePeriods com startTime e endTime no horário local da loja (HH:MM:SS).

uuid

obrigatório

ID da loja na DeliveryVip.

Próximos passos

Ações

Escolha entre update, upsert e force para sincronizar o catálogo.

Upsert

Crie ou altere produtos, opções e categorias.

Visão geral

Pedidos

Catálogo

Indoor

Descontos

Ferramentas

Referência

Requisição

Estrutura da loja

Status e horários da loja

Próximos passos

Ações

Upsert

​Requisição

​Estrutura da loja

​Status e horários da loja

​Próximos passos

Ações

Upsert

Requisição

Estrutura da loja

Status e horários da loja

Próximos passos