Ideal House
Zum Hauptinhalt springen

Ein Produkt aktualisieren#

Aktualisiert ein Produkt synchron. Identifizieren Sie es mit productId oder sku zusammen mit shopId. Geben Sie genau einen Identifikator an; Anfragen mit beiden oder keinem davon liefern 400 Bad Request.

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

Die Kennung wird getrennt vom product-Objekt angegeben. Dadurch kann eine Integration ein Produkt anhand seiner aktuellen SKU finden und die SKU in derselben Anfrage ändern.

Verwenden Sie beim Ändern einer SKU productId als Kennung. So bleiben Wiederholungsversuche eindeutig, wenn die erste Anfrage die SKU aktualisiert, ihre Antwort aber verloren geht.

Anforderungstext#

FeldTypErforderlichBeschreibung
shopIdstringJaVon Ideal House bereitgestellte Shop ID.
productIdstringBedingtID des gesuchten Produkts. Erforderlich, wenn sku nicht angegeben wird.
skustringBedingtAktuelle SKU des gesuchten Produkts. Erforderlich, wenn productId nicht angegeben wird.
productobjectJaZu aktualisierende Felder. Fügen Sie mindestens ein Feld ein.

Bearbeitbare Produktfelder#

Nur die in product enthaltenen Felder werden aktualisiert.

FeldTypMaximale LängeBeschreibung
skustring120Neue SKU. Sie muss innerhalb des Shops eindeutig bleiben.
externalProductIdstring120Externe Produktkennung.
groupIdstring120Produktgruppenkennung.
collectionIdstring120Kennung der Produktsammlung.
namestring255Produktname.
titlestring255Titel der Produktanzeige.
brandstring120Produktmarke.
productTypestring120Produkttyp in Ihrer Taxonomie.
normalizedProductTypestring40Normalisierter Produkttyp. Stimmen Sie die unterstützten Werte mit Ideal House ab.
categorystring120Produktkategorie.
stylestring120Produktstil.
colorstring120Produktfarbe.
availabilitystring40Produktverfügbarkeitswert.
imageUrlstring1,000Öffentliche HTTP- oder HTTPS-Quellbild-URL.
previewImageUrlstring1,000HTTP- oder HTTPS-Vorschaubild-URL.
productUrlstring1,000HTTP- oder HTTPS-Produktdetail-URL.
attributesobjectProduktattribute. Wenn dieses Objekt bereitgestellt wird, ersetzt es das aktuelle Attributobjekt.
statusstringProduktstatus. Der Bearbeitungsendpunkt akzeptiert active oder inactive.

Die folgenden Felder sind schreibgeschützt: id, shopId, productCode, createdAt und updatedAt. Verwenden Sie den Löschendpunkt, um den Status eines Produkts auf invalid zu setzen.

Anhand der SKU aktualisieren#

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"
    }
  }'

Anhand der Produkt-ID aktualisieren und die SKU ändern#

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

Eine erfolgreiche Aktualisierung liefert 200 OK und das vollständige aktualisierte Produktobjekt. Ein Produkt mit dem Status inactive bleibt gespeichert und ist weiterhin über den Endpunkt zum Auflisten der Produkte verfügbar.