Create Carousel

Lists storefront category carousels with rendered product HTML for a project or host.

POST

Authentication

Requirement: Not specified
Credential type: Not specified
Scopes: Not specified

Permissions

Requires a project with the commerce or portfolio extension enabled.

Headers

No header metadata is available for this operation.

Path Parameters

This operation has no path parameters.

Query Parameters

This operation does not accept query parameters.

Request Body

Schema: RuntimeCategoryCarouselsRequest

Field	Required	Type	Details
`project_id`	No	integer	Description: Target project identifier.
`offset`	No	integer	Description: Integer value.
`limit`	No	integer	Description: Maximum number of records to return.
`products_limit`	No	integer	Description: Integer value.
`product_type`	No	string	Description: Product type value.
`category_key`	No	string	Description: Text value.
`order`	No	integer	Description: Sort field used by this operation.
`category_slug`	No	string	Description: URL-safe slug value.
`category_slugs`	No	array<string>	Description: Array value. Items: string
`category_ids`	No	array<integer>	Description: Array value. Items: integer
`exclude_product_ids`	No	array<integer>	Description: Array value. Items: integer
`product_item_code`	No	string	Description: Text value.
`featured_product_item_code`	No	string	Description: Text value.
`product_item_codes`	No	array<string>	Description: Array value. Items: string
`featured_product_item_codes`	No	array<string>	Description: Array value. Items: string

Response Body

Example 200 response

json

{
  "items": [],
  "has_more": true,
  "next_offset": 1
}

Errors

404 NOT_FOUND

Availability

Available in: v0.1.0
Available since: v0.1.0
Implementation: Available
Deprecation: Not specified
Rate limits: Not specified

Example request

POST/__runtime/categories/carousels

Base URLhttps://api.modusell.com

curl --request POST \
  --url "https://api.modusell.com/__runtime/categories/carousels" \
  --header "Content-Type: application/json" \
  --data '{"project_id":1,"offset":1,"limit":1,"products_limit":1,"product_type":"VALUE","category_key":"VALUE","order":1,"category_slug":"VALUE","category_slugs":[],"category_ids":[],"exclude_product_ids":[],"product_item_code":"VALUE","featured_product_item_code":"VALUE","product_item_codes":[],"featured_product_item_codes":[]}'

Response

Examples are not available for this release.

Authentication

Authentication requirements are not specified for this operation.