Logísticas - Serviços

bling_erp_api.resources.logisticas_servicos.LogisticasServicosResource

LogisticasServicosResource(transport: Transport)

Bases: BaseResource

Operações de serviços de logísticas do Bling. Mapeia /logisticas/servicos.

Métodos canônicos em pt-BR. Aliases em inglês disponíveis para compatibilidade.

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 = 1, limite: int = 100, tipo_integracao: str | None = None
) -> LogisticasServicosGetResponse200

Lista serviços de logísticas.

Endpoint: GET /logisticas/servicos

Lista serviços de logísticas cadastrados com paginação.

Parameters:

Name	Type	Description	Default
pagina	int	Número da página (Bling: pagina, integer, opcional)	1
limite	int	Quantidade por página (Bling: limite, integer, opcional)	100
tipo_integracao	str | None	Tipo de integração (Bling: tipoIntegracao, string, opcional)	None

Returns:

Type	Description
LogisticasServicosGetResponse200	Bling API response. Response schemas: 200: LogisticasServicosDadosDTO; 400: ErrorResponse

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

def listar(
    self,
    *,
    pagina: int = 1,
    limite: int = 100,
    tipo_integracao: str | None = None,
) -> LogisticasServicosGetResponse200:
    """Lista serviços de logísticas.

    Endpoint: GET /logisticas/servicos

    Lista serviços de logísticas cadastrados com paginação.

    Args:
        pagina: Número da página (Bling: ``pagina``, integer, opcional)
        limite: Quantidade por página (Bling: ``limite``, integer, opcional)
        tipo_integracao: Tipo de integração (Bling: ``tipoIntegracao``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: LogisticasServicosDadosDTO; 400: ErrorResponse
    """
    params = compact_params(
        {"pagina": pagina, "limite": limite, "tipoIntegracao": tipo_integracao}
    )
    raw = self._get("/logisticas/servicos", params=params)
    return self._validate_response(LogisticasServicosGetResponse200, raw)

obter

obter(
    id_logistica_servico: int,
) -> LogisticasServicosIdLogisticaServicoGetResponse200

Obtém um serviço de logística.

Endpoint: GET /logisticas/servicos/{idLogisticaServico}

Obtém um serviço de logística pelo ID.

Parameters:

Name	Type	Description	Default
id_logistica_servico	int	ID do serviço (Bling: idLogisticaServico, integer, obrigatório)	required

Returns:

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

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

def obter(
    self, id_logistica_servico: int
) -> LogisticasServicosIdLogisticaServicoGetResponse200:
    """Obtém um serviço de logística.

    Endpoint: GET /logisticas/servicos/{idLogisticaServico}

    Obtém um serviço de logística pelo ID.

    Args:
        id_logistica_servico: ID do serviço (Bling: ``idLogisticaServico``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: LogisticasServicosDadosDTO; 404: ErrorResponse
    """
    raw = self._get(f"/logisticas/servicos/{id_logistica_servico}")
    return self._validate_response(LogisticasServicosIdLogisticaServicoGetResponse200, raw)

criar

criar(
    dados: LogisticasServicosDadosCreateRequestDTO,
) -> LogisticasServicosPostResponse201

Cria um serviço de logística.

Endpoint: POST /logisticas/servicos

Cria um novo serviço de logística personalizada.

Parameters:

Name	Type	Description	Default
dados	LogisticasServicosDadosCreateRequestDTO	Dados do serviço (Bling: request body, object, obrigatório)	required

Returns:

Type	Description
LogisticasServicosPostResponse201	Bling API response. Response schemas: 201: LogisticasServicosDadosSaveDTO; 400: ErrorResponse

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

def criar(
    self, dados: LogisticasServicosDadosCreateRequestDTO
) -> LogisticasServicosPostResponse201:
    """Cria um serviço de logística.

    Endpoint: POST /logisticas/servicos

    Cria um novo serviço de logística personalizada.

    Args:
        dados: Dados do serviço (Bling: request body, object, obrigatório)

    Returns:
        Bling API response. Response schemas: 201: LogisticasServicosDadosSaveDTO; 400: ErrorResponse
    """
    raw = self._post("/logisticas/servicos", json=to_json_object(dados))
    return self._validate_response(LogisticasServicosPostResponse201, raw)

alterar

alterar(
    id_logistica_servico: int, dados: LogisticasServicosDadosSaveRequestDTO
) -> LogisticasServicosIdLogisticaServicoPutResponse200

Altera um serviço de logística.

Endpoint: PUT /logisticas/servicos/{idLogisticaServico}

Altera dados de um serviço de logística personalizada pelo ID.

Parameters:

Name	Type	Description	Default
id_logistica_servico	int	ID do serviço (Bling: idLogisticaServico, integer, obrigatório)	required
dados	LogisticasServicosDadosSaveRequestDTO	Dados do serviço (Bling: request body, object, obrigatório)	required

Returns:

Type	Description
LogisticasServicosIdLogisticaServicoPutResponse200	Bling API response. Response schemas: 200: LogisticasServicosDadosSaveDTO; 400: ErrorResponse; 404: ErrorResponse

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

def alterar(
    self, id_logistica_servico: int, dados: LogisticasServicosDadosSaveRequestDTO
) -> LogisticasServicosIdLogisticaServicoPutResponse200:
    """Altera um serviço de logística.

    Endpoint: PUT /logisticas/servicos/{idLogisticaServico}

    Altera dados de um serviço de logística personalizada pelo ID.

    Args:
        id_logistica_servico: ID do serviço (Bling: ``idLogisticaServico``, integer, obrigatório)
        dados: Dados do serviço (Bling: request body, object, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: LogisticasServicosDadosSaveDTO; 400: ErrorResponse; 404: ErrorResponse
    """
    raw = self._put(f"/logisticas/servicos/{id_logistica_servico}", json=to_json_object(dados))
    return self._validate_response(LogisticasServicosIdLogisticaServicoPutResponse200, raw)

alterar_situacao

alterar_situacao(id_logistica_servico: int, ativo: bool) -> JsonObject

Ativa ou desativa um serviço de logística.

Endpoint: PATCH /logisticas/{idLogisticaServico}/situacoes

Desativa ou ativa um serviço de uma logística personalizada pelo ID.

Parameters:

Name	Type	Description	Default
id_logistica_servico	int	ID do serviço (Bling: idLogisticaServico, integer, obrigatório)	required
ativo	bool	Ativar ou desativar (Bling: request body, boolean, obrigatório)	required

Returns:

Type	Description
JsonObject	Bling API response. Response schemas: 400: ErrorResponse; 404: ErrorResponse

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

def alterar_situacao(self, id_logistica_servico: int, ativo: bool) -> JsonObject:  # noqa: FBT001
    """Ativa ou desativa um serviço de logística.

    Endpoint: PATCH /logisticas/{idLogisticaServico}/situacoes

    Desativa ou ativa um serviço de uma logística personalizada pelo ID.

    Args:
        id_logistica_servico: ID do serviço (Bling: ``idLogisticaServico``, integer, obrigatório)
        ativo: Ativar ou desativar (Bling: request body, boolean, obrigatório)

    Returns:
        Bling API response. Response schemas: 400: ErrorResponse; 404: ErrorResponse
    """
    return self._patch(
        f"/logisticas/{id_logistica_servico}/situacoes",
        json=to_json_object({"ativo": ativo}),
    )