Catalog Service

About This API

Wix Stores creates a catalog of store owners’ items for purchase and allows store owners to create smaller collections of products by type or theme. A catalog organizes the store’s products and collections and facilitates inventory management. With the Wix Stores Catalog API you can query individual products, collections or the entire catalog, as well as create products and add their media.

Querying the products and collections in the catalog enables you to coordinate a store’s inventory across other sales platforms (e.g., Facebook marketplace), or inventory management tools (e.g., NetSuite, TradeGecko), among other uses.

Terminology

  • The catalog is a complete list of all the store’s products.
  • Collections are themed groupings of items for purchase that a store owner can create to organize their products (e.g., Spring 2019, Running shoes, etc.). Products can belong to multiple collections.
  • Options are property types that customers can select within the specific product - e.g., color and size.
  • Choices are the available selections within each option - e.g., red and green choices under the Color option.
  • Variants are combinations of different product options and choices - e.g., a red shirt in size large. A variant can override the following values from the parent product:
    • Price
    • SKU
    • Weight
    • Inventory

Error handling

Status codeDescription
200Success
400Invalid input (e.g., when the filter format is not valid or when providing invalid options when calling productOptionsAvailability)
401Invalid authorization token, or Wix stores is not installed
404Requested product or collection is not found
500Unexpected error
Was this helpful?
Yes
No

Filter and sort

Query Language

Endpoints that allow querying follow these format guidelines.

Query Products

Fields That Allow Filtering

FieldOperatorsSorting Allowed
name$eq,$ne,$hasSome,$contains,$startsWithAllowed
description$eq,$ne,$hasSome,$contains,$startsWith
sku$eq,$ne,$hasSome,$contains,$startsWithAllowed
id$eq,$ne,$hasSomeAllowed
price$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
numericId$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
productType$eq,$ne,$hasSomeAllowed
slug$eq,$ne,$hasSome,$contains,$startsWithAllowed
collections.id$eq,$ne,$hasSome,$hasAll
options.<option name>$eq,$ne,$hasSome,$hasAll
inventoryStatus$eq,$ne,$hasSome
lastUpdated$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
createdDate$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed

** Note that "HasSome" is same as the operator "IN" in SQL

Examples

Query products where price = 10

Copy
1
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"price\": \"10\"}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'

Query products, order by price descending

Copy
1
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"sort":"[{\"price\": \"desc\"}]"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'

Getting all products for a given collection

Copy
1
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"collections.id\": { \"$hasSome\": [\"your_collection_id_here\"]} }"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'

Getting multiple products by IDs

Copy
1
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"id\": {\"$hasSome\": [\"YOUR_PRODUCT_ID_HERE\", \"YOUR_PRODUCT_ID_HERE\"]}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'

Getting all products with a specific choice

Copy
1
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"productOptions.size\": \"L\"}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'

Getting all products in a store

  1. Get the first page:
Copy
1
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"sort":"[{\"numericId\": \"asc\"}]"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
  1. Take the numericId of the last returned item and run the following query:
Copy
1
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"sort":"[{\"numericId\": \"asc\"}]","filter":"{\"numericId\": {\"$gt\": LAST_NUMERIC_ID}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
  1. Continue until no more records are returned.

Query Collections

Fields That Allow Filtering

FieldOperatorsSorting Allowed
name$eq,$ne,$hasSome,$contains,$startsWithAllowed
id$eq,$ne,$hasSome,$contains,$startsWithAllowed

** Note that "HasSome" is same as the operator "IN" in SQL

Examples

Query collections where name = my collection

Copy
1
curl 'https://www.wixapis.com/stores/v1/collections/query' --data-binary '{"query":{"filter":"{\"name\": \"my collection\"}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
Was this helpful?
Yes
No

Use Cases

In this example we will query a product variant:

  • The product is a shirt
  • The shirt has 2 options - size and color
  • The size option has 3 choices - S/M/L
  • The color option has 3 choices - Red/Green/Blue
  • The product variant S+Red is out of stock

The product's options field

Copy
1
curl 'https://www.wixapis.com/stores/v1/products/<product id>' -H 'Content-Type: application/json' -H 'Authorization: XXX'
Copy
1
{
2
...
3
"productOptions": [
4
{
5
"optionType": "drop_down",
6
"name": "Size",
7
"choices": [
8
{
9
"value": "S",
10
"description": "S",
11
"inStock": true,
12
"visible": true
13
},
14
{
15
"value": "M",
16
"description": "M",
17
"inStock": true,
18
"visible": true
19
},
20
{
21
"value": "L",
22
"description": "L",
23
"inStock": true,
24
"visible": true
25
}
26
]
27
},
28
{
29
"optionType": "color",
30
"name": "Color",
31
"choices": [
32
{
33
"value": "#FF0000",
34
"description": "Red",
35
"inStock": true,
36
"visible": true
37
},
38
{
39
"value": "#00FF00",
40
"description": "Green",
41
"inStock": true,
42
"visible": true
43
},
44
{
45
"value": "#00000FF",
46
"description": "Blue",
47
"inStock": true,
48
"visible": true
49
}
50
]
51
}
52
]
53
}

