Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Partially update an extra product price

Updates one or more fields of an extra product-price record. Only the fields included in the request body are changed; everything left out keeps its current value.

The product cannot be changed. When currency_type or price_list is included, the resulting pair must still have matching currencies.

patch
/extra_product_price/{id}/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters
idstringRequired

The identifier of the extra product-price record. Either the numeric pk, or the combined {price_list_code}-{pk} form (split on the last hyphen).

Example: 42
Body

The body of an extra product-price partial update request. Only the fields included in the body are changed; every field is optional.

productintegerOptional

Including a product that differs from the record's current one is rejected. Omitting it keeps the current product.

pricestring · decimalOptional

The selling price, tax included.

currency_typestring · enumOptional

An ISO 4217 currency code accepted by the product-price endpoints.

Possible values:
tax_ratestring · decimalOptional

The VAT rate applied to price, as a percentage.

retail_pricestring · nullableOptional

The original or reference retail price.

price_listintegerOptional

The identifier of the price list this price belongs to.

extra_fieldobjectOptional

Free-form JSON for extra data.

Responses
200

The updated extra product-price record.

application/json

An extra product-price record — a price for a product in a price list other than the primary one, typically a seller-specific or channel-specific price.

pkintegerRead-onlyOptional

The unique identifier of the record.

productintegerOptional

The identifier of the priced product.

pricestring · decimalOptional

The selling price, tax included.

currency_typestring · enumOptional

ISO 4217 currency code the order item's price is expressed in.

Example: tryPossible values:
tax_ratestring · decimalOptional

The VAT rate applied to price, as a percentage.

retail_pricestring · nullableOptional

The recommended retail price, used to show a strike-through price.

price_listintegerOptional

The identifier of the price list this price belongs to.

extra_fieldobject · nullableOptional

Free-form data carried on the price record. Snapshotted into the order item's extra_field as price_extra_field at creation.

patch/extra_product_price/{id}/
PATCH /api/v1/remote/1/extra_product_price/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "price": "159.90"
}
{
  "pk": 1,
  "product": 1,
  "price": "text",
  "currency_type": "try",
  "tax_rate": "text",
  "retail_price": null,
  "price_list": 1,
  "price_list_detailed": {
    "pk": 1,
    "name": "text",
    "code": null,
    "currency": "try"
  },
  "extra_field": null
}

Last updated

Was this helpful?