eCommerce - Products

Update a Product

PUT

/ecommerce/products/{id}

Update a Product

curl --request PUT \
  --url https://www.my-site.com/api/site/v2/ecommerce/products/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-site-id: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": [
    {
      "id": "<string>",
      "items": [
        {
          "enabled": "<string>",
          "id": "<string>",
          "module_field_14/product_attribute_option/inventory/1": "<string>",
          "module_field_14/product_attribute_option/price/aud/1": "<string>",
          "module_field_14/product_attribute_option/price/aud/2": "<string>",
          "module_field_14/product_attribute_option/price/cad/1": "<string>",
          "module_field_14/product_attribute_option/price/cad/2": "<string>",
          "module_field_14/product_attribute_option/price/eur/1": "<string>",
          "module_field_14/product_attribute_option/price/eur/2": "<string>",
          "module_field_14/product_attribute_option/price/gbp/1": "<string>",
          "module_field_14/product_attribute_option/price/gbp/2": "<string>",
          "module_field_14/product_attribute_option/price/nzd/1": "<string>",
          "module_field_14/product_attribute_option/price/nzd/2": "<string>",
          "module_field_14/product_attribute_option/price/usd/1": "<string>",
          "module_field_14/product_attribute_option/price/usd/2": "<string>",
          "module_field_14/product_attribute_option_2": "<string>",
          "module_field_14/product_attribute_option_3": "<string>",
          "module_field_14/product_attribute_option_4": "<string>",
          "module_field_14/product_attribute_option_6": "<string>",
          "name": "<string>"
        }
      ],
      "name": "<string>"
    }
  ],
  "category_array": [
    {}
  ],
  "enabled": "<string>",
  "expiry_date": "<string>",
  "module_field_14/product/inventory/1": "<string>",
  "module_field_14/product/inventory/2": "<string>",
  "module_field_14/product/inventory/3": "<string>",
  "module_field_14/product/price/aud/1": "<string>",
  "module_field_14/product/price/aud/2": "<string>",
  "module_field_14/product/price/cad/1": "<string>",
  "module_field_14/product/price/cad/2": "<string>",
  "module_field_14/product/price/eur/1": "<string>",
  "module_field_14/product/price/eur/2": "<string>",
  "module_field_14/product/price/gbp/1": "<string>",
  "module_field_14/product/price/gbp/2": "<string>",
  "module_field_14/product/price/nzd/1": "<string>",
  "module_field_14/product/price/nzd/2": "<string>",
  "module_field_14/product/price/usd/1": "<string>",
  "module_field_14/product/price/usd/2": "<string>",
  "module_field_14/product_1": "<string>",
  "module_field_14/product_2": "<string>",
  "module_field_14/product_3": "<string>",
  "module_field_14/product_4": "<string>",
  "module_field_14/product_5": "<string>",
  "name": "<string>",
  "release_date": "<string>",
  "secure_zone_array": [
    {}
  ],
  "slug": "<string>",
  "weighting": "<string>"
}
'

Authorizations

x-api-keystringheaderrequired

Your Siteglide API key

x-site-idstringheaderrequired

The ID of the Siteglide site you are working with (not an API key — just the numeric site ID)

Path Parameters

idstringrequired

The Product Item ID

Example: 1

Your Products custom fields as a JSON object. When updating Attributes and Attribute Options, if you do not provide an ID then a new item will be made. Providing a valid ID will update the existing item. For more information on Product Database structure, please see <a href="https://developers.siteglide.com/database-structure" target="_blank" rel="noopener nofollow">this document</a>

attributesobject[]

Show child attributes

category_arrayobject[]

enabledstringrequired

expiry_datestring

module_field_14/product/inventory/1string

module_field_14/product/inventory/2string

module_field_14/product/inventory/3string

module_field_14/product/price/aud/1string

module_field_14/product/price/aud/2string

module_field_14/product/price/cad/1string

module_field_14/product/price/cad/2string

module_field_14/product/price/eur/1string

module_field_14/product/price/eur/2string

module_field_14/product/price/gbp/1string

module_field_14/product/price/gbp/2string

module_field_14/product/price/nzd/1string

module_field_14/product/price/nzd/2string

module_field_14/product/price/usd/1string

module_field_14/product/price/usd/2string

module_field_14/product_1string

module_field_14/product_2string

module_field_14/product_3string

module_field_14/product_4string

module_field_14/product_5string

namestringrequired

release_datestring

secure_zone_arrayobject[]

slugstring

weightingstring

Response

Still need help? Ask the team

Authorizations

Path Parameters

Body

Response