Pular para o conteúdo principal
Novidades, mudanças de comportamento e breaking changes nas APIs. Use os filtros por produto para ver só o que afeta a sua integração. Rotas em descontinuação ficam em Deprecations.
Partner API
Faturas com valor proporcional e novos tipos de item
  • Invoices: os blocos de preço das faturas (totalPrice[] com type, value e currency) agora trazem também usageTimeValue, o valor proporcional ao tempo em que a assinatura da loja ficou ativa no mês. O value continua sendo o valor do mês cheio. Vale para GET /partner/v2/{partnerId}/invoices, GET /partner/v2/{partnerId}/merchants/invoices e GET /partner/v2/{partnerId}/resales/invoices (no resumo, nos itens e nos planos). Saiba mais
  • Invoices: os itens de GET /partner/v2/merchants/invoices e GET /partner/v2/resales/invoices passam a trazer o valor em reais: totalPrice (mês cheio) e totalUsageTimePrice (proporcional ao usageTime). Os dois campos só são enviados quando o token representa o parceiro dono da fatura; para token de revenda eles não aparecem, assim como o tieredPricingRanges do metadata. Saiba mais
  • Invoices: novos tipos de item nas faturas: GROWTH_DISCOUNT (descontos), INTEGRATION_MARKETING (integrações de marketing) e INTEGRATION_LOGISTIC (integrações de logística). Saiba mais
  • Resales: POST /partner/v2/resales/{resaleId}/activate, PUT /partner/v2/resales/{resaleId}/subscription e PUT /partner/v2/resales/{resaleId}/agreementCode passam a ignorar o planId, já que a assinatura de uma revenda não tem plano. Antes, enviar planId resultava em erro 500. Saiba mais
Breaking change, Invoices: em GET /partner/v2/{partnerId}/resales/invoices, o bloco RECEIVABLE passa a ser enviado só quando a tabela de preços de recebíveis está habilitada para o parceiro, como já acontecia em GET /partner/v2/{partnerId}/invoices. Sem ela, os arrays totalPrice do resumo, de cada plano e de cada item trazem apenas o bloco PAYABLE. Integrações que leem totalPrice[1] ou assumem dois blocos devem passar a procurar pelo campo type. Além disso, o resumo passa a considerar só as faturas de lojas vinculadas a revendas: um parceiro sem revendas, que antes recebia um grupo com resaleId: null com as lojas diretas, agora recebe 204 No Content. Saiba mais
Merchant API
Imagem nas opções e image.url só com https
  • Catálogo: as opções (options) agora retornam a imagem no GET /merchant/v3/{merchantId}, no mesmo formato dos produtos (image.url e image.checksum). O campo só é enviado quando a opção possui imagem cadastrada. O envio de imagem para opções via merchantUpdate, merchantUpsert e merchantForce (entityType: "OPTION") também passa a estar documentado. Saiba mais
Breaking change, Catálogo: o campo image.url de produtos (ITEM) e opções (OPTION) agora aceita apenas URLs https:// no merchantUpdate, no merchantUpsert e no merchantForce. Até então, URLs http:// também eram aceitas; agora a requisição é rejeitada com 422 Unprocessable Content. Integrações que enviam imagens via http:// devem migrar para https://. Saiba mais
Fidelidade
Limites comerciais de resgate na fidelidade
  • Fidelidade: o programa agora pode declarar limites comerciais de resgate por pedido em capabilities.redemptionLimits (min e max, cada um fixed em BRL ou percent). Omitir o objeto, ou um dos limites, significa sem limite ali: programas existentes seguem permitindo 100%. O teto estrutural continua valendo sempre, e percentuais incidem sobre os itens do pedido, nunca sobre o total (frete e taxas não são resgatáveis). Saiba mais
  • Fidelidade: a resposta de saldo (GET /v1/loyalty/accounts/{accountId}) passa a aceitar o mesmo objeto redemptionLimits, opcional, para operadores cujas regras variam por cliente. Quando presente, ele substitui integralmente os limites do programa para aquele cliente: não é merge campo a campo. Saiba mais
