Ideal House
Aller au contenu principal

Mettre à jour un produit#

Met à jour un produit de manière synchrone. Identifiez le produit à l'aide de productId ou de sku, conjointement avec shopId. Fournissez exactement un identifiant ; les requêtes contenant les deux ou aucun identifiant retournent 400 Bad Request.

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

L'identifiant est distinct de l'objet product. Cela permet à une intégration de localiser un produit par son SKU actuel et de modifier le SKU dans la même requête.

Utilisez productId comme identifiant lors du changement d'un SKU. Cela garde les nouvelles tentatives non ambiguës si la première requête met à jour le SKU mais que sa réponse est perdue.

Corps de la requête#

ChampTypeRequisDescription
shopIdstringOuiShop ID fourni par Ideal House.
productIdstringConditionnelID de produit à localiser. Requis lorsque sku est omis.
skustringConditionnelSKU actuel à localiser. Requis lorsque productId est omis.
productobjectOuiChamps à mettre à jour. Incluez au moins un champ.

Champs de produit éditables#

Seuls les champs inclus dans product sont mis à jour.

ChampTypeLongueur maximaleDescription
skustring120Nouveau SKU. Il doit rester unique au sein de la boutique.
externalProductIdstring120Identifiant externe du produit.
groupIdstring120Identifiant de groupe de produits.
collectionIdstring120Identifiant de collection de produits.
namestring255Nom du produit.
titlestring255Titre d'affichage du produit.
brandstring120Marque du produit.
productTypestring120Type de produit selon votre taxonomie.
normalizedProductTypestring40Type de produit normalisé. Convenez des valeurs prises en charge avec Ideal House.
categorystring120Catégorie du produit.
stylestring120Style du produit.
colorstring120Couleur du produit.
availabilitystring40Valeur de disponibilité.
imageUrlstring1,000URL de l'image source publique HTTP ou HTTPS.
previewImageUrlstring1,000URL de l'image d'aperçu HTTP ou HTTPS.
productUrlstring1,000URL de détail du produit HTTP ou HTTPS.
attributesobjectAttributs du produit. Lorsqu'il est fourni, cet objet remplace l'objet attributs actuel.
statusstringStatut du produit. Le point de terminaison de mise à jour accepte active ou inactive.

Les champs suivants sont en lecture seule : id, shopId, productCode, createdAt et updatedAt. Utilisez le point de terminaison de suppression pour définir un produit sur invalid.

Mise à jour par 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"
    }
  }'

Mise à jour par ID de produit et changement du SKU#

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

Une mise à jour réussie renvoie 200 OK et l'objet produit mis à jour complet. Un produit inactive est conservé et reste disponible via le point de terminaison de liste des produits.