Membros da loja

Membros são os usuários com acesso ao painel da loja. Cada um tem um papel: owner, manager ou operator (veja Papéis de membros).

Ação	Endpoint	Sucesso
Listar	`GET /partner/v2/merchants/{merchantId}/members`	`200` ou `204`
Adicionar	`POST /partner/v2/merchants/{merchantId}/members`	`201`
Atualizar	`PATCH /partner/v2/merchants/{merchantId}/members/{memberId}`	`200`
Remover	`DELETE /partner/v2/merchants/{merchantId}/members/{memberId}`	`200`
Magic link	`POST /partner/v2/merchants/{merchantId}/members/{memberId}/magic-link`	`201`

Loja ou membro fora do alcance do token retorna 404.

O objeto membro

{
  "id": "b90a8ae0-9cf0-40ef-a295-b3f43db65076",
  "role": "MANAGER",
  "user": { "name": "João Souza", "email": "joao@exemplo.com.br" },
  "status": "ACTIVE"
}

uuid

ID do membro (não do usuário).

string

OWNER, MANAGER ou OPERATOR.

object

name e email do usuário.

string

ACTIVE: o usuário já tem acesso. INVITED: convite enviado para um e-mail que já tinha conta, aguardando aceite.

Listar membros

Traz os membros com acesso ativo. Convites pendentes não aparecem.

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

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

response = requests.get(
    f"https://api.deliveryvip.com.br/partner/v2/merchants/{merchant_id}/members",
    headers={"Authorization": f"Bearer {token}"},
)
members = [] if response.status_code == 204 else response.json()

Adicionar membro

string

obrigatório

Papel, em minúsculas: owner, manager ou operator.

string

obrigatório

Nome do usuário.

string

obrigatório

E-mail do usuário.

curl --request POST 'https://api.deliveryvip.com.br/partner/v2/merchants/{merchantId}/members' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "member": { "role": "manager" },
    "user": { "name": "João Souza", "email": "joao@exemplo.com.br" }
  }'

const response = await fetch(`https://api.deliveryvip.com.br/partner/v2/merchants/${merchantId}/members`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    member: { role: 'manager' },
    user: { name: 'João Souza', email: 'joao@exemplo.com.br' },
  }),
})
const member = await response.json()

response = requests.post(
    f"https://api.deliveryvip.com.br/partner/v2/merchants/{merchant_id}/members",
    headers={"Authorization": f"Bearer {token}"},
    json={
        "member": {"role": "manager"},
        "user": {"name": "João Souza", "email": "joao@exemplo.com.br"},
    },
)
member = response.json()

A resposta é sempre 201 Created com o membro, em um de dois formatos:

E-mail novo
E-mail com conta

A conta é criada e vinculada à loja na hora. O membro volta com status: ACTIVE. Para o primeiro acesso, gere um magic link.

Nenhuma conta é alterada e nenhum acesso é concedido: um convite é enviado para o e-mail e o membro volta com status: INVITED. Ele vira ACTIVE quando o dono da conta aceitar. O link do convite usa o domínio do painel do parceiro; sem domínio configurado, a resposta é 403 (partner must be setup a domain to user access).

O papel precisa ir em minúsculas. OWNER, em maiúsculas, é recusado com 422.

Atualizar membro

Troca o papel de um membro.

string

obrigatório

Novo papel, em minúsculas: owner, manager ou operator.

curl --request PATCH 'https://api.deliveryvip.com.br/partner/v2/merchants/{merchantId}/members/{memberId}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{ "member": { "role": "operator" } }'

Responde 200 OK com o membro atualizado, ou 422 se o papel for inválido.

Remover membro

Remove o acesso do membro à loja. Também serve para cancelar um convite pendente. A conta do usuário não é apagada.

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

Resposta (200)

{ "id": "b90a8ae0-9cf0-40ef-a295-b3f43db65076" }

MagicLink

Gera um link para o membro entrar no painel sem senha. Só funciona para membros ACTIVE.

curl --request POST 'https://api.deliveryvip.com.br/partner/v2/merchants/{merchantId}/members/{memberId}/magic-link' \
  --header 'Authorization: Bearer {token}'

Resposta (201)

{
  "magicLink": "https://painel.seudominio.com.br/magic-links/authenticate?em=...&sign_in_token=...",
  "magicLinkExpiresAt": "2025-10-23T07:33:23-03:00"
}

O link vale por 6 horas e é de uso único.
O host é o domínio do painel do parceiro. Sem domínio configurado, a resposta é 403 (partner must be setup a domain to user access).
O link não substitui o segundo fator: se a conta exige código por e-mail (o padrão) ou autenticação em dois fatores, abrir o link inicia esse desafio e o login só termina depois do código.

Visão geral

Lojas

Revendas

Planos

Faturas

Cadastro

Referência

O objeto membro

Listar membros

Adicionar membro

Atualizar membro

Remover membro

MagicLink

​O objeto membro

​Listar membros

​Adicionar membro

​Atualizar membro

​Remover membro

​MagicLink

O objeto membro

Listar membros

Adicionar membro

Atualizar membro

Remover membro

MagicLink