API legada/Referência completa/Produtos (REST)

Campos do produto

A referência completa dos campos do produto, com descrição, valor padrão e valores aceitos.

Um produto tem várias propriedades, representadas por campos. Esta página lista todos os campos aceitos, com descrição, valor padrão e valores aceitos.

Campos do produto

A tabela a seguir lista todos os campos disponíveis nos objetos de produto.

Campo	Descrição	Valor padrão	Valores aceitos
`product`*	Nome do produto	nenhum	string
`category_ids`*	IDs das categorias às quais o produto pertence	nenhum	Lista de IDs de categoria válidos
`main_category`*	ID da categoria principal	nenhum	ID de categoria existente
`price`*	Preço	0	float
`company_id`*	ID da loja ou do vendedor a que o produto pertence	ID da empresa padrão	integer
`status`*	Status do produto: `A` para Ativo, `D` para Desativado, `H` para Oculto	`A`	`A`, `D`, `H`
`amount`	Quantidade do produto em estoque	1	integer
`avail_since`	Data a partir da qual o produto está disponível	nenhum	Data em formato UNIX
`box_height`	Altura da caixa	0	integer
`box_length`	Comprimento da caixa	0	integer
`box_width`	Largura da caixa	0	integer
`details_layout`	Layout da página de detalhes do produto	`'default'`	Nome de modelo de produto válido
`edp_shipping`	Somente para produtos para download: ativa ou desativa o envio	`N`	`Y`, `N`
`exceptions_type`	Tipo de exceção: permitir (`A`, de Allow) ou proibir (`F`, de Forbid) produtos com certas combinações de opções	`F`	`A`, `F`
`feature_comparison`	Ativa ou desativa a inclusão do produto em uma lista de comparação de características	`N`	`Y`, `N`
`free_shipping`	Permite frete grátis	`N`	`Y`, `N`
`full_description`	Descrição completa do produto	`''`	string
`image_pairs`	Pares de imagens adicionais	lista vazia	Objeto com o ID do par de imagens como chave e o par de imagens como valor
`is_edp`	Indica se o produto é para download	`N`	`Y`, `N`
`lang_code`	Código do idioma	Código do idioma padrão	`en`, `ru` etc.
`list_price`	Preço sugerido pelo fabricante	0	float
`list_qty_count`	Número de itens na caixa de seleção de quantidade	0	integer
`localization`	Texto com IDs de localização separados por vírgula	`''`	string
`low_avail_limit`	Valor mínimo de disponibilidade em estoque	0	integer
`main_pair`	Par formado pela imagem completa e pela miniatura	lista vazia	Objeto de par principal (veja Campos do par principal abaixo)
`max_items_in_box`	Número máximo de itens por caixa	0	integer
`max_qty`	Quantidade máxima por pedido	0	integer
`meta_description`	Meta descrição	`''`	string
`meta_keywords`	Palavras-chave (meta)	`''`	string
`min_items_in_box`	Número mínimo de itens por caixa	0	integer
`min_qty`	Quantidade mínima por pedido	0	integer
`options_type`	Aplica as opções ao mesmo tempo (`P`) ou em sequência (`S`)	`P`	`S`, `P`
`out_of_stock_actions`	Ação para produto sem estoque: `N` para nenhuma, `B` para comprar antecipadamente, `S` para pedir aviso de reposição	`N`	`N`, `B`, `S`
`page_title`	Título da página do produto	`''`	string
`point_price`	Preço em pontos de recompensa	0	float
`popularity`	Índice de popularidade do produto, calculado a partir de visualizações, inclusões no carrinho e compras	3	integer
`product_code`	Código do produto	`''`	string
`product_features`	Características do produto	lista vazia	Objeto com as características do produto, tendo o ID da característica como chave e os dados da característica como valor
`product_id`	ID do produto	Definido automaticamente	integer
`promo_text`	Texto promocional	`''`	string
`qty_step`	Passo da quantidade	0	integer
`return_period`	Prazo de devolução, em dias	10	integer
`sales_amount`	Quantidade de vendas	0	integer
`search_words`	Palavras-chave de busca do produto	`''`	string
`seo_name`	Nome SEO da página do produto	`''`	string
`shared_product`	Indica se o produto é compartilhado	`N`	`Y`, `N`
`shipping_freight`	Frete do produto	0	float
`shipping_params`	Dados de envio agregados	Texto gerado automaticamente a partir dos dados de envio	string
`short_description`	Descrição curta	`''`	string
`tax_ids`	Lista de IDs de imposto	lista vazia	array
`timestamp`	Data e hora de criação	Definido automaticamente	Timestamp válido em formato UNIX
`tracking`	Modo de controle de estoque: `O` para controlar com opções, `B` para controlar sem opções, `D` para não controlar	`B`	`O`, `B`, `D`
`unlimited_download`	Para produtos EDP: permite ou não downloads ilimitados	`N`	`Y`, `N`
`updated_timestamp`	Data e hora da última atualização	Timestamp da última atualização, em segundos	Timestamp válido em formato UNIX
`usergroup_ids`	IDs dos grupos de usuários	`'0'`	Texto com IDs de grupos de usuários separados por vírgula
`weight`	Peso	0	float
`zero_price_action`	Ação para preço zero: `R` para não permitir que o cliente adicione o produto ao carrinho, `P` para permitir que o cliente adicione o produto ao carrinho, `A` para pedir que o cliente informe o preço	`R`	`R`, `P`, `A`

