Sorting Algorithm

Retrieve Sorting Algorithm

get

Retrieve a specific sorting algorithm by ID

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Sorting Algorithm retrieved successfully

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkinteger · int64Read-onlyOptional

Sorting algorithm object ID.

Example: 1

catalogintegerOptional

Related catalog object ID.

Example: 1

codestring · max: 64Optional

The code of the sorting algorithm.

Example: price_asc

namestring · max: 255Optional

The name of the sorting algorithm.

Example: Price Ascending

sorting_typestring · enumOptional

The type of sorting algorithm.

Example: staticPossible values:

rulesetobjectOptional

A JSON object containing the ruleset for the sorting algorithm.

Example: [{"exp":[{"field":"stock"},{"attribute":"stock"}],"mode":"sum","path":"r0001","order":"desc","rule_type":"sorter"}]

configobjectOptional

A JSON object containing the configuration for the sorting algorithm.

Example: {"mode":"max","order":"asc","client":"stream","base_url":"http://cdn_url/stream_files/test.csv","delimeter":";","file_format":"csv"}

is_visiblebooleanOptional

Indicates whether this sorting algorithm is visible.

Default: true

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get/api/v1/sorting_algorithms/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/sorting_algorithms/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "catalog": 1,
  "code": "price_asc",
  "name": "Price Ascending",
  "sorting_type": "static",
  "ruleset": [
    {
      "exp": [
        {
          "field": "stock"
        },
        {
          "attribute": "stock"
        }
      ],
      "mode": "sum",
      "path": "r0001",
      "order": "desc",
      "rule_type": "sorter"
    }
  ],
  "config": {
    "mode": "max",
    "order": "asc",
    "client": "stream",
    "base_url": "http://cdn_url/stream_files/test.csv",
    "delimeter": ";",
    "file_format": "csv"
  },
  "is_visible": true,
  "created_date": "2026-07-10T08:00:59.806Z",
  "modified_date": "2026-07-10T08:00:59.806Z"
}

Update Sorting Algorithm

put

Update a specific sorting algorithm by ID

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkinteger · int64Read-onlyOptional

Sorting algorithm object ID.

Example: 1

catalogintegerOptional

Related catalog object ID.

Example: 1

codestring · max: 64Optional

The code of the sorting algorithm.

Example: price_asc

namestring · max: 255Optional

The name of the sorting algorithm.

Example: Price Ascending

sorting_typestring · enumOptional

The type of sorting algorithm.

Example: staticPossible values:

rulesetobjectOptional

A JSON object containing the ruleset for the sorting algorithm.

Example: [{"exp":[{"field":"stock"},{"attribute":"stock"}],"mode":"sum","path":"r0001","order":"desc","rule_type":"sorter"}]

configobjectOptional

A JSON object containing the configuration for the sorting algorithm.

Example: {"mode":"max","order":"asc","client":"stream","base_url":"http://cdn_url/stream_files/test.csv","delimeter":";","file_format":"csv"}

is_visiblebooleanOptional

Indicates whether this sorting algorithm is visible.

Default: true

Responses

200

Sorting Algorithm updated

No content

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

put/api/v1/sorting_algorithms/{id}/

HTTPcURLJavaScriptPython

PUT /api/v1/sorting_algorithms/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "catalog": 1,
  "code": "price_asc",
  "name": "Price Ascending",
  "sorting_type": "static",
  "ruleset": [
    {
      "exp": [
        {
          "field": "stock"
        },
        {
          "attribute": "stock"
        }
      ],
      "mode": "sum",
      "path": "r0001",
      "order": "desc",
      "rule_type": "sorter"
    }
  ],
  "config": {
    "mode": "max",
    "order": "asc",
    "client": "stream",
    "base_url": "http://cdn_url/stream_files/test.csv",
    "delimeter": ";",
    "file_format": "csv"
  },
  "is_visible": true,
  "modified_date": "2026-07-10T08:00:59.806Z"
}

No content

Delete Sorting Algorithm

delete

Delete a specific Sorting Algorithm by ID

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Sorting Algorithm deleted successfully

No content

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

delete/api/v1/sorting_algorithms/{id}/

HTTPcURLJavaScriptPython

DELETE /api/v1/sorting_algorithms/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Partial Update Sorting Algorithm

patch

Partial update a specific sorting algorithm by ID

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkinteger · int64Read-onlyOptional

Sorting algorithm object ID.

Example: 1

catalogintegerOptional

Related catalog object ID.

Example: 1

codestring · max: 64Optional

The code of the sorting algorithm.

Example: price_asc

namestring · max: 255Optional

The name of the sorting algorithm.

Example: Price Ascending

sorting_typestring · enumOptional

The type of sorting algorithm.

Example: staticPossible values:

rulesetobjectOptional

A JSON object containing the ruleset for the sorting algorithm.

Example: [{"exp":[{"field":"stock"},{"attribute":"stock"}],"mode":"sum","path":"r0001","order":"desc","rule_type":"sorter"}]

configobjectOptional

A JSON object containing the configuration for the sorting algorithm.

Example: {"mode":"max","order":"asc","client":"stream","base_url":"http://cdn_url/stream_files/test.csv","delimeter":";","file_format":"csv"}

is_visiblebooleanOptional

Indicates whether this sorting algorithm is visible.

Default: true

Responses

200

Sorting Algorithm updated

No content

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch/api/v1/sorting_algorithms/{id}/

HTTPcURLJavaScriptPython

