This article shares a possible use case your app could support, as well as sample flows that could support this use case. This can be a helpful jumping-off point as you plan your app's implementation.
To create a product and assign a new info section with a single API call:
Call Create Product and pass
the uniqueName and title to the product.infoSections array.
Note: if an info section with infoSection.uniqueName already exists, the call will fail.
The Info Sections API allows you to create and update multiple info sections. You can then use and reuse these info sections and assign them across multiple products.
To create and assign an info section to a product:
infoSection.id or infoSection.uniqueName from the info section you created.infoSection.id or the infoSection.uniqueName to the infoSections array.The following table shows field support for filters and sorting for the info section object:
| Field | Supported Filters | Sortable |
|---|---|---|
id | $eq, $ne, $exists, $in, $hasSome, $startsWith | |
createdDate | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
updatedDate | $eq, $ne, $exists, $in, $hasSome, $lt, $le, $gt, $ge | Sortable |
uniqueName | $eq, $ne, $exists, $in, $hasSome, $startsWith | Sortable |
title | $eq, $ne, $exists, $in, $hasSome, $startsWith | Sortable |
Related content: API Query Language, Query Info Sections
An info section is a visible property of a product Add info sections to a product to provide all the explanations your customers need.
Info section ID.
Revision number, which increments by 1 each time the info section is updated. To prevent conflicting changes, the current revision must be passed when updating the info section.
Ignored when creating an info section.
Date and time the info section was created.
Date and time the info section was updated.
Unique name. Used as an identifier.
Info section title.
Info section description using rich content.
See Ricos document referenceInfo section description in HTML.
When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
plainDescription is ignored when value is also passed to the description field.
Number of products this info section is assigned to.
Note: Returned only when you pass "ASSIGNED_PRODUCTS_COUNT" to the fields array in Info Sections API requests.
{
"infoSection": {
"id": "5db34212-4870-4a28-b210-187be25b24cd",
"revision": "1",
"createdDate": "2024-06-30T09:07:44.449Z",
"updatedDate": "2024-06-30T09:07:44.449Z",
"uniqueName": "Series 4 Cup",
"title": "Product Features",
"description": {
"nodes": [
{
"type": "PARAGRAPH",
"id": "ohot5271",
"nodes": [
{
"type": "TEXT",
"id": "",
"nodes": [],
"textData": {
"text": "Dual-wall",
"decorations": [
{
"type": "COLOR",
"colorData": {
"foreground": "#ff0000"
}
},
{
"type": "BOLD",
"fontWeightValue": 700
}
]
}
},
{
"type": "TEXT",
"id": "",
"nodes": [],
"textData": {
"text": " design for the hydration bottle keeps drinks cold for up to 24 hours & hot for up to 12 hours ",
"decorations": []
}
}
]
},
{
"type": "TABLE",
"id": "jx3te102",
"nodes": [
{
"type": "TABLE_ROW",
"id": "yysx7107",
"nodes": [
{
"type": "TABLE_CELL",
"id": "gl0nw108",
"nodes": [
{
"type": "PARAGRAPH",
"id": "h0mav109",
"nodes": [
{
"type": "TEXT",
"id": "",
"nodes": [],
"textData": {
"text": "product",
"decorations": []
}
}
]
}
]
}
]
}
],
"tableData": {
"dimensions": {
"colsWidthRatio": [587],
"rowsHeight": [47],
"colsMinWidth": [120]
}
}
},
{
"type": "PARAGRAPH",
"id": "cjje5104",
"nodes": []
}
],
"metadata": {
"version": 1
},
"documentStyle": {}
},
"assignedProductsCount": 1
}
}This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates an info section.
To assign the info section to a product, include the infoSection.id or infoSection.uniqueName
when creating or
updating a product.
You can only call this method when authenticated as a Wix app or Wix user identity.
Info section to create.
Created info section.
Creates an info section of type paragraph, with product feature descriptions.
curl -X POST \
'https://www.wixapis.com/stores/v3/info-sections' \
-H 'Content-type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"infoSection": {
"uniqueName": "Series 4 Cup",
"title": "Product Features",
"description": {
"nodes": [
{
"type": "PARAGRAPH",
"id": "ohot5271",
"nodes": [
{
"type": "TEXT",
"textData": {
"text": "Dual-wall",
"decorations": [
{
"type": "COLOR",
"colorData": {
"foreground": "#ff0000"
}
},
{
"type": "BOLD",
"fontWeightValue": 700
}
]
}
},
{
"type": "TEXT",
"textData": {
"text": " design for the hydration bottle keeps drinks cold for up to 24 hours & hot for up to 12 hours "
}
}
]
},
{
"type": "TABLE",
"id": "jx3te102",
"nodes": [
{
"type": "TABLE_ROW",
"id": "yysx7107",
"nodes": [
{
"type": "TABLE_CELL",
"id": "gl0nw108",
"nodes": [
{
"type": "PARAGRAPH",
"id": "h0mav109",
"nodes": [
{
"type": "TEXT",
"textData": {
"text": "product"
}
}
]
}
]
}
]
}
],
"tableData": {
"dimensions": {
"colsWidthRatio": [
587
],
"rowsHeight": [
47
],
"colsMinWidth": [
120
]
}
}
},
{
"type": "PARAGRAPH",
"id": "cjje5104"
}
],
"metadata": {
"version": 1
}
}
}
}'{
"infoSection": {
"id": "5db34212-4870-4a28-b210-187be25b24cd",
"revision": "1",
"createdDate": "2024-06-30T12:58:08.297Z",
"updatedDate": "2024-06-30T12:58:08.297Z",
"uniqueName": "Series 5 Cup",
"title": "Product Features",
"description": {
"nodes": [
{
"type": "PARAGRAPH",
"id": "ohot5271",
"nodes": [
{
"type": "TEXT",
"id": "",
"nodes": [],
"textData": {
"text": "Dual-wall",
"decorations": [
{
"type": "COLOR",
"colorData": {
"foreground": "#ff0000"
}
},
{
"type": "BOLD",
"fontWeightValue": 700
}
]
}
},
{
"type": "TEXT",
"id": "",
"nodes": [],
"textData": {
"text": " design for the hydration bottle keeps drinks cold for up to 24 hours & hot for up to 12 hours ",
"decorations": []
}
}
]
},
{
"type": "TABLE",
"id": "jx3te102",
"nodes": [
{
"type": "TABLE_ROW",
"id": "yysx7107",
"nodes": [
{
"type": "TABLE_CELL",
"id": "gl0nw108",
"nodes": [
{
"type": "PARAGRAPH",
"id": "h0mav109",
"nodes": [
{
"type": "TEXT",
"id": "",
"nodes": [],
"textData": {
"text": "product",
"decorations": []
}
}
]
}
]
}
]
}
],
"tableData": {
"dimensions": {
"colsWidthRatio": [587],
"rowsHeight": [47],
"colsMinWidth": [120]
}
}
},
{
"type": "PARAGRAPH",
"id": "cjje5104",
"nodes": []
}
],
"metadata": {
"version": 1
}
}
}
}There are 2 errors with this status code.
This method may also return standard errors. Learn more about standard Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves an info section.
Info section ID.
Fields to include in the response.
Supported values: ASSIGNED_PRODUCTS_COUNT
Info section.
Gets an info section by Id.
curl -X GET \
'https://www.wixapis.com/stores/v3/info-sections/5db34212-4870-4a28-b210-187be25b24cd' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'{
"infoSection": {
"id": "5db34212-4870-4a28-b210-187be25b24cd",
"revision": "1",
"createdDate": "2024-06-30T12:58:08.297Z",
"updatedDate": "2024-06-30T12:58:08.297Z",
"uniqueName": "Series 5 Cup",
"title": "Product Features",
"description": {
"nodes": [
{
"type": "PARAGRAPH",
"id": "ohot5271",
"nodes": [
{
"type": "TEXT",
"id": "",
"nodes": [],
"textData": {
"text": "Dual-wall",
"decorations": [
{
"type": "COLOR",
"colorData": {
"foreground": "#ff0000"
}
},
{
"type": "BOLD",
"fontWeightValue": 700
}
]
}
},
{
"type": "TEXT",
"id": "",
"nodes": [],
"textData": {
"text": " design for the hydration bottle keeps drinks cold for up to 24 hours & hot for up to 12 hours ",
"decorations": []
}
}
]
},
{
"type": "TABLE",
"id": "jx3te102",
"nodes": [
{
"type": "TABLE_ROW",
"id": "yysx7107",
"nodes": [
{
"type": "TABLE_CELL",
"id": "gl0nw108",
"nodes": [
{
"type": "PARAGRAPH",
"id": "h0mav109",
"nodes": [
{
"type": "TEXT",
"id": "",
"nodes": [],
"textData": {
"text": "product",
"decorations": []
}
}
]
}
]
}
]
}
],
"tableData": {
"dimensions": {
"colsWidthRatio": [587],
"rowsHeight": [47],
"colsMinWidth": [120]
}
}
},
{
"type": "PARAGRAPH",
"id": "cjje5104",
"nodes": []
}
],
"metadata": {
"version": 1
}
}
}
}This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.