ProductPrices

Retrieve a product price

get

Retrieve the fields of a specific product price by ID.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Product price retrieved successfully.

application/json

404

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

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/product_price/{id} HTTP/1.1
Host: 
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-05-22T11:00:37.295Z",
  "modified_date": "2025-05-22T11:00:37.295Z"
}

Retrieve a product price with details

get

Retrieve the details of a specific product price by ID with additional details.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Product price with details retrieved successfully.

application/json

401

Unauthorized Access

application/json

404

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

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/product_price/{id}/detailed/ HTTP/1.1
Host: 
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-05-22T11:00:37.295Z",
  "modified_date": "2025-05-22T11:00:37.295Z"
}

Update a product price

put

Update the fields of a specific product price by ID.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

idinteger · int64Optional

Product Price ID

productintegerOptional

ID of the product related with the price.

price_listintegerOptional

ID of the price list related with the price.

retail_pricenumber · decimal | nullableOptional

Retail price of the product, can be null or blank.

Example: 100

tax_ratenumber · decimalOptional

Tax rate applied to the product price.

Example: 18

currency_typestring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

The actual price of the product.

Example: 120

price_typestring · enumOptional

Type of the price.

Example: defaultPossible values:

discount_percentagenumber · decimalOptional

Discount percentage applied to the price, if any.

Example: 10

modifier_collectioninteger · int64 | nullableOptional

ID of the Modifier Collection applied to adjust the product price. Can be null.

adjusted_pricenumber · decimal | nullableOptional

Adjusted price of the product after modifiers. Can be null.

Example: 108

created_datestring · date-timeOptional

Creation Date of the Product Price

modified_datestring · date-timeOptional

Modification Date of the Product Price

Responses

200

Product price updated successfully.

application/json

400

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

application/json

401

Unauthorized Access

application/json

404

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

application/json

406

A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/product_price/{id}/ HTTP/1.1
Host: 
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-05-22T11:00:37.295Z",
  "modified_date": "2025-05-22T11:00:37.295Z"
}

{
  "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-05-22T11:00:37.295Z",
  "modified_date": "2025-05-22T11:00:37.295Z"
}

Delete a product price

delete

Delete a specific product price by ID.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

No content

401

Unauthorized Access

application/json

404

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

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/product_price/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Partial update a product price

patch

Update specific fields of a specific product price by ID.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

idinteger · int64Optional

Product Price ID

productintegerOptional

ID of the product related with the price.

price_listintegerOptional

ID of the price list related with the price.

retail_pricenumber · decimal | nullableOptional

Retail price of the product, can be null or blank.

Example: 100

tax_ratenumber · decimalOptional

Tax rate applied to the product price.

Example: 18

currency_typestring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

The actual price of the product.

Example: 120

price_typestring · enumOptional

Type of the price.

Example: defaultPossible values:

discount_percentagenumber · decimalOptional

Discount percentage applied to the price, if any.

Example: 10

modifier_collectioninteger · int64 | nullableOptional

ID of the Modifier Collection applied to adjust the product price. Can be null.

adjusted_pricenumber · decimal | nullableOptional

Adjusted price of the product after modifiers. Can be null.

Example: 108

created_datestring · date-timeOptional

Creation Date of the Product Price

modified_datestring · date-timeOptional

Modification Date of the Product Price

Responses

200

Product price updated successfully.

application/json

400

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

application/json

401

Unauthorized Access

application/json

404

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

application/json

406

A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/product_price/{id}/ HTTP/1.1
Host: 
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-05-22T11:00:37.295Z",
  "modified_date": "2025-05-22T11:00:37.295Z"
}

{
  "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-05-22T11:00:37.295Z",
  "modified_date": "2025-05-22T11:00:37.295Z"
}

Bulk Upsert Product Prices

post

Create or update multiple product prices in bulk

Authorizations

Body

idinteger · int64Optional

Product Price ID

productintegerOptional

ID of the product related with the price.

price_listintegerOptional

ID of the price list related with the price.

retail_pricenumber · decimal | nullableOptional

Retail price of the product, can be null or blank.

Example: 100

tax_ratenumber · decimalOptional

Tax rate applied to the product price.

Example: 18

currency_typestring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

The actual price of the product.

Example: 120

price_typestring · enumOptional

Type of the price.

Example: defaultPossible values:

