Skip to content

Categorias de Anúncios

bling_erp_api.resources.ad_categories.AdCategoriesResource 

AdCategoriesResource(transport: Transport)

Bases: BaseResource

Operações de categorias de anúncios do Bling.

Este recurso mapeia os endpoints /anuncios/categorias. Os métodos canônicos usam português para acompanhar a documentação oficial; os métodos em inglês continuam disponíveis como aliases de 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 

listar(
    *,
    tipo_integracao: str,
    id_loja: int,
    id_categoria: int | None = None,
    tipo_produto: str | None = None,
) -> JsonObject

Lista categorias de anúncios.

Endpoint: GET /anuncios/categorias

Obtém categorias de anúncios.

Parameters:

Name Type Description Default
tipo_integracao str

Tipo de integração (Bling: tipoIntegracao, string, obrigatório)

 required
id_loja int

ID da loja (Bling: idLoja, integer, obrigatório)

 required
id_categoria int | None

ID da categoria (Bling: idCategoria, integer, opcional)

 None
tipo_produto str | None

Tipo do produto (Bling: tipoProduto, string, opcional)

 None

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 200: AnunciosCategoriaDTO; 400: ErrorResponse
Source code in src/bling_erp_api/resources/ad_categories.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def listar(
    self,
    *,
    tipo_integracao: str,
    id_loja: int,
    id_categoria: int | None = None,
    tipo_produto: str | None = None,
) -> JsonObject:
    """Lista categorias de anúncios.

    Endpoint: GET /anuncios/categorias

    Obtém categorias de anúncios.

    Args:
        tipo_integracao: Tipo de integração (Bling: ``tipoIntegracao``, string, obrigatório)
        id_loja: ID da loja (Bling: ``idLoja``, integer, obrigatório)
        id_categoria: ID da categoria (Bling: ``idCategoria``, integer, opcional)
        tipo_produto: Tipo do produto (Bling: ``tipoProduto``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: AnunciosCategoriaDTO; 400: ErrorResponse
    """
    params: QueryParams = {
        "tipoIntegracao": tipo_integracao,
        "idLoja": id_loja,
        **_ad_categories_list_params(id_categoria=id_categoria, tipo_produto=tipo_produto),
    }
    return self._get("/anuncios/categorias", params=params)

obter 

obter(id_categoria: str, *, tipo_integracao: str, id_loja: int) -> JsonObject

Obtém uma categoria de anúncio com atributos.

Endpoint: GET /anuncios/categorias/{idCategoria}

Obtém uma categoria de anúncio pelo ID com seus atributos.

Parameters:

Name Type Description Default
id_categoria str

ID da categoria no marketplace (Bling: idCategoria, string, obrigatório)

 required
tipo_integracao str

Tipo de integração (Bling: tipoIntegracao, string, obrigatório)

 required
id_loja int

ID da loja (Bling: idLoja, integer, obrigatório)

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 200: AnunciosGetAttributesFromCategoryResponseDTO; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/ad_categories.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
def obter(
    self,
    id_categoria: str,
    *,
    tipo_integracao: str,
    id_loja: int,
) -> JsonObject:
    """Obtém uma categoria de anúncio com atributos.

    Endpoint: GET /anuncios/categorias/{idCategoria}

    Obtém uma categoria de anúncio pelo ID com seus atributos.

    Args:
        id_categoria: ID da categoria no marketplace (Bling: ``idCategoria``, string, obrigatório)
        tipo_integracao: Tipo de integração (Bling: ``tipoIntegracao``, string, obrigatório)
        id_loja: ID da loja (Bling: ``idLoja``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: AnunciosGetAttributesFromCategoryResponseDTO; 400: ErrorResponse; 404: ErrorResponse
    """
    params = compact_params(
        {
            "tipoIntegracao": tipo_integracao,
            "idLoja": id_loja,
        }
    )
    return self._get(f"/anuncios/categorias/{id_categoria}", params=params)