Listar lojas

GET /partner/v2/merchants traz todas as lojas abaixo de quem autorizou o seu app: as diretas do parceiro e as das revendas. A ordem é da loja criada mais recentemente para a mais antiga, sem paginação.

Status	Quando
`200 OK`	Lista de lojas.
`204 No Content`	Nenhuma loja encontrada. A resposta vem sem corpo.
`403 Forbidden`	`subscriptionStatus` inválido (`Invalid subscription status`) ou `x-partners` fora do alcance do token.

Requisição

curl 'https://api.deliveryvip.com.br/partner/v2/merchants?subscriptionStatus[]=ACTIVATED' \
  --header 'Authorization: Bearer {token}' \
  --header 'x-partners: {partnerId}'

const url = new URL('https://api.deliveryvip.com.br/partner/v2/merchants')
url.searchParams.append('subscriptionStatus[]', 'ACTIVATED')

const response = await fetch(url, {
  headers: { Authorization: `Bearer ${token}`, 'x-partners': partnerId },
})
const merchants = response.status === 204 ? [] : await response.json()

response = requests.get(
    "https://api.deliveryvip.com.br/partner/v2/merchants",
    params={"subscriptionStatus[]": ["ACTIVATED"]},
    headers={"Authorization": f"Bearer {token}", "x-partners": partner_id},
)
merchants = [] if response.status_code == 204 else response.json()

Cada item tem o mesmo formato de Obter detalhes da loja.

Resposta (200)

[
  {
    "id": "466caa37-ab0b-4f9d-b583-896681627367",
    "name": "Cantina da Maria",
    "corporateName": "Cantina da Maria LTDA",
    "identifier": "11.222.333/0001-44",
    "email": "contato@cantinadamaria.com.br",
    "storeUrl": "https://cantinadamaria.dvstore.com.br",
    "createdAt": "2025-09-30T17:35:03-03:00",
    "updatedAt": "2025-10-02T10:12:41-03:00",
    "personResponsible": {
      "name": "Maria Silva",
      "email": "maria@exemplo.com.br",
      "phone": { "number": "5511999998888" }
    },
    "address": {
      "country": "Brasil",
      "state": "SP",
      "city": "São Paulo",
      "district": "Bela Vista",
      "street": "Avenida Paulista",
      "number": "1000",
      "postalCode": "01310-100",
      "formattedAddress": "Avenida Paulista, 1000 - Bela Vista, São Paulo - SP",
      "coordinates": { "latitude": -23.5650, "longitude": -46.6520 }
    },
    "subscription": {
      "status": "ACTIVATED",
      "warning": false,
      "blocked": false,
      "agreementCode": "123456",
      "lastActivationAt": "2025-10-01T09:00:00-03:00",
      "planId": "aa67c98c-d81f-5a9c-b0bc-26caa0051aea"
    },
    "features": [
      { "featureType": "INDOOR_QRCODE", "status": "ACTIVATED", "lastActivationAt": "2025-10-01T09:05:00-03:00" }
    ],
    "partnerId": "32eeaefa-6a31-487f-9402-fd9a41683830",
    "resaleId": "ea5705df-5537-4b1b-b291-3536839d3d6f"
  }
]

Filtros

Os filtros podem ser combinados.

string[]

Status da assinatura: TRIAL, TRIAL_EXPIRED, ACTIVATED, CANCELLED ou DEMO. Repita o parâmetro para cada valor, com colchetes. Um valor desconhecido retorna 403.

/partner/v2/merchants?subscriptionStatus[]=TRIAL&subscriptionStatus[]=ACTIVATED

string

Código do contrato da assinatura (agreementCode), comparação exata.

/partner/v2/merchants?subscriptionAgreementCode=123456789

string

CNPJ ou CPF da loja, formatado com pontos, barra e traço, do mesmo jeito que a API devolve em identifier.

/partner/v2/merchants?merchantIdentifier=08.460.509/1101-45

Filtrar por Partners

Sem filtro, a resposta traz as lojas de todos os parceiros e revendas que autorizaram o seu app com esse token. Para restringir, envie o header x-partners com um ou mais IDs, separados por vírgula ou em headers repetidos.

string[]

IDs de parceiros ou revendas que autorizaram o seu app.

x-partners: 0a0000aa-0aa0-00aa-aa00-0000aa000001,0a0000aa-0aa0-00aa-aa00-0000aa000002

Se o mesmo token representa mais de um parceiro e o seu sistema trata cada um separadamente, use x-partners. Sem ele, as lojas de todos chegam misturadas na mesma lista.

Recebi 403 usando x-partners

Com o header, a API confere se o token tem permissão em todos os IDs informados. Se faltar em algum, a resposta é 403 e o title lista os IDs sem acesso:

{ "status": "403", "title": "invalid x-partners 0a0000aa-0aa0-00aa-aa00-0000aa000002" }

Para continuar recebendo: remova esses IDs do header e chame de novo.Para achar a causa:

O parceiro ou a revenda pode ter revogado o acesso do seu app. Peça para autorizar de novo.
Se a autorização é recente, o token pode ter sido gerado antes dela. Gere um novo token.

Visão geral

Lojas

Revendas

Planos

Faturas

Cadastro

Referência

Requisição

Filtros

Filtrar por Partners

​Requisição

​Filtros

​Filtrar por Partners

Requisição

Filtros

Filtrar por Partners