SalesChannelGetStockList

Retrieves a specific stock list data of given channel

get

Retrieves a specific stock list data 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

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.

pkintegerRead-onlyOptional

The unique identifier for the stock list

namestring · max: 255Optional

The name of the stock list

codestring · max: 50Optional

The code of the stock list

is_auto_syncbooleanOptional

Indicates if the stock list is set to auto-sync

Default: false

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

HTTPcURLJavaScriptPython

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

{
  "pk": 1,
  "name": "text",
  "code": "text",
  "is_auto_sync": false,
  "created_date": "2026-06-09T05:55:21.651Z",
  "modified_date": "2026-06-09T05:55:21.651Z"
}

Lists all of stock list data of given channel

get

Lists all of stock 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}/stock_lists/

HTTPcURLJavaScriptPython

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

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2026-06-09T05:55:21.651Z",
      "modified_date": "2026-06-09T05:55:21.651Z"
    }
  ]
}

Lists all of stock list data of given channel

get

Lists all of stock 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}/stock_lists/detailed/

HTTPcURLJavaScriptPython

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

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2026-06-09T05:55:21.651Z",
      "modified_date": "2026-06-09T05:55:21.651Z"
    }
  ]
}