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.
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#
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
shopId | string | Sim | Shop ID fornecido por Ideal House. |
productId | string | Condicional | ID do produto para localizar. Obrigatório quando sku é omitido. |
sku | string | Condicional | SKU atual para localizar. Obrigatório quando productId é omitido. |
product | object | Sim | Campos a atualizar. Inclua pelo menos um campo. |
Campos Editáveis do Produto#
Somente os campos incluídos em product são atualizados.
| Campo | Tipo | Comprimento Máximo | Descrição |
|---|---|---|---|
sku | string | 120 | Novo SKU. Deve permanecer único dentro da loja. |
externalProductId | string | 120 | Identificador externo do produto. |
groupId | string | 120 | Identificador do grupo de produtos. |
collectionId | string | 120 | Identificador da coleção de produtos. |
name | string | 255 | Nome do produto. |
title | string | 255 | Título de exibição do produto. |
brand | string | 120 | Marca do produto. |
productType | string | 120 | Tipo de produto na sua taxonomia. |
normalizedProductType | string | 40 | Tipo de produto normalizado. Coordene os valores suportados com Ideal House. |
category | string | 120 | Categoria do produto. |
style | string | 120 | Estilo do produto. |
color | string | 120 | Cor do produto. |
availability | string | 40 | Valor de disponibilidade. |
imageUrl | string | 1,000 | URL da imagem de origem pública HTTP ou HTTPS. |
previewImageUrl | string | 1,000 | URL da imagem de visualização HTTP ou HTTPS. |
productUrl | string | 1,000 | URL de detalhes do produto HTTP ou HTTPS. |
attributes | object | — | Atributos do produto. Quando fornecido, este objeto substitui o objeto de atributos atual. |
status | string | — | Status 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#
{
"shopId": "shop_123",
"sku": "SKU-10001",
"product": {
"name": "Large Gold Wall Mirror",
"color": "Antique Gold",
"status": "active"
}
}
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#
{
"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.