discount_percentagenumber · decimalOptional

Discount percentage applied to the price, if any.

Example: 10

modifier_collectioninteger · int64 | nullableOptional

ID of the Modifier Collection applied to adjust the product price. Can be null.

adjusted_pricenumber · decimal | nullableOptional

Adjusted price of the product after modifiers. Can be null.

Example: 108

created_datestring · date-timeOptional

Creation Date of the Product Price

modified_datestring · date-timeOptional

Modification Date of the Product Price

Responses

200

Successfully processed bulk upsert

application/json

Responseobject

Empty response on success

400

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

application/json

401

Unauthorized Access

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/product_price/bulk_upsert/ HTTP/1.1
Host: 
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
  }
]

{}

List Product Prices

get

Retrieve a list of product prices with optional filters

Authorizations

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

productinteger · int64Optional

Filter by Product ID.

Example: 123

is_activebooleanOptional

Filter by active status (True or False)

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

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

pk__ininteger[]Optional

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

price_listinteger · int64Optional

Filter by Price List ID.

Example: 2

currency_typestring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

Filter by the product price.

Example: 120

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

retail_pricenumber · decimalOptional

Filter by Retail Price.

Example: 100

product__attributes__some_keystringOptional

Filter by a specific key in the 'attributes' JSON object of the product.

Example: product__attributes__color=red

product__localized_attributes__some_keystringOptional

Filter by a specific key in the 'localized_attributes' JSON object of the product.

Example: product__localized_attributes__color=red

extra_field__some_keystringOptional

Filter by a specific key in the 'extra_field' JSON object.

Example: extra_field__some_key=some_value

Responses

200

List of Product Prices

application/json

401

Unauthorized Access

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/product_price/ HTTP/1.1
Host: 
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-05-22T11:00:37.295Z",
      "modified_date": "2025-05-22T11:00:37.295Z"
    }
  ]
}

Create a product price

post

Create a new product price with the specified data.

Authorizations

Body

idinteger · int64Optional

Product Price ID

productintegerOptional

ID of the product related with the price.

price_listintegerOptional

ID of the price list related with the price.

retail_pricenumber · decimal | nullableOptional

Retail price of the product, can be null or blank.

Example: 100

tax_ratenumber · decimalOptional

Tax rate applied to the product price.

Example: 18

currency_typestring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

The actual price of the product.

Example: 120

price_typestring · enumOptional

Type of the price.

Example: defaultPossible values:

discount_percentagenumber · decimalOptional

Discount percentage applied to the price, if any.

Example: 10

modifier_collectioninteger · int64 | nullableOptional

ID of the Modifier Collection applied to adjust the product price. Can be null.

adjusted_pricenumber · decimal | nullableOptional

Adjusted price of the product after modifiers. Can be null.

Example: 108

created_datestring · date-timeOptional

Creation Date of the Product Price

modified_datestring · date-timeOptional

Modification Date of the Product Price

Responses

201

Product price created successfully.

application/json

400

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

application/json

401

Unauthorized Access

application/json

403

Forbidden

406

A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/product_price/ HTTP/1.1
Host: 
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-05-22T11:00:37.295Z",
  "modified_date": "2025-05-22T11:00:37.295Z"
}

{
  "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-05-22T11:00:37.295Z",
  "modified_date": "2025-05-22T11:00:37.295Z"
}

List Product Prices with Details

get

Retrieve a detailed list of product prices with optional filters

Authorizations

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

productinteger · int64Optional

Filter by Product ID.

Example: 123

is_activebooleanOptional

Filter by active status (True or False)

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

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

pk__ininteger[]Optional

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

price_listinteger · int64Optional

Filter by Price List ID.

Example: 2

currency_typestring · enumOptional

Currency type for the price list.

Example: tryPossible values:

pricenumber · decimalOptional

Filter by the product price.

Example: 120

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

retail_pricenumber · decimalOptional

Filter by Retail Price.

Example: 100

product__attributes__some_keystringOptional

Filter by a specific key in the 'attributes' JSON object of the product.

Example: product__attributes__color=red

product__localized_attributes__some_keystringOptional

Filter by a specific key in the 'localized_attributes' JSON object of the product.

Example: product__localized_attributes__color=red

extra_field__some_keystringOptional

Filter by a specific key in the 'extra_field' JSON object.

Example: extra_field__some_key=some_value

