SalesChannelGetPriceList

Retrieves specific price list data with given id of given channel

get

Retrieves specific price list data with given id of given channel

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

OK

application/json

pkinteger · int64Optional

Price List ID

namestring · max: 64Optional

Name of the price list.

Example: Standard Price List

codestring · max: 64 · nullableOptional

Unique code for the price list. Can be null or blank.

Example: shop_price_list

currencystring · enumOptional

Currency type for the price list.

Example: tryPossible values:

is_auto_syncbooleanOptional

Indicates whether the price list is auto-synchronized with an external integration.

Default: falseExample: true

created_datestring · date-timeOptional

Creation Date of the Price List

modified_datestring · date-timeOptional

Last Modification Date of the Price List

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/{channel_id}/price_lists/{id}/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/{channel_id}/price_lists/{id}/detailed/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "name": "Standard Price List",
  "code": "shop_price_list",
  "currency": "try",
  "is_auto_sync": true,
  "created_date": "2026-03-06T21:30:25.309Z",
  "modified_date": "2026-03-06T21:30:25.309Z"
}

Lists all of price list data of given channel

get

Lists all of price list data of given channel

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

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

namestringOptional

Filter by name.

codestringOptional

Filter by code.

code__exactstringOptional

Filters by exact code

is_auto_syncbooleanOptional

Filter by auto-sync status.

Example: true

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

Responses

200

OK

application/json

countintegerOptionalExample: 0

nextstring · nullableOptional

Next page URL

previousstring · nullableOptional

Previous page URL

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/{channel_id}/price_lists/

HTTPcURLJavaScriptPython

GET /api/v1/{channel_id}/price_lists/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "name": "Standard Price List",
      "code": "shop_price_list",
      "currency": "try",
      "is_auto_sync": true,
      "created_date": "2026-03-06T21:30:25.309Z",
      "modified_date": "2026-03-06T21:30:25.309Z"
    }
  ]
}

Lists all of price list data of given channel

get

Lists all of price list data of given channel

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

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

namestringOptional

Filter by name.

codestringOptional

Filter by code.

code__exactstringOptional

Filters by exact code

is_auto_syncbooleanOptional

Filter by auto-sync status.

Example: true

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

Responses

200

OK

application/json

countintegerOptionalExample: 0

nextstring · nullableOptional

Next page URL

previousstring · nullableOptional

Previous page URL

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/{channel_id}/price_lists/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/{channel_id}/price_lists/detailed/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "name": "Standard Price List",
      "code": "shop_price_list",
      "currency": "try",
      "is_auto_sync": true,
      "created_date": "2026-03-06T21:30:25.309Z",
      "modified_date": "2026-03-06T21:30:25.309Z"
    }
  ]
}