LogoLogo
  • Welcome to Akinon Documentation
  • Products
    • ACC
    • Omnitron
    • Commerce
    • Order Management System (OMS)
    • Instore
    • Integrator
    • Marketplace Dashboard (MPD)
    • Project Zero (PZ)
    • Seller Center
    • Akifast
    • App Maker
  • API Reference
    • Welcome to Akinon API Reference
  • Omnitron
    • Getting Started
    • Integration
      • Product
        • Product
        • Pre-Product
        • Attribute
        • Attribute Value
        • Attribute Set
        • Product Image
      • Price
        • Price List
        • Product Price
        • Currency Unit Table
      • Stock
        • Stock List
        • Product Stock
      • Order
        • Get Orders
        • Search Order
        • Get Order Detail by Order Number
        • Get Order Item Detail
        • Orders ID Detail Integration
        • Orders Waiting to Send to ERP
        • Update Order and Order Item
        • Stock Reservation Release
        • Order Cancellation
        • Cancellation & Refund Pending Orders
        • Order Discount Items
        • Order Status Codes & Cancellation Statuses
      • Migration
        • Getting Started
        • User Migration
        • Address Migration
        • Old Order Migration
        • Old Order Item Migration
        • View Migration Progress
        • Currency Options
    • PIM
      • Attributes & Sets
      • Mapping
      • Localization
      • Media
    • Catalogue
      • Introduction
      • Price List
      • Stock List
      • Catalogue Item
      • Category Trees
      • Product Collection
      • Product Sorting
    • Channels
      • Introduction
      • Payments
      • Customers
    • Order
      • Getting Started
      • Fulfillment
      • Cancellations & Refunds
    • Retail Stores
      • Retail Stores
    • User Management
      • Roles & Permissions
      • Add & Remove
    • Whippy Ware
      • Introduction
      • Stock
      • Stock Lists
      • Stock List Rules
      • Stock Providers
      • Stock Locations
  • Omnitron OpenAPIs
    • Without Server
      • Customers
      • Reporting
      • Deleted Items
      • Pos
      • AttributeValues
      • Attribute Values
      • Providers
      • LDAPProviders
      • Healthcheck
      • LoyaltyTransactions
      • Policies
      • Exports
      • Dashboard
      • AuthTOTP
      • Price Lists
      • ProductPrices
      • Districts
      • Cities
      • Countries
      • Townships
      • PrometheusMetrics
      • Language
      • Content Types
      • Mappings
      • Applications
      • ApplicationPermissions
      • Error Reports
      • MailTemplates
      • UploadLogo
      • SalesChannelMarketPlaceAttributeSetConfig
      • SalesChannelCancellationRequestImage
      • SalesChannelCities
      • SalesChannelCancellationReasons
      • SalesChannelCargoCompany
      • SalesChannelProductImage
      • SalesChannelAttributeConfig
      • SalesChannelAttributeValueConfig
      • SalesChannelTownships
      • SalesChannelCustomers
      • SalesChannelFailedIntegrations
      • SalesChannelGetStockList
      • SalesChannelRetailStore
      • IntegrationActions
      • SalesChannelOrderShippingInfo
      • SalesChannelBatchRequests
      • SalesChannelAddresses
      • SalesChannelMarketPlaceAttributeSet
      • SalesChannelErrorReports
      • SalesChannelCategoryNodes
      • SalesChannelDistricts
      • SalesChannelProductStock
      • SalesChannelExtraProductStock
      • SalesChannelOrders
      • SalesChannelCancellationPlans
      • SalesChannelExtraProductPrices
      • SalesChannelProduct
      • SalesChannelAttributeSchemas
      • SalesChannelProductCategories
      • SalesChannelCancellationRequests
      • SalesChannelMarketPlaceAttributeValue
      • SalesChannelMappedProduct
      • SalesChannelMarketPlaceAttribute
      • SalesChannelOrderItem
      • SalesChannelProductPrice
      • SalesChannelCreateOrder
      • GetPriceList
      • SalesChannelCountries
      • SalesChannelGetPriceList
      • SalesChannelCategoryTree
    • With Server
      • Customers
      • Reporting
      • Deleted Items
      • Pos
      • AttributeValues
      • Attribute Values
      • Providers
      • LDAPProviders
      • Healthcheck
      • LoyaltyTransactions
      • Policies
      • Exports
      • Dashboard
      • AuthTOTP
      • Price Lists
      • ProductPrices
      • Districts
      • Cities
      • Countries
      • Townships
      • PrometheusMetrics
      • Language
      • Mappings
      • Content Types
      • Applications
      • ApplicationPermissions
      • Error Reports
      • MailTemplates
      • UploadLogo
      • SalesChannelMarketPlaceAttributeSetConfig
      • SalesChannelCancellationRequestImage
      • SalesChannelCities
      • SalesChannelCancellationReasons
      • SalesChannelCargoCompany
      • SalesChannelProductImage
      • SalesChannelAttributeConfig
      • SalesChannelAttributeValueConfig
      • SalesChannelTownships
      • SalesChannelCustomers
      • SalesChannelFailedIntegrations
      • SalesChannelGetStockList
      • IntegrationActions
      • SalesChannelRetailStore
      • SalesChannelOrderShippingInfo
      • SalesChannelBatchRequests
      • SalesChannelAddresses
      • SalesChannelMarketPlaceAttributeSet
      • SalesChannelErrorReports
      • SalesChannelDistricts
      • SalesChannelCategoryNodes
      • SalesChannelProductStock
      • SalesChannelExtraProductStock
      • SalesChannelCountries
      • SalesChannelOrders
      • SalesChannelProduct
      • SalesChannelCancellationPlans
      • SalesChannelExtraProductPrices
      • SalesChannelProductCategories
      • SalesChannelAttributeSchemas
      • SalesChannelCancellationRequests
      • SalesChannelMarketPlaceAttributeValue
      • SalesChannelMappedProduct
      • SalesChannelMarketPlaceAttribute
      • SalesChannelOrderItem
      • SalesChannelProductPrice
      • SalesChannelCreateOrder
      • GetPriceList
      • SalesChannelGetPriceList
      • SalesChannelCategoryTree
  • Commerce
    • Users
      • Getting Started
      • User Management & Authentication
      • Password & OTP Operations
      • User Profile & Segment Management
      • User Payment & Card Management
      • User Orders & Cancellations
      • Anonymous User Orders & Cancellations
      • User Support & Conversation
      • Captcha Validation
      • Currency & Akifast Operations
    • Checkout
      • Payment Related
      • Payment Strategy Related
      • Shipping Related
      • Independent Pages
    • Product
    • User Collections
    • Basket
    • Discount
    • Autocomplete
    • Breadcrumb
    • Pretty URLs
    • Menu
    • Widgets
    • Loyalty Accounts
    • Address Migration
    • Index Configuration
    • Favourite Products
    • User Address
    • Data Warehouse
    • Introduction
      • Filtering Parameters
    • Data Warehouse
    • Default
  • OMS
    • Package Services
    • Package Item Services
    • Package Denial Reason Services
    • Order Services
    • Order Item Services
    • Transfer Order Services
    • Transfer Item Services
    • Channel Services
    • Cancellation Plan Services
    • Cancellation Reason Services
    • Address Setup Services
    • City Services
    • District Services
    • Township Services
    • Stock Location Address Services
    • Webhook Setup Services
    • Webhook Event Services
    • Omnitron Order Webhooks
    • Undelivered Webhook Event Services
    • Inventory Discrepancy Services
    • OMS Setup Services
    • UI Settings Services
    • OMS Audit Events Service
    • Customer Address Services
    • Application Settings Services
    • Content Type Services
    • Customer Services
    • Channel Setup Services
    • Demo Data Service
    • Order Execution Plan Services
    • Invoice Services
    • Localization Services
    • Action Log Services
    • Order Log Services
    • Celery Metrics Service
    • Stock Location Services
    • Stock Location Address Services
    • Stock Location Sender Address Services
    • Stock Location Sender Address Setup Services
    • Cargo Company Condition Services
    • Permission Group Services
  • OMS OpenAPIs
    • Package Services
      • Default
    • Transfer Order Services
      • Default
  • Instore
    • Password Reset Services
  • Integrator
    • Projects
    • Flows
    • Logs
  • Seller Center
    • Languages
    • Categories
    • Introduction
    • Products
    • Packages
    • Orders
    • Claims
    • Shipping Methods
  • Akifast
    • Authentication
  • B2B
    • Quotation
    • Basket
    • Division
    • User
    • Staff User
    • Groups
    • Notification
    • Notification Template
  • Flows
    • Shipment Flows
    • Payment Flows
    • SMS Flows
    • Basket Offer Flows
