Sales Channel Product

Get product by ID

get

Retrieve a specific product by ID.

Authorizations

AuthorizationstringRequired

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

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

attributesobjectOptional

Filter by image attributes

attributes_kwargsstringOptional

Filter by attributes using additional keyword arguments.

Example: attributes_kwargs__color=blue

localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

localized_attributes_kwargsstringOptional

Filter by localized attributes with additional keywords.

Example: localized_attributes_kwargs__locale=en-GB

namestringOptional

Filter by name.

base_codestringOptional

Filter by base code.

Example: BASECODE123

skustringOptional

Product SKU (case-insensitive)

uuidstringOptional

Filter by UUID.

Example: 123e4567-e89b-12d3-a456-426614174000

is_activebooleanOptional

Filter by active status (True or False)

extra_attributesstringOptional

Filter by extra attributes.

Example: extra_attributes__color=red

parentintegerOptional

Filter by parent product ID.

group_productsinteger[]Optional

Filter by grouped products.

attribute_setinteger · int64Optional

Filter by related attribute set ID

Example: 1

custom_attribute_setinteger[]Optional

Filter by custom attribute set IDs.

listing_codestringOptional

Filter by listing code.

is_seller_productbooleanOptional

Filter by seller product status (True or False).

brandintegerOptional

Filter by brand ID.

erp_categoriesintegerOptional

Filter by ERP category ID.

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

descriptionstringOptional

Filter by product description.

weightnumberOptional

Filter by product weight.

product_typearray · enumOptional

Filter by product type.

Possible values:

productization_datestringOptional

Filter by productization date with lookup expressions (e.g., gte, lte).

Example: productization_date__gte=2024-01-01

data_sourceinteger[]Optional

Filter by data source IDs.

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

sku__exactstringOptional

Filter by exact SKU.

Example: SKU123

sku__instring[]Optional

Filter by multiple SKUs (comma-separated).

sku_exclude__exactstringOptional

Exclude exact SKU.

Example: SKU789

sku_exclude__instring[]Optional

Exclude multiple SKUs (comma-separated).

base_code_exclude__instring[]Optional

Exclude multiple base codes (comma-separated).

base_code__exactstringOptional

Filter by exact base code.

base_code__iexactstringOptional

Filter by base code (case-insensitive).

base_code_exclude__exactstringOptional

Exclude exact base code.

base_code_exclude__iexactstringOptional

Exclude base code (case-insensitive).

pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

attributes_excludestringOptional

Exclude attributes in JSON format.

Example: attributes_exclude__size=small

product_type_excludearray · enumOptional

Exclude product types.

Possible values:

attribute_set_excludeinteger[]Optional

Exclude specific attribute sets.

offer_parentintegerOptional

Filter by parent products with a 'simple' product type.

group_parent_setinteger[]Optional

Filter by parent products with a 'grouped' product type.

parent__isnullbooleanOptional

Filter by whether parent is null (True or False).

catalogiteminteger[]Optional

Filter by catalog items.

listable_products_onlybooleanOptional

Filter by listable products only (True or False).

productimage__isnullbooleanOptional

Filter by whether the product has associated images.

productvideo__isnullbooleanOptional

Filter by whether the product has associated videos.

downloadableimage__isnullbooleanOptional

Filter by whether the product has downloadable images.

stock_list_not_containsstringOptional

Exclude products in specific stock lists.

price_list_not_containsstringOptional

Exclude products in specific price lists.

attribute_set__isnullbooleanOptional

Filter by whether attribute set is null.

exclude_bundle_chapter_productsintegerOptional

Exclude products associated with specific bundle chapters.

discountedbooleanOptional

Filter by discounted products.

data_source_excludeinteger[]Optional

Exclude specific data sources.

data_source__isnullbooleanOptional

Filter by whether data source is null.

exclude_passive_distributed_productsbooleanOptional

Exclude passive distributed products.

Responses

200

Product

application/json

idinteger · int64Read-onlyOptional

Unique identifier for the product

namestring · max: 255Required

Name of the product

base_codestring · nullableOptional

Base code for product variants

skustring · max: 255Required

Stock keeping unit - unique identifier for the product

uuidstring · uuidOptional

Unique identifier for the product price.

Example: 550e8400-e29b-41d4-a716-446655440000

