Skip to content

Logísticas - Remessas

bling_erp_api.resources.logisticas_remessas.LogisticasRemessasResource 

LogisticasRemessasResource(transport: Transport)

Bases: BaseResource

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

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 
141
142
143
def __init__(self, transport: Transport) -> None:
    """Create a resource bound to a transport."""
    self._transport = transport

listar_por_logistica 

listar_por_logistica(
    id_logistica: int,
) -> LogisticasIdLogisticaRemessasGetResponse200

Lista remessas de uma logística.

Endpoint: GET /logisticas/{idLogistica}/remessas

Obtém as remessas de postagem de 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
LogisticasIdLogisticaRemessasGetResponse200

Bling API response. Response schemas: 200: LogisticasRemessasDadosDTO; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/logisticas_remessas.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def listar_por_logistica(
    self, id_logistica: int
) -> LogisticasIdLogisticaRemessasGetResponse200:
    """Lista remessas de uma logística.

    Endpoint: GET /logisticas/{idLogistica}/remessas

    Obtém as remessas de postagem de uma logística pelo ID.

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

    Returns:
        Bling API response. Response schemas: 200: LogisticasRemessasDadosDTO; 400: ErrorResponse; 404: ErrorResponse
    """
    raw = self._get(f"/logisticas/{id_logistica}/remessas")
    return self._validate_response(LogisticasIdLogisticaRemessasGetResponse200, raw)

obter 

obter(id_remessa: int) -> LogisticasRemessasIdRemessaGetResponse200

Obtém uma remessa de postagem.

Endpoint: GET /logisticas/remessas/{idRemessa}

Obtém uma remessa de postagem pelo ID.

Parameters:

Name Type Description Default
id_remessa int

ID da remessa de postagem (Bling: idRemessa, integer, obrigatório)

 required

Returns:

Type Description
LogisticasRemessasIdRemessaGetResponse200

Bling API response. Response schemas: 200: LogisticasRemessasDadosBaseDTO; 404: ErrorResponse
Source code in src/bling_erp_api/resources/logisticas_remessas.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def obter(self, id_remessa: int) -> LogisticasRemessasIdRemessaGetResponse200:
    """Obtém uma remessa de postagem.

    Endpoint: GET /logisticas/remessas/{idRemessa}

    Obtém uma remessa de postagem pelo ID.

    Args:
        id_remessa: ID da remessa de postagem (Bling: ``idRemessa``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: LogisticasRemessasDadosBaseDTO; 404: ErrorResponse
    """
    raw = self._get(f"/logisticas/remessas/{id_remessa}")
    return self._validate_response(LogisticasRemessasIdRemessaGetResponse200, raw)

criar 

criar(dados: JsonObject) -> LogisticasRemessasPostResponse201

Cria uma remessa de postagem.

Endpoint: POST /logisticas/remessas

Cria uma remessa de postagem de uma logística.

Parameters:

Name Type Description Default
dados JsonObject

Dados da remessa (Bling: request body, object, obrigatório)

 required

Returns:

Type Description
LogisticasRemessasPostResponse201

Bling API response. Response schemas: 201: LogisticasRemessaRemessaDTO; 400: ErrorResponse
Source code in src/bling_erp_api/resources/logisticas_remessas.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def criar(self, dados: JsonObject) -> LogisticasRemessasPostResponse201:
    """Cria uma remessa de postagem.

    Endpoint: POST /logisticas/remessas

    Cria uma remessa de postagem de uma logística.

    Args:
        dados: Dados da remessa (Bling: request body, object, obrigatório)

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

alterar 

alterar(
    id_remessa: int, dados: JsonObject
) -> LogisticasRemessasIdRemessaPutResponse200

Altera uma remessa de postagem.

Endpoint: PUT /logisticas/remessas/{idRemessa}

Altera uma remessa de postagem pelo ID.

Parameters:

Name Type Description Default
id_remessa int

ID da remessa de postagem (Bling: idRemessa, integer, obrigatório)

 required
dados JsonObject

Dados da remessa (Bling: request body, object, obrigatório)

 required

Returns:

Type Description
LogisticasRemessasIdRemessaPutResponse200

Bling API response. Response schemas: 200: LogisticasRemessaRemessaDTO; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/logisticas_remessas.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def alterar(
    self, id_remessa: int, dados: JsonObject
) -> LogisticasRemessasIdRemessaPutResponse200:
    """Altera uma remessa de postagem.

    Endpoint: PUT /logisticas/remessas/{idRemessa}

    Altera uma remessa de postagem pelo ID.

    Args:
        id_remessa: ID da remessa de postagem (Bling: ``idRemessa``, integer, obrigatório)
        dados: Dados da remessa (Bling: request body, object, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: LogisticasRemessaRemessaDTO; 400: ErrorResponse; 404: ErrorResponse
    """
    raw = self._put(f"/logisticas/remessas/{id_remessa}", json=to_json_object(dados))
    return self._validate_response(LogisticasRemessasIdRemessaPutResponse200, raw)

remover 

remover(id_remessa: int) -> JsonObject

Remove uma remessa de postagem.

Endpoint: DELETE /logisticas/remessas/{idRemessa}

Remove uma remessa de postagem pelo ID.

Parameters:

Name Type Description Default
id_remessa int

ID da remessa de postagem (Bling: idRemessa, 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_remessas.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def remover(self, id_remessa: int) -> JsonObject:
    """Remove uma remessa de postagem.

    Endpoint: DELETE /logisticas/remessas/{idRemessa}

    Remove uma remessa de postagem pelo ID.

    Args:
        id_remessa: ID da remessa de postagem (Bling: ``idRemessa``, integer, obrigatório)

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