Ideal House
Pular para o conteúdo

Atualizar um Produto#

Atualiza um produto de forma síncrona. Identifique o produto com productId ou sku, juntamente com shopId. Forneça exatamente um identificador; solicitações que contenham ambos ou nenhum retornam 400 Bad Request.

http
PATCH https://sdkapi.ideal.house/product-import/products

O identificador é separado do objeto product. Isso permite que uma integração localize um produto pelo seu SKU atual e altere o SKU na mesma solicitação.

Use productId como identificador ao alterar um SKU. Isso mantém as retentativas desambiguadas caso a primeira solicitação atualize o SKU mas sua resposta seja perdida.

Corpo da Solicitação#

CampoTipoObrigatórioDescrição
shopIdstringSimShop ID fornecido por Ideal House.
productIdstringCondicionalID do produto para localizar. Obrigatório quando sku é omitido.
skustringCondicionalSKU atual para localizar. Obrigatório quando productId é omitido.
productobjectSimCampos a atualizar. Inclua pelo menos um campo.

Campos Editáveis do Produto#

Somente os campos incluídos em product são atualizados.

CampoTipoComprimento MáximoDescrição
skustring120Novo SKU. Deve permanecer único dentro da loja.
externalProductIdstring120Identificador externo do produto.
groupIdstring120Identificador do grupo de produtos.
collectionIdstring120Identificador da coleção de produtos.
namestring255Nome do produto.
titlestring255Título de exibição do produto.
brandstring120Marca do produto.
productTypestring120Tipo de produto na sua taxonomia.
normalizedProductTypestring40Tipo de produto normalizado. Coordene os valores suportados com Ideal House.
categorystring120Categoria do produto.
stylestring120Estilo do produto.
colorstring120Cor do produto.
availabilitystring40Valor de disponibilidade.
imageUrlstring1,000URL da imagem de origem pública HTTP ou HTTPS.
previewImageUrlstring1,000URL da imagem de visualização HTTP ou HTTPS.
productUrlstring1,000URL de detalhes do produto HTTP ou HTTPS.
attributesobjectAtributos do produto. Quando fornecido, este objeto substitui o objeto de atributos atual.
statusstringStatus do produto. O endpoint de atualização aceita active ou inactive.

Os seguintes campos são apenas leitura: id, shopId, productCode, createdAt e updatedAt. Use o endpoint de exclusão para definir o produto como invalid.

Atualizar por SKU#

json
{
  "shopId": "shop_123",
  "sku": "SKU-10001",
  "product": {
    "name": "Large Gold Wall Mirror",
    "color": "Antique Gold",
    "status": "active"
  }
}
bash
curl --request PATCH \
  'https://sdkapi.ideal.house/product-import/products' \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
  --header 'X-Client-Secret: <YOUR_CLIENT_SECRET>' \
  --data-raw '{
    "shopId": "shop_123",
    "sku": "SKU-10001",
    "product": {
      "name": "Large Gold Wall Mirror",
      "color": "Antique Gold",
      "status": "active"
    }
  }'

Atualizar por ID do Produto e Alterar o SKU#

json
{
  "shopId": "shop_123",
  "productId": "product_123",
  "product": {
    "sku": "SKU-10001-NEW",
    "name": "Large Gold Wall Mirror",
    "status": "inactive"
  }
}

Uma atualização bem-sucedida retorna 200 OK e o objeto completo do produto atualizado. Um produto inactive é mantido e permanece disponível através do endpoint Listar Produtos.