**Now let's query the availability of S **
Notice in the response that:

  1. Red is out of stock, because S+Red is out of stock
  2. availableForPurchase is false, because both size and color must be given for this product
Copy
1
curl 'https://www.wixapis.com/stores/v1/products/<product id>/productOptionsAvailability' --data-binary '{"options": {"Size": "S"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
Copy
1
{
2
"productOptions": [
3
{
4
"optionType": "drop_down",
5
"name": "Size",
6
"choices": [
7
{
8
"value": "S",
9
"description": "S",
10
"inStock": true,
11
"visible": true
12
},
13
{
14
"value": "M",
15
"description": "M",
16
"inStock": true,
17
"visible": true
18
},
19
{
20
"value": "L",
21
"description": "L",
22
"inStock": true,
23
"visible": true
24
}
25
]
26
},
27
{
28
"optionType": "color",
29
"name": "Color",
30
"choices": [
31
{
32
"value": "#FF0000",
33
"description": "Red",
34
"inStock": false,
35
"visible": true
36
},
37
{
38
"value": "#00FF00",
39
"description": "Green",
40
"inStock": true,
41
"visible": true
42
},
43
{
44
"value": "#00000FF",
45
"description": "Blue",
46
"inStock": true,
47
"visible": true
48
}
49
]
50
}
51
],
52
"availableForPurchase": false
53
}

**Now let's query the availability of S+Green **
Notice in the response that:

  1. We get the selected variant, with proper values for price, weight, SKU and inventory
  2. availableForPurchase is true
Copy
1
curl 'https://www.wixapis.com/stores/v1/products/<product id>/productOptionsAvailability' --data-binary '{"options": {"Size": "S","Color": "Green"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
Copy
1
{
2
"selectedVariant": {
3
"price": {
4
"currency": "USD",
5
"price": 81,
6
"discountedPrice": 81,
7
"formatted": {
8
"price": "$81.00",
9
"discountedPrice": "$81.00"
10
}
11
},
12
"weight": 0,
13
"sku": "364215376135191",
14
"inStock": true,
15
"visible": true
16
},
17
"productOptions": [
18
{
19
"optionType": "drop_down",
20
"name": "Size",
21
"choices": [
22
{
23
"value": "S",
24
"description": "S",
25
"inStock": true,
26
"visible": true
27
},
28
{
29
"value": "M",
30
"description": "M",
31
"inStock": true,
32
"visible": true
33
},
34
{
35
"value": "L",
36
"description": "L",
37
"inStock": true,
38
"visible": true
39
}
40
]
41
},
42
{
43
"optionType": "color",
44
"name": "Color",
45
"choices": [
46
{
47
"value": "#FF0000",
48
"description": "Red",
49
"inStock": false,
50
"visible": true
51
},
52
{
53
"value": "#00FF00",
54
"description": "Green",
55
"inStock": true,
56
"visible": true
57
},
58
{
59
"value": "#00000FF",
60
"description": "Blue",
61
"inStock": true,
62
"visible": true
63
}
64
]
65
}
66
],
67
"availableForPurchase": true
68
}
Was this helpful?
Yes
No

eCommerce Integration

Product details passed from the Stores catalog to an eCommerce cart, checkout, or order, must follow a certain structure in the form of the catalogReference object.

  • catalogItemId - in the context of Wix Stores products, this is the productId
  • appId - the Stores app ID. When using products from the Stores catalog, this must always be "215238eb-22a5-4c36-9e7b-e7c08025e04e"
  • options - this field can hold different key-value pairs, depending on variant management and whether the product/variant has custom text fields.

Refer to the following catalogReference object examples for more detail:

Managed Variants

When a product's variants are managed (product.manageVariants: true), the options object should hold the variant's variantId. In the following example, the variant also has customTextFields:

Copy
1
{
2
"catalogReference": {
3
"catalogItemId": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a",
4
"appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
5
"options": {
6
"variantId": "00000000-0000-0020-0005-ad9cdc10d3b8",
7
"customTextFields": {
8
"What would you like written on the custom label?": "Hope you enjoy the coffee! :)"
9
}
10
}
11
}
12
}

