COcoevera
Product

ProductPriceListPrices.create

Creates a ProductPriceListPrice record.

post/entities/ProductPriceListPrices

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

currency_idstring uuid required

Id of the currency the price is denominated in.

pricenumber double

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

product_idstring uuid required

Id of the product the price applies to.

product_price_list_idstring uuid required

Id of the price list this price belongs to.

settingsstring binary required

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

{
  "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
}

Response

The created ProductPriceListPrice record.

successboolean

True when the request 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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.