product__sku__exactstringOptional

Filter by exact SKU.

Example: SKU123

product__sku__instring[]Optional

Filter by multiple SKUs (comma-separated).

product__sku_exclude__exactstringOptional

Exclude exact SKU.

Example: SKU789

product__sku_exclude__instring[]Optional

Exclude multiple SKUs (comma-separated).

product__base_code_exclude__instring[]Optional

Exclude multiple base codes (comma-separated).

product__base_code__exactstringOptional

Filter by exact base code.

product__base_code__iexactstringOptional

Filter by base code (case-insensitive).

product__base_code_exclude__exactstringOptional

Exclude exact base code.

product__base_code_exclude__iexactstringOptional

Exclude base code (case-insensitive).

product__pk__ininteger[]Optional

Filter by multiple primary keys (comma-separated).

product__attributesstringOptional

Filter by attributes in JSON format.

Example: attributes__color=red

product__attributes_excludestringOptional

Exclude attributes in JSON format.

Example: attributes_exclude__size=small

product__attributes_kwargsstringOptional

Filter by attributes using additional keyword arguments.

Example: attributes_kwargs__color=blue

product__localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

product__localized_attributes_kwargsstringOptional

Filter by localized attributes with additional keywords.

Example: localized_attributes_kwargs__locale=en-GB

product__extra_attributesstringOptional

Filter by extra attributes.

Example: extra_attributes__color=red

product__product_typearray · enumOptional

Filter by product type.

Possible values:

product__product_type_excludearray · enumOptional

Exclude product types.

Possible values:

product__attribute_setinteger[]Optional

Filter by attribute sets.

product__attribute_set_excludeinteger[]Optional

Exclude specific attribute sets.

product__parentintegerOptional

Filter by parent product ID.

product__offer_parentintegerOptional

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

product__group_parent_setinteger[]Optional

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

product__group_productsinteger[]Optional

Filter by grouped products.

product__parent__isnullbooleanOptional

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

product__catalogiteminteger[]Optional

Filter by catalog items.

product__listable_products_onlybooleanOptional

Filter by listable products only (True or False).

product__productimage__isnullbooleanOptional

Filter by whether the product has associated images.

product__productvideo__isnullbooleanOptional

Filter by whether the product has associated videos.

product__downloadableimage__isnullbooleanOptional

Filter by whether the product has downloadable images.

product__stock_list_not_containsstringOptional

Exclude products in specific stock lists.

product__price_list_not_containsstringOptional

Exclude products in specific price lists.

product__productization_datestringOptional

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

Example: productization_date__gte=2024-01-01

product__attribute_set__isnullbooleanOptional

Filter by whether attribute set is null.

product__exclude_bundle_chapter_productsintegerOptional

Exclude products associated with specific bundle chapters.

product__discountedbooleanOptional

Filter by discounted products.

product__data_sourceinteger[]Optional

Filter by data source IDs.

product__data_source_excludeinteger[]Optional

Exclude specific data sources.

product__data_source__isnullbooleanOptional

Filter by whether data source is null.

product__exclude_passive_distributed_productsbooleanOptional

Exclude passive distributed products.

product__custom_attribute_setinteger[]Optional

Filter by custom attribute set IDs.

product__brandintegerOptional

Filter by brand ID.

product__erp_categoriesintegerOptional

Filter by ERP category ID.

channelintegerOptional

Filter by channel ID.

channel_idintegerOptional

Filter by exact channel ID.

channel_namestringOptional

Filter by channel name (case-insensitive).

content_type_namestringOptional

Filter by content type model name.

version_datestring · date-timeOptional

Filter by version date using various lookup expressions.

Example: integration__version_date__gt=2024-01-01T00:00:00Z

remote_id__instring[]Optional

Filter by multiple remote IDs.

remote_id__exactstringOptional

Filter by exact remote ID.

object_id__ininteger[]Optional

Filter by multiple object IDs.

statestring · jsonOptional

Filter by state using JSON-based filtering.

Example: integration__state__status="ready"

local_batch_id__exactstringOptional

Filter by exact local batch ID.

Responses

200

List of Product Prices with Details

application/json

401

Unauthorized Access

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/product_price/detailed/ HTTP/1.1
Host: 
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-05-22T11:00:37.295Z",
      "modified_date": "2025-05-22T11:00:37.295Z"
    }
  ]
}