Ideal House
Przejdź do treści

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.

http
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#

PoleTypWymaganeOpis
shopIdstringTakShop ID przekazany przez Ideal House.
productIdstringWarunkoweID szukanego produktu. Wymagany, gdy pominięto sku.
skustringWarunkoweBieżący SKU szukanego produktu. Wymagany, gdy pominięto productId.
productobjectTakPola do aktualizacji. Uwzględnij co najmniej jedno pole.

Edytowalne pola produktów#

Tylko pola zawarte w product są aktualizowane.

PoleTypMaksymalna długośćOpis
skustring120Nowy SKU. Musi pozostać unikalny w obrębie sklepu.
externalProductIdstring120Zewnętrzny identyfikator produktu.
groupIdstring120Identyfikator grupy produktów.
collectionIdstring120Identyfikator kolekcji produktów.
namestring255Nazwa produktu.
titlestring255Tytuł produktu używany do wyświetlania.
brandstring120Marka produktu.
productTypestring120Typ produktu w Twojej taksonomii.
normalizedProductTypestring40Znormalizowany typ produktu. Uzgodnij obsługiwane wartości z Ideal House.
categorystring120Kategoria produktu.
stylestring120Styl produktu.
colorstring120Kolor produktu.
availabilitystring40Wartość dostępności produktu.
imageUrlstring1,000Adres URL publicznego obrazu źródłowego HTTP lub HTTPS.
previewImageUrlstring1,000Adres URL obrazu podglądu HTTP lub HTTPS.
productUrlstring1,000Adres URL HTTP lub HTTPS strony ze szczegółami produktu.
attributesobjectAtrybuty produktu. Po podaniu obiekt ten zastępuje bieżący obiekt atrybutów.
statusstringStan 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#

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

Edytuj według identyfikatora produktu i zmień kod SKU#

json
{
  "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.