descriptionstring · max: 512 · nullableOptional

Detailed description of the product

brandinteger · nullableOptional

Foreign key to Brand model

erp_categoriesinteger[]Optional

List of ERP category IDs

tax_ratenumber · decimal · max: 999.99 · nullableOptional

Tax rate percentage

weightnumber · decimal · max: 99999999.99 · nullableOptional

Product weight

product_typestring · enumRequired

Type of the product

Possible values:

productization_datestring · date-time · nullableOptional

Date when product was productized from pre status

created_datestring · date-timeRead-onlyOptional

Timestamp when the product was created

modified_datestring · date-timeRead-onlyOptional

Timestamp when the product was last updated

is_activebooleanOptional

Whether the product is currently active

Default: true

attribute_setinteger · nullableOptional

Foreign key to AttributeSet model

parentinteger · nullableOptional

Foreign key to parent Product

group_productsinteger[] · nullableOptional

List of product IDs in the group

listing_codestring · nullableOptional

Listing code for the product

is_seller_productbooleanOptional

Whether the product is a seller product

Default: false

custom_attribute_setinteger · nullableOptional

Foreign key to AttributeSet model

403

Forbidden

404

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

application/json

500

Server Error

get/api/v1/channel/{channel_id}/products/{id}/

GET /api/v1/channel/{channel_id}/products/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "data_source": 1,
  "id": 1,
  "name": "text",
  "base_code": "text",
  "sku": "text",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "description": "text",
  "brand": 1,
  "erp_categories": [
    1
  ],
  "tax_rate": 1,
  "weight": 1,
  "product_type": "pre_product",
  "productization_date": "2026-07-11T01:37:46.649Z",
  "created_date": "2026-07-11T01:37:46.649Z",
  "modified_date": "2026-07-11T01:37:46.649Z",
  "is_active": true,
  "attribute_set": 1,
  "parent": 1,
  "group_products": [
    1
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "listing_code": "text",
  "is_seller_product": false,
  "custom_attribute_set": 1
}

Get detailed product by ID

get

Retrieve a specific detailed product by ID.

Authorizations

AuthorizationstringRequired

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

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

attributesobjectOptional

Filter by image attributes

attributes_kwargsstringOptional

Filter by attributes using additional keyword arguments.

Example: attributes_kwargs__color=blue

localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

localized_attributes_kwargsstringOptional

Filter by localized attributes with additional keywords.

Example: localized_attributes_kwargs__locale=en-GB

namestringOptional

Filter by name.

base_codestringOptional

Filter by base code.

Example: BASECODE123

skustringOptional

Product SKU (case-insensitive)

uuidstringOptional

Filter by UUID.

Example: 123e4567-e89b-12d3-a456-426614174000

is_activebooleanOptional

Filter by active status (True or False)

extra_attributesstringOptional

Filter by extra attributes.

Example: extra_attributes__color=red

parentintegerOptional

Filter by parent product ID.

group_productsinteger[]Optional

Filter by grouped products.

attribute_setinteger · int64Optional

Filter by related attribute set ID

Example: 1

custom_attribute_setinteger[]Optional

Filter by custom attribute set IDs.

listing_codestringOptional

Filter by listing code.

is_seller_productbooleanOptional

Filter by seller product status (True or False).

brandintegerOptional

Filter by brand ID.

erp_categoriesintegerOptional

Filter by ERP category ID.

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

descriptionstringOptional

Filter by product description.

weightnumberOptional

Filter by product weight.

product_typearray · enumOptional

Filter by product type.

Possible values:

productization_datestringOptional

Filter by productization date with lookup expressions (e.g., gte, lte).

Example: productization_date__gte=2024-01-01

data_sourceinteger[]Optional

Filter by data source IDs.

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

sku__exactstringOptional

Filter by exact SKU.

Example: SKU123

sku__instring[]Optional

Filter by multiple SKUs (comma-separated).

sku_exclude__exactstringOptional

Exclude exact SKU.

Example: SKU789

sku_exclude__instring[]Optional

Exclude multiple SKUs (comma-separated).

base_code_exclude__instring[]Optional

Exclude multiple base codes (comma-separated).

base_code__exactstringOptional

Filter by exact base code.

base_code__iexactstringOptional

