Criar um novo produto

API's Conta Azul Pro (v2)

API para gerenciamento de dados do ERP Conta Azul Pro

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

https://developers.contaazul.com/_mock/openapi/

Servidor de produção

https://api-public.contaazul.com/

Autenticação

Operations

Cobranças

Operations

Contratos

Operations

Centro de Custo

Operations

Categorias

Operations

Conta Financeira

Operations

Financeiro

Operations

Produto

Operations

Obter produtos por filtro

Request

Query

paginainteger

Default 1

tamanho_paginainteger

Default 10

campo_ordenacaostring

Default "NOME"

Enum"NOME""CODIGO""VALOR_VENDA""ESTOQUE"

direcao_ordenacaostring

Direção da ordenação (ASC para ascendente, DESC para descendente).

Default "ASC"

Enum"ASC""DESC"

Bodyapplication/jsonrequired

buscastring

Example: "exemplo de busca"

statusstringrequired

Enum"ATIVO""INATIVO""TODOS"

Example: "ATIVO"

intervalo_valor_vendaobject

curl -i -X POST \
  'https://developers.contaazul.com/_mock/openapi/v1/produto/busca?campo_ordenacao=NOME&direcao_ordenacao=ASC&pagina=1&tamanho_pagina=10' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "busca": "exemplo de busca",
    "status": "ATIVO",
    "intervalo_valor_venda": {
      "min": 10,
      "max": 100
    }
  }'

Responses

Resposta bem-sucedida

Bodyapplication/json

itensArray of objects

itens_totaisinteger

Example: 1

Response

application/json

{
  "itens": [
    { … }
  ],
  "itens_totais": 1
}

Criar um novo produto

Request

Bodyapplication/jsonrequired

Ao cadastrar um novo produto, deve-se observar o formato do produto. Caso o formato seja VARIACAO, o item "variação" é obrigatório.

nomestring

Example: "Nome do Produto"

codigo_skustring

Example: "SKU12345"

codigo_eanstring

Example: "1234567890123"

observacaostring

Example: "Descrição do produto"

formatostring

Enum"SIMPLES""VARIACAO"

Example: "VARIACAO"

estoqueobject

dimensaoobject

variacaoobject

curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/produto \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "nome": "Nome do Produto",
    "codigo_sku": "SKU12345",
    "codigo_ean": "1234567890123",
    "observacao": "Descrição do produto",
    "formato": "VARIACAO",
    "estoque": {
      "quantidade": 100,
      "localizacao": "Armazém A"
    },
    "dimensao": {
      "altura": 10,
      "largura": 5,
      "profundidade": 2
    },
    "variacao": {
      "tipos": [
        {
          "descricao": "Tamanho",
          "opcoes": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "descricao": "G"
            }
          ]
        }
      ],
      "produtos": [
        {
          "nome": "Produto Variado - Tamanho G",
          "codigo": "PROD123",
          "codigo_ean": "1234567890123",
          "versao": 1,
          "valor_venda": 99.99,
          "estoque": 50,
          "opcoes": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "descricao": "G"
            }
          ]
        }
      ]
    }
  }'

Responses

Produto criado com sucesso

Bodyapplication/json

idstring(uuid)

Example: "123e4567-e89b-12d3-a456-426614174000"

identificador_legadostring

Example: "legacy-id-123"

ativoboolean

Example: true

versaointeger

Example: 1

nomestring

Example: "Nome do Produto"

codigo_skustring

Example: "PROD123"

codigo_eanstring

Example: "1234567890123"

observacaostring

Example: "Descrição do Produto"

statusstring

Status do produto

Enum"ATIVO""INATIVO"

Example: "ATIVO"

formatostring

Formato do produto.

Enum"SIMPLES""VARIACAO"

Example: "VARIACAO"

estoqueobject

dimensoesobject

ecommerceobject

variacaoobject

Response

application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "identificador_legado": "legacy-id-123",
  "ativo": true,
  "versao": 1,
  "nome": "Nome do Produto",
  "codigo_sku": "PROD123",
  "codigo_ean": "1234567890123",
  "observacao": "Descrição do Produto",
  "status": "ATIVO",
  "formato": "VARIACAO",
  "estoque": {
    "estoque_total": 100,
    "valor_venda": 99.99,
    "custo_medio": 50,
    "estoque_disponivel": 80,
    "estoque_minimo": 10,
    "estoque_maximo": 200
  },
  "dimensoes": {
    "altura": 10,
    "largura": 5,
    "profundidade": 2
  },
  "ecommerce": {
    "condicao": "NOVO",
    "integracao_ativa": true,
    "descricao_adicional": "Descrição adicional do produto",
    "titulo_seo": "Título SEO",
    "descricao_seo": "Descrição SEO",
    "url_seo": "url-seo"
  },
  "variacao": {
    "tipos": [ … ],
    "produtos": [ … ]
  }
}

Atualizar um produto existente

Request

Path

idstring(uuid)required

Bodyapplication/jsonrequired

ativoboolean

Example: true

versaointeger

Example: 1

nomestring

Example: "Nome do Produto Atualizado"

codigostring

Example: "PROD123"

codigo_eanstring

Example: "1234567890123"

observacaostring

Example: "Descrição do Produto Atualizada"

statusstring

Status do produto

Enum"ATIVO""INATIVO"

Example: "ATIVO"

