ProductPrices
Retrieve the fields of a specific product price by ID.
Unique identifier of the resource
1Product price retrieved successfully.
The given resource or object was not found or does not exist.
GET /api/v1/product_price/{id} HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"id": 1,
"product": 1,
"price_list": 1,
"retail_price": 100,
"tax_rate": 18,
"currency_type": "try",
"price": 120,
"price_type": "default",
"discount_percentage": 10,
"modifier_collection": 1,
"adjusted_price": 108,
"extra_field": {
"custom_field": "example_value"
},
"created_date": "2025-12-01T08:47:14.682Z",
"modified_date": "2025-12-01T08:47:14.682Z"
}Retrieve the details of a specific product price by ID with additional details.
Unique identifier of the resource
1Product price with details retrieved successfully.
Unauthorized Access
The given resource or object was not found or does not exist.
GET /api/v1/product_price/{id}/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"product": 1,
"price_list": 1,
"id": 1,
"retail_price": 100,
"tax_rate": 18,
"currency_type": "try",
"price": 120,
"price_type": "default",
"discount_percentage": 10,
"modifier_collection": 1,
"adjusted_price": 108,
"extra_field": {
"custom_field": "example_value"
},
"created_date": "2025-12-01T08:47:14.682Z",
"modified_date": "2025-12-01T08:47:14.682Z"
}Update the fields of a specific product price by ID.
Unique identifier of the resource
1Product Price ID
ID of the product related with the price.
ID of the price list related with the price.
Retail price of the product, can be null or blank.
100Tax rate applied to the product price.
18Currency type for the price list.
tryPossible values: The actual price of the product.
120Type of the price.
defaultPossible values: Discount percentage applied to the price, if any.
10ID of the Modifier Collection applied to adjust the product price. Can be null.
Adjusted price of the product after modifiers. Can be null.
108Creation Date of the Product Price
Modification Date of the Product Price
Product price updated successfully.
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
The given resource or object was not found or does not exist.
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
PUT /api/v1/product_price/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 327
{
"id": 1,
"product": 1,
"price_list": 1,
"retail_price": 100,
"tax_rate": 18,
"currency_type": "try",
"price": 120,
"price_type": "default",
"discount_percentage": 10,
"modifier_collection": 1,
"adjusted_price": 108,
"extra_field": {
"custom_field": "example_value"
},
"created_date": "2025-12-01T08:47:14.682Z",
"modified_date": "2025-12-01T08:47:14.682Z"
}{
"id": 1,
"product": 1,
"price_list": 1,
"retail_price": 100,
"tax_rate": 18,
"currency_type": "try",
"price": 120,
"price_type": "default",
"discount_percentage": 10,
"modifier_collection": 1,
"adjusted_price": 108,
"extra_field": {
"custom_field": "example_value"
},
"created_date": "2025-12-01T08:47:14.682Z",
"modified_date": "2025-12-01T08:47:14.682Z"
}Delete a specific product price by ID.
Unique identifier of the resource
1No content
Unauthorized Access
The given resource or object was not found or does not exist.
DELETE /api/v1/product_price/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Update specific fields of a specific product price by ID.
Unique identifier of the resource
1Product Price ID
ID of the product related with the price.
ID of the price list related with the price.
Retail price of the product, can be null or blank.
100Tax rate applied to the product price.
18Currency type for the price list.
tryPossible values: The actual price of the product.
120Type of the price.
defaultPossible values: Discount percentage applied to the price, if any.
10ID of the Modifier Collection applied to adjust the product price. Can be null.
Adjusted price of the product after modifiers. Can be null.
108Creation Date of the Product Price
Modification Date of the Product Price
Product price updated successfully.
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
The given resource or object was not found or does not exist.
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
PATCH /api/v1/product_price/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 327
{
"id": 1,
"product": 1,
"price_list": 1,
"retail_price": 100,
"tax_rate": 18,
"currency_type": "try",
"price": 120,
"price_type": "default",
"discount_percentage": 10,
"modifier_collection": 1,
"adjusted_price": 108,
"extra_field": {
"custom_field": "example_value"
},
"created_date": "2025-12-01T08:47:14.682Z",
"modified_date": "2025-12-01T08:47:14.682Z"
}{
"id": 1,
"product": 1,
"price_list": 1,
"retail_price": 100,
"tax_rate": 18,
"currency_type": "try",
"price": 120,
"price_type": "default",
"discount_percentage": 10,
"modifier_collection": 1,
"adjusted_price": 108,
"extra_field": {
"custom_field": "example_value"
},
"created_date": "2025-12-01T08:47:14.682Z",
"modified_date": "2025-12-01T08:47:14.682Z"
}Create or update multiple product prices in bulk
Product Price ID
ID of the product related with the price.
ID of the price list related with the price.
Retail price of the product, can be null or blank.
100Tax rate applied to the product price.
18Currency type for the price list.
tryPossible values: The actual price of the product.
120Type of the price.
defaultPossible values: Discount percentage applied to the price, if any.
10ID of the Modifier Collection applied to adjust the product price. Can be null.
Adjusted price of the product after modifiers. Can be null.
108Creation Date of the Product Price
Modification Date of the Product Price
Successfully processed bulk upsert
Empty response on success
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
POST /api/v1/product_price/bulk_upsert/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 154
[
{
"price_list": 1,
"product": 123,
"price": 99.99,
"currency": "USD",
"tax_rate": 18
},
{
"price_list": 1,
"product": 124,
"price": 149.99,
"currency": "USD",
"tax_rate": 18
}
]{}Retrieve a list of product prices with optional filters
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Filter by Product ID.
123Filter by active status (True or False)
Filter 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 creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by multiple primary key values (comma-separated list of integers)
Filter by Price List ID.
2Currency type for the price list.
tryPossible values: Filter by the product price.
120Filter by Tax Rate.
18Filter by Retail Price.
100Filter by a specific key in the 'attributes' JSON object of the product.
product__attributes__color=redFilter by a specific key in the 'localized_attributes' JSON object of the product.
product__localized_attributes__color=redFilter by a specific key in the 'extra_field' JSON object.
extra_field__some_key=some_valueList of Product Prices
Unauthorized Access
GET /api/v1/product_price/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"id": 1,
"product": 1,
"price_list": 1,
"retail_price": 100,
"tax_rate": 18,
"currency_type": "try",
"price": 120,
"price_type": "default",
"discount_percentage": 10,
"modifier_collection": 1,
"adjusted_price": 108,
"extra_field": {
"custom_field": "example_value"
},
"created_date": "2025-12-01T08:47:14.682Z",
"modified_date": "2025-12-01T08:47:14.682Z"
}
]
}Create a new product price with the specified data.
Product Price ID
ID of the product related with the price.
ID of the price list related with the price.
Retail price of the product, can be null or blank.
100Tax rate applied to the product price.
18Currency type for the price list.
tryPossible values: The actual price of the product.
120Type of the price.
defaultPossible values: Discount percentage applied to the price, if any.
10ID of the Modifier Collection applied to adjust the product price. Can be null.
Adjusted price of the product after modifiers. Can be null.
108Creation Date of the Product Price
Modification Date of the Product Price
Product price created successfully.
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
Forbidden
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
POST /api/v1/product_price/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 327
{
"id": 1,
"product": 1,
"price_list": 1,
"retail_price": 100,
"tax_rate": 18,
"currency_type": "try",
"price": 120,
"price_type": "default",
"discount_percentage": 10,
"modifier_collection": 1,
"adjusted_price": 108,
"extra_field": {
"custom_field": "example_value"
},
"created_date": "2025-12-01T08:47:14.682Z",
"modified_date": "2025-12-01T08:47:14.682Z"
}{
"id": 1,
"product": 1,
"price_list": 1,
"retail_price": 100,
"tax_rate": 18,
"currency_type": "try",
"price": 120,
"price_type": "default",
"discount_percentage": 10,
"modifier_collection": 1,
"adjusted_price": 108,
"extra_field": {
"custom_field": "example_value"
},
"created_date": "2025-12-01T08:47:14.682Z",
"modified_date": "2025-12-01T08:47:14.682Z"
}Retrieve a detailed list of product prices with optional filters
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Filter by Product ID.
123Filter by active status (True or False)
Filter 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 creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by multiple primary key values (comma-separated list of integers)
Filter by Price List ID.
2Currency type for the price list.
tryPossible values: Filter by the product price.
120Filter by Tax Rate.
18Filter by Retail Price.
100Filter by a specific key in the 'attributes' JSON object of the product.
product__attributes__color=redFilter by a specific key in the 'localized_attributes' JSON object of the product.
product__localized_attributes__color=redFilter by a specific key in the 'extra_field' JSON object.
extra_field__some_key=some_valueFilter 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 keys (comma-separated).
Filter by attributes in JSON format.
attributes__color=redExclude attributes in JSON format.
attributes_exclude__size=smallFilter 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-GBFilter by extra attributes.
extra_attributes__color=redFilter by product type.
Exclude product types.
Filter by attribute sets.
Exclude specific attribute sets.
Filter by parent product ID.
Filter by parent products with a 'simple' product type.
Filter by parent products with a 'grouped' product type.
Filter by grouped products.
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 productization date with lookup expressions (e.g., gte, lte).
productization_date__gte=2024-01-01Filter by whether attribute set is null.
Exclude products associated with specific bundle chapters.
Filter by discounted products.
Filter by data source IDs.
Exclude specific data sources.
Filter by whether data source is null.
Exclude passive distributed products.
Filter by custom attribute set IDs.
Filter by brand ID.
Filter by ERP category ID.
Filter by channel ID.
Filter by exact channel ID.
Filter by channel name (case-insensitive).
Filter by content type model name.
Filter by version date using various lookup expressions.
integration__version_date__gt=2024-01-01T00:00:00ZFilter by multiple remote IDs.
Filter by exact remote ID.
Filter by multiple object IDs.
Filter by state using JSON-based filtering.
integration__state__status="ready"Filter by exact local batch ID.
List of Product Prices with Details
Unauthorized Access
GET /api/v1/product_price/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"id": 1,
"product": 1,
"price_list": 1,
"retail_price": 100,
"tax_rate": 18,
"currency_type": "try",
"price": 120,
"price_type": "default",
"discount_percentage": 10,
"modifier_collection": 1,
"adjusted_price": 108,
"extra_field": {
"custom_field": "example_value"
},
"created_date": "2025-12-01T08:47:14.682Z",
"modified_date": "2025-12-01T08:47:14.682Z"
}
]
}Was this helpful?