Product Price

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ csv of string ]

No

The unique identifier (UIDs) of the site to manage data for

query

$filter

string

No

A filter expression in OData v4 format

query

$top

int32

No

The maximum documents to return

query

$skip

int32

No

The documents to skip before returning

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against

query

entity_ids

[ string ]

No

An array of entity identifiers

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_mappings

boolean

No

Include the mappings for the document in the response

query

include_mappings_for_entities

[ csv of string ]

No

Specifies entity types for which mappings are presented as a part of the response (For example, include_mappings_for_entities_param='product','product-price', etc.

query

include_entities

[ csv of string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_audit

boolean

No

Adds audit fields to each document when returning a result (is_active, is_master, created_at, created_by, updated_at, updated_by)

query

include_inactive

boolean

No

Includes the documents that are inactive for the current sites

header

X-Company-ID

string

Yes

The identifier of the company to manage data for

header

X-Site-IDs

[ csv of string ]

No

The unique identifiers (UIDs) of the site to manage data for

query

$filter

string

No

A filter expression in OData v4 format

query

$top

int32

No

The maximum documents to return

query

$skip

int32

No

The documents to skip before returning

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against

query

entity_ids

[ string ]

No

An array of entity identifiers

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ csv of string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_audit

boolean

No

Adds audit fields to each document when returning a result (is_active, is_master, created_at, created_by, updated_at, updated_by)

query

include_inactive

boolean

No

Includes the documents that are inactive for the current sites

query

include_mappings_for_entities

[ csv of string ]

No

Specifies entity types for which mappings are presented as a part of the response (For example, include_mappings_for_entities_param='product','product-price', etc.

header

X-Company-ID

string

Yes

The identifier of the company to manage data for

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ csv of string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

body

body

Yes

The JSON formatted request

header

X-Company-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The identifier of the entity

body

body

Yes

The JSON formatted request

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The identifier of the entity

header

X-Company-ID

string

Yes

The identifier of the company to manage data for

header

X-Site-IDs

[ csv of string ]

No

The unique identifiers (UIDs) of the site to manage data for

body

body

Yes

Supports the mappings field (array/boolean) for each document. With mappings: True mappings are created for the current date and sites from the X-Site-IDs header.

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ csv of string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

header

X-Company-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ csv of string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

body

body

Yes

The JSON of the category being patched

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

header

X-Company-ID

string

Yes

The identifier of the company to manage data for

header

X-Site-IDs

[ csv of string ]

No

The identifiers of the site to manage data for

path

entity_id

string

Yes

The identifier of the entity

query

$top

int32

No

The maximum documents to return

query

$skip

int32

No

The documents to skip before returning

query

$filter

string

No

A filter expression in OData v4 format

query

$orderby

string

No

An order by expression in OData v4 format

query

include_inactive

boolean

No

Includes the documents that are inactive for the current sites

header

X-Company-ID

string

Yes

The identifier of the company to manage data for

header

X-Site-IDs

[ csv of string ]

No

The unique identifiers (UIDs) of the site to manage data for

path

entity_id

string

Yes

The identifier of the entity

body

body

Yes

The array of the product price mappings being added

total

integer

items

[ array ]

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

site_id

string

The identifier of the site associated with the document

entity_id

string

The auto-assigned unique identifier of the entity, set on creation. All future versions of the entity share the same entity_id.

document_id

string

The identifier of the document in the collection the mapping refers to

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time the document was updated

updated_at

string

The last date and time the document was updated

header

X-Company-ID

string

Yes

The identifier of the company to manage data for

body

body

Yes

The JSON of the product price mapping being added

document_id

string

The identifier of the document in the collection the mapping refers to

entity_id

string

The auto-assigned unique identifier (UID) of the entity, set on creation. All future versions of the entity share the same entity_id.

effective_date

string

The date and time the document becomes "current"

site_ids

[ string ]

The identifier of the site associated with the document

total

integer

items

[ array ]

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

site_id

string

The identifier of the site associated with the document

entity_id

string

The auto-assigned unique identifier (UID) of the entity, set on creation. All future versions of the entity share the same entity_id.

document_id

string

The identifier of the document in the collection the mapping refers to

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time the document was updated

updated_at

string

The last date and time the document was updated

name

string

No

type

string

No

The possible values are"standard," "conditional," "child-tag," "child-product," "child-both," "child-quantity-product," "child-quantity-tag," or "child-quantity-both."

unit_price

number (currency)

Yes

product_id

string

No

time_period_entity_ids

[ string,object ]

No

product_entity_id

string,object

No

product_tag_entity_ids

[ string,object ]

No

parent_product_entity_ids

[ string,object ]

No

external_tag_ids

[ string ]

No

quantity_based

object

No

apply_type

string

No

The possible values are"replace" or "adjust."

external_category_ids

[ string ]

No

The category identifiers provided by IRIS/EDM, not exposed to the Data Management (DM) user interface (UI)

product_category_entity_ids

[ string,object ]

No

An array of Product Category entity identifiers

child_product_entity_id

string,object

No

allowed_order_source_entity_ids

[ string,object ]

No

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ string ]

No

An array of allowed Order Source identifiers

allowed_order_destination_entity_ids

[ string,object ]

No

An array of allowed Order Destination entity identifiers

allowed_order_destination_ids

[ string ]

No

An array of allowed Order Destination identifiers

is_quantity_based

boolean

No

The flag that indicates if the price is quantity-based or not

quantity_group_id

string,object

No

The identifier of the group of quantity price ranges. It helps to understand which prices are related to the same group.

child_type

string

No

The possible values are"child-product," "child-tag," or "child-both."

child_product_entity_ids

[ string,object ]

No

The list of the product entity identifiers related to the price

child_tag_entity_ids

[ string,object ]

No

The list of the tag entity identifiers related to the price

range_start

integer

No

The quantity-based field. It defines the range start of the price.

range_end

integer

No

The quantity-based field. It defines the range end of the price.

tax_inclusive

boolean

No

This price already includes all taxes that are applicable to it

product_tax_inclusive

boolean

No

The internal property to keep tax_inclusive sync logic (tax_inclusive is inherited from the parent product)

priority

integer

No

Defines the priority between the prices of one type

_id

_id

No

company_id

company_id

No

entity_id

entity_id

No

is_master

is_master

No

is_active

is_active

No

external_id

external_id

No

created_by

created_by

No

updated_by

updated_by

No

created_at

created_at

No

updated_at

updated_at

No

name

string

type

string

The possible values are"standard," "conditional," "child-tag," "child-product," "child-both," "child-quantity-product," "child-quantity-tag," or "child-quantity-both."

unit_price

number (currency)

product_id

string

time_period_entity_ids

[ string, object ]

product_entity_id

string, object

product_tag_entity_ids

[ string, object ]

parent_product_entity_ids

[ string, object ]

external_tag_ids

[ string ]

quantity_based

object

apply_type

string

The possible values are"replace" or "adjust."

external_category_ids

[ string ]

The category identifiers provided by IRIS/EDM, not exposed to the Data Management (DM) user interface (UI)

product_category_entity_ids

[ string, object ]

An array of Product Category entity identifiers

child_product_entity_id

string, object

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ string ]

An array of allowed Order Source identifiers

allowed_order_destination_entity_ids

[ string, object ]

An array of allowed Order Destination entity identifiers

allowed_order_destination_ids

[ string ]

An array of allowed Order Destination identifiers

is_quantity_based

boolean

The flag that indicates if the price is quantity-based or not

quantity_group_id

string, object

The identifier of the group of quantity price ranges. Defines which prices are related to the same group.

child_type

string

The possible values are "child-product," "child-tag," or "child-both."

child_product_entity_ids

[ string, object ]

The list of the product entity identifiers related to the price

child_tag_entity_ids

[ string, object ]

The list of the tag entity identifiers related to the price

range_start

integer

The quantity-based field. It defines the range start of the price.

range_end

integer

The quantity-based field. It defines the range end of the price.

tax_inclusive

boolean

The price already includes all taxes that are applicable to it

product_tax_inclusive

boolean

The internal property to keep tax_inclusive sync logic (tax_inclusive is inherited from parent product)

priority

integer

Defines the priority between the prices of one type

entity_id

entity_id

external_id

external_id

name

string

type

string

The possible values are"standard," "conditional," "child-tag," "child-product," "child-both," "child-quantity-product," "child-quantity-tag," or "child-quantity-both."

unit_price

number (currency)

product_id

string

time_period_entity_ids

[ string, object ]

product_entity_id

string, object

product_tag_entity_ids

[ string, object ]

parent_product_entity_ids

[ string, object ]

external_tag_ids

[ string ]

quantity_based

object

apply_type

string

The possible values are"replace" or "adjust."

external_category_ids

[ string ]

The category identifiers provided by IRIS/EDM, not exposed to the Data Management (DM) user interface (UI)

product_category_entity_ids

[ string, object ]

An array of Product Category entity identifiers

child_product_entity_id

string, object

allowed_order_source_entity_ids

[ string, object ]

An array of allowed Order Source entity identifiers

allowed_order_source_ids

[ string ]

An array of allowed Order Source identifiers

allowed_order_destination_entity_ids

[ string, object ]

An array of allowed Order Destination entity identifiers

allowed_order_destination_ids

[ string ]

An array of allowed Order Destination identifiers

is_quantity_based

boolean

The flag that indicates if the price is quantity-based or not

quantity_group_id

string, object

The identifier of the group of quantity price ranges. It helps to understand which prices are related to the same group.

child_type

string

The possible values are "child-product," "child-tag," or "child-both."

child_product_entity_ids

[ string, object ]

The list of the product entity identifiers related to the price

child_tag_entity_ids

[ string, object ]

The list of the tag entity identifiers related to the price

range_start

integer

The quantity-based field. It defines the range start of the price.

range_end

integer

The quantity-based field. It defines the range end of the price.

tax_inclusive

boolean

The price already includes all taxes that are applicable to it

product_tax_inclusive

boolean

The internal property to keep tax_inclusive sync logic (tax_inclusive is inherited from the parent product)

priority

integer

Defines the priority between prices of one type

external_id

external_id

total

integer

items

[ product_price ]

name

string

product_id

string

product_entity_id

string,object

The product entity_id

quantity_based

boolean

The flag that indicates if the price is quantity-based or not

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned unique ID of this entity, set on creation. All future versions of this entity will share the same entity_id

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The date and time (date-time) the document was created

updated_at

string

The last date and time (date-time) the document was updated