Skip to content

Logísticas - Objetos

bling_erp_api.resources.logisticas_objetos.LogisticasObjetosResource 

LogisticasObjetosResource(transport: Transport)

Bases: BaseResource

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

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

obter 

obter(id_objeto: int) -> LogisticasObjetosIdObjetoGetResponse200

Obtém um objeto de logística.

Endpoint: GET /logisticas/objetos/{idObjeto}

Obtém um objeto de logística pelo ID.

Parameters:

Name Type Description Default
id_objeto int

ID do objeto logístico (Bling: idObjeto, integer, obrigatório)

 required

Returns:

Type Description
LogisticasObjetosIdObjetoGetResponse200

Bling API response. Response schemas: 200: LogisticasObjetosDadosDTO; 404: ErrorResponse
Source code in src/bling_erp_api/resources/logisticas_objetos.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def obter(self, id_objeto: int) -> LogisticasObjetosIdObjetoGetResponse200:
    """Obtém um objeto de logística.

    Endpoint: GET /logisticas/objetos/{idObjeto}

    Obtém um objeto de logística pelo ID.

    Args:
        id_objeto: ID do objeto logístico (Bling: ``idObjeto``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: LogisticasObjetosDadosDTO; 404: ErrorResponse
    """
    raw = self._get(f"/logisticas/objetos/{id_objeto}")
    return self._validate_response(LogisticasObjetosIdObjetoGetResponse200, raw)

criar 

criar(dados: JsonObject) -> LogisticasObjetosPostResponse201

Cria um objeto de logística.

Endpoint: POST /logisticas/objetos

Cria um objeto de logística personalizada.

Parameters:

Name Type Description Default
dados JsonObject

Dados do objeto (Bling: request body, object, obrigatório)

 required

Returns:

Type Description
LogisticasObjetosPostResponse201

Bling API response. Response schemas: 201: LogisticasObjetosObjetoDTO; 400: ErrorResponse
Source code in src/bling_erp_api/resources/logisticas_objetos.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def criar(self, dados: JsonObject) -> LogisticasObjetosPostResponse201:
    """Cria um objeto de logística.

    Endpoint: POST /logisticas/objetos

    Cria um objeto de logística personalizada.

    Args:
        dados: Dados do objeto (Bling: request body, object, obrigatório)

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

alterar 

alterar(
    id_objeto: int, dados: JsonObject
) -> LogisticasObjetosIdObjetoPutResponse200

Altera um objeto de logística.

Endpoint: PUT /logisticas/objetos/{idObjeto}

Altera dados de um objeto de logística personalizada pelo ID.

Parameters:

Name Type Description Default
id_objeto int

ID do objeto logístico (Bling: idObjeto, integer, obrigatório)

 required
dados JsonObject

Dados do objeto (Bling: request body, object, obrigatório)

 required

Returns:

Type Description
LogisticasObjetosIdObjetoPutResponse200

Bling API response. Response schemas: 200: LogisticasObjetosObjetoDTO; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/logisticas_objetos.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def alterar(self, id_objeto: int, dados: JsonObject) -> LogisticasObjetosIdObjetoPutResponse200:
    """Altera um objeto de logística.

    Endpoint: PUT /logisticas/objetos/{idObjeto}

    Altera dados de um objeto de logística personalizada pelo ID.

    Args:
        id_objeto: ID do objeto logístico (Bling: ``idObjeto``, integer, obrigatório)
        dados: Dados do objeto (Bling: request body, object, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: LogisticasObjetosObjetoDTO; 400: ErrorResponse; 404: ErrorResponse
    """
    raw = self._put(f"/logisticas/objetos/{id_objeto}", json=to_json_object(dados))
    return self._validate_response(LogisticasObjetosIdObjetoPutResponse200, raw)

remover 

remover(id_objeto: int) -> JsonObject

Remove um objeto de logística.

Endpoint: DELETE /logisticas/objetos/{idObjeto}

Remove um objeto de logística personalizada que não esteja em uma PLP.

Parameters:

Name Type Description Default
id_objeto int

ID do objeto logístico (Bling: idObjeto, 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_objetos.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def remover(self, id_objeto: int) -> JsonObject:
    """Remove um objeto de logística.

    Endpoint: DELETE /logisticas/objetos/{idObjeto}

    Remove um objeto de logística personalizada que não esteja em uma PLP.

    Args:
        id_objeto: ID do objeto logístico (Bling: ``idObjeto``, integer, obrigatório)

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