Logísticas

bling_erp_api.resources.logisticas.LogisticasResource

LogisticasResource(transport: Transport)

Bases: BaseResource

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

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,
    tipos_integracoes: list[str] | None = None,
    situacao: str | None = None,
    logisticas_reversas: bool | None = None,
) -> LogisticasGetResponse200

Lista logísticas.

Endpoint: GET /logisticas

Lista logísticas cadastradas 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
tipos_integracoes	list[str] | None	Lista de tipos de integração (Bling: tiposIntegracoes[], array, opcional)	None
situacao	str | None	Situação (Bling: situacao, string, opcional)	None
logisticas_reversas	bool | None	Apenas logísticas reversas (Bling: logisticasReversas, boolean, opcional)	None

Returns:

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

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

def listar(  # noqa: PLR0913
    self,
    *,
    pagina: int = 1,
    limite: int = 100,
    tipo_integracao: str | None = None,
    tipos_integracoes: list[str] | None = None,
    situacao: str | None = None,
    logisticas_reversas: bool | None = None,
) -> LogisticasGetResponse200:
    """Lista logísticas.

    Endpoint: GET /logisticas

    Lista logísticas cadastradas 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)
        tipos_integracoes: Lista de tipos de integração (Bling: ``tiposIntegracoes[]``, array, opcional)
        situacao: Situação (Bling: ``situacao``, string, opcional)
        logisticas_reversas: Apenas logísticas reversas (Bling: ``logisticasReversas``, boolean, opcional)

    Returns:
        Bling API response. Response schemas: 200: LogisticasDadosBaseDTO; 404: ErrorResponse
    """
    params: QueryParams = {
        "pagina": pagina,
        "limite": limite,
        **_logisticas_list_params(
            tipo_integracao=tipo_integracao,
            tipos_integracoes=tipos_integracoes,
            situacao=situacao,
            logisticas_reversas=logisticas_reversas,
        ),
    }
    raw = self._get("/logisticas", params=params)
    return self._validate_response(LogisticasGetResponse200, raw)

obter

obter(
    id_logistica: int, *, listar_servicos_inativos: bool | None = None
) -> LogisticasIdLogisticaGetResponse200

Obtém uma logística.

Endpoint: GET /logisticas/{idLogistica}

Obtém uma logística pelo ID.

Parameters:

Name	Type	Description	Default
id_logistica	int	ID da logística (Bling: idLogistica, integer, obrigatório)	required
listar_servicos_inativos	bool | None	Incluir serviços inativos (Bling: listarServicosInativos, boolean, opcional)	None

Returns:

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

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

def obter(
    self, id_logistica: int, *, listar_servicos_inativos: bool | None = None
) -> LogisticasIdLogisticaGetResponse200:
    """Obtém uma logística.

    Endpoint: GET /logisticas/{idLogistica}

    Obtém uma logística pelo ID.

    Args:
        id_logistica: ID da logística (Bling: ``idLogistica``, integer, obrigatório)
        listar_servicos_inativos: Incluir serviços inativos (Bling: ``listarServicosInativos``, boolean, opcional)

    Returns:
        Bling API response. Response schemas: 200: LogisticasDadosDTO; 404: ErrorResponse
    """
    params = compact_params({"listarServicosInativos": listar_servicos_inativos})
    raw = self._get(f"/logisticas/{id_logistica}", params=params)
    return self._validate_response(LogisticasIdLogisticaGetResponse200, raw)

criar

criar(dados: JsonObject) -> LogisticasPostResponse201

Cria uma logística.

Endpoint: POST /logisticas

Cria uma nova logística.

Parameters:

Name	Type	Description	Default
dados	JsonObject	Dados da logística (Bling: request body, object, obrigatório)	required

Returns:

Type	Description
LogisticasPostResponse201	Bling API response. Response schemas: 201: LogisticasLogisticaDTO; 400: ErrorResponse

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

def criar(self, dados: JsonObject) -> LogisticasPostResponse201:
    """Cria uma logística.

    Endpoint: POST /logisticas

    Cria uma nova logística.

    Args:
        dados: Dados da logística (Bling: request body, object, obrigatório)

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

alterar

alterar(id_logistica: int, dados: JsonObject) -> JsonObject

Altera uma logística.

Endpoint: PUT /logisticas/{idLogistica}

Altera uma logística pelo ID.

Parameters:

Name	Type	Description	Default
id_logistica	int	ID da logística (Bling: idLogistica, integer, obrigatório)	required
dados	JsonObject	Dados da logística (Bling: request body, object, obrigatório)	required

Returns:

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

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

def alterar(self, id_logistica: int, dados: JsonObject) -> JsonObject:
    """Altera uma logística.

    Endpoint: PUT /logisticas/{idLogistica}

    Altera uma logística pelo ID.

    Args:
        id_logistica: ID da logística (Bling: ``idLogistica``, integer, obrigatório)
        dados: Dados da logística (Bling: request body, object, obrigatório)

    Returns:
        Bling API response. Response schemas: 400: ErrorResponse
    """
    return self._put(f"/logisticas/{id_logistica}", json=to_json_object(dados))

remover

remover(id_logistica: int) -> JsonObject

Remove uma logística.

Endpoint: DELETE /logisticas/{idLogistica}

Remove uma logística pelo ID.

Parameters:

Name	Type	Description	Default
id_logistica	int	ID da logística (Bling: idLogistica, integer, 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.py

def remover(self, id_logistica: int) -> JsonObject:
    """Remove uma logística.

    Endpoint: DELETE /logisticas/{idLogistica}

    Remove uma logística pelo ID.

    Args:
        id_logistica: ID da logística (Bling: ``idLogistica``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 400: ErrorResponse; 404: ErrorResponse
    """
    return self._delete(f"/logisticas/{id_logistica}")