Non-Managed Variants

When a product's variants are not managed (product.manageVariants: false), the options object should hold the variant's options and choices

Copy
1
{
2
"catalogReference": {
3
"catalogItemId": "4d93fb7e-e612-612f-5c27-81b35b503ad7",
4
"appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
5
"options": {
6
"options": {
7
"Size": "Medium",
8
"Color": "Red"
9
}
10
}
11
}
12
}
Was this helpful?
Yes
No

Product Object

Attributes
idstringRead-only
Product ID (generated automatically by the catalog).

namestringminLength 1maxLength 80
Product name. Min: 1 character Max: 80 characters

slugstringmaxLength 100
A friendly URL name (generated automatically by the catalog when a product is created), can be updated.

visibleboolean
Whether the product is visible to site visitors.

productTypestring
3 supported values:
unspecified_product_typephysicaldigital
Currently, only creating physical products ( "productType": "physical" ) is supported via the API.

descriptionstringmaxLength 8000
Product description. Accepts rich text.

skustringmaxLength 40
Stock keeping unit. If variant management is enabled, SKUs will be set per variant, and this field will be empty.

weightnumberminimum 0maximum 999999999.99format double
Product weight. If variant management is enabled, weight will be set per variant, and this field will be empty.

weightRangeobject
Product weight range. The minimum and maximum weights of all the variants.

stockobject
Product inventory status (in future this will be writable via Inventory API).

priceobject
Deprecated (use priceData instead).

priceDataobject
Price data.

convertedPriceDataobject
Price data, converted to the currency specified in request header.

priceRangeobject
Product price range. The minimum and maximum prices of all the variants.

costAndProfitDataobject
Cost and profit data.

costRangeobject
Product cost range. The minimum and maximum costs of all the variants.

pricePerUnitDataobject
Price per unit data.

additionalInfoSectionsArray <AdditionalInfoSection>
Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.).

ribbonsArray <Ribbon>Read-only
Deprecated (use ribbon instead).

mediaobject
Media items (images, videos etc) associated with this product (writable via Add Product Media endpoint).

customTextFieldsArray <CustomTextField>Read-only
Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.

manageVariantsboolean
Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data.

productOptionsArray <ProductOption>maxItems 6
Options for this product.

productPageUrlobject
Product page URL for this product (generated automatically by the server).

numericIdnumberRead-only
Product’s unique numeric ID (assigned in ascending order). Primarily used for sorting and filtering when crawling all products.

inventoryItemIdstringRead-only
Inventory item ID - ID referencing the inventory system.

discountobject
Discount deducted from the product's original price.

collectionIdsArray <string>Read-only
A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).

variantsArray <Variant>Read-only
Product variants, will be provided if the the request was sent with the includeVariants flag.

lastUpdatedstringRead-onlyformat date-time
Date and time the product was last updated.

createdDatestringRead-onlyformat date-time
Date and time the product was created.

seoDataobject
Custom SEO data for the product.

ribbonstringmaxLength 30
Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out".

brandstringminLength 1maxLength 50
Product brand. Including a brand name can help improve site and product visibility on search engines.
Was this helpful?
Yes
No

PostCreate Product

Creates a new product.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/products

Was this helpful?
Yes
No

PatchUpdate Product

Updates specified fields in a product.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/stores/v1/products/{product.id}

Was this helpful?
Yes
No

DeleteDelete Product

Deletes a product.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/stores/v1/products/{id}

Was this helpful?
Yes
No

PatchUpdate Product Variants

Updates variants of a specified product.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/stores/v1/products/{id}/variants

Was this helpful?
Yes
No

PostReset All Product Variant Data

Resets the data (such as the price and the weight) of all variants for a given product to their default values.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/products/{id}/variants/resetToDefault

Was this helpful?
Yes
No

PostAdd Products To Collection

Adds products to a specified collection.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/collections/{id}/productIds

Was this helpful?
Yes
No

PostRemove Products From Collection

Developer Preview

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

Deletes products from a specified collection.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/collections/{id}/productIds/delete

Was this helpful?
Yes
No

PostAdd Product Media

Adds media items to a specified product, either via URL or existing media ID.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/products/{id}/media

Was this helpful?
Yes
No

PostRemove Product Media

Removes specified media items from a product. Pass an empty array to remove all media items.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/products/{id}/media/delete

Was this helpful?
Yes
No

PatchAdd Product Media To Choices

Developer Preview

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

Links media items that are already associated with a specific product to a choice within the same product.

Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).

To remove all existing media items, call the Remove Product Media From Choices endpoint.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/stores/v1/products/{id}/choices/media

Was this helpful?
Yes
No

PostRemove Product Media From Choices

