Abbiamo DocsListar filiais
Lista todas as filiais (sellers) cadastradas na conta.
Conceito relacionado
Entenda o conceito no guia: Filial (Seller).
Header obrigatório. Toda chamada exige o header x-abbiamo-seller-group-key.
Preencha-o no canto superior direito desta página ou veja como obter a sua chave.
Rate limit: 300 requisições por minuto por chave. Acima disso a API retorna HTTP 429.
Este endpoint retorna suas filiais paginadas, com page_size padrão de 10 resultados por página.
É fácil paginar os resultados usando o campo has_next_page. Considerando todos os campos presentes na resposta, recomendamos uma das duas abordagens:
- se page < total_pages
- se has_next_page
{
"page": 1,
"page_size": 10,
"total_pages": 9,
"has_next_page": true,
"total_results": 86,
"results": [...]
}Authorization
sellerGroupKey x-abbiamo-seller-group-key<token>
In: header
Query Parameters
page?integer
Número da página para buscar resultados
Default
1Format
int32page_size?integer
Quantidade de resultados por página
Default
10Format
int32Response Body
application/json
application/json
curl -X GET "https://example.com/seller-group/v1/sellers"{
"page": 1,
"page_size": 2,
"total_pages": 7,
"has_next_page": true,
"total_results": 13,
"results": [
{
"id": "6cd78cb2-f55e-4207-8e79-2f7c66e3f0d4",
"identifier": "12345678000190",
"trading_name": "Example Trading",
"document_number": "12345678000190",
"email": "john.doe@example.com",
"document_type": "CNPJ",
"country": "BRA",
"phone": "21988887777",
"active": true,
"address": {
"country": "BRA",
"zip_code": "22793081",
"state": "RJ",
"city": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"street": "123 Main Street",
"street_number": "456",
"complement": "Apt 789",
"reference": "Proximo ao parque",
"latitude": -22.930140003064,
"longitude": -43.23429998161
}
},
{
"id": "93b7dea3-6acd-4237-9e69-d1358b41a9c5",
"identifier": "12345678000190",
"trading_name": "Go Go Fruits",
"document_number": "12345678000190",
"email": "contato@exemplo.com.br",
"document_type": "CNPJ",
"country": "BRA",
"phone": "21999999999",
"active": true,
"address": {
"zip_code": "04029904",
"country": "BRA",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Indianópolis",
"street": "Avenida Ibirapuera",
"street_number": "3407",
"complement": null,
"reference": null,
"latitude": -23.52045997445427,
"longitude": -46.438805678513575
}
}
]
}{
"status_code": 401,
"timestamp": "2024-08-30T20:15:21.447Z",
"message": "Please provide a valid Abbiamo Token",
"code": "HTTP_EXCEPTION",
"error_id": "fe18678b-254b-462e-8761-ba17cbabf54f"
}