> ## 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. # Atualizar merchant > Notifica a DeliveryVip de mudanças na loja do token. Modos: - corpo vazio: agenda uma nova leitura completa do merchant e do catálogo via getMerchant; - apenas `merchantStatus`: abre (`AVAILABLE`) ou fecha (`UNAVAILABLE`) a loja, sem nova leitura; - `entityType` com `updatedObjects`: agenda uma nova leitura completa (as entidades informadas não são aplicadas individualmente); - `merchantStatus` com `entityType`: faz as duas coisas. A nova leitura exige onboarding com `getMerchantURL` e é processada de forma assíncrona; acompanhe o resultado em `/v1/merchantStatus`. ## OpenAPI ````yaml https://app.deliveryvip.com.br/swaggers/opendelivery.yaml post /v1/merchantUpdate openapi: 3.0.3 info: version: v1 title: API OpenDelivery DeliveryVip description: >- API compatível com o padrão Open Delivery (Abrasel), em que a DeliveryVip atua como Ordering Application para Software Services (PDVs e sistemas de gestão). A autenticação usa OAuth 2.0 `client_credentials` no endpoint `/oauth/token` deste mesmo host, com o escopo `od.all` (tokens sem esse escopo recebem 403). Os tokens são opacos e enviados no header `Authorization: Bearer `. Datas são retornadas em UTC (ISO 8601). servers: - url: https://od.deliveryvip.com.br description: Produção security: - bearerAuth: [] tags: - name: OAuth description: Emissão de access tokens para a API OpenDelivery. - name: Versions description: Versões da API implementadas. Não exigem autenticação. - name: Events description: >- Mudanças de estado e outras notificações dos pedidos das lojas vinculadas ao aplicativo. - name: Orders description: Detalhes do pedido e ações sobre ele. - name: Merchants description: Onboarding da loja, abertura/fechamento e atualização de catálogo. paths: /v1/merchantUpdate: post: tags: - Merchants summary: Atualizar merchant description: >- Notifica a DeliveryVip de mudanças na loja do token. Modos: - corpo vazio: agenda uma nova leitura completa do merchant e do catálogo via getMerchant; - apenas `merchantStatus`: abre (`AVAILABLE`) ou fecha (`UNAVAILABLE`) a loja, sem nova leitura; - `entityType` com `updatedObjects`: agenda uma nova leitura completa (as entidades informadas não são aplicadas individualmente); - `merchantStatus` com `entityType`: faz as duas coisas. A nova leitura exige onboarding com `getMerchantURL` e é processada de forma assíncrona; acompanhe o resultado em `/v1/merchantStatus`. operationId: merchantUpdate requestBody: required: false content: application/json: schema: type: object properties: merchantStatus: type: string description: Novo estado da loja. enum: - AVAILABLE - UNAVAILABLE entityType: type: string description: Tipo da entidade alterada. Exige `updatedObjects`. enum: - MERCHANT - BASIC_INFO - SERVICE - MENU - CATEGORY - ITEM - ITEM_OFFER - OPTION_GROUP - OPTION - AVAILABILITY updatedObjects: type: array description: >- Objetos alterados. Obrigatório quando `entityType` é enviado. items: type: object additionalProperties: true examples: status: summary: Fechar a loja value: merchantStatus: UNAVAILABLE entidades: summary: Notificar itens alterados value: entityType: ITEM_OFFER updatedObjects: - id: a1b2c3 responses: '204': description: Atualização aceita. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/MultipleMerchants' '422': description: >- Valor inválido de `merchantStatus` ou `entityType`, `entityType` sem `updatedObjects` (`objects_empty`), ou nova leitura solicitada sem onboarding com getMerchant (`api_info_missing`). content: application/json: schema: $ref: '#/components/schemas/Error' components: 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 MultipleMerchants: description: >- O token está vinculado a mais de uma loja e a operação exige uma única (`Token must be associated with a single merchant`). content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - title - status properties: title: type: string description: Descrição do problema. Várias mensagens vêm separadas por `|`. example: Record not found status: type: string description: Código HTTP da resposta, como texto. example: '404' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Access token opaco obtido em `POST /oauth/token` (host `od.deliveryvip.com.br`) com `grant_type=client_credentials` e escopo `od.all`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.