> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Documentação das APIs da DeliveryVip, em português. Regras que mais quebram integrações: (1) Merchant API: faça polling em GET /merchant/v3/events:polling no máximo a cada 30 s por token; confirme todo evento recebido com POST /merchant/v3/events/acknowledgment e corpo [{"id": ""}] (o campo lido é id, não eventId), inclusive eventos repetidos ou que o sistema não trata; deduplique por eventId; o evento é só um aviso, busque o pedido na orderURL. (2) Tokens client_credentials valem 24 h e não têm refresh_token: peça outro ao receber 401. (3) Webhooks: valide a assinatura HMAC sobre o corpo bruto e responda 2xx rápido; o polling é a reconciliação. (4) Open Delivery: host od.deliveryvip.com.br, um client_secret por loja, datas em UTC. (5) Fidelidade: o operador implementa 5 rotas assinadas com HMAC e chama o config push; o estorno precisa ser idempotente. (6) Partner API: scope dv.partner. Não invente endpoints: use a referência gerada das specs OpenAPI. # Cadastrar loja por página pública > Cria uma loja e a conta do seu dono a partir de uma landing page pública, em que quem preenche o formulário é um visitante anônimo e não o backend do parceiro. A resposta é propositalmente a mesma esteja o e-mail cadastrado ou não, para que o endpoint não sirva para descobrir quais endereços já têm conta. O que muda é o que acontece por trás: Quando o e-mail está livre, a conta e a loja são criadas e `entryUrl` é retornado: um link de uso único, válido por 5 minutos, que autentica o novo dono. Quando o e-mail já pertence a uma conta, nada é criado, nenhum acesso é concedido e `entryUrl` não vem na resposta: um e-mail é enviado ao dono real do endereço, e só ele pode dar continuidade ao cadastro. Uma conta existente nunca é vinculada a uma loja nova sem prova de titularidade. ## OpenAPI ````yaml https://app.deliveryvip.com.br/swaggers/partner.yaml post /partner/v2/{partnerId}/signup openapi: 3.0.3 info: version: v2 title: API de Parceiros DeliveryVip description: >- A API de Parceiros da DeliveryVip permite que parceiros e revendas gerenciem as lojas (merchants) e as revendas da sua carteira: cadastro, consulta, membros, assinaturas, recursos contratados, aplicações autorizadas, planos e faturas. Todas as rotas exigem um access token OAuth 2.0 com o escopo `dv.partner`, enviado no cabeçalho `Authorization: Bearer `. O token dá acesso aos parceiros autorizados para a aplicação. O cabeçalho opcional `x-partners` (lista de UUIDs separados por vírgula) restringe a requisição a um subconjunto desses parceiros; um UUID fora da autorização do token resulta em `403`. Erros seguem o formato `{"status": "", "title": }`, em que `title` é um texto ou, em erros de validação, um objeto com as mensagens por campo. servers: - url: https://api.deliveryvip.com.br description: Produção security: - bearerAuth: [] tags: - name: Signup description: >- Cadastro público de loja, consumido por uma landing page e não pelo backend do parceiro. - name: Plans description: Planos disponíveis para as lojas do parceiro. - name: Invoices description: Faturas das lojas do parceiro. - name: Merchants description: Cadastro, listagem e consulta de lojas, vendas e faturas. - name: Merchants/Subscriptions description: >- Ativação, cancelamento, aviso, bloqueio e atualização da assinatura da loja. - name: Merchants/Members description: Adição, alteração e remoção de membros da loja. - name: Merchants/Applications description: Autorização e revogação de aplicações na loja. - name: Merchants/Features description: Contratação e cancelamento de recursos adicionais da loja. - name: Resales description: Cadastro, listagem e consulta de revendas e suas faturas. - name: Resales/Subscriptions description: >- Ativação, cancelamento, aviso, bloqueio e atualização da assinatura da revenda. - name: Resales/Members description: Adição, alteração e remoção de membros da revenda. - name: Resales/Applications description: Autorização e revogação de aplicações na revenda. paths: /partner/v2/{partnerId}/signup: post: tags: - Signup summary: Cadastrar loja por página pública description: >- Cria uma loja e a conta do seu dono a partir de uma landing page pública, em que quem preenche o formulário é um visitante anônimo e não o backend do parceiro. A resposta é propositalmente a mesma esteja o e-mail cadastrado ou não, para que o endpoint não sirva para descobrir quais endereços já têm conta. O que muda é o que acontece por trás: Quando o e-mail está livre, a conta e a loja são criadas e `entryUrl` é retornado: um link de uso único, válido por 5 minutos, que autentica o novo dono. Quando o e-mail já pertence a uma conta, nada é criado, nenhum acesso é concedido e `entryUrl` não vem na resposta: um e-mail é enviado ao dono real do endereço, e só ele pode dar continuidade ao cadastro. Uma conta existente nunca é vinculada a uma loja nova sem prova de titularidade. parameters: - $ref: '#/components/parameters/partnerId' requestBody: required: true content: application/json: schema: type: object required: - user - store properties: user: type: object description: Dados do dono da loja. required: - name - email - password properties: name: type: string description: Nome do dono. email: type: string format: email description: E-mail de acesso do dono. password: type: string format: password description: >- Senha escolhida pelo lead. É com ela que ele entra normalmente depois, sem que nenhum token de acesso precise circular por e-mail. phone: type: object properties: number: type: string description: Telefone do dono. store: type: object description: Dados da loja. required: - name - identifier - address properties: name: type: string description: Nome fantasia. corporateName: type: string description: >- Razão social. Opcional; quando omitida, usa o nome fantasia. identifier: type: string description: >- CNPJ ou CPF (somente dígitos). Ambos são aceitos e validados. email: type: string format: email description: >- E-mail da loja. Opcional; quando omitido, usa o e-mail do dono. address: $ref: '#/components/schemas/addressInput' example: user: name: Maria Souza email: maria@pizzariadamaria.com.br password: s3nh4-f0rte phone: number: '11987654321' store: name: Pizzaria da Maria corporateName: Pizzaria da Maria LTDA identifier: '12345678000195' address: postalCode: '01310100' street: Avenida Paulista number: '1000' district: Bela Vista city: São Paulo state: SP responses: '201': description: >- Recebido. Retornado nos dois cenários: `entryUrl` e `merchantId` só vêm quando a conta foi de fato criada. content: application/json: schema: type: object required: - message properties: message: type: string description: Mensagem de confirmação do recebimento. entryUrl: type: string format: uri description: >- Link de entrada de uso único, válido por 5 minutos. Ausente quando o e-mail já pertencia a uma conta. merchantId: type: string format: uuid description: UUID da loja criada. '401': $ref: '#/components/responses/Unauthorized' '403': description: >- Proibido. Retornado quando o `partnerId` não é autorizado para o token ou quando o parceiro não tem domínio de painel configurado ("partner must be setup a domain to user access"). content: application/json: schema: $ref: '#/components/schemas/error' '422': $ref: '#/components/responses/UnprocessableEntity' components: parameters: partnerId: in: path name: partnerId description: UUID do parceiro ou da revenda. required: true schema: type: string format: uuid schemas: addressInput: type: object required: - postalCode - street - number - district - city - state properties: postalCode: type: string description: CEP. street: type: string description: Logradouro. number: type: string description: Número. district: type: string description: Bairro. city: type: string description: Cidade. state: type: string description: UF. error: type: object properties: status: type: string description: Código HTTP, como texto. example: '422' title: description: >- Mensagem de erro. Em erros de validação, é um objeto com a lista de mensagens de cada campo. oneOf: - type: string - type: object additionalProperties: type: array items: type: string responses: Unauthorized: description: Token ausente, inválido ou expirado. content: application/json: schema: type: object properties: title: type: string example: Unauthorized status: type: integer example: 401 UnprocessableEntity: description: Dados inválidos ou parâmetro obrigatório ausente. content: application/json: schema: $ref: '#/components/schemas/error' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Access token OAuth 2.0 (opaco) com o escopo `dv.partner`, obtido em `POST /authentication/v1/oauth/token`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.