Campos do par principal

O objeto main_pair contém os campos a seguir. image_pairs guarda os pares adicionais, e cada um deles tem a mesma estrutura.

Campo	Descrição	Valor padrão	Valores aceitos
`detailed_id`	ID da imagem completa	Definido automaticamente	integer
`image_id`	ID da miniatura	0	integer
`pair_id`	ID do par de imagens	Definido automaticamente	integer
`position`	Posição do par de imagens entre os demais	0	integer
`icon`	Dados da miniatura	nenhum	objeto (semelhante a `detailed`)
`detailed`	Dados da imagem completa	nenhum	object
`absolute_path`	Caminho absoluto da imagem no sistema de arquivos	nenhum	Caminho de arquivo válido
`alt`	Texto alternativo (exibido se a imagem não carregar)	`''`	string
`http_image_path`	Caminho HTTP da imagem	nenhum	URL HTTP válida que aponta para a imagem
`image_path`	Caminho real da imagem (HTTP ou HTTPS; pode ser igual a `http_image_path`)	nenhum	URL válida que aponta para a imagem
`image_x`	Largura da imagem, em pixels	nenhum	integer
`image_y`	Altura da imagem	nenhum	integer

Exemplo de requisição de produto

json

{
  "product": "Premium Bluetooth Headphones",
  "category_ids": [12, 45],
  "main_category": 12,
  "price": 99.99,
  "status": "A",
  "company_id": 5,
  "product_code": "BT-HEAD-001",
  "short_description": "Noise-cancelling premium headphones with 24-hour battery life",
  "full_description": "Experience premium sound quality with our noise-cancelling Bluetooth headphones. Featuring 24-hour battery life, comfortable ear cushions, and crystal-clear sound.",
  "amount": 50,
  "weight": 0.35,
  "free_shipping": "Y",
  "is_edp": "N",
  "tracking": "B",
  "popularity": 9
}

Veja também

Campos do produto

A referência completa dos campos do produto, com descrição, valor padrão e valores aceitos.

Um produto tem várias propriedades, representadas por campos. Esta página lista todos os campos aceitos, com descrição, valor padrão e valores aceitos.

Campos do produto

A tabela a seguir lista todos os campos disponíveis nos objetos de produto.

