> ## 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. # Criar loja > Cria uma loja vinculada ao parceiro ou à revenda informada em `partnerId`. Os campos podem ser enviados na raiz do corpo ou dentro de um objeto `merchant`. ## OpenAPI ````yaml https://app.deliveryvip.com.br/swaggers/partner.yaml post /partner/v2/{partnerId}/merchants 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}/merchants: post: tags: - Merchants summary: Criar loja description: >- Cria uma loja vinculada ao parceiro ou à revenda informada em `partnerId`. Os campos podem ser enviados na raiz do corpo ou dentro de um objeto `merchant`. parameters: - $ref: '#/components/parameters/partnerId' requestBody: required: true content: application/json: schema: type: object required: - name - corporateName - identifier - email - personResponsible - address properties: name: type: string description: Nome fantasia. corporateName: type: string description: Razão social. 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. personResponsible: type: object description: Responsável pela loja. required: - name - email - phone properties: name: type: string description: Nome do responsável. email: type: string format: email description: E-mail do responsável. phone: type: object required: - number properties: number: type: string description: Telefone do responsável. identifier: type: string description: CPF do responsável. address: $ref: '#/components/schemas/addressInput' example: name: Pizzaria da Maria corporateName: Pizzaria da Maria LTDA identifier: '12345678000195' email: contato@pizzariadamaria.com.br personResponsible: name: Maria Souza email: maria@pizzariadamaria.com.br phone: number: '11987654321' identifier: '12345678909' address: postalCode: '01310100' street: Avenida Paulista number: '1000' district: Bela Vista city: São Paulo state: SP responses: '201': description: Loja criada. content: application/json: schema: $ref: '#/components/schemas/merchant' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '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. merchant: type: object required: - id - name - createdAt - updatedAt - address - subscription - features - partnerId properties: id: type: string format: uuid description: UUID da loja. name: type: string description: Nome fantasia. corporateName: type: string description: Razão social. Omitida quando vazia. identifier: type: string description: CNPJ ou CPF. Omitido quando vazio. email: type: string description: E-mail da loja. Omitido quando vazio. phone: $ref: '#/components/schemas/phone' storeUrl: type: string description: URL do domínio principal da loja. Omitida quando não há domínio. createdAt: type: string format: date-time description: Data de criação. updatedAt: type: string format: date-time description: Data da última alteração. personResponsible: type: object description: Responsável pela loja. Omitido quando não há nenhum dado. properties: name: type: string description: Nome do responsável. email: type: string description: E-mail do responsável. phone: $ref: '#/components/schemas/phone' identifier: type: string description: CPF do responsável. address: $ref: '#/components/schemas/address' subscription: allOf: - $ref: '#/components/schemas/subscription' - type: object properties: planId: type: string format: uuid description: UUID do plano da assinatura. Omitido quando não há plano. features: type: array description: Recursos adicionais da loja. items: type: object required: - featureType - status properties: featureType: $ref: '#/components/schemas/merchantFeatureType' status: type: string description: >- `ACTIVATED` quando contratado; `CANCELLED` quando cancelado e ainda dentro da janela em que não pode ser recontratado; `AVAILABLE` nos demais casos. enum: - ACTIVATED - AVAILABLE - CANCELLED lastActivationAt: type: string format: date-time description: Data da última contratação. lastCancellationAt: type: string format: date-time description: >- Data do último cancelamento. Só vem quando não está contratado. partnerId: type: string format: uuid description: UUID do parceiro. resaleId: type: string format: uuid description: UUID da revenda. Omitido quando a loja não é de revenda. phone: type: object required: - number properties: number: type: string description: Telefone no formato E.164 sem o sinal de mais. example: '5511987654321' address: type: object required: - country - state - city - district - street - number - postalCode - formattedAddress - coordinates properties: country: type: string description: País. state: type: string description: UF. city: type: string description: Cidade. district: type: string description: Bairro. street: type: string description: Logradouro. number: type: string description: Número. complement: type: string description: Complemento. Omitido quando vazio. reference: type: string description: Ponto de referência. Omitido quando vazio. postalCode: type: string description: CEP. formattedAddress: type: string description: Endereço completo formatado. coordinates: type: object properties: latitude: type: number format: float nullable: true longitude: type: number format: float nullable: true subscription: type: object required: - status properties: status: type: string description: Status da assinatura. enum: - TRIAL - DEMO - TRIAL_EXPIRED - ACTIVATED - CANCELLED agreementCode: type: string description: Código de contrato. Omitido quando vazio. warning: type: boolean description: Indica se há aviso de bloqueio. Só vem com a assinatura ativa. blocked: type: boolean description: >- Indica se a assinatura está bloqueada. Só vem com a assinatura ativa. trialExpiresAt: type: string format: date-time description: Fim do período de teste. Só vem durante o teste (`TRIAL`). lastActivationAt: type: string format: date-time description: Data da última ativação. lastCancellationAt: type: string format: date-time description: Data do último cancelamento. lastBlockedAt: type: string format: date-time description: Data do último bloqueio. Só vem com a assinatura ativa. lastWarningAt: type: string format: date-time description: Data do último aviso. Só vem com a assinatura ativa. merchantFeatureType: type: string enum: - DELIVERYBOT_NOTIFICATION - DELIVERYBOT_ASSISTANT - INDOOR_VIEWER - INDOOR_QRCODE - INDOOR_TABLET - DOMAIN_CUSTOM - GROWTH_DISCOUNT - INTEGRATION_MARKETING - INTEGRATION_LOGISTIC 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 Forbidden: description: >- Proibido. Retornado quando o token não tem o escopo `dv.partner`, quando o cabeçalho `x-partners` é inválido ou quando o `partnerId` não é autorizado para o token. content: application/json: schema: $ref: '#/components/schemas/error' 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.