PATCH /api/v1/sorting_algorithms/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "catalog": 1,
  "code": "price_asc",
  "name": "Price Ascending",
  "sorting_type": "static",
  "ruleset": [
    {
      "exp": [
        {
          "field": "stock"
        },
        {
          "attribute": "stock"
        }
      ],
      "mode": "sum",
      "path": "r0001",
      "order": "desc",
      "rule_type": "sorter"
    }
  ],
  "config": {
    "mode": "max",
    "order": "asc",
    "client": "stream",
    "base_url": "http://cdn_url/stream_files/test.csv",
    "delimeter": ";",
    "file_format": "csv"
  },
  "is_visible": true,
  "modified_date": "2026-07-10T08:00:59.806Z"
}

No content

List Sorting Algorithm

get

List Sorting Algorithm

Authorizations

Token

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

idintegerOptional

Filters by id

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

sorting_typestring · enumOptional

The type of sorting algorithm.

Possible values:

rulesetobjectOptional

A JSON object containing the ruleset for the sorting algorithm.

Example: [{"exp":[{"field":"stock"},{"attribute":"stock"}],"mode":"sum","path":"r0001","order":"desc","rule_type":"sorter"}]

configobjectOptional

A JSON object containing the configuration for the sorting algorithm.

Example: {"mode":"max","order":"asc","client":"stream","base_url":"http://cdn_url/stream_files/test.csv","delimeter":";","file_format":"csv"}

catalog_idintegerOptional

Filter by catalog ID.

codestringOptional

Filter by code.

namestringOptional

Filter by name.

is_visiblebooleanOptional

Indicates whether this sorting algorithm is visible.

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

Responses

200

OK

application/json

countintegerOptionalExample: 0

nextstring · nullableOptional

Next page URL

previousstring · nullableOptional

Previous page URL

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get/api/v1/sorting_algorithms/

HTTPcURLJavaScriptPython

GET /api/v1/sorting_algorithms/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2026-07-10T08:00:59.806Z",
      "modified_date": "2026-07-10T08:00:59.806Z"
    }
  ]
}

Create Sorting Algorithm

post

Create a new sorting algorithm.

Authorizations

Token

AuthorizationstringRequired

Body

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkinteger · int64Read-onlyOptional

Sorting algorithm object ID.

Example: 1

catalogintegerOptional

Related catalog object ID.

Example: 1

codestring · max: 64Optional

The code of the sorting algorithm.

Example: price_asc

namestring · max: 255Optional

The name of the sorting algorithm.

Example: Price Ascending

sorting_typestring · enumOptional

The type of sorting algorithm.

Example: staticPossible values:

rulesetobjectOptional

A JSON object containing the ruleset for the sorting algorithm.

Example: [{"exp":[{"field":"stock"},{"attribute":"stock"}],"mode":"sum","path":"r0001","order":"desc","rule_type":"sorter"}]

configobjectOptional

A JSON object containing the configuration for the sorting algorithm.

Example: {"mode":"max","order":"asc","client":"stream","base_url":"http://cdn_url/stream_files/test.csv","delimeter":";","file_format":"csv"}

is_visiblebooleanOptional

Indicates whether this sorting algorithm is visible.

Default: true

Responses

201

Sorting Algorithm Created

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkinteger · int64Read-onlyOptional

Sorting algorithm object ID.

Example: 1

catalogintegerOptional

Related catalog object ID.

Example: 1

codestring · max: 64Optional

The code of the sorting algorithm.

Example: price_asc

namestring · max: 255Optional

The name of the sorting algorithm.

Example: Price Ascending

sorting_typestring · enumOptional

The type of sorting algorithm.

Example: staticPossible values:

rulesetobjectOptional

A JSON object containing the ruleset for the sorting algorithm.

Example: [{"exp":[{"field":"stock"},{"attribute":"stock"}],"mode":"sum","path":"r0001","order":"desc","rule_type":"sorter"}]

configobjectOptional

A JSON object containing the configuration for the sorting algorithm.

Example: {"mode":"max","order":"asc","client":"stream","base_url":"http://cdn_url/stream_files/test.csv","delimeter":";","file_format":"csv"}

is_visiblebooleanOptional

Indicates whether this sorting algorithm is visible.

Default: true

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post/api/v1/sorting_algorithms/

HTTPcURLJavaScriptPython

POST /api/v1/sorting_algorithms/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "catalog": 1,
  "code": "price_asc",
  "name": "Price Ascending",
  "sorting_type": "static",
  "ruleset": [
    {
      "exp": [
        {
          "field": "stock"
        },
        {
          "attribute": "stock"
        }
      ],
      "mode": "sum",
      "path": "r0001",
      "order": "desc",
      "rule_type": "sorter"
    }
  ],
  "config": {
    "mode": "max",
    "order": "asc",
    "client": "stream",
    "base_url": "http://cdn_url/stream_files/test.csv",
    "delimeter": ";",
    "file_format": "csv"
  },
  "is_visible": true,
  "modified_date": "2026-07-10T08:00:59.806Z"
}

{
  "pk": 1,
  "catalog": 1,
  "code": "price_asc",
  "name": "Price Ascending",
  "sorting_type": "static",
  "ruleset": [
    {
      "exp": [
        {
          "field": "stock"
        },
        {
          "attribute": "stock"
        }
      ],
      "mode": "sum",
      "path": "r0001",
      "order": "desc",
      "rule_type": "sorter"
    }
  ],
  "config": {
    "mode": "max",
    "order": "asc",
    "client": "stream",
    "base_url": "http://cdn_url/stream_files/test.csv",
    "delimeter": ";",
    "file_format": "csv"
  },
  "is_visible": true,
  "created_date": "2026-07-10T08:00:59.806Z",
  "modified_date": "2026-07-10T08:00:59.806Z"
}