GET

Get Arranged Items

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 list of arranged items in a category.

Permissions
Read categories
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read v3 catalog
Manage v3 catalog
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/categories/v1/categories/{categoryId}/arranged-items
Path Params
categoryIdstringRequired

Category ID.

Query Params
treeReference.appNamespacestringminLength 4maxLength 150

Namespace of the app that manages the tree.

For example, "@wix/stores", "@bookings/bookingslist", "@achievements/quizzes".

treeReference.treeKeystringminLength 1maxLength 44

Tree key. You must pass this when a single app manages more than one tree.

Response Object
itemsArray <ItemReference>maxItems 100

List of arranged items.

Get arranged items

Get the manual order of items in a category.

Request
cURL
curl -X GET \
 'https://www.wixapis.com/categories/v1/categories/bbd52b32-21d2-4dbe-bfc5-d320f93f8911/arranged-items?treeReference.appNamespace=%40wix%2Fstores' \
 -H 'Content-Type: application/json' \
 -H 'Authorization: <AUTH>'
Response
JSON
{
  "items": [
    {
      "catalogItemId": "77b6a4b3-1542-49bd-918a-5501a5d859f5",
      "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
    },
    {
      "catalogItemId": "05519a6e-222b-413a-957c-0ef7a32779b5",
      "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
    },
    {
      "catalogItemId": "0318a3d8-f31c-4ba3-98c7-387571a2eac4",
      "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
    }
  ]
}
Errors

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

Did this help?