Powered by GitBook

© 2025 Akinon. All rights reserved.

On this page

Was this helpful?

  1. Omnitron OpenAPIs
  2. Without Server

SalesChannelProduct

PreviousSalesChannelExtraProductPricesNextSalesChannelAttributeSchemas

Was this helpful?

Get product by ID

get

Retrieve a specific product by ID.

Authorizations
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

Filters 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__gtintegerOptional

Filters by primary key greater than the given 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
403
Forbidden
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
get
GET /api/v1/channel/{channel_id}/products/{id}/ HTTP/1.1
Host: 
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-05-22T11:01:39.639Z",
  "created_date": "2025-05-22T11:01:39.639Z",
  "modified_date": "2025-05-22T11:01:39.639Z",
  "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
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

Filters 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__gtintegerOptional

Filters by primary key greater than the given 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
403
Forbidden
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
get
GET /api/v1/channel/{channel_id}/products/{id}/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "parent": 1,
  "group_products": [
    1
  ],
  "productimage_set": [
    {
      "pk": 1,
      "status": "active",
      "order": 1,
      "created_date": "2025-05-22T11:01:39.639Z",
      "modified_date": "2025-05-22T11:01:39.639Z",
      "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-05-22T11:01:39.639Z",
  "created_date": "2025-05-22T11:01:39.639Z",
  "modified_date": "2025-05-22T11:01:39.639Z",
  "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
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

Filters 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__gtintegerOptional

Filters by primary key greater than the given 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
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
get
GET /api/v1/channel/{channel_id}/products/ HTTP/1.1
Host: 
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-05-22T11:01:39.639Z",
      "data_source": 1,
      "created_date": "2025-05-22T11:01:39.639Z",
      "modified_date": "2025-05-22T11:01:39.639Z",
      "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
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

Filters 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__gtintegerOptional

Filters by primary key greater than the given 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
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
get
GET /api/v1/channel/{channel_id}/products/detailed/ HTTP/1.1
Host: 
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-05-22T11:01:39.639Z",
      "data_source": 1,
      "created_date": "2025-05-22T11:01:39.639Z",
      "modified_date": "2025-05-22T11:01:39.639Z",
      "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
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Responses
200
OK
application/json
get
GET /api/v1/channel/{channel_id}/products/inserts/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

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-05-22T11:01:39.639Z",
    "data_source": 1,
    "created_date": "2025-05-22T11:01:39.639Z",
    "modified_date": "2025-05-22T11:01:39.639Z",
    "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
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Responses
200
OK
application/json
get
GET /api/v1/channel/{channel_id}/products/updates/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

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-05-22T11:01:39.639Z",
    "data_source": 1,
    "created_date": "2025-05-22T11:01:39.639Z",
    "modified_date": "2025-05-22T11:01:39.639Z",
    "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
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Responses
200
OK
application/json
get
GET /api/v1/channel/{channel_id}/products/inserts_or_updates/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

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-05-22T11:01:39.639Z",
    "data_source": 1,
    "created_date": "2025-05-22T11:01:39.639Z",
    "modified_date": "2025-05-22T11:01:39.639Z",
    "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
  }
]
  • GETGet product by ID
  • GETGet detailed product by ID
  • GETList all products for a channel
  • GETList all detailed products for a channel
  • GETList all of inserted products from related channel
  • GETList all of updated products from related channel
  • GETList all of inserted or updated products from related channel