Listar filiais

Lista todas as filiais (sellers) cadastradas na conta.

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.

It's easy to paginate through results using the has_next_page field. Considering all the fields containing in the response, we recommend one of the two approaches the possibilities are:

  • if page < total_pages
  • if has_next_page
{
  "page": 1,
  "page_size": 10,
  "total_pages": 9,
  "has_next_page": true,
  "total_results": 86,
  "results": [...]
}
GET
/seller-group/v1/sellers
x-abbiamo-seller-group-key<token>

In: header

Query Parameters

page?integer

Número da pÔgina para buscar resultados

Default1
Formatint32
page_size?integer

Quantidade de resultados por pƔgina

Default10
Formatint32

Response Body

application/json

application/json

curl -X GET "https://example.com/seller-group/v1/sellers"
"{\n  \"page\": 1,\n  \"page_size\": 2,\n  \"total_pages\": 7,\n  \"has_next_page\": true,\n  \"total_results\": 13,\n  \"results\": [\n    {\n      \"id\": \"6cd78cb2-f55e-4207-8e79-2f7c66e3f0d4\",\n      \"identifier\": \"71955998000126\",\n      \"trading_name\": \"Example Trading\",\n      \"document_number\": \"71955998000126\",\n      \"email\": \"john.doe@example.com\",\n      \"document_type\": \"CNPJ\",\n      \"country\": \"BRA\",\n      \"phone\": \"21988887777\",\n      \"active\": true,\n      \"address\": {\n        \"country\": \"BRA\",\n        \"zip_code\": \"22793081\",\n        \"state\": \"RJ\",\n        \"city\": \"Rio de Janeiro\",\n        \"neighborhood\": \"Barra da Tijuca\",\n        \"street\": \"123 Main Street\",\n        \"street_number\": \"456\",\n        \"complement\": \"Apt 789\",\n        \"reference\": \"Proximo ao parque\",\n        \"latitude\": -22.930140003064,\n        \"longitude\": -43.23429998161\n      }\n    },\n    {\n      \"id\": \"93b7dea3-6acd-4237-9e69-d1358b41a9c5\",\n      \"identifier\": \"54857486000108\",\n      \"trading_name\": \"Go Go Fruits\",\n      \"document_number\": \"54857486000108\",\n      \"email\": \"silveiradudu@gmail.com\",\n      \"document_type\": \"CNPJ\",\n      \"country\": \"BRA\",\n      \"phone\": \"21967591314\",\n      \"active\": true,\n      \"address\": {\n        \"zip_code\": \"04029904\",\n        \"country\": \"BRA\",\n        \"state\": \"SP\",\n        \"city\": \"São Paulo\",\n        \"neighborhood\": \"Indianópolis\",\n        \"street\": \"Avenida Ibirapuera\",\n        \"street_number\": \"3407\",\n        \"complement\": null,\n        \"reference\": null,\n        \"latitude\": -23.52045997445427,\n        \"longitude\": -46.438805678513575\n      }\n    }\n  ]\n}"
"{\n  \"status_code\": 401,\n  \"timestamp\": \"2024-08-30T20:15:21.447Z\",\n  \"message\": \"Please provide a valid Abbiamo Token\",\n  \"code\": \"HTTP_EXCEPTION\",\n  \"error_id\": \"fe18678b-254b-462e-8761-ba17cbabf54f\"\n}"