Vendedores

bling_erp_api.resources.vendedores.VendedoresResource

VendedoresResource(transport: Transport)

Bases: BaseResource

Vendedores API resource. Maps to /vendedores endpoints.

Provides operations for sellers (vendedores) in the Bling API. Canonical methods are in pt-BR following the official Bling documentation; English aliases are available for compatibility.

Source code in src/bling_erp_api/resources/base.py

def __init__(self, transport: Transport) -> None:
    """Create a resource bound to a transport."""
    self._transport = transport

listar

listar(
    *,
    pagina: int | None = None,
    limite: int | None = None,
    nome_contato: str | None = None,
    situacao_contato: str | None = None,
    id_contato: int | None = None,
    id_loja: int | None = None,
    data_alteracao_inicial: str | None = None,
    data_alteracao_final: str | None = None,
) -> VendedoresGetResponse200

Lista os vendedores.

Endpoint: GET /vendedores

Obtém uma lista paginada de vendedores cadastrados. Aceita filtros opcionais para refinar a consulta.

Parameters:

Name	Type	Description	Default
pagina	int | None	N° da página da listagem (Bling: pagina, integer, opcional)	None
limite	int | None	Quantidade de registros por página (Bling: limite, integer, opcional)	None
nome_contato	str | None	Nome do contato para filtro (Bling: nomeContato, string, opcional)	None
situacao_contato	str | None	Situação do contato para filtro (Bling: situacaoContato, string, opcional, [A Ativo, I Inativo, S Sem movimento, E Excluído, T Todos])	None
id_contato	int | None	ID do contato para filtro (Bling: idContato, integer, opcional)	None
id_loja	int | None	ID da loja para filtro (Bling: idLoja, integer, opcional)	None
data_alteracao_inicial	str | None	Data de alteração inicial (Bling: dataAlteracaoInicial, string, opcional)	None
data_alteracao_final	str | None	Data de alteração final (Bling: dataAlteracaoFinal, string, opcional)	None

Returns:

Type	Description
VendedoresGetResponse200	Bling API response. Response schemas: 200: VendedoresGetResponse200; 404: ErrorResponse

Source code in src/bling_erp_api/resources/vendedores.py

def listar(  # noqa: PLR0913
    self,
    *,
    pagina: int | None = None,
    limite: int | None = None,
    nome_contato: str | None = None,
    situacao_contato: str | None = None,
    id_contato: int | None = None,
    id_loja: int | None = None,
    data_alteracao_inicial: str | None = None,
    data_alteracao_final: str | None = None,
) -> VendedoresGetResponse200:
    """Lista os vendedores.

    Endpoint: GET /vendedores

    Obtém uma lista paginada de vendedores cadastrados. Aceita filtros
    opcionais para refinar a consulta.

    Args:
        pagina: N° da página da listagem (Bling: ``pagina``, integer, opcional)
        limite: Quantidade de registros por página (Bling: ``limite``, integer, opcional)
        nome_contato: Nome do contato para filtro (Bling: ``nomeContato``, string, opcional)
        situacao_contato: Situação do contato para filtro (Bling: ``situacaoContato``, string, opcional, [`A` Ativo, `I` Inativo, `S` Sem movimento, `E` Excluído, `T` Todos])
        id_contato: ID do contato para filtro (Bling: ``idContato``, integer, opcional)
        id_loja: ID da loja para filtro (Bling: ``idLoja``, integer, opcional)
        data_alteracao_inicial: Data de alteração inicial (Bling: ``dataAlteracaoInicial``, string, opcional)
        data_alteracao_final: Data de alteração final (Bling: ``dataAlteracaoFinal``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: VendedoresGetResponse200; 404: ErrorResponse
    """
    params = _vendedores_list_params(
        pagina=pagina,
        limite=limite,
        nome_contato=nome_contato,
        situacao_contato=situacao_contato,
        id_contato=id_contato,
        id_loja=id_loja,
        data_alteracao_inicial=data_alteracao_inicial,
        data_alteracao_final=data_alteracao_final,
    )
    raw = self._get(self.BASE_PATH, params=params)
    return VendedoresGetResponse200.model_validate(raw)

obter

obter(id_vendedor: int) -> VendedoresIdVendedorGetResponse200

Obtém um vendedor pelo ID.

Endpoint: GET /vendedores/{idVendedor}

Obtém os dados de um vendedor específico pelo seu ID.

Parameters:

Name	Type	Description	Default
id_vendedor	int	ID do vendedor (Bling: idVendedor, integer, obrigatório)	required

Returns:

Name	Type	Description
	VendedoresIdVendedorGetResponse200	Bling API response. Response schemas: 200: VendedoresIdVendedorGetResponse200;
404	VendedoresIdVendedorGetResponse200	ErrorResponse

Source code in src/bling_erp_api/resources/vendedores.py

