v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Product

ProductPriceListPrices.update

Modifies ProductPriceListPrice or ProductPriceListPrices with given id(s)

patch/entities/ProductPriceListPrices/{id}

Path parameters

idstring uuid required

ID of ProductPriceListPrice to update

Query parameters

validation-levelinteger

Specify validation level of ProductPriceListPrice on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

currency_idstring uuid

Id of the currency.

pricenumber double

Price amount stored at 6-decimal precision; values set via the API are rounded.

product_idstring uuid

Id of the product.

product_price_list_idstring uuid

Id of the price list.

settingsstring binary

Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "currency_id": "01234567-abcd-dcba-ffff-000000000000",
  "price": 4.32,
  "product_id": "01234567-abcd-dcba-ffff-000000000000",
  "product_price_list_id": "01234567-abcd-dcba-ffff-000000000000",
  "settings": "blob",
  "revision": 1
}

Response

Modification confirmation. Returns resulting ProductPriceListPrice

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "currency_id": "01234567-abcd-dcba-ffff-000000000000",
    "price": 4.32,
    "product_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_price_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "settings": "blob",
    "revision": 1
  }
}