Skip to main content
POST
/
commerce
/
catalog
/
admin
/
productsortdefinitions
Error
A valid request URL is required to generate request examples
{
  "name": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "sortExpressions": [
    {
      "field": "<string>",
      "direction": "<string>"
    }
  ],
  "productSortDefinitionId": 123,
  "categoryId": 123,
  "endDate": "2023-11-07T05:31:56Z",
  "boosted": [
    {
      "productCode": "<string>",
      "sliceValue": "<string>",
      "position": 123,
      "isPinned": true
    }
  ],
  "buried": [
    {
      "productCode": "<string>",
      "sliceValue": "<string>",
      "position": 123,
      "isPinned": true
    }
  ],
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

useProvidedId
boolean
default:false

If true, the provided Id value will be used as the ProductSortDefinitionId. If omitted or false, the system will generate a ProductSortDefinitionId

responseFields
string

limits which fields are returned in the response body

Body

application/json

Properties of the new product sort definition. Required properties of StartDate and Name.

Defines a default sort for a list of products and allows some products to be boosted to the top or pinned ot a specific position, or buried at the bottom of the list. Only 10 items can be boosted or pinned and up to

name
string
required

Short Name for the sort definition. Required.

startDate
string<date-time>
required

The Start Date when the sort definition becomes active

sortExpressions
object[]
required

Sort expression to apply Max two expressions

productSortDefinitionId
integer<int32> | null

System or user provided ID for the ProductSortDefinition

categoryId
integer<int32> | null
endDate
string<date-time> | null

Optional end date for a product sort definition

boosted
object[] | null

List of products being positioned

buried
object[] | null

List of products being positioned

auditInfo
object

Response

Success

Defines a default sort for a list of products and allows some products to be boosted to the top or pinned ot a specific position, or buried at the bottom of the list. Only 10 items can be boosted or pinned and up to

name
string
required

Short Name for the sort definition. Required.

startDate
string<date-time>
required

The Start Date when the sort definition becomes active

sortExpressions
object[]
required

Sort expression to apply Max two expressions

productSortDefinitionId
integer<int32> | null

System or user provided ID for the ProductSortDefinition

categoryId
integer<int32> | null
endDate
string<date-time> | null

Optional end date for a product sort definition

boosted
object[] | null

List of products being positioned

buried
object[] | null

List of products being positioned

auditInfo
object