Product Collections
Retrieve a specific product collection by ID
Unique identifier of the resource
1Activate id to hyperlink the response data.
OK
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Update an existing product collection
Unique identifier of the resource
1Activate id to hyperlink the response data.
Name of the product collection
Type of the product collection
Foreign key to Catalog model
Whether the product collection is active
trueForeign key to SortOption model
Date and time when the collection expires
List of selected filters for the collection
OK
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Delete an existing product collection
Unique identifier of the resource
1No Content
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
No content
Partially update an existing product collection
Unique identifier of the resource
1Activate id to hyperlink the response data.
Name of the product collection
Type of the product collection
Foreign key to Catalog model
Whether the product collection is active
Foreign key to SortOption model
Date and time when the collection expires
List of selected filters for the collection
OK
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Retrieve a specific product collection with detailed information
A unique integer value identifying this product collection.
Activate id to hyperlink the response data.
OK
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
List all product collections
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Activate id to hyperlink the response data.
Filter by catalog ID
Filter by collection type
Filter by expiration date greater than
Filter by expiration date greater than or equal to
Filter by expiration date less than
Filter by expiration date less than or equal to
Filter by whether expiration date is null
Filter by multiple IDs (comma-separated)
Filter by active status
Filter by name
Filter by slug
OK
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Create a new product collection
Activate id to hyperlink the response data.
Name of the product collection
Type of the product collection
Foreign key to Catalog model
Whether the product collection is active
trueForeign key to SortOption model
Date and time when the collection expires
List of selected filters for the collection
Created
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
List product collections with detailed information
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Activate id to hyperlink the response data.
Filter by catalog ID
Filter by collection type
Filter by expiration date greater than
Filter by expiration date greater than or equal to
Filter by expiration date less than
Filter by expiration date less than or equal to
Filter by whether expiration date is null
Filter by multiple IDs (comma-separated)
Filter by active status
Filter by name
Filter by slug
OK
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
List product collections with detailed information using the detailed_list action
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Activate id to hyperlink the response data.
Filter by catalog ID
Filter by collection type
Filter by expiration date greater than
Filter by expiration date greater than or equal to
Filter by expiration date less than
Filter by expiration date less than or equal to
Filter by whether expiration date is null
Filter by multiple IDs (comma-separated)
Filter by active status
Filter by name
Filter by slug
OK
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Last updated
Was this helpful?