Bewerk een product#
Werkt één product synchroon bij. Identificeer het met productId of sku, samen met shopId. Geef precies één identificator op; verzoeken met beide of geen van beide retourneren 400 Bad Request.
PATCH https://sdkapi.ideal.house/product-import/products
De identificator staat buiten het object product. Zo kan een integratie een product opzoeken op basis van de huidige SKU en die SKU in hetzelfde verzoek wijzigen.
Gebruik productId als identificatie bij het wijzigen van een SKU. Hierdoor blijven nieuwe pogingen ondubbelzinnig als de eerste aanvraag de SKU bijwerkt, maar het antwoord verloren gaat.
Verzoekinhoud#
| Veld | Type | Vereist | Beschrijving |
|---|---|---|---|
shopId | string | Ja | Shop ID verstrekt door Ideal House. |
productId | string | Voorwaardelijk | ID van het te zoeken product. Verplicht wanneer sku ontbreekt. |
sku | string | Voorwaardelijk | Huidige SKU van het te zoeken product. Verplicht wanneer productId ontbreekt. |
product | object | Ja | Velden die moeten worden bijgewerkt. Voeg ten minste één veld toe. |
Bewerkbare productvelden#
Alleen de velden die in product zijn opgenomen, worden bijgewerkt.
| Veld | Type | Maximale lengte | Beschrijving |
|---|---|---|---|
sku | string | 120 | Nieuwe SKU. Moet uniek blijven binnen de winkel. |
externalProductId | string | 120 | Externe product-ID. |
groupId | string | 120 | Productgroep-ID. |
collectionId | string | 120 | Identificatie van productverzameling. |
name | string | 255 | Productnaam. |
title | string | 255 | Productweergavetitel. |
brand | string | 120 | Productmerk. |
productType | string | 120 | Producttype in uw taxonomie. |
normalizedProductType | string | 40 | Genormaliseerd producttype. Stem de ondersteunde waarden af met Ideal House. |
category | string | 120 | Productcategorie. |
style | string | 120 | Productstijl. |
color | string | 120 | Productkleur. |
availability | string | 40 | Waarde van productbeschikbaarheid. |
imageUrl | string | 1,000 | Openbare HTTP- of HTTPS-bronafbeeldings-URL. |
previewImageUrl | string | 1,000 | HTTP- of HTTPS-URL van voorbeeldafbeelding. |
productUrl | string | 1,000 | HTTP- of HTTPS-productdetail-URL. |
attributes | object | — | Productkenmerken. Indien geleverd vervangt dit object het huidige attributenobject. |
status | string | — | Productstatus. Het bewerkingseindpunt accepteert active of inactive. |
De volgende velden zijn alleen-lezen: id, shopId, productCode, createdAt en updatedAt. Gebruik het verwijderingseindpunt om de status van een product op invalid te zetten.
Bewerken per 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"
}
}'
Bewerk op product-ID en wijzig de SKU#
{
"shopId": "shop_123",
"productId": "product_123",
"product": {
"sku": "SKU-10001-NEW",
"name": "Large Gold Wall Mirror",
"status": "inactive"
}
}
Een geslaagde update retourneert 200 OK en het volledige bijgewerkte productobject. Een product met de status inactive blijft bewaard en beschikbaar via het eindpunt voor de productlijst.