v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBMarketplace
Consulta os sellers
Retorna a lista de sellers vinculados à empresa autenticada, com suporte à pesquisa por nome ou CPF/CNPJ.
A busca por Nome ou CpfCnpj é feita com similaridade. Para busca exata por CPF/CNPJ, o valor deve conter apenas os dígitos, SEM pontos ou traços.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Nome | Texto | Parte do nome da seller a ser pesquisada | Não |
| CpfCnpj | Texto | CPF/CNPJ | Não |
| Page | Número | Número da página da consulta (paginação começa em 1) | Não (default = 1) |
Resposta
A resposta da requisição retorna um objeto com os dados de paginação e a lista de sellers encontrados.
Estrutura de resposta:
SellerConsultaResponse
| Campo | Tipo | Descrição |
|---|---|---|
| Pages | Número | Total de páginas disponíveis |
| Total | Número | Quantidade total de sellers encontrados |
| Items | Array[SellerConsultaItemResponse] | Lista dos sellers |
SellerConsultaItemResponse
| Campo | Tipo | Descrição |
|---|---|---|
| Id | Texto | ID do seller |
| Nome | Texto | Nome do seller |
| RazaoSocial | Texto | Razão Social (ou mesmo nome para pessoa física) |
| Pessoa | Texto | Tipo de pessoa: F (Física) ou J (Jurídica) |
| CPFCNPJ | Texto | CPF/CNPJ do seller |
| Titularidade | Texto | Nome exato do titular da conta |
| NomeCurto | Texto | Nome abreviado usado em notificações (ex: SMS) |
| Texto | Endereço de e-mail | |
| Telefone | Texto | Telefone com DDD no formato 00-0000-0000 |
| Cep | Texto | Código de Endereçamento Postal |
| Logradouro | Texto | Rua, avenida, etc |
| Complemento | Texto | Complemento do endereço |
| Numero | Texto | Número do endereço |
| Bairro | Texto | Nome do bairro |
| Cidade | Texto | Nome da cidade |
| UF | Texto | Unidade da federação (UF), ex: SP, RJ |
| Ativo | Booleano | Indica se o seller está ativo ou inativo |
| ContaDestinoId | Texto | Identificador único da conta destino cadastrada |
| CodigoBanco | Texto | Código do banco (padrão Febraban) |
| AgenciaConta | Texto | Número da agência |
| DigitoAgenciaConta | Texto | Dígito verificador da agência |
| NumeroConta | Texto | Número da conta |
| DigitoNumeroConta | Texto | Dígito verificador da conta |
get/api/marketplace/sellers
Query parameters
Nomestring
Parte do nome da seller que foi cadastrada
CpfCnpjstring
CPF ou CNPJ do seller
Pageinteger
Número da página da consulta
Headers
Aeskeystring required
Response
Lista dos seller cadastrados
Example response
{
"Items": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"ContaDestinoId": "00000000-0000-0000-0000-000000000000"
}
]
}