def obter(self, id_vendedor: int) -> VendedoresIdVendedorGetResponse200:
    """Obtém um vendedor pelo ID.

    Endpoint: GET /vendedores/{idVendedor}

    Obtém os dados de um vendedor específico pelo seu ID.

    Args:
        id_vendedor: ID do vendedor (Bling: ``idVendedor``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: VendedoresIdVendedorGetResponse200;
        404: ErrorResponse
    """
    raw = self._get(f"{self.BASE_PATH}/{id_vendedor}")
    try:
        return VendedoresIdVendedorGetResponse200.model_validate(raw)
    except ValidationError:
        if raw == {"data": []}:
            return VendedoresIdVendedorGetResponse200(data=None)
        raise

list

list(
    *,
    page: int | None = None,
    limit: int | None = None,
    contact_name: str | None = None,
    contact_status: str | None = None,
    contact_id: int | None = None,
    store_id: int | None = None,
    updated_start: str | None = None,
    updated_end: str | None = None,
) -> VendedoresGetResponse200

Compatibility alias for listar().

Lista os vendedores.

Endpoint: GET /vendedores

Obtém uma lista paginada de vendedores cadastrados. Aceita filtros opcionais para refinar a consulta.

Parameters:

Name	Type	Description	Default
page	int | None	N° da página da listagem (Bling: pagina, integer, opcional)	None
limit	int | None	Quantidade de registros por página (Bling: limite, integer, opcional)	None
contact_name	str | None	Nome do contato para filtro (Bling: nomeContato, string, opcional)	None
contact_status	str | None	Situação do contato para filtro (Bling: situacaoContato, string, opcional)	None
contact_id	int | None	ID do contato para filtro (Bling: idContato, integer, opcional)	None
store_id	int | None	ID da loja para filtro (Bling: idLoja, integer, opcional)	None
updated_start	str | None	Data de alteração inicial (Bling: dataAlteracaoInicial, string, opcional)	None
updated_end	str | None	Data de alteração final (Bling: dataAlteracaoFinal, string, opcional)	None

Returns:

Type	Description
VendedoresGetResponse200	Bling API response. Response schemas: 200: VendedoresGetResponse200; 404: ErrorResponse

Source code in src/bling_erp_api/resources/vendedores.py

def list(  # noqa: PLR0913
    self,
    *,
    page: int | None = None,
    limit: int | None = None,
    contact_name: str | None = None,
    contact_status: str | None = None,
    contact_id: int | None = None,
    store_id: int | None = None,
    updated_start: str | None = None,
    updated_end: str | None = None,
) -> VendedoresGetResponse200:
    """Compatibility alias for ``listar()``.

    Lista os vendedores.

    Endpoint: GET /vendedores

    Obtém uma lista paginada de vendedores cadastrados. Aceita filtros
    opcionais para refinar a consulta.

    Args:
        page: N° da página da listagem (Bling: ``pagina``, integer, opcional)
        limit: Quantidade de registros por página (Bling: ``limite``, integer, opcional)
        contact_name: Nome do contato para filtro (Bling: ``nomeContato``, string, opcional)
        contact_status: Situação do contato para filtro (Bling: ``situacaoContato``, string, opcional)
        contact_id: ID do contato para filtro (Bling: ``idContato``, integer, opcional)
        store_id: ID da loja para filtro (Bling: ``idLoja``, integer, opcional)
        updated_start: Data de alteração inicial (Bling: ``dataAlteracaoInicial``, string, opcional)
        updated_end: Data de alteração final (Bling: ``dataAlteracaoFinal``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: VendedoresGetResponse200; 404: ErrorResponse
    """
    return self.listar(
        pagina=page,
        limite=limit,
        nome_contato=contact_name,
        situacao_contato=contact_status,
        id_contato=contact_id,
        id_loja=store_id,
        data_alteracao_inicial=updated_start,
        data_alteracao_final=updated_end,
    )

get

get(seller_id: int) -> VendedoresIdVendedorGetResponse200

Compatibility alias for obter().

Obtém um vendedor pelo ID.

Endpoint: GET /vendedores/{idVendedor}

Obtém os dados de um vendedor específico pelo seu ID.

Parameters:

Name	Type	Description	Default
seller_id	int	ID do vendedor (Bling: idVendedor, integer, obrigatório)	required

Returns:

Name	Type	Description
	VendedoresIdVendedorGetResponse200	Bling API response. Response schemas: 200: VendedoresIdVendedorGetResponse200;
404	VendedoresIdVendedorGetResponse200	ErrorResponse

Source code in src/bling_erp_api/resources/vendedores.py

def get(self, seller_id: int) -> VendedoresIdVendedorGetResponse200:
    """Compatibility alias for ``obter()``.

    Obtém um vendedor pelo ID.

    Endpoint: GET /vendedores/{idVendedor}

    Obtém os dados de um vendedor específico pelo seu ID.

    Args:
        seller_id: ID do vendedor (Bling: ``idVendedor``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: VendedoresIdVendedorGetResponse200;
        404: ErrorResponse
    """
    return self.obter(id_vendedor=seller_id)