Open Delivery
Open Delivery multi-loja e merchantStatus
  • Open Delivery: um mesmo app agora atende várias lojas. Declarando a extensão Open Delivery, cada loja que instala o app recebe um client_secret próprio (formato ods_..., o client_id continua sendo o do app) e o token emitido com ele vale só para aquela loja. A configuração (merchantId, URL de webhook e endpoint de catálogo) passa a ser por loja, assim como o circuito de webhooks: uma loja com endpoint fora do ar não interrompe as entregas das demais. Saiba mais
  • Open Delivery: novo endpoint GET /v1/merchantStatus?merchantId={id} para acompanhar o processamento assíncrono disparado pelo merchantUpdate. Retorna lastRead, status (SUCCESS, PROCESSING ou FAIL) e moreInfo com o detalhe da falha. Saiba mais
Merchant API
Tipos individuais no menu dos produtos
  • Catálogo: o campo menu dos produtos agora usa os tipos individuais DELIVERY, TAKEOUT e INDOOR. O valor agregado DELIVERY_TAKEOUT continua aceito no envio por retrocompatibilidade (expandido automaticamente para DELIVERY + TAKEOUT) e ainda é devolvido nas respostas quando o produto tem entrega e retirada. Prefira os tipos individuais em novas integrações. Saiba mais
FidelidadeMerchant API
Extensão de fidelidade
  • Fidelidade: nova extensão de fidelidade para apps que operam programas de cashback: o cliente adere ao programa no checkout (com consentimento e PIN opcional), resgata saldo como desconto e acumula sobre pedidos concluídos. O app declara a extensão com uma api_base_url, ativa o programa por lojista via PUT /merchant/v3/{merchantId}/loyalty/config e implementa o contrato HTTP do operador (spec loyalty_operator.yaml). Requer o novo scope dv.loyalty além do od.all. Saiba mais
  • Order: o pedido agora pode trazer o bloco loyalty (visível apenas para o app cujo programa o cliente aderiu), com accountId, programId e o redemption do pedido (status CONFIRMED/REVERSED). Saiba mais
Partner API
Signup público na Partner API
  • Signup: novo endpoint público POST /partner/v2/{partnerId}/signup na API Partner para cadastrar lojas e contas de proprietários a partir de uma landing page. A resposta é a mesma para e-mail novo ou já cadastrado (proteção contra enumeração de usuários): a presença do campo entryUrl indica se a conta foi criada. Saiba mais
Open DeliveryMerchant API
Datas em UTC no Open Delivery e filtros de polling
  • Open Delivery: as datas da API Open Delivery agora são serializadas em UTC (RFC 3339, sufixo Z, ex.: 2026-08-10T17:39:28Z), conforme exigido pela spec OD. A API Merchant V3 segue usando UTC-3. Saiba mais
  • Events: os filtros eventType e orderType dos endpoints de polling (GET /merchant/v3/events:polling e GET /v1/events:polling do Open Delivery) seguem a serialização de arrays da spec OpenAPI (style: form, explode: true): repita o parâmetro na query, sem colchetes, ex.: ?eventType=CREATED&eventType=CANCELLED. Valores inválidos retornam 403 Forbidden. Saiba mais
Merchant API
Polling limitado a 100 eventos
  • Events: o endpoint GET /merchant/v3/events:polling agora retorna no máximo 100 eventos por chamada, sempre do mais antigo para o mais recente. Se a resposta vier com 100 eventos, envie o acknowledgment e chame o polling novamente em seguida, sem aguardar o intervalo usual, até receber menos de 100 eventos (ou 204 No Content). Integrações que precisam de eventos em tempo real devem considerar os webhooks como canal principal. Saiba mais
WebhooksMerchant APIPartner API
Webhooks e novo prazo das deprecations
  • Webhooks: agora a API Merchant pode enviar os eventos de pedido e de indoor em tempo real para uma URL sua, como complemento ao polling. Configure a URL de notificação no painel e valide a assinatura X-App-Signature. Saiba mais
  • Deprecations: o prazo de descontinuação das rotas em deprecação (Merchant v1/v2, Tabs available/unavailable e Invoices/Agreement Code da Partner v2) foi adiado para 01/08/2026. As rotas da Partner v1 já foram removidas e retornam 410 Gone. Saiba mais
Merchant API
Modos de Mesa e Comanda
  • Places: com os novos modos de Mesa e Comanda, agora é possível abrir ou fechar uma mesa para consumo. Saiba mais
  • Order: novos atributos no objeto indoor do pedido para suportar os modos de Mesa e Comanda. Saiba mais
  • Event: novos atributos nos eventos para suportar os modos de Mesa e Comanda. Saiba mais
  • Deprecations: as rotas available e unavailable das comandas entram em descontinuação. Saiba mais