Filter by base code (case-insensitive).

base_code_exclude__exactstringOptional

Exclude exact base code.

base_code_exclude__iexactstringOptional

Exclude base code (case-insensitive).

pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

attributes_excludestringOptional

Exclude attributes in JSON format.

Example: attributes_exclude__size=small

product_type_excludearray · enumOptional

Exclude product types.

Possible values:

attribute_set_excludeinteger[]Optional

Exclude specific attribute sets.

offer_parentintegerOptional

Filter by parent products with a 'simple' product type.

group_parent_setinteger[]Optional

Filter by parent products with a 'grouped' product type.

parent__isnullbooleanOptional

Filter by whether parent is null (True or False).

catalogiteminteger[]Optional

Filter by catalog items.

listable_products_onlybooleanOptional

Filter by listable products only (True or False).

productimage__isnullbooleanOptional

Filter by whether the product has associated images.

productvideo__isnullbooleanOptional

Filter by whether the product has associated videos.

downloadableimage__isnullbooleanOptional

Filter by whether the product has downloadable images.

stock_list_not_containsstringOptional

Exclude products in specific stock lists.

price_list_not_containsstringOptional

Exclude products in specific price lists.

attribute_set__isnullbooleanOptional

Filter by whether attribute set is null.

exclude_bundle_chapter_productsintegerOptional

Exclude products associated with specific bundle chapters.

discountedbooleanOptional

Filter by discounted products.

data_source_excludeinteger[]Optional

Exclude specific data sources.

data_source__isnullbooleanOptional

Filter by whether data source is null.

exclude_passive_distributed_productsbooleanOptional

Exclude passive distributed products.

Responses

200

Product

application/json

idinteger · int64Read-onlyOptional

Unique identifier for the product

namestring · max: 255Required

Name of the product

base_codestring · nullableOptional

Base code for product variants

skustring · max: 255Required

Stock keeping unit - unique identifier for the product

uuidstring · uuidOptional

Unique identifier for the product price.

Example: 550e8400-e29b-41d4-a716-446655440000

descriptionstring · max: 512 · nullableOptional

Detailed description of the product

brandinteger · nullableOptional

Foreign key to Brand model

erp_categoriesinteger[]Optional

List of ERP category IDs

tax_ratenumber · decimal · max: 999.99 · nullableOptional

Tax rate percentage

weightnumber · decimal · max: 99999999.99 · nullableOptional

Product weight

product_typestring · enumRequired

Type of the product

Possible values:

productization_datestring · date-time · nullableOptional

Date when product was productized from pre status

created_datestring · date-timeRead-onlyOptional

Timestamp when the product was created

modified_datestring · date-timeRead-onlyOptional

Timestamp when the product was last updated

is_activebooleanOptional

Whether the product is currently active

Default: true

listing_codestring · nullableOptional

Listing code for the product

is_seller_productbooleanOptional

Whether the product is a seller product

Default: false

403

Forbidden

404

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

application/json

500

Server Error

get/api/v1/channel/{channel_id}/products/{id}/detailed/

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

{
  "parent": 1,
  "group_products": [
    1
  ],
  "productimage_set": [
    {
      "pk": 1,
      "status": "active",
      "order": 1,
      "created_date": "2026-07-11T01:37:46.649Z",
      "modified_date": "2026-07-11T01:37:46.649Z",
      "specialimage_set": [
        {
          "id": 1,
          "product": 1,
          "product_image": 1,
          "image_type": "base"
        }
      ],
      "image": "binary"
    }
  ],
  "attribute_set": 1,
  "custom_attribute_set": 1,
  "data_source": 1,
  "id": 1,
  "name": "text",
  "base_code": "text",
  "sku": "text",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "description": "text",
  "brand": 1,
  "erp_categories": [
    1
  ],
  "tax_rate": 1,
  "weight": 1,
  "product_type": "pre_product",
  "productization_date": "2026-07-11T01:37:46.649Z",
  "created_date": "2026-07-11T01:37:46.649Z",
  "modified_date": "2026-07-11T01:37:46.649Z",
  "is_active": true,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "listing_code": "text",
  "is_seller_product": false
}

List all products for a channel

get

Retrieve a list of all products associated with a specific channel

Authorizations

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

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

