setArrangedItems( )

Sets arranged items in a category.

The order of items in the items array determines the order of items in the category. The category's existing list of arranged items will be overridden.

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
Category item write
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
categoryIdstringRequired

Category ID.

treeReferenceTreeReferenceRequired

Category tree reference details.

optionsSetArrangedItemsOptions
Returns
Return Type:Promise<SetArrangedItemsResponse>
Errors
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?