Campo	Descrição	Valor padrão	Valores aceitos
`product`*	Nome do produto	nenhum	string
`category_ids`*	IDs das categorias às quais o produto pertence	nenhum	Lista de IDs de categoria válidos
`main_category`*	ID da categoria principal	nenhum	ID de categoria existente
`price`*	Preço	0	float
`company_id`*	ID da loja ou do vendedor a que o produto pertence	ID da empresa padrão	integer
`status`*	Status do produto: `A` para Ativo, `D` para Desativado, `H` para Oculto	`A`	`A`, `D`, `H`
`amount`	Quantidade do produto em estoque	1	integer
`avail_since`	Data a partir da qual o produto está disponível	nenhum	Data em formato UNIX
`box_height`	Altura da caixa	0	integer
`box_length`	Comprimento da caixa	0	integer
`box_width`	Largura da caixa	0	integer
`details_layout`	Layout da página de detalhes do produto	`'default'`	Nome de modelo de produto válido
`edp_shipping`	Somente para produtos para download: ativa ou desativa o envio	`N`	`Y`, `N`
`exceptions_type`	Tipo de exceção: permitir (`A`, de Allow) ou proibir (`F`, de Forbid) produtos com certas combinações de opções	`F`	`A`, `F`
`feature_comparison`	Ativa ou desativa a inclusão do produto em uma lista de comparação de características	`N`	`Y`, `N`
`free_shipping`	Permite frete grátis	`N`	`Y`, `N`
`full_description`	Descrição completa do produto	`''`	string
`image_pairs`	Pares de imagens adicionais	lista vazia	Objeto com o ID do par de imagens como chave e o par de imagens como valor
`is_edp`	Indica se o produto é para download	`N`	`Y`, `N`
`lang_code`	Código do idioma	Código do idioma padrão	`en`, `ru` etc.
`list_price`	Preço sugerido pelo fabricante	0	float
`list_qty_count`	Número de itens na caixa de seleção de quantidade	0	integer
`localization`	Texto com IDs de localização separados por vírgula	`''`	string
`low_avail_limit`	Valor mínimo de disponibilidade em estoque	0	integer
`main_pair`	Par formado pela imagem completa e pela miniatura	lista vazia	Objeto de par principal (veja Campos do par principal abaixo)
`max_items_in_box`	Número máximo de itens por caixa	0	integer
`max_qty`	Quantidade máxima por pedido	0	integer
`meta_description`	Meta descrição	`''`	string
`meta_keywords`	Palavras-chave (meta)	`''`	string
`min_items_in_box`	Número mínimo de itens por caixa	0	integer
`min_qty`	Quantidade mínima por pedido	0	integer
`options_type`	Aplica as opções ao mesmo tempo (`P`) ou em sequência (`S`)	`P`	`S`, `P`
`out_of_stock_actions`	Ação para produto sem estoque: `N` para nenhuma, `B` para comprar antecipadamente, `S` para pedir aviso de reposição	`N`	`N`, `B`, `S`
`page_title`	Título da página do produto	`''`	string
`point_price`	Preço em pontos de recompensa	0	float
`popularity`	Índice de popularidade do produto, calculado a partir de visualizações, inclusões no carrinho e compras	3	integer
`product_code`	Código do produto	`''`	string
`product_features`	Características do produto	lista vazia	Objeto com as características do produto, tendo o ID da característica como chave e os dados da característica como valor
`product_id`	ID do produto	Definido automaticamente	integer
`promo_text`	Texto promocional	`''`	string
`qty_step`	Passo da quantidade	0	integer
`return_period`	Prazo de devolução, em dias	10	integer
`sales_amount`	Quantidade de vendas	0	integer
`search_words`	Palavras-chave de busca do produto	`''`	string
`seo_name`	Nome SEO da página do produto	`''`	string
`shared_product`	Indica se o produto é compartilhado	`N`	`Y`, `N`
`shipping_freight`	Frete do produto	0	float
`shipping_params`	Dados de envio agregados	Texto gerado automaticamente a partir dos dados de envio	string
`short_description`	Descrição curta	`''`	string
`tax_ids`	Lista de IDs de imposto	lista vazia	array
`timestamp`	Data e hora de criação	Definido automaticamente	Timestamp válido em formato UNIX
`tracking`	Modo de controle de estoque: `O` para controlar com opções, `B` para controlar sem opções, `D` para não controlar	`B`	`O`, `B`, `D`
`unlimited_download`	Para produtos EDP: permite ou não downloads ilimitados	`N`	`Y`, `N`
`updated_timestamp`	Data e hora da última atualização	Timestamp da última atualização, em segundos	Timestamp válido em formato UNIX
`usergroup_ids`	IDs dos grupos de usuários	`'0'`	Texto com IDs de grupos de usuários separados por vírgula
`weight`	Peso	0	float
`zero_price_action`	Ação para preço zero: `R` para não permitir que o cliente adicione o produto ao carrinho, `P` para permitir que o cliente adicione o produto ao carrinho, `A` para pedir que o cliente informe o preço	`R`	`R`, `P`, `A`

Campos do par principal

O objeto main_pair contém os campos a seguir. image_pairs guarda os pares adicionais, e cada um deles tem a mesma estrutura.

Campo	Descrição	Valor padrão	Valores aceitos
`detailed_id`	ID da imagem completa	Definido automaticamente	integer
`image_id`	ID da miniatura	0	integer
`pair_id`	ID do par de imagens	Definido automaticamente	integer
`position`	Posição do par de imagens entre os demais	0	integer
`icon`	Dados da miniatura	nenhum	objeto (semelhante a `detailed`)
`detailed`	Dados da imagem completa	nenhum	object
`absolute_path`	Caminho absoluto da imagem no sistema de arquivos	nenhum	Caminho de arquivo válido
`alt`	Texto alternativo (exibido se a imagem não carregar)	`''`	string
`http_image_path`	Caminho HTTP da imagem	nenhum	URL HTTP válida que aponta para a imagem
`image_path`	Caminho real da imagem (HTTP ou HTTPS; pode ser igual a `http_image_path`)	nenhum	URL válida que aponta para a imagem
`image_x`	Largura da imagem, em pixels	nenhum	integer
`image_y`	Altura da imagem	nenhum	integer

Exemplo de requisição de produto

json

{
  "product": "Premium Bluetooth Headphones",
  "category_ids": [12, 45],
  "main_category": 12,
  "price": 99.99,
  "status": "A",
  "company_id": 5,
  "product_code": "BT-HEAD-001",
  "short_description": "Noise-cancelling premium headphones with 24-hour battery life",
  "full_description": "Experience premium sound quality with our noise-cancelling Bluetooth headphones. Featuring 24-hour battery life, comfortable ear cushions, and crystal-clear sound.",
  "amount": 50,
  "weight": 0.35,
  "free_shipping": "Y",
  "is_edp": "N",
  "tracking": "B",
  "popularity": 9
}