POST

Update Extended Fields

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a product's extended fields.

Extended fields must first be configured in the app dashboard.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v3/products/{productId}/update-extended-fields
Path Params
productIdstringRequired

Product ID.

Body Params
namespacestringRequiredminLength 4maxLength 150

App namespace.

namespaceDatastructRequired

Data to update.

fieldsArray <string>maxItems 100

Fields to include in the response.

Response Object
productProduct

Updated product.

Update product extended fields
Request
cURL
curl POST 'https://www.wixapis.com/stores/v3/products/abc62281-87b7-47e8-98ba-20e25341ad98/update-extended-fields' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
        "productId": "abc62281-87b7-47e8-98ba-20e25341ad98",
        "namespace": "@my-app/data-extension-name",
        "namespaceData": {
            "sustainable": true
        }
    }'
Response
JSON
{
  "product": {
    "id": "abc62281-87b7-47e8-98ba-20e25341ad98",
    "revision": "11",
    "createdDate": "2024-07-22T14:04:05.787Z",
    "updatedDate": "2024-07-22T16:45:18.485Z",
    "name": "Recyclable Shopping bag",
    "slug": "shopping-bag",
    "visible": true,
    "visibleInPos": true,
    "media": {},
    "options": [],
    "modifiers": [],
    "infoSections": [],
    "mainCategoryId": "643721c3-446e-47f3-87ee-0a58d6842d48",
    "actualPriceRange": {
      "minValue": {
        "amount": "0.5"
      },
      "maxValue": {
        "amount": "0.5"
      }
    },
    "compareAtPriceRange": {
      "minValue": {
        "amount": "0.5"
      },
      "maxValue": {
        "amount": "0.5"
      }
    },
    "inventory": {
      "availabilityStatus": "OUT_OF_STOCK",
      "preorderAvailability": "NO_VARIANTS",
      "preorderStatus": "DISABLED"
    },
    "productType": "PHYSICAL",
    "physicalProperties": {},
    "extendedFields": {
      "namespaces": {
        "@my-app/data-extension-name": {
          "sustainable": true
        }
      }
    }
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?