About the Wix Stores Info Sections V3 API

The Info Sections API allows you to create and manage info sections, which can then be assigned to products using the Products API.

Info sections are displayed on your site, allowing store owners to provide detailed, organized, and comprehensive information about their products.

This API provides all the necessary functionality to manage a bank of info sections, which can be applied to products to ensure a consistent info sections experience across your store.

With the Info Sections API, you can:

Create and manage a bank of info sections.
Retrieve information about existing info sections.

Before you begin

It’s important to note the following points before starting to code:

The Info Sections V3 API is only available for use with the Stores Catalog V3.
You must call getCatalogVersion()[https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-provision/get-catalog-version] to get the site's Stores catalog version before using any of the Info Sections V3 API methods. If the site uses Stores Catalog V1, the Info Sections V3 API methods will not be available.

Did this help?

Setup

To use the InfoSectionsV3 API, install the @wix/stores package using npm or Yarn:

Copy

Then import { infoSectionsV3 } from @wix/stores:

Copy

Did this help?

bulkCreateInfoSections( )

Developer Preview

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

Creates multiple info sections.

Authentication

When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

infoSectionsArray<InfoSection>Required

Info sections to create.

optionsBulkCreateInfoSectionsOptions

Returns

Return Type:Promise<BulkCreateInfoSectionsResponse>

Example shown:

bulkCreateInfoSections: Wix-hosted

JavaScript

Errors

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

Did this help?

bulkDeleteInfoSections( )

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 multiple info sections.

Authentication

When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

infoSectionIdsArray<string>Required

IDs of info sections to delete.

Returns

Return Type:Promise<BulkDeleteInfoSectionsResponse>

Example shown:

bulkDeleteInfoSections: Wix-hosted

JavaScript

Errors

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

Did this help?

bulkGetOrCreateInfoSections( )

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 multiple info sections by ID or uniqueName, or creates multiple info sections if those with the passed uniqueName don't exist.

Note: If an info section with the passed uniqueName doesn't exist, the uniqueName and title fields are required to create a new info section.

Authentication

When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

optionsBulkGetOrCreateInfoSectionsOptions

Returns

Return Type:Promise<BulkGetOrCreateInfoSectionsResponse>

Example shown:

bulkGetOrCreateInfoSections: Wix-hosted

JavaScript

Errors

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

Did this help?

bulkUpdateInfoSections( )

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 multiple info sections.

Each time an info section is updated, revision increments by 1. The current revision must be passed when updating an info section. This ensures you're working with the latest info section and prevents unintended overwrites.

Authentication

When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

infoSectionsArray<MaskedInfoSection>Required

List of info sections to update.

optionsBulkUpdateInfoSectionsOptions

Returns

Return Type:Promise<BulkUpdateInfoSectionsResponse>

Example shown:

bulkUpdateInfoSections: Wix-hosted

JavaScript

Errors

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

Did this help?

createInfoSection( )

Developer Preview

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.

Authentication

When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

infoSectionInfoSectionRequired

Info section to create.

Returns

Return Type:Promise<InfoSection>

Example shown:

createInfoSection: Wix-hosted

JavaScript

Errors

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

Did this help?