formatostring

Enum"SIMPLES""VARIACAO"

Example: "VARIACAO"

grupoobject

estoqueobject

fiscalobject

dimensaoobject

ecommerceobject

curl -i -X PUT \
  'https://developers.contaazul.com/_mock/openapi/v1/produto/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "ativo": true,
    "versao": 1,
    "nome": "Nome do Produto Atualizado",
    "codigo": "PROD123",
    "codigo_ean": "1234567890123",
    "observacao": "Descrição do Produto Atualizada",
    "status": "ATIVO",
    "formato": "VARIACAO",
    "grupo": {
      "id": 14689,
      "name": "Categoria de Produto",
      "uuid": "34471cce-67a2-48b8-a526-1120c0704ed3"
    },
    "estoque": {
      "estoque_reservado": 0,
      "estoque_total": 100,
      "valor_venda": 99.99,
      "custo_medio": 50,
      "estoque_disponivel": 75
    },
    "fiscal": {
      "unidade_medida": {
        "id": 8161,
        "descricao": "Un"
      }
    },
    "dimensao": {
      "altura": 10,
      "largura": 5,
      "profundidade": 2
    },
    "ecommerce": {
      "condicao": "NOVO",
      "integracao_habilitada": false,
      "observacao_adicional": "Descrição adicional....",
      "titulo_seo": "Produto 1.0",
      "descricao": "Lorem ipsum",
      "url_seo": "produto-x-1-0"
    }
  }'

Responses

Produto atualizado com sucesso

Bodyapplication/json

idstring(uuid)

Example: "123e4567-e89b-12d3-a456-426614174000"

identificador_legadostring

Example: "legacy-id-123"

ativoboolean

Example: true

versaointeger

Example: 1

nomestring

Example: "Nome do Produto"

codigo_skustring

Example: "PROD123"

codigo_eanstring

Example: "1234567890123"

observacaostring

Example: "Descrição do Produto"

statusstring

Status do produto

Enum"ATIVO""INATIVO"

Example: "ATIVO"

formatostring

Formato do produto.

Enum"SIMPLES""VARIACAO"

Example: "VARIACAO"

estoqueobject

dimensoesobject

ecommerceobject

variacaoobject

Response

application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "identificador_legado": "legacy-id-123",
  "ativo": true,
  "versao": 1,
  "nome": "Nome do Produto",
  "codigo_sku": "PROD123",
  "codigo_ean": "1234567890123",
  "observacao": "Descrição do Produto",
  "status": "ATIVO",
  "formato": "VARIACAO",
  "estoque": {
    "estoque_total": 100,
    "valor_venda": 99.99,
    "custo_medio": 50,
    "estoque_disponivel": 80,
    "estoque_minimo": 10,
    "estoque_maximo": 200
  },
  "dimensoes": {
    "altura": 10,
    "largura": 5,
    "profundidade": 2
  },
  "ecommerce": {
    "condicao": "NOVO",
    "integracao_ativa": true,
    "descricao_adicional": "Descrição adicional do produto",
    "titulo_seo": "Título SEO",
    "descricao_seo": "Descrição SEO",
    "url_seo": "url-seo"
  },
  "variacao": {
    "tipos": [ … ],
    "produtos": [ … ]
  }
}

Excluir um produto existente

Request

Path

idstring(uuid)required

curl -i -X DELETE \
  'https://developers.contaazul.com/_mock/openapi/v1/produto/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Produto excluído com sucesso

Desativar produtos

Request

Desativa uma lista de produtos pelo ID.

Bodyapplication/jsonrequiredArray [

string(uuid)

Lista de IDs dos produtos a serem desativados.

]

curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/produto/desativar \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    "123e4567-e89b-12d3-a456-426614174000",
    "34471cce-67a2-48b8-a526-1120c0704ed3"
  ]'

Responses

Produtos desativados com sucesso.

Bodyapplication/json

todosArray of strings(uuid)

Lista de todos os produtos.

produtos_desativadosArray of strings(uuid)

Lista de produtos desativados.

Response

application/json

{
  "todos": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "produtos_desativados": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

Cadastro de Pessoas

Operations

Protocolo

Operations

Venda

Operations

Serviço

Operations

API's Conta Azul Pro (v2)

Autenticação

Cobranças

Contratos

Centro de Custo

Categorias

Conta Financeira

Financeiro

Produto

Obter produtos por filtro

Request

Responses

Was this helpful?

Criar um novo produto

Request

Responses

Was this helpful?

Atualizar um produto existente

Request

Responses

Was this helpful?

Excluir um produto existente

Request

Responses

Was this helpful?

Desativar produtos

Request

Responses

Was this helpful?

Cadastro de Pessoas

Protocolo

Venda

Serviço

API's Conta Azul Pro (v2)

Autenticação

Cobranças

Contratos

Centro de Custo

Categorias

Conta Financeira

Financeiro

Produto

Obter produtos por filtro

RequestExpand all

Responses

Was this helpful?

Criar um novo produto

RequestExpand all

Responses

Was this helpful?

Atualizar um produto existente

RequestExpand all

Responses

Was this helpful?

Excluir um produto existente

Request

Responses

Was this helpful?

Desativar produtos

Request

Responses

Was this helpful?

Cadastro de Pessoas

Protocolo

Venda

Serviço

Request

Request

Request