commerce/catalog/admin/productsortdefinitions

Use the Product Sort Definition resource to create, update, and delete sort order definitions used in visual merchandising.

You can use these definitions to apply organization rules to a category defined by a product property or custom attribute. The sort order determines the order that products are displayed in, such as newest to oldest, so that they can be rearranged.

JSON Example

ProductSortDefinition Properties

Property	Description
auditInfo	type: auditInfo Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.
auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
boosted	type: list of productSortOverride List of products being boosted.
productSortOverride.isPinned	type: bool Flag to indicate that the product is pinned at the specified position. Not applicable to buried products.
productSortOverride.position	type: int Indicates the relative position of the product to other overridden products. Position is absolute if IsPinned is true. Not applicable to buried products. Buried products will be given a default of -1.
productSortOverride.productCode	type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.
buried	type: list of productSortOverride List of products being positioned.
productSortOverride.isPinned	type: bool Flag to indicate that the product is pinned at the specified position. Not applicable to buried products.
productSortOverride.position	type: int Indicates the relative position of the product to other overridden products. Position is absolute if IsPinned is true. Not applicable to buried products. Buried products will be given a default of -1.
productSortOverride.productCode	type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.
categoryId	type: int ID of the relevant category.
endDate	type: DateTime Optional end date for a product sort definition.
name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
productSortDefinitionId	type: int System or user provided ID for the ProductSortDefinition.
sortExpressions	type: list of productSortExpression Sort expression to apply two expression.
productSortExpression.direction	type: string ASC or DESC. Represents a product that is positioned out of its normal sort position. It can be boosted to the top of the list, positioned exactly or buried at the bottom.
productSortExpression.field	type: string A property that is a wrapper for additional properties pertaining to the schema such as the type, label, any associated data, an ID, and the order of the response.
startDate	type: DateTime The Start Date when the sort definition becomes active.

Operations

Operation Name	Request URI	Description
AddProductSortDefinition	POST %3fuseProvidedId%3d%7buseProvidedId%7d%26responseFields%3d%7bresponseFields%7d	Adds a new product sort definition.
DeleteProductSortDefinition	DELETE %7bproductSortDefinitionId%7d	Deletes the product sort definition specified by its ProductSortDefinitionID.
GetProductSortDefinition	GET %7bproductSortDefinitionId%7d%3fresponseFields%3d%7bresponseFields%7d	Gets a single product sort definition.
GetProductSortDefinitions	GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d	Retrieves a list of product sort definitions according to any specified filter criteria and sort options.
UpdateProductSortDefinition	PUT %7bproductSortDefinitionId%7d%3fresponseFields%3d%7bresponseFields%7d	Updates the details of a product sort definition.