SalesChannelProductPrice

Retrieves all of inserted product prices from related channel

get

Retrieves all of inserted product prices data from related channel

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
chevron-right
200

OK

application/json
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
created_datestring · date-timeOptional

Creation Date of the Product Price

modified_datestring · date-timeOptional

Modification Date of the Product Price

get
/api/v1/channel/{channel_id}/product_prices/{id}/
200

OK

Retrieves all of inserted product prices from related channel

get

Retrieves all of inserted product prices data from related channel

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
chevron-right
200

OK

application/json
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
created_datestring · date-timeOptional

Creation Date of the Product Price

modified_datestring · date-timeOptional

Modification Date of the Product Price

get
/api/v1/channel/{channel_id}/product_prices/{id}/detailed/
200

OK

List all of product prices from related channel

get

Lists all of product prices data from related channel

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Query parameters
product__attributesstringOptional

Filter by attributes in JSON format.

Example: attributes__color=red
product__localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US
extra_field__some_keystringOptional

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

Example: extra_field__some_key=some_value
productinteger · int64Optional

Filter by Product ID.

Example: 123
integration_actionintegerOptional

Filter by integration action id

Example: 0
currency_typestring · enumOptional

Currency type for the price list.

Example: tryPossible values:
pricestringOptional

Filter by product price's price

Example: 10.00
tax_ratestringOptional

Filter by product price's tax_rate

Example: 10.00
retail_pricestringOptional

Filter by product price's retail price

Example: 10.00
price_liststringOptional

Exact products in specific price lists.

pk__ininteger[]Optional

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

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses
chevron-right
200

OK

application/json
countintegerOptionalExample: 0
nextstring · nullableOptional

Next page URL

previousstring · nullableOptional

Previous page URL

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

List all of product prices from related channel

get

Lists all of product prices data from related channel

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Query parameters
product__attributesstringOptional

Filter by attributes in JSON format.

Example: attributes__color=red
product__localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US
extra_field__some_keystringOptional

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

Example: extra_field__some_key=some_value
productinteger · int64Optional

Filter by Product ID.

Example: 123
integration_actionintegerOptional

Filter by integration action id

Example: 0
currency_typestring · enumOptional

Currency type for the price list.

Example: tryPossible values:
pricestringOptional

Filter by product price's price

Example: 10.00
tax_ratestringOptional

Filter by product price's tax_rate

Example: 10.00
retail_pricestringOptional

Filter by product price's retail price

Example: 10.00
price_liststringOptional

Exact products in specific price lists.

pk__ininteger[]Optional

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

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses
chevron-right
200

OK

application/json
countintegerOptionalExample: 0
nextstring · nullableOptional

Next page URL

previousstring · nullableOptional

Previous page URL

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

List all of inserted product prices from related channel

get

Lists all of inserted product prices data from related channel

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Responses
chevron-right
200

OK

application/json
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
created_datestring · date-timeOptional

Creation Date of the Product Price

modified_datestring · date-timeOptional

Modification Date of the Product Price

get
/api/v1/channel/{channel_id}/product_prices/inserts/
200

OK

List all of updated product prices from related channel

get

Lists all of updated product prices data from related channel

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Responses
chevron-right
200

OK

application/json
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
created_datestring · date-timeOptional

Creation Date of the Product Price

modified_datestring · date-timeOptional

Modification Date of the Product Price

get
/api/v1/channel/{channel_id}/product_prices/updates/
200

OK

List all of inserted or updated product prices from related channel

get

Lists all of inserted or updated product prices data from related channel

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Responses
chevron-right
200

OK

application/json
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
created_datestring · date-timeOptional

Creation Date of the Product Price

modified_datestring · date-timeOptional

Modification Date of the Product Price

get
/api/v1/channel/{channel_id}/product_prices/inserts_or_updates/
200

OK

Last updated

Was this helpful?