attributesobjectOptional

Filter by image attributes

attributes_kwargsstringOptional

Filter by attributes using additional keyword arguments.

Example: attributes_kwargs__color=blue

localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

localized_attributes_kwargsstringOptional

Filter by localized attributes with additional keywords.

Example: localized_attributes_kwargs__locale=en-GB

namestringOptional

Filter by name.

base_codestringOptional

Filter by base code.

Example: BASECODE123

skustringOptional

Product SKU (case-insensitive)

uuidstringOptional

Filter by UUID.

Example: 123e4567-e89b-12d3-a456-426614174000

is_activebooleanOptional

Filter by active status (True or False)

extra_attributesstringOptional

Filter by extra attributes.

Example: extra_attributes__color=red

parentintegerOptional

Filter by parent product ID.

group_productsinteger[]Optional

Filter by grouped products.

attribute_setinteger · int64Optional

Filter by related attribute set ID

Example: 1

custom_attribute_setinteger[]Optional

Filter by custom attribute set IDs.

listing_codestringOptional

Filter by listing code.

is_seller_productbooleanOptional

Filter by seller product status (True or False).

brandintegerOptional

Filter by brand ID.

erp_categoriesintegerOptional

Filter by ERP category ID.

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

descriptionstringOptional

Filter by product description.

weightnumberOptional

Filter by product weight.

product_typearray · enumOptional

Filter by product type.

Possible values:

productization_datestringOptional

Filter by productization date with lookup expressions (e.g., gte, lte).

Example: productization_date__gte=2024-01-01

data_sourceinteger[]Optional

Filter by data source IDs.

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

sku__exactstringOptional

Filter by exact SKU.

Example: SKU123

sku__instring[]Optional

Filter by multiple SKUs (comma-separated).

sku_exclude__exactstringOptional

Exclude exact SKU.

Example: SKU789

sku_exclude__instring[]Optional

Exclude multiple SKUs (comma-separated).

base_code_exclude__instring[]Optional

Exclude multiple base codes (comma-separated).

base_code__exactstringOptional

Filter by exact base code.

base_code__iexactstringOptional

Filter by base code (case-insensitive).

base_code_exclude__exactstringOptional

Exclude exact base code.

base_code_exclude__iexactstringOptional

Exclude base code (case-insensitive).

pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

attributes_excludestringOptional

Exclude attributes in JSON format.

Example: attributes_exclude__size=small

product_type_excludearray · enumOptional

Exclude product types.

Possible values:

attribute_set_excludeinteger[]Optional

Exclude specific attribute sets.

offer_parentintegerOptional

Filter by parent products with a 'simple' product type.

group_parent_setinteger[]Optional

Filter by parent products with a 'grouped' product type.

parent__isnullbooleanOptional

Filter by whether parent is null (True or False).

catalogiteminteger[]Optional

Filter by catalog items.

listable_products_onlybooleanOptional

Filter by listable products only (True or False).

productimage__isnullbooleanOptional

Filter by whether the product has associated images.

productvideo__isnullbooleanOptional

Filter by whether the product has associated videos.

downloadableimage__isnullbooleanOptional

Filter by whether the product has downloadable images.

stock_list_not_containsstringOptional

Exclude products in specific stock lists.

price_list_not_containsstringOptional

Exclude products in specific price lists.

attribute_set__isnullbooleanOptional

Filter by whether attribute set is null.

exclude_bundle_chapter_productsintegerOptional

Exclude products associated with specific bundle chapters.

discountedbooleanOptional

Filter by discounted products.

data_source_excludeinteger[]Optional

Exclude specific data sources.

data_source__isnullbooleanOptional

Filter by whether data source is null.

exclude_passive_distributed_productsbooleanOptional

Exclude passive distributed products.

Responses

200

Successful response

application/json

countintegerOptional

Total number of records

nextstring · uri · nullableOptional

URL of the next page

previousstring · uri · nullableOptional

URL of the previous page

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