Partner API
Novo sistema de cobrança
  • Plans: implementamos um novo sistema de cobrança: toda assinatura agora deve estar vinculada a um plano de cobrança específico. Saiba mais
  • Invoices: com a mudança no modelo de cobrança, o módulo de Invoices foi reestruturado. Agora é possível listar as faturas de cada merchant para verificar o plano associado, o consumo de recursos e os valores calculados pela nova tabela de preços. Saiba mais
  • Deprecations: para acomodar o novo sistema de cobrança, algumas rotas e versões de API serão descontinuadas. Consulte Deprecations para a lista completa e os prazos de remoção.
Merchant API
Catálogo: MODIFIER dentro de ITEM e métodos de pagamento
  • Catalog & Services: no merchantUpdate e no merchantUpsert, o entityType MODIFIER foi removido. Ele agora fica dentro de ITEM, que deve ser usado para manter o modifier atualizado.
  • Catalog & Services: agora é possível adicionar os métodos de pagamento pela API.
Merchant API
Campo salesChannel nos pedidos
  • SalesChannel: novo campo salesChannel nos pedidos. Saiba mais
Merchant API
Endpoints de descontos
  • Descontos: novos endpoints para adicionar, atualizar e remover descontos de um merchant na API Merchant. Saiba mais
Merchant API
Listagem de pedidos
  • Listar pedidos: novo endpoint para listar os pedidos de um merchant na API Merchant. Saiba mais
Partner API
Faturas de merchants e revendas
  • Faturas dos merchants: novo endpoint para listar as faturas do ano e mês dos merchants na API Partner. Saiba mais
  • Faturas das revendas: novo endpoint para listar as faturas do ano e mês das revendas na API Partner. Saiba mais
Merchant APIPartner API
Indoor no pedido, merchantId nos eventos, revendas e recursos
  • Order: placeName e tabId adicionados quando o pedido é do tipo INDOOR. Saiba mais
  • Order events: merchantId adicionado aos eventos. Saiba mais
  • Indoor events: merchantId, tabId, tabCode e tabName adicionados. Saiba mais
  • Assinatura: nova rota para avisar um merchant sobre um possível bloqueio. Saiba mais
  • Revenda: nova API para gerenciar as revendas. Saiba mais
  • Recursos: nova API para gerenciar os recursos dos merchants. Saiba mais
Merchant API
Entidade MODIFIER no catálogo
  • Catalog & Services: entidade MODIFIER adicionada ao merchantUpdate e ao merchantUpsert. Saiba mais
Merchant APIPartner API
API de catálogo e novos filtros
  • Catalog & Services: agora é possível atualizar, inserir e administrar o catálogo de um merchant pela API. Saiba mais
  • Order events: o polling de eventos passa a aceitar o filtro orderType. Saiba mais
  • Listar merchants: a lista de merchants passa a aceitar o filtro por identifier. Saiba mais
Merchant API
Tracking de pedidos
  • Order API: agora é possível fazer o tracking de um pedido. Saiba mais
Partner API
Permissão de aplicativos por merchant
  • Partner API: agora é possível adicionar ou remover a permissão de uma aplicação para um merchant. Saiba mais
Merchant API
Taxa de entrega por coordenada
  • Merchant Tools: agora é possível saber a taxa de entrega a partir de uma latitude e longitude. Saiba mais
Merchant API
Pedidos e comandas indoor
  • Merchant Indoor: agora é possível receber pedidos e cadastrar comandas do tipo indoor. Saiba mais
Partner API
MagicLink, membros e cadastro de merchants
  • MagicLink: agora é possível logar um membro sem senha. Saiba mais
  • Membros: agora é possível listar, adicionar, atualizar e remover membros de um merchant. Saiba mais
  • Cadastrar merchant: agora é possível adicionar um merchant a um partner. Saiba mais
  • Novo filtro: ao listar merchants ou vendas, agora é possível filtrar só os merchants dos partners desejados. Saiba mais
Merchant API
Ação delivered
  • Nova order action: nova ação delivered na API de pedidos. Saiba mais
Partner API
Partner API V2
  • Partner API V2: com ela é possível controlar as assinaturas dos merchants e acompanhar o faturamento delas. Saiba mais