Retornar Parceiros
Esta rota será usada para buscar parceiros, este endpoint retorna um array contendo objetos de parceiros, classificados a partir do parceiro criado mais recentemente.
Se nenhum filtro for passado, será retornado um array de objetos contendo seus últimos 10 parceiros cadastrados.
GETv3/sub_sellers
Request Query Params
| Atributo | Tipo | Descrição |
|---|---|---|
| sub_seller_id | string | Filtrar por um ID de um parceiro específico. |
| status | string | Filtrar por status. Valores aceitos: active, inactive e pending |
| date_created | dateTime | Filtrar por data de criação. |
| date_updated | dateTime | Filtrar por data de atualização. |
| count | int32 | Retorna n objetos de parceiros. Máximo de 1.000 e padrão de 10. |
| page | int32 | Útil para implementar uma paginação de resultados. |
Dica
As propriedades date_created e date_updated podem ser usadas para filtrar pesquisas de intervalo de datas usando os seguintes atributos:
| Atributo | Descrição |
|---|---|
| < | menor que |
| > | maior que |
| <= | menor ou igual a |
| >= | maior ou igual a |
curl -X GET -G "https://api.marlim.co/v3/sub_sellers" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created=">=1620086400000" \
-d date_created="<=1620172799000"
Atenção
A filtragem de data usa unixTimeStamp em milissegundos para representá-la. Para gerar o unixTimeStamp de uma data, você pode usar o console do Google Chrome com o seguinte código em Javascript: new Date("2023-01-01T00:00:00.000Z").getTime() que retornará 1672531200000.
Response Object
Ao buscar parceiros, é retornado um objeto com 4 propriedades: total, page, offset e sellers.
| Atributo | Tipo | Descrição |
|---|---|---|
| total | int32 | Total de parceiros que atendem ao filtro passado na consulta. |
| page | int32 | Página atual referente ao offset de páginas. |
| offset | int32 | Total de páginas para count dividido por total de parceiros retornados na consulta. |
| sub_sellers | array | Array de objetos contendo os parceiros. |
Exemplo de Response Object
{
"total": 1,
"page": 1,
"offset": 1,
"sub_sellers": [
{
"status": "active",
"sub_seller_id": "s_k4m6Rw5rlQszEY7fiuRe",
"name": "Empresa Jedi",
"date_created": "2025-07-07T19:26:42.779Z",
"date_updated": "2025-07-07T20:26:42.779Z",
"business_name": "Empresa Jedi LTDA",
"social_name": "Empresa Jedi",
"email": "contato@empresajedi.com.br",
"document": "12345678000190",
"automatic_anticipation_enabled": true,
"phone_number": {
"ddd": "11",
"number": "999999999"
},
"main_address": {
"zip_code": "01234567",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Centro",
"street": "Rua Jedi",
"number": "123",
"complementary": "Sala 45"
},
"managing_partner": {
"name": "Luke Skywalker",
"document": "12345678900",
"birthdate": "01/01/1980",
"phone_number": {
"ddd": "11",
"number": "988888888"
},
"address": {
"zip_code": "01234567",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Centro",
"street": "Rua Jedi",
"number": "123",
"complementary": "Apto 45"
}
},
"bank_account": {
"bank": "001",
"agency": "1234",
"agency_digit": "5",
"account_number": "123456",
"account_digit": "7",
"type": "checking",
"pix": {
"type": "email",
"key": "contato@empresajedi.com.br"
}
}
},
]
}
Array SubSellers
Se a resposta da consulta for maior ou igual a 1, dentro da propriedade sub_sellers, este é o array de objetos que sua aplicação recebe como resposta. Se o filtro utilizado não encontrar nenhum parceiro, um array vazio será retornado.
| Atributo | Tipo | Descrição |
|---|---|---|
| status | string | Status do parceiro. Valores possíveis: active, inactive ou pending. |
| sub_seller_id | string | ID do parceiro. |
| name | string | Nome do parceiro. |
| date_created | dateTime | Data de criação do parceiro no formato ISODateTime. |
| date_updated | dateTime | Data de atualização do parceiro no formato ISODateTime. |
| business_name | string | Razão Social do parceiro. |
| social_name | string | Nome Fantasia do parceiro. |
| string | E-mail do parceiro. | |
| document | string | CNPJ do parceiro. |
| automatic_anticipation_enabled | boolean | Indica se o recebedor receberá antecipações automaticamente. |
| phone_number | object | Objeto Telefone do parceiro. |
| main_address | object | Objeto Endereço principal do parceiro. |
| managing_partner | object | Objeto Sócio administrador do parceiro. |
| bank_account | object | Objeto Conta bancária do parceiro. |
Exemplos
- 10 últimos parceiros
- Parceiro não encontrado
curl -X GET -G "https://api.marlim.co/v3/sub_sellers" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
{
"total": 150,
"page": 1,
"offset": 15,
"sub_sellers": [
{
"status": "active",
"sub_seller_id": "s_k4m6Rw5rlQszEY7fiuRe",
"name": "Empresa Jedi",
"date_created": "2025-08-27T15:32:46.057Z",
"date_updated": "2025-08-27T16:32:46.057Z",
"business_name": "Empresa Jedi LTDA",
"social_name": "Empresa Jedi",
"email": "contato@empresajedi.com.br",
"automatic_anticipation_enabled": true,
"document": "12345678000190",
"phone_number": {
"ddd": "11",
"number": "999999999"
},
"main_address": {
"zip_code": "01234567",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Centro",
"street": "Rua Jedi",
"number": "123",
"complementary": "Sala 45"
},
"managing_partner": {
"name": "Luke Skywalker",
"document": "12345678900",
"birthdate": "01/01/1980",
"phone_number": {
"ddd": "11",
"number": "988888888"
},
"address": {
"zip_code": "01234567",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Centro",
"street": "Rua Jedi",
"number": "123",
"complementary": "Apto 45"
}
},
"bank_account": {
"bank": "001",
"agency": "1234",
"agency_digit": "5",
"account_number": "123456",
"account_digit": "7",
"type": "checking",
"pix": {
"type": "email",
"key": "contato@empresajedi.com.br"
}
}
},
{
"+9n": "..."
}
]
}
curl -X GET -G "https://api.marlim.co/v3/sub_sellers" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d sub_seller_id="sub_123456789"
{
"errors": {
"type": "Sub Seller with id [ sub_123456789 ] was not found."
}
}