Developer Preview

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

Removes media items from all or some of a product's choices. (Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).)

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/products/{id}/choices/media/delete

Was this helpful?
Yes
No

DeleteDelete Product Options

Developer Preview

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

Delete all options from a specific product. Only available when variant management is disabled.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/stores/v1/products/{id}/options

Was this helpful?
Yes
No

PostRemove Brand

Deletes a product's brand.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/products/{id}/remove-brand

Was this helpful?
Yes
No

PostCreate Collection

Creates a new collection.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/collections

Was this helpful?
Yes
No

PatchUpdate Collection Properties

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 specified properties of a collection. To add products to a collection, call the Add Products to Collection endpoint.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/stores/v1/collections/{collection.id}

Was this helpful?
Yes
No

DeleteDelete Collection

Developer Preview

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

Deletes a collection.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/stores/v1/collections/{id}

Was this helpful?
Yes
No

PostRemove Ribbon

Deletes a product's ribbon.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/products/{id}/remove-ribbon

Was this helpful?
Yes
No

PostBulk Update Product Property

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 specified property for up to 100 products at a time.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/bulk/products/update

Was this helpful?
Yes
No

PostBulk Adjust Product Properties

Developer Preview

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

Adjusts a specified numerical property for up to 100 products at a time. The property can be increased or decreased either by percentage or amount.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores/v1/bulk/products/adjust-properties

Was this helpful?
Yes
No

PostQuery Products

Returns a list of up to 100 products, given the provided paging, sorting and filtering. See Stores Pagination for more information.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Products
Read Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores-reader/v1/products/query

Was this helpful?
Yes
No

GetGet Product

Retrieves a product with the provided ID.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Products
Read Products
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/stores-reader/v1/products/{id}

Was this helpful?
Yes
No

PostQuery Collections

Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering. See Stores Pagination for more information.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Products
Read Products
Learn more about permission scopes.
Was this helpful?
Yes
No

GetGet Collection

Retrieves a collection with the provided ID.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Products
Read Products
Learn more about permission scopes.
Was this helpful?
Yes
No

GetGet Collection By Slug

Retrieves a collection with the provided slug.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Products
Read Products
Learn more about permission scopes.
Was this helpful?
Yes
No

PostGet Product Options Availability

Developer Preview

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

Gets the availability of relevant product variants based on the product ID and selections provided. See Use Cases for an example.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Products
Read Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores-reader/v1/products/{id}/productOptionsAvailability

Was this helpful?
Yes
No

PostQuery Product Variants

Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs. See Stores Pagination for more information.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Products
Read Products
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/stores-reader/v1/products/{id}/variants/query

Was this helpful?
Yes
No

PostQuery Store Variants

Developer Preview

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

Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Products
Read Products
Learn more about permission scopes.
Was this helpful?
Yes
No

GetGet Store Variant

Developer Preview

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

Retrieves a store variant with the provided ID.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Products
Read Products
Learn more about permission scopes.
Was this helpful?
Yes
No

Product Created

Triggered when a product is created.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
productIdstring
Product ID (generated automatically by the catalog).

namestring
Product name.

priceobject
Product price.

visibleboolean
Whether the product is visible to customers.

mediaobject
Media items (images, videos, etc.) associated with this product.

skustring
Product stock keeping unit (SKU). If variants are being managed, this will be empty.

productPageUrlobject
Product page URL for this product (generated automatically by the server).

brandstring
Product brand.

costAndProfitDataobject
Cost and profit data
Was this helpful?
Yes
No

Product Changed

Triggered when a product is changed.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
productIdstring
Product ID.

changedFieldsArray <string>
List of product fields that were changed.
Was this helpful?
Yes
No

Product Deleted

Triggered when a product is deleted.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
productIdstring
ID of the product that was deleted.
Was this helpful?
Yes
No

Collection Created

Triggered when a collection is created.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
collection_Idstring
Collection ID (generated automatically by the catalog).

namestring
Collection name.

mediaobject
Media items (images, videos, etc.) associated with this collection.

slugstring
Collection slug

visibleboolean
Collection visible status
Was this helpful?
Yes
No

Collection Changed

Triggered when a collection is changed.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
collection_Idstring
Collection ID (generated automatically by the catalog).

changedFieldsArray <string>
List of collection fields that were changed.
Was this helpful?
Yes
No

Collection Deleted

Triggered when a collection is deleted.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
collection_Idstring
ID of the collection that was deleted.
Was this helpful?
Yes
No

Variants Changed

Triggered when a product variant is changed.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
productIdstring
Product ID.

variantsArray <VariantChanged>
List of variants that were changed.
Was this helpful?
Yes
No