Sign in

v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Catálogo - Produtos

Atualizar produto

Atualiza um produto específico

put/{alias}/catalog/products/{id}

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do produto

Request body

simpleboolean required

Produto possui ou não variações

brand_idinteger required

ID da marca

erp_idinteger

ID de ERP

activeboolean required

Indica se o produto está ativo

searchableboolean

Indica se o produto é buscável

is_digitalboolean

Indica se o produto é digital

buy_similarsboolean

Sugerir carrossel de produtos similares na compra

priorityinteger

Nível de relevância (1 ->Padrão, 2 -> Média, 3 -> Alta)

ratinginteger

Nota de avaliação do produto definida manualmente (quando não calculada a partir das avaliações de clientes).

ncmstring

Código NCM

namestring required

Nome do produto. O valor é sanitizado e normalizado automaticamente.

slugstring

Utilizado em URL e listagens

videostring

Vídeo do produto

descriptionstring

Descrição do produto. O valor é sanitizado e normalizado automaticamente.

specificationsstring

Especificações do produto. O valor é sanitizado e normalizado automaticamente.

measuresstring

Medidas do produto (ex: 10x20x30 cm). O valor é sanitizado e normalizado automaticamente.

gift_valuenumber float

Valor de presente associado ao produto

seo_titlestring

Título do produto para SEO

seo_descriptionstring

Descrição do produto para SEO

seo_keywordsstring

Palavras-chave para SEO

canonical_urlstring

URL canônica do produto

google_categorystring

Categoria Google do produto

search_termsstring

Termos extras de busca do produto

categories_idsinteger[]

IDs das categorias vinculadas

flags_idsinteger[]

IDs das flags vinculadas

filters_values_idsinteger[]

IDs dos valores de filtros vinculados

variations_idsinteger[]

IDs das variações do produto

similars_idsinteger[]

IDs de produtos similares

collections_idsinteger[]

IDs das coleções vinculadas

Example request

{
  "simple": true,
  "active": true,
  "searchable": true,
  "is_digital": true,
  "buy_similars": true,
  "rating": 4,
  "slug": "nome-do-produto",
  "skus": [
    {
      "quantity_managed": true,
      "blocked_sale": true
    }
  ],
  "create_redirect": {
    "url_from": "/produto-antigo",
    "url_to": "/produto-novo"
  }
}

Response

Produto atualizado com sucesso

idinteger

Identificador único do produto.

merchant_idinteger

ID da loja

affiliation_idinteger

ID de afiliação do produto

erp_idinteger

ID do produto no ERP

seller_idinteger

ID do vendedor

activeboolean

Indica se o produto está ativo

searchableboolean

Indica se o produto é buscável

is_digitalboolean

Indica se o produto é digital

ratinginteger

Nota média de avaliação do produto.

priorityinteger

Nível de relevância (1 -> Padrão, 2 -> Média, 3 -> Alta)

ncmstring

Código NCM do produto

namestring

Nome do produto

slugstring

Slug (URL amigável) do produto

warrantyinteger

Garantia em meses

custom_shippingboolean

Indica se o Frete é customizado

shipping_pricenumber float

Valor do frete customizado em reais

gift_valuenumber float

Valor de presente (se aplicável)

simpleboolean

Indica se o produto é simples

Example response

{
  "id": 12345678,
  "merchant_id": 1,
  "active": true,
  "searchable": true,
  "is_digital": true,
  "rating": 4,
  "slug": "nome-do-produto",
  "custom_shipping": true,
  "shipping_price": 39.9,
  "simple": true
}