API Reference

Entidade product

Tipos de Produto

Na Get Commerce, existem dois tipos principais de produtos que podem ser cadastrados via API. Abaixo, uma breve explicação sobre cada um deles:

Produto Simples

Este é o tipo de produto mais básico e amplamente utilizado em lojas virtuais. O termo "simples" não indica falta de detalhes no cadastro, mas sim a ausência de variações adicionais como cor e tamanho. O produto simples é ideal para cadastrar itens únicos, sem variações.

Exemplos incluem: TV LCD 32'', armário, violão, DVD de algum show, caneca, entre outros.

Produto simples "Relógio Diesel Stand Out DZ4396/1PN"

Produto simples "Relógio Diesel Stand Out DZ4396/1PN"


Produtos Configuráveis (com Variações)

Esse tipo de produto é utilizado quando você precisa cadastrar um item praticamente idêntico, mas que varia em um aspecto, como tamanho.

Um exemplo comum é o cadastro de uma camiseta em diferentes tamanhos: P, M, G e GG (ou seja, um conjunto de produtos iguais com variação apenas no tamanho).

As variações destes produtos são criadas como Produtos Simples que deverão ter os atributos de variação preenchidos. No produto acima, por exemplo, os produtos simples precisariam ter os atributos "cor" e "tamanho" para serem associados ao configurável.

📘

Importante!

Os atributos de variação (ex.: "cor" e "tamanho") de um produto configurável devem ser do tipo select.
Saiba mais aqui: Atributos de Produtos

Campos

Abaixo, segue a descrição dos possíveis campos e seus valores nas requisições desta entidade.

CampoCampo PaiTipoDescrição
entity_id *-intIdentificador único do produto
name *-stringNome do produto
sku *-stringCódigo do produto
price *-floatPreço principal do produto. Casas decimais separadas por .
special_price-floatPreço promocional do produto. Casas decimais separadas por .. Deve ser menor que o preço principal
url_path *-stringURL path do produto na loja
description *-htmlDescrição completa do produto (exibida ao final das páginas de produto)
short_description * -htmlDescrição curta do produto (exibida abaixo do nome do produto nas páginas de produto)
weight *-floatPeso do produto (em Kg). Casas decimais separadas por .
type_id *-stringTipo do produto

simple - Simples
configurable - Configurável
grouped - Agrupado
bundle - Pacote de Produtos
virtual - Produto Virtual
downloadable - Produto Digital
status *-intStatus do produto

1 - Habilitado
2 - Desabilitado
visibility *-intVisibilidade do produto

1 - Não exibir individualmente
2 - Catálogo
3 - Buscar
4 - Catálogo, Busca
category_ids-arrayIDs das categorias às quais o produto está associados. Saiba mais em: Categorias
attributes-attributes_objectAtributos adicionais/personalizados do produto. Saiba mais em: Produtos - Atributos
stock-stock_objectInformações acerca do estoque do produto. Saiba mais em: Produtos - Estoque

attributes_object

Atributos adicionais/personalizados do produto.

📘

Abaixo estão listados os atributos padrões que estarão presentes em todos os sistemas. É possível que cada sistema possua outros atributos condizentes com suas necessidades.

CódigoCampo PaiTipoDescrição
mgs_brandattributesstringMarca do produto
volume_alturaattributesstringAltura do volume do produto (em cm)
volume_comprimentoattributesstringComprimento do volume do produto (em cm)
volume_larguraattributesstringLargura do volume do produto (em cm)