Listar faturas das lojas (descontinuado)

GET /partner/v2/merchants/invoices está descontinuado. A data de desligamento anunciada foi 01/07/2025: hoje a rota ainda responde, mas toda resposta traz os headers Deprecation: true e Sunset: Tue, 01 Jul 2025 00:00:00 GMT e ela pode ser removida a qualquer momento. Use GET /partner/v2/{partnerId}/merchants/invoices ou GET /partner/v2/{partnerId}/invoices.

O endpoint devolve uma fatura por loja que o token alcança, para o mês pedido, com os itens que a DeliveryVip cobra do parceiro.

Status	Quando
`200 OK`	Lista de faturas.
`204 No Content`	Nenhuma fatura no período.
`403 Forbidden`	`x-partners` fora do alcance do token.

Requisição

curl 'https://api.deliveryvip.com.br/partner/v2/merchants/invoices?year=2024&month=1' \
  --header 'Authorization: Bearer {token}'

const response = await fetch(
  'https://api.deliveryvip.com.br/partner/v2/merchants/invoices?year=2024&month=1',
  { headers: { Authorization: `Bearer ${token}` } },
)

response = requests.get(
    "https://api.deliveryvip.com.br/partner/v2/merchants/invoices",
    params={"year": 2024, "month": 1},
    headers={"Authorization": f"Bearer {token}"},
)

integer

Ano. Sem ele, vale o ano corrente.

integer

Mês, de 1 a 12. Sem ele, vale o mês corrente.

string[]

Restringe a parceiros ou revendas específicos, como em Filtrar por Partners.

Resposta

Resposta (200)

[
  {
    "merchantId": "2a710c93-ece1-4d57-9038-6fc714c0e81b",
    "month": "1",
    "year": "2024",
    "items": [
      {
        "itemType": "DELIVERY_TAKEOUT",
        "quantity": 1,
        "usageTime": 0.5,
        "totalPrice": 150.0,
        "totalUsageTimePrice": 75.0,
        "metadata": {
          "agreementCode": "123456",
          "sales": {
            "all": { "quantity": 1059, "totalPrice": 96125.11 },
            "success": { "quantity": 1059, "totalPrice": 96125.11 },
            "cancelled": { "quantity": 0, "totalPrice": 0.0 }
          }
        }
      },
      { "itemType": "INDOOR_QRCODE", "quantity": 7, "usageTime": 0.5, "totalPrice": 35.0, "totalUsageTimePrice": 17.5 }
    ],
    "partnerId": "ba1fcc5c-8570-4a8d-b7dc-9d4077f85be8",
    "resaleId": "70d3fdf7-1c4a-49d5-8be9-171e417b8f61"
  }
]

uuid

ID da loja.

string | integer

Mês da fatura. Repete o valor enviado na query (texto); sem o parâmetro, vem como número.

string | integer

Ano da fatura, com a mesma regra de month.

uuid

ID do parceiro.

uuid

ID da revenda. Só aparece em lojas de revenda.

object[]

Itens da fatura.

Mostrar propriedades

string

DELIVERY_TAKEOUT, DELIVERYBOT_NOTIFICATION, DELIVERYBOT_ASSISTANT, INDOOR_VIEWER, INDOOR_QRCODE, INDOOR_TABLET, DOMAIN_CUSTOM, GROWTH_DISCOUNT, INTEGRATION_MARKETING, INTEGRATION_LOGISTIC, SALES_REVENUE, ORDERS_COUNT ou MULTI_STORE. Veja Definições de faturas.

integer

Quantidade usada no mês.

number

Fração do mês em que a assinatura da loja ficou ativa, de 0 a 1 (ex.: 0.5 para uma loja ativada no dia 16 de um mês de 30 dias).

number

Valor do item no mês cheio, em reais: o que o parceiro paga à DeliveryVip. Só para token do parceiro dono da fatura.

number

Valor proporcional ao usageTime, em reais. Só para token do parceiro dono da fatura.

object

Só no item DELIVERY_TAKEOUT: agreementCode, totais de vendas (sales.all, sales.success, sales.cancelled) e, quando o preço é por faixas, tieredPricingRanges (só para token do parceiro dono da fatura).

totalPrice e totalUsageTimePrice mostram quanto o parceiro paga à DeliveryVip pela loja, por isso só aparecem quando o token representa o parceiro dono da fatura. Para um token de revenda, os dois campos não são enviados (nem como null) e o metadata não traz tieredPricingRanges. itemType, quantity, usageTime e o resto do metadata continuam iguais.

Visão geral

Lojas

Revendas

Planos

Faturas

Cadastro

Referência

Listar faturas das lojas (descontinuado)

Requisição

Resposta

​Requisição

​Resposta

Requisição

Resposta