API atual/Referência completa/Representantes comerciais

Sellers atendidos

Lista, atribui e remove os sellers que um representante do marketplace atende.

No modo marketplace, um representante atende vários sellers e ganha comissão sobre os pedidos deles. Esta tabela diz quais. (No modo do seller, a equipe de campo é de uma loja só e o vínculo é o owner_vendor_id.)

Listar os sellers atendidos

GET/api/v1/admin/trade-reps/{id}/vendorsAdmin

Lista os sellers atribuídos a um representante

Parâmetros de caminho

idintegerobrigatório

Id do representante.

200Sellers atendidos

json

{
  "total": 1,
  "vendors": [
    {
      "id": 5,
      "rep_id": 2,
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "vendor_name": "Loja Seller Teste",
      "assigned_at": "2026-07-14T23:35:59Z"
    }
  ]
}

Campos da resposta

vendorsarray

Vínculos.

vendors[].idinteger

Id do vínculo (não do seller).

vendors[].rep_idinteger

Representante.

vendors[].vendor_iduuid

Seller.

vendors[].vendor_namestring

Razão social do seller.

vendors[].assigned_atstring

Quando foi atribuído (RFC 3339).

totalinteger

Quantidade de vínculos.

Atribuir um seller

POST/api/v1/admin/trade-reps/{id}/vendorsAdmin

Atribui um seller ao representante

Parâmetros de caminho

idintegerobrigatório

Id do representante.

Corpo da requisição

vendor_iduuidobrigatório

Id do seller.

bash

curl -X POST "$BASE_URL/api/v1/admin/trade-reps/2/vendors" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36"}'

201Seller atribuído

json

{
  "id": 6,
  "rep_id": 2,
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "assigned_at": "2026-10-11T22:00:00Z"
}

Remover um seller

DELETE/api/v1/admin/trade-reps/{id}/vendors/{vendorId}Admin

Remove um seller do representante

Parâmetros de caminho

idintegerobrigatório

Id do representante.

vendorIduuidobrigatório

Id do seller.

200Removido

json

{ "status": "unassigned" }

Erros

Status	Quando	Corpo de exemplo
400	`id` não é inteiro.	`{"error":"invalid trade rep ID"}`
400	Falta `vendor_id`.	`{"error":"vendor_id is required"}`
404	Remoção de um seller que não estava atribuído.	`{"error":"vendor assignment not found"}`
409	O seller já está atribuído a esse representante.	`{"error":"vendor already assigned to this trade rep"}`
500	Seller ou representante não existe.	`{"error":"failed to assign vendor","detail":"..."}`
401 / 403	Sem token, módulo desligado ou sem privilégio.	`{"error":"module_disabled","module":"trade-reps"}`

Veja também

Sellers atendidos

Lista, atribui e remove os sellers que um representante do marketplace atende.

Listar os sellers atendidos

GET/api/v1/admin/trade-reps/{id}/vendorsAdmin

Lista os sellers atribuídos a um representante

Parâmetros de caminho

idintegerobrigatório

Id do representante.

200Sellers atendidos

json

{
  "total": 1,
  "vendors": [
    {
      "id": 5,
      "rep_id": 2,
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "vendor_name": "Loja Seller Teste",
      "assigned_at": "2026-07-14T23:35:59Z"
    }
  ]
}

Campos da resposta

vendorsarray

Vínculos.

vendors[].idinteger

Id do vínculo (não do seller).

vendors[].rep_idinteger

Representante.

vendors[].vendor_iduuid

Seller.

vendors[].vendor_namestring

Razão social do seller.

vendors[].assigned_atstring

Quando foi atribuído (RFC 3339).

totalinteger

Quantidade de vínculos.

Atribuir um seller

POST/api/v1/admin/trade-reps/{id}/vendorsAdmin

Atribui um seller ao representante

Parâmetros de caminho

idintegerobrigatório

Id do representante.

Corpo da requisição

vendor_iduuidobrigatório

Id do seller.

bash

curl -X POST "$BASE_URL/api/v1/admin/trade-reps/2/vendors" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36"}'

201Seller atribuído

json

{
  "id": 6,
  "rep_id": 2,
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "assigned_at": "2026-10-11T22:00:00Z"
}

Remover um seller

DELETE/api/v1/admin/trade-reps/{id}/vendors/{vendorId}Admin

Remove um seller do representante

Parâmetros de caminho

idintegerobrigatório

Id do representante.

vendorIduuidobrigatório

Id do seller.

200Removido

json

{ "status": "unassigned" }

Erros

Status	Quando	Corpo de exemplo
400	`id` não é inteiro.	`{"error":"invalid trade rep ID"}`
400	Falta `vendor_id`.	`{"error":"vendor_id is required"}`
404	Remoção de um seller que não estava atribuído.	`{"error":"vendor assignment not found"}`
409	O seller já está atribuído a esse representante.	`{"error":"vendor already assigned to this trade rep"}`
500	Seller ou representante não existe.	`{"error":"failed to assign vendor","detail":"..."}`
401 / 403	Sem token, módulo desligado ou sem privilégio.	`{"error":"module_disabled","module":"trade-reps"}`