Ideal House
Passa al contenuto

Modifica un prodotto#

Aggiorna un prodotto in modo sincrono. Identificarlo tramite productId oppure sku, insieme a shopId. Fornire esattamente un identificatore: le richieste con entrambi o nessuno dei due restituiscono 400 Bad Request.

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

L'identificatore è separato dall’oggetto product. Ciò consente a un'integrazione di individuare un prodotto in base al suo SKU corrente e di modificare lo SKU nella stessa richiesta.

Utilizzare productId come identificatore quando si modifica uno SKU. Ciò mantiene i tentativi non ambigui se la prima richiesta aggiorna lo SKU ma la risposta viene persa.

Corpo della richiesta#

CampoTipoObbligatorioDescrizione
shopIdstringID negozio fornito da Ideal House. (Shop ID)
productIdstringCondizionaleID del prodotto da individuare. Obbligatorio se sku è omesso.
skustringCondizionaleSKU attuale del prodotto da individuare. Obbligatorio se productId è omesso.
productobjectCampi da aggiornare. Includere almeno un campo.

Campi prodotto modificabili#

Solo i campi inclusi in product sono aggiornati.

CampoTipoLunghezza massimaDescrizione
skustring120Nuovo codice. Deve rimanere unico all'interno del negozio. (SKU)
externalProductIdstring120Identificatore del prodotto esterno.
groupIdstring120Identificatore del gruppo di prodotti.
collectionIdstring120Identificatore della raccolta prodotti.
namestring255Nome del prodotto.
titlestring255Titolo visualizzato del prodotto.
brandstring120Marchio del prodotto.
productTypestring120Tipo di prodotto nella tassonomia.
normalizedProductTypestring40Tipo di prodotto normalizzato. Concordare i valori supportati con Ideal House.
categorystring120Categoria di prodotto.
stylestring120Stile del prodotto.
colorstring120Colore del prodotto.
availabilitystring40Valore disponibilità prodotto.
imageUrlstring1,000URL pubblico dell'immagine di origine HTTP o HTTPS.
previewImageUrlstring1,000URL dell'immagine di anteprima HTTP o HTTPS.
productUrlstring1,000URL dei dettagli del prodotto HTTP o HTTPS.
attributesobjectAttributi del prodotto. Quando fornito, questo oggetto sostituisce l'oggetto attributi corrente.
statusstringStato del prodotto. L'endpoint di modifica accetta active o inactive.

I seguenti campi sono di sola lettura: id, shopId, productCode, createdAt e updatedAt. Usare l’endpoint di eliminazione per impostare lo stato di un prodotto su invalid.

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

Modifica per ID prodotto e modifica SKU#

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

Un aggiornamento riuscito restituisce 200 OK e l’oggetto prodotto completo aggiornato. Un prodotto inactive viene conservato e resta disponibile tramite l’endpoint che elenca i prodotti.