Obter detalhes da loja

GET /partner/v2/merchants/{merchantId} devolve a loja completa. É o mesmo objeto que vem em cada item de Listar lojas e na resposta do cadastro.

Status	Quando
`200 OK`	A loja.
`404 Not Found`	A loja não existe ou não está abaixo de quem autorizou o app.

Requisição

curl 'https://api.deliveryvip.com.br/partner/v2/merchants/{merchantId}' \
  --header 'Authorization: Bearer {token}'

const response = await fetch(`https://api.deliveryvip.com.br/partner/v2/merchants/${merchantId}`, {
  headers: { Authorization: `Bearer ${token}` },
})
const merchant = await response.json()

response = requests.get(
    f"https://api.deliveryvip.com.br/partner/v2/merchants/{merchant_id}",
    headers={"Authorization": f"Bearer {token}"},
)
merchant = response.json()

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" },
    "identifier": "123.456.789-09"
  },
  "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.565, "longitude": -46.652 }
  },
  "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": "DELIVERYBOT_ASSISTANT", "status": "AVAILABLE" },
    { "featureType": "INDOOR_QRCODE", "status": "ACTIVATED", "lastActivationAt": "2025-10-01T09:05:00-03:00" },
    {
      "featureType": "INDOOR_TABLET",
      "status": "CANCELLED",
      "lastActivationAt": "2025-10-01T09:05:00-03:00",
      "lastCancellationAt": "2025-10-20T17:36:56-03:00"
    }
  ],
  "partnerId": "32eeaefa-6a31-487f-9402-fd9a41683830",
  "resaleId": "ea5705df-5537-4b1b-b291-3536839d3d6f"
}

Campos

Campos opcionais vazios não são enviados, nem como null.

uuid

ID da loja.

string

Nome fantasia.

string

Razão social.

string

CNPJ ou CPF, formatado.

string

E-mail da loja.

object

Telefone da loja, em phone.number (E.164 sem +).

string

URL do domínio principal da loja. Só aparece quando a loja tem domínio principal.

datetime

Data do cadastro.

datetime

Data da última alteração.

object

Responsável pela loja.

Mostrar propriedades

string

Nome.

string

E-mail.

string

Telefone, em E.164 sem +.

string

CPF.

object

Endereço da loja.

Mostrar propriedades

string

País.

string

UF.

string

Cidade.

string

Bairro.

string

Rua.

string

Número.

string

Complemento, quando houver.

string

Ponto de referência, quando houver.

string

CEP.

string

Endereço completo em uma linha.

object

latitude e longitude.

object

Assinatura da loja. Veja Definições.

Mostrar propriedades

string

TRIAL, TRIAL_EXPIRED, ACTIVATED, CANCELLED ou DEMO.

boolean

Se a loja está em aviso. Só com status ACTIVATED.

boolean

Se a loja está bloqueada. Só com status ACTIVATED.

string

Código do contrato, quando definido.

datetime

Fim do período de teste. Só com status TRIAL.

datetime

Data da última ativação.

datetime

Data do último cancelamento.

datetime

Data do último bloqueio. Só com status ACTIVATED.

datetime

Data do último aviso. Só com status ACTIVATED.

uuid

Plano de cobrança da assinatura. Veja Planos.

object[]

Recursos da loja.

Mostrar propriedades

string

Tipo do recurso. Veja Sobre os recursos.

string

AVAILABLE, ACTIVATED ou CANCELLED.

datetime

Data da última contratação.

datetime

Data do último cancelamento. Só quando o recurso não está contratado.

uuid

ID do parceiro da loja.

uuid

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

Visão geral

Lojas

Revendas

Planos

Faturas

Cadastro

Referência

Requisição

Campos

​Requisição

​Campos

Requisição

Campos