get/api/v1/channel/{channel_id}/products/

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

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "id": 1,
      "name": "text",
      "base_code": "text",
      "sku": "text",
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "description": "text",
      "brand": 1,
      "erp_categories": [
        1
      ],
      "tax_rate": 1,
      "weight": 1,
      "product_type": "pre_product",
      "productization_date": "2026-07-11T01:37:46.649Z",
      "data_source": 1,
      "created_date": "2026-07-11T01:37:46.649Z",
      "modified_date": "2026-07-11T01:37:46.649Z",
      "is_active": true,
      "attribute_set": 1,
      "parent": 1,
      "group_products": [
        1
      ],
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "listing_code": "text",
      "is_seller_product": false,
      "custom_attribute_set": 1
    }
  ]
}

List all detailed products for a channel

get

Retrieve a list of all detailed products associated with a specific channel

Authorizations

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

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

attributesobjectOptional

Filter by image attributes

attributes_kwargsstringOptional

Filter by attributes using additional keyword arguments.

Example: attributes_kwargs__color=blue

localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

localized_attributes_kwargsstringOptional

Filter by localized attributes with additional keywords.

Example: localized_attributes_kwargs__locale=en-GB

namestringOptional

Filter by name.

base_codestringOptional

Filter by base code.

Example: BASECODE123

skustringOptional

Product SKU (case-insensitive)

uuidstringOptional

Filter by UUID.

Example: 123e4567-e89b-12d3-a456-426614174000

is_activebooleanOptional

Filter by active status (True or False)

extra_attributesstringOptional

Filter by extra attributes.

Example: extra_attributes__color=red

parentintegerOptional

Filter by parent product ID.

group_productsinteger[]Optional

Filter by grouped products.

attribute_setinteger · int64Optional

Filter by related attribute set ID

Example: 1

custom_attribute_setinteger[]Optional

Filter by custom attribute set IDs.

listing_codestringOptional

Filter by listing code.

is_seller_productbooleanOptional

Filter by seller product status (True or False).

brandintegerOptional

Filter by brand ID.

erp_categoriesintegerOptional

Filter by ERP category ID.

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

descriptionstringOptional

Filter by product description.

weightnumberOptional

Filter by product weight.

product_typearray · enumOptional

Filter by product type.

Possible values:

productization_datestringOptional

Filter by productization date with lookup expressions (e.g., gte, lte).

Example: productization_date__gte=2024-01-01

data_sourceinteger[]Optional

Filter by data source IDs.

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

sku__exactstringOptional

Filter by exact SKU.

Example: SKU123

sku__instring[]Optional

Filter by multiple SKUs (comma-separated).

sku_exclude__exactstringOptional

Exclude exact SKU.

Example: SKU789

sku_exclude__instring[]Optional

Exclude multiple SKUs (comma-separated).

base_code_exclude__instring[]Optional

Exclude multiple base codes (comma-separated).

base_code__exactstringOptional

Filter by exact base code.

base_code__iexactstringOptional

Filter by base code (case-insensitive).

base_code_exclude__exactstringOptional

Exclude exact base code.

base_code_exclude__iexactstringOptional

Exclude base code (case-insensitive).

pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

attributes_excludestringOptional

Exclude attributes in JSON format.

Example: attributes_exclude__size=small

product_type_excludearray · enumOptional

Exclude product types.

Possible values:

attribute_set_excludeinteger[]Optional

Exclude specific attribute sets.

offer_parentintegerOptional

Filter by parent products with a 'simple' product type.

group_parent_setinteger[]Optional

Filter by parent products with a 'grouped' product type.

parent__isnullbooleanOptional

Filter by whether parent is null (True or False).

catalogiteminteger[]Optional

Filter by catalog items.

listable_products_onlybooleanOptional

Filter by listable products only (True or False).

productimage__isnullbooleanOptional

Filter by whether the product has associated images.

productvideo__isnullbooleanOptional

Filter by whether the product has associated videos.

downloadableimage__isnullbooleanOptional

Filter by whether the product has downloadable images.

stock_list_not_containsstringOptional

Exclude products in specific stock lists.

price_list_not_containsstringOptional

Exclude products in specific price lists.

attribute_set__isnullbooleanOptional

Filter by whether attribute set is null.

exclude_bundle_chapter_productsintegerOptional

Exclude products associated with specific bundle chapters.

discountedbooleanOptional

Filter by discounted products.

data_source_excludeinteger[]Optional

Exclude specific data sources.

data_source__isnullbooleanOptional

Filter by whether data source is null.

exclude_passive_distributed_productsbooleanOptional

Exclude passive distributed products.

Responses

200

Successful response

application/json

countintegerOptional

Total number of records

nextstring · uri · nullableOptional

URL of the next page

previousstring · uri · nullableOptional

URL of the previous page

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

get/api/v1/channel/{channel_id}/products/detailed/

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

{
  "results": [
    {
      "id": 1,
      "name": "text",
      "base_code": "text",
      "sku": "text",
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "description": "text",
      "brand": 1,
      "erp_categories": [
        1
      ],
      "tax_rate": 1,
      "weight": 1,
      "product_type": "pre_product",
      "productization_date": "2026-07-11T01:37:46.649Z",
      "data_source": 1,
      "created_date": "2026-07-11T01:37:46.649Z",
      "modified_date": "2026-07-11T01:37:46.649Z",
      "is_active": true,
      "attribute_set": 1,
      "parent": 1,
      "group_products": [
        1
      ],
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "listing_code": "text",
      "is_seller_product": false,
      "custom_attribute_set": 1
    }
  ],
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com"
}

List all of inserted products from related channel

get

Lists all of inserted products data from related channel

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Responses

200

application/json

idinteger · int64Read-onlyOptional

Unique identifier for the product

namestring · max: 255Required

Name of the product

base_codestring · nullableOptional

Base code for product variants

skustring · max: 255Required

Stock keeping unit - unique identifier for the product

uuidstring · uuidOptional

Unique identifier for the product price.

Example: 550e8400-e29b-41d4-a716-446655440000

descriptionstring · max: 512 · nullableOptional

Detailed description of the product

brandinteger · nullableOptional

Foreign key to Brand model

erp_categoriesinteger[]Optional

List of ERP category IDs

tax_ratenumber · decimal · max: 999.99 · nullableOptional

Tax rate percentage

weightnumber · decimal · max: 99999999.99 · nullableOptional

Product weight

product_typestring · enumRequired

Type of the product

Possible values:

productization_datestring · date-time · nullableOptional

Date when product was productized from pre status

created_datestring · date-timeRead-onlyOptional

Timestamp when the product was created

modified_datestring · date-timeRead-onlyOptional

Timestamp when the product was last updated

is_activebooleanOptional

Whether the product is currently active

Default: true

attribute_setinteger · nullableOptional

Foreign key to AttributeSet model

parentinteger · nullableOptional

Foreign key to parent Product

group_productsinteger[] · nullableOptional

List of product IDs in the group

listing_codestring · nullableOptional

Listing code for the product

is_seller_productbooleanOptional

Whether the product is a seller product

Default: false

custom_attribute_setinteger · nullableOptional

Foreign key to AttributeSet model

get/api/v1/channel/{channel_id}/products/inserts/

GET /api/v1/channel/{channel_id}/products/inserts/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "id": 1,
    "name": "text",
    "base_code": "text",
    "sku": "text",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "description": "text",
    "brand": 1,
    "erp_categories": [
      1
    ],
    "tax_rate": 1,
    "weight": 1,
    "product_type": "pre_product",
    "productization_date": "2026-07-11T01:37:46.649Z",
    "data_source": 1,
    "created_date": "2026-07-11T01:37:46.649Z",
    "modified_date": "2026-07-11T01:37:46.649Z",
    "is_active": true,
    "attribute_set": 1,
    "parent": 1,
    "group_products": [
      1
    ],
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "listing_code": "text",
    "is_seller_product": false,
    "custom_attribute_set": 1
  }
]

List all of updated products from related channel

get

List all of updated products from related channel

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Responses

200

application/json

idinteger · int64Read-onlyOptional

Unique identifier for the product

namestring · max: 255Required

Name of the product

base_codestring · nullableOptional

Base code for product variants

skustring · max: 255Required

Stock keeping unit - unique identifier for the product

uuidstring · uuidOptional

Unique identifier for the product price.

Example: 550e8400-e29b-41d4-a716-446655440000

descriptionstring · max: 512 · nullableOptional

Detailed description of the product

brandinteger · nullableOptional

Foreign key to Brand model

erp_categoriesinteger[]Optional

List of ERP category IDs

tax_ratenumber · decimal · max: 999.99 · nullableOptional

Tax rate percentage

weightnumber · decimal · max: 99999999.99 · nullableOptional

Product weight

product_typestring · enumRequired

Type of the product

Possible values:

productization_datestring · date-time · nullableOptional

Date when product was productized from pre status

created_datestring · date-timeRead-onlyOptional

Timestamp when the product was created

modified_datestring · date-timeRead-onlyOptional

Timestamp when the product was last updated

is_activebooleanOptional

Whether the product is currently active

Default: true

attribute_setinteger · nullableOptional

Foreign key to AttributeSet model

parentinteger · nullableOptional

Foreign key to parent Product

group_productsinteger[] · nullableOptional

List of product IDs in the group

listing_codestring · nullableOptional

Listing code for the product

is_seller_productbooleanOptional

Whether the product is a seller product

Default: false

custom_attribute_setinteger · nullableOptional

Foreign key to AttributeSet model

get/api/v1/channel/{channel_id}/products/updates/

GET /api/v1/channel/{channel_id}/products/updates/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "id": 1,
    "name": "text",
    "base_code": "text",
    "sku": "text",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "description": "text",
    "brand": 1,
    "erp_categories": [
      1
    ],
    "tax_rate": 1,
    "weight": 1,
    "product_type": "pre_product",
    "productization_date": "2026-07-11T01:37:46.649Z",
    "data_source": 1,
    "created_date": "2026-07-11T01:37:46.649Z",
    "modified_date": "2026-07-11T01:37:46.649Z",
    "is_active": true,
    "attribute_set": 1,
    "parent": 1,
    "group_products": [
      1
    ],
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "listing_code": "text",
    "is_seller_product": false,
    "custom_attribute_set": 1
  }
]

List all of inserted or updated products from related channel

get

List all of inserted or updated products from related channel

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Responses

200

application/json

idinteger · int64Read-onlyOptional

Unique identifier for the product

namestring · max: 255Required

Name of the product

base_codestring · nullableOptional

Base code for product variants

skustring · max: 255Required

Stock keeping unit - unique identifier for the product

uuidstring · uuidOptional

Unique identifier for the product price.

Example: 550e8400-e29b-41d4-a716-446655440000

descriptionstring · max: 512 · nullableOptional

Detailed description of the product

brandinteger · nullableOptional

Foreign key to Brand model

erp_categoriesinteger[]Optional

List of ERP category IDs

tax_ratenumber · decimal · max: 999.99 · nullableOptional

Tax rate percentage

weightnumber · decimal · max: 99999999.99 · nullableOptional

Product weight

product_typestring · enumRequired

Type of the product

Possible values:

productization_datestring · date-time · nullableOptional

Date when product was productized from pre status

created_datestring · date-timeRead-onlyOptional

Timestamp when the product was created

modified_datestring · date-timeRead-onlyOptional

Timestamp when the product was last updated

is_activebooleanOptional

Whether the product is currently active

Default: true

attribute_setinteger · nullableOptional

Foreign key to AttributeSet model

parentinteger · nullableOptional

Foreign key to parent Product

group_productsinteger[] · nullableOptional

List of product IDs in the group

listing_codestring · nullableOptional

Listing code for the product

is_seller_productbooleanOptional

Whether the product is a seller product

Default: false

custom_attribute_setinteger · nullableOptional

Foreign key to AttributeSet model

get/api/v1/channel/{channel_id}/products/inserts_or_updates/

GET /api/v1/channel/{channel_id}/products/inserts_or_updates/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "id": 1,
    "name": "text",
    "base_code": "text",
    "sku": "text",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "description": "text",
    "brand": 1,
    "erp_categories": [
      1
    ],
    "tax_rate": 1,
    "weight": 1,
    "product_type": "pre_product",
    "productization_date": "2026-07-11T01:37:46.649Z",
    "data_source": 1,
    "created_date": "2026-07-11T01:37:46.649Z",
    "modified_date": "2026-07-11T01:37:46.649Z",
    "is_active": true,
    "attribute_set": 1,
    "parent": 1,
    "group_products": [
      1
    ],
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "listing_code": "text",
    "is_seller_product": false,
    "custom_attribute_set": 1
  }
]

PreviousSales Channel Orders NextSales Channel Cancellation Plans

Last updated 6 months ago

Was this helpful?