setCustomizationChoices( )

Developer Preview

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

Sets a customization's choices. Any and all existing choices will be overridden.

Note: A choice cannot be overridden if it is assigned to one or more products.

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
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Customization write in v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
function setCustomizationChoices(
  customizationId: string,
  choices: Array<Choice>,
  options: SetCustomizationChoicesOptions,
): Promise<SetCustomizationChoicesResponse>;
Method Parameters
customizationIdstringRequired

Customization ID.

choicesArray<Choice>Required

Choices to set.

optionsSetCustomizationChoicesOptions
Returns
Return Type:Promise<SetCustomizationChoicesResponse>
JavaScript
import { customizationsV3 } from "@wix/stores";

async function setCustomizationChoices(customizationId, choices, options) {
  const response = await customizationsV3.setCustomizationChoices(
    customizationId,
    choices,
    options,
  );
}
Errors
400Invalid Argument

There are 5 errors with this status code.

428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?