Edytuj produkt#
Aktualizuje jeden produkt synchronicznie. Zidentyfikuj go przez productId albo sku wraz z shopId. Podaj dokładnie jeden identyfikator; żądania zawierające oba lub żaden z nich zwracają 400 Bad Request.
PATCH https://sdkapi.ideal.house/product-import/products
Identyfikator podaje się poza obiektem product. Dzięki temu integracja może znaleźć produkt na podstawie jego obecnego SKU i zmienić SKU w tym samym żądaniu.
Używaj productId jako identyfikatora podczas zmiany SKU. Dzięki temu ponowne próby pozostaną jednoznaczne, jeśli pierwsze żądanie zmieni SKU, ale odpowiedź zostanie utracona.
Treść żądania#
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
shopId | string | Tak | Shop ID przekazany przez Ideal House. |
productId | string | Warunkowe | ID szukanego produktu. Wymagany, gdy pominięto sku. |
sku | string | Warunkowe | Bieżący SKU szukanego produktu. Wymagany, gdy pominięto productId. |
product | object | Tak | Pola do aktualizacji. Uwzględnij co najmniej jedno pole. |
Edytowalne pola produktów#
Tylko pola zawarte w product są aktualizowane.
| Pole | Typ | Maksymalna długość | Opis |
|---|---|---|---|
sku | string | 120 | Nowy SKU. Musi pozostać unikalny w obrębie sklepu. |
externalProductId | string | 120 | Zewnętrzny identyfikator produktu. |
groupId | string | 120 | Identyfikator grupy produktów. |
collectionId | string | 120 | Identyfikator kolekcji produktów. |
name | string | 255 | Nazwa produktu. |
title | string | 255 | Tytuł produktu używany do wyświetlania. |
brand | string | 120 | Marka produktu. |
productType | string | 120 | Typ produktu w Twojej taksonomii. |
normalizedProductType | string | 40 | Znormalizowany typ produktu. Uzgodnij obsługiwane wartości z Ideal House. |
category | string | 120 | Kategoria produktu. |
style | string | 120 | Styl produktu. |
color | string | 120 | Kolor produktu. |
availability | string | 40 | Wartość dostępności produktu. |
imageUrl | string | 1,000 | Adres URL publicznego obrazu źródłowego HTTP lub HTTPS. |
previewImageUrl | string | 1,000 | Adres URL obrazu podglądu HTTP lub HTTPS. |
productUrl | string | 1,000 | Adres URL HTTP lub HTTPS strony ze szczegółami produktu. |
attributes | object | — | Atrybuty produktu. Po podaniu obiekt ten zastępuje bieżący obiekt atrybutów. |
status | string | — | Stan produktu. Punkt końcowy edycji akceptuje active lub inactive. |
Następujące pola są tylko do odczytu: id, shopId, productCode, createdAt i updatedAt. Aby ustawić status produktu na invalid, użyj punktu końcowego usuwania.
Edytuj przez 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"
}
}'
Edytuj według identyfikatora produktu i zmień kod SKU#
{
"shopId": "shop_123",
"productId": "product_123",
"product": {
"sku": "SKU-10001-NEW",
"name": "Large Gold Wall Mirror",
"status": "inactive"
}
}
Pomyślna aktualizacja zwraca 200 OK oraz kompletny, zaktualizowany obiekt produktu. Produkt ze statusem inactive zostaje zachowany i nadal jest dostępny przez punkt końcowy listy produktów.