SalesChannelProduct
Retrieve a specific product by ID.
Channel ID to operate on
Unique identifier of the resource
1Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilter by image attributes
Filter by attributes using additional keyword arguments.
attributes_kwargs__color=blueFilter by localized attributes in JSON format.
localized_attributes__locale=en-USFilter by localized attributes with additional keywords.
localized_attributes_kwargs__locale=en-GBFilters by name
Filter by base code.
BASECODE123Product SKU (case-insensitive)
Filter by UUID.
123e4567-e89b-12d3-a456-426614174000Filter by active status (True or False)
Filter by extra attributes.
extra_attributes__color=redFilter by parent product ID.
Filter by grouped products.
Filter by related attribute set ID
1Filter by custom attribute set IDs.
Filter by listing code.
Filter by seller product status (True or False).
Filter by brand ID.
Filter by ERP category ID.
Filter by Tax Rate.
18Filter by product description.
Filter by product weight.
Filter by product type.
Filter by productization date with lookup expressions (e.g., gte, lte).
productization_date__gte=2024-01-01Filter by data source IDs.
Filters by primary key
Filters by primary key greater than the given value
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filter by exact SKU.
SKU123Filter by multiple SKUs (comma-separated).
Exclude exact SKU.
SKU789Exclude multiple SKUs (comma-separated).
Exclude multiple base codes (comma-separated).
Filter by exact base code.
Filter by base code (case-insensitive).
Exclude exact base code.
Exclude base code (case-insensitive).
Filter by multiple primary key values (comma-separated list of integers)
Exclude attributes in JSON format.
attributes_exclude__size=smallExclude product types.
Exclude specific attribute sets.
Filter by parent products with a 'simple' product type.
Filter by parent products with a 'grouped' product type.
Filter by whether parent is null (True or False).
Filter by catalog items.
Filter by listable products only (True or False).
Filter by whether the product has associated images.
Filter by whether the product has associated videos.
Filter by whether the product has downloadable images.
Exclude products in specific stock lists.
Exclude products in specific price lists.
Filter by whether attribute set is null.
Exclude products associated with specific bundle chapters.
Filter by discounted products.
Exclude specific data sources.
Filter by whether data source is null.
Exclude passive distributed products.
Product
Forbidden
The given resource or object was not found or does not exist.
Server Error
GET /api/v1/channel/{channel_id}/products/{id}/ HTTP/1.1
Host: sandbox.akinon.com
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": "2025-12-01T14:08:31.354Z",
"created_date": "2025-12-01T14:08:31.354Z",
"modified_date": "2025-12-01T14:08:31.354Z",
"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
}Retrieve a specific detailed product by ID.
Channel ID to operate on
Unique identifier of the resource
1Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilter by image attributes
Filter by attributes using additional keyword arguments.
attributes_kwargs__color=blueFilter by localized attributes in JSON format.
localized_attributes__locale=en-USFilter by localized attributes with additional keywords.
localized_attributes_kwargs__locale=en-GBFilters by name
Filter by base code.
BASECODE123Product SKU (case-insensitive)
Filter by UUID.
123e4567-e89b-12d3-a456-426614174000Filter by active status (True or False)
Filter by extra attributes.
extra_attributes__color=redFilter by parent product ID.
Filter by grouped products.
Filter by related attribute set ID
1Filter by custom attribute set IDs.
Filter by listing code.
Filter by seller product status (True or False).
Filter by brand ID.
Filter by ERP category ID.
Filter by Tax Rate.
18Filter by product description.
Filter by product weight.
Filter by product type.
Filter by productization date with lookup expressions (e.g., gte, lte).
productization_date__gte=2024-01-01Filter by data source IDs.
Filters by primary key
Filters by primary key greater than the given value
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filter by exact SKU.
SKU123Filter by multiple SKUs (comma-separated).
Exclude exact SKU.
SKU789Exclude multiple SKUs (comma-separated).
Exclude multiple base codes (comma-separated).
Filter by exact base code.
Filter by base code (case-insensitive).
Exclude exact base code.
Exclude base code (case-insensitive).
Filter by multiple primary key values (comma-separated list of integers)
Exclude attributes in JSON format.
attributes_exclude__size=smallExclude product types.
Exclude specific attribute sets.
Filter by parent products with a 'simple' product type.
Filter by parent products with a 'grouped' product type.
Filter by whether parent is null (True or False).
Filter by catalog items.
Filter by listable products only (True or False).
Filter by whether the product has associated images.
Filter by whether the product has associated videos.
Filter by whether the product has downloadable images.
Exclude products in specific stock lists.
Exclude products in specific price lists.
Filter by whether attribute set is null.
Exclude products associated with specific bundle chapters.
Filter by discounted products.
Exclude specific data sources.
Filter by whether data source is null.
Exclude passive distributed products.
Product
Forbidden
The given resource or object was not found or does not exist.
Server Error
GET /api/v1/channel/{channel_id}/products/{id}/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"parent": 1,
"group_products": [
1
],
"productimage_set": [
{
"pk": 1,
"status": "active",
"order": 1,
"created_date": "2025-12-01T14:08:31.354Z",
"modified_date": "2025-12-01T14:08:31.354Z",
"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": "2025-12-01T14:08:31.354Z",
"created_date": "2025-12-01T14:08:31.354Z",
"modified_date": "2025-12-01T14:08:31.354Z",
"is_active": true,
"attributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"listing_code": "text",
"is_seller_product": false
}Retrieve a list of all products associated with a specific channel
The channel ID of the resource.
5Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilter by image attributes
Filter by attributes using additional keyword arguments.
attributes_kwargs__color=blueFilter by localized attributes in JSON format.
localized_attributes__locale=en-USFilter by localized attributes with additional keywords.
localized_attributes_kwargs__locale=en-GBFilters by name
Filter by base code.
BASECODE123Product SKU (case-insensitive)
Filter by UUID.
123e4567-e89b-12d3-a456-426614174000Filter by active status (True or False)
Filter by extra attributes.
extra_attributes__color=redFilter by parent product ID.
Filter by grouped products.
Filter by related attribute set ID
1Filter by custom attribute set IDs.
Filter by listing code.
Filter by seller product status (True or False).
Filter by brand ID.
Filter by ERP category ID.
Filter by Tax Rate.
18Filter by product description.
Filter by product weight.
Filter by product type.
Filter by productization date with lookup expressions (e.g., gte, lte).
productization_date__gte=2024-01-01Filter by data source IDs.
Filters by primary key
Filters by primary key greater than the given value
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filter by exact SKU.
SKU123Filter by multiple SKUs (comma-separated).
Exclude exact SKU.
SKU789Exclude multiple SKUs (comma-separated).
Exclude multiple base codes (comma-separated).
Filter by exact base code.
Filter by base code (case-insensitive).
Exclude exact base code.
Exclude base code (case-insensitive).
Filter by multiple primary key values (comma-separated list of integers)
Exclude attributes in JSON format.
attributes_exclude__size=smallExclude product types.
Exclude specific attribute sets.
Filter by parent products with a 'simple' product type.
Filter by parent products with a 'grouped' product type.
Filter by whether parent is null (True or False).
Filter by catalog items.
Filter by listable products only (True or False).
Filter by whether the product has associated images.
Filter by whether the product has associated videos.
Filter by whether the product has downloadable images.
Exclude products in specific stock lists.
Exclude products in specific price lists.
Filter by whether attribute set is null.
Exclude products associated with specific bundle chapters.
Filter by discounted products.
Exclude specific data sources.
Filter by whether data source is null.
Exclude passive distributed products.
Successful response
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
GET /api/v1/channel/{channel_id}/products/ HTTP/1.1
Host: sandbox.akinon.com
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": "2025-12-01T14:08:31.354Z",
"data_source": 1,
"created_date": "2025-12-01T14:08:31.354Z",
"modified_date": "2025-12-01T14:08:31.354Z",
"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
}
]
}Retrieve a list of all detailed products associated with a specific channel
The channel ID of the resource.
5Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilter by image attributes
Filter by attributes using additional keyword arguments.
attributes_kwargs__color=blueFilter by localized attributes in JSON format.
localized_attributes__locale=en-USFilter by localized attributes with additional keywords.
localized_attributes_kwargs__locale=en-GBFilters by name
Filter by base code.
BASECODE123Product SKU (case-insensitive)
Filter by UUID.
123e4567-e89b-12d3-a456-426614174000Filter by active status (True or False)
Filter by extra attributes.
extra_attributes__color=redFilter by parent product ID.
Filter by grouped products.
Filter by related attribute set ID
1Filter by custom attribute set IDs.
Filter by listing code.
Filter by seller product status (True or False).
Filter by brand ID.
Filter by ERP category ID.
Filter by Tax Rate.
18Filter by product description.
Filter by product weight.
Filter by product type.
Filter by productization date with lookup expressions (e.g., gte, lte).
productization_date__gte=2024-01-01Filter by data source IDs.
Filters by primary key
Filters by primary key greater than the given value
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filter by exact SKU.
SKU123Filter by multiple SKUs (comma-separated).
Exclude exact SKU.
SKU789Exclude multiple SKUs (comma-separated).
Exclude multiple base codes (comma-separated).
Filter by exact base code.
Filter by base code (case-insensitive).
Exclude exact base code.
Exclude base code (case-insensitive).
Filter by multiple primary key values (comma-separated list of integers)
Exclude attributes in JSON format.
attributes_exclude__size=smallExclude product types.
Exclude specific attribute sets.
Filter by parent products with a 'simple' product type.
Filter by parent products with a 'grouped' product type.
Filter by whether parent is null (True or False).
Filter by catalog items.
Filter by listable products only (True or False).
Filter by whether the product has associated images.
Filter by whether the product has associated videos.
Filter by whether the product has downloadable images.
Exclude products in specific stock lists.
Exclude products in specific price lists.
Filter by whether attribute set is null.
Exclude products associated with specific bundle chapters.
Filter by discounted products.
Exclude specific data sources.
Filter by whether data source is null.
Exclude passive distributed products.
Successful response
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
GET /api/v1/channel/{channel_id}/products/detailed/ HTTP/1.1
Host: sandbox.akinon.com
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": "2025-12-01T14:08:31.354Z",
"data_source": 1,
"created_date": "2025-12-01T14:08:31.354Z",
"modified_date": "2025-12-01T14:08:31.354Z",
"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"
}Lists all of inserted products data from related channel
The channel ID of the resource.
5OK
GET /api/v1/channel/{channel_id}/products/inserts/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
OK
[
{
"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": "2025-12-01T14:08:31.354Z",
"data_source": 1,
"created_date": "2025-12-01T14:08:31.354Z",
"modified_date": "2025-12-01T14:08:31.354Z",
"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
The channel ID of the resource.
5OK
GET /api/v1/channel/{channel_id}/products/updates/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
OK
[
{
"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": "2025-12-01T14:08:31.354Z",
"data_source": 1,
"created_date": "2025-12-01T14:08:31.354Z",
"modified_date": "2025-12-01T14:08:31.354Z",
"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
The channel ID of the resource.
5OK
GET /api/v1/channel/{channel_id}/products/inserts_or_updates/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
OK
[
{
"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": "2025-12-01T14:08:31.354Z",
"data_source": 1,
"created_date": "2025-12-01T14:08:31.354Z",
"modified_date": "2025-12-01T14:08:31.354Z",
"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
}
]Was this helpful?

