Product

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_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 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_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 inactive for the current sites

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

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

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

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

[ 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

_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

[ 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

product_entity_id

string, object

The product entity_id

product_id

string

product_entity_ids

array

An array of variations

name

string

Yes

The default name of the product

product_id

string

Yes

The unique identifier (UID) of the product

caption

string

No

The caption that is displayed on the button in the menu. The maximum of five (5) lines and 255 characters allowed.

product_type

string

Yes

The type of product.

The possible values are "standard," "modifier," "comment," "placeholder," "modifier_placeholder," "gift_card," "gift_certificate," "fee," or "retail_item."

item_type

string

No

The product item type.

The possible values are "product," "modifier," "comment," "placeholder," "modifier_placeholder," "gift_card," "gift_certificate," "fee," or  "retail_item."

revenue_class

string

No

include_on_item_count

boolean

No

The flag that indicates if a product affects the item count

include_on_item_count_value

integer

No

Determines the value that the item is counted as when added to an order

guest_count

integer

No

Defines the number of guests that are associated with an order when the product has been added

reporting_category

object

No

alt_item_name

string

No

item_description

string

No

is_open_price

boolean

Yes

The flag that determines if the user is prompted for a price when adding to the order

is_bundle

boolean

No

The flag that indicates to enable the product as a bundle

bundle_components_entity_ids

[ string, object ]

No

An array of bundle_component entity_ids

kitchen_routing_category_entity_ids

[ string, object ]

No

The categories that the product are routed to

modifier_collection_entity_id

string, object

No

Allows the definition of the modifier collection for the product

display_modifier_selection_screen

string

No

Allows overriding the "Display Modifier Menu on Item Add" option in preferences for the current product.

The possible values are "use_company_preference," "when_product_is_added_to_order," or "do_not_display_automatically."

builds

[ object ]

No

tax_group_entity_id

string, object

No

The group of tax rates to be applied on an order

default_cost

number (currency)

No

The default cost of the product

unit_size

integer

No

Allows the user to set the size for each unit for the price that is configured

unit_type

string

No

Allows the user to select the type of the unit that makes up the item.

The possible values are "none," "pack," "each," "case," "bottle," "can," "gallon," "quart," "milliliter," "liter," "pound," "ounce," "gram," or "kilograms."

always_print_in_red

boolean

No

The flag that indicates whether or not the modifier always prints in red (overrides modifier group setting)

include_in_plain_builds

boolean

No

The flag that indicates whether or not the modifier is included by default in a build

allow_quantity

boolean

No

The flag that indicates whether or not the modifier allows changing quantities

increment_modifier_quantity_by

number

No

The possible values are 1, 0.5, 0.33333, or 0.25

fractional_increment_modifier_quantity_by

object

No

fractional_secondary_increment_modifier_quantity_by

object

No

variation_info

object

No

show_confirmaion_prompt

boolean

No

The flag that determines if the user is prompted to confirm combining order item components into a bundle when the bundle components are added to the order separately

advance_on_component_fulfillment

string

No

Allows overriding the "Advance on Component Fulfillment" option in preferences for the current product.

The possible values are "use_company_preference," "on_final_component_choice," or "do_not_automatically_advance."

prompt_item_conversio_on_change

boolean

No

The flag that determines if the bundle is changed based on the size of the components added

allow_plain_builds

boolean

No

external_category_ids

[ string ]

No

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

external_tag_ids

[ string ]

No

External tag identifiers

images

[ object ]

No

An array of product related images

nutritional_data

[ object ]

No

The nutrition values for the product

allergens

[ object ]

No

The allergens presence information

product_category_entity_ids

[ string, object ]

No

An array of product category entity identifiers

product_tag_entity_ids

[ string, object ]

No

The tags that are currently added to the product

prompt_for_quantity

boolean

No

The flag that determines if the user is prompted to enter the quantity when adding to the order

kitchen_routing_type

string

No

Determines how the product is routed to the kitchen.

The possible values are "by_category" or  "by_destination."

order_destination_entity_id

string, object

No

The order destination entity identifier

kitchen_routing_categories_by_destination

[ object ]

No

An array of objects with kitchen_routing_category_entity_ids by order_destination_entity_id

alternate_kitchen_name

string

No

The optimized shorter name for kitchen printing and video

display_modifier_priority_entity_id

string, object

No

The priority in which the modifier displays in relation to other modifiers in the kitchen displays

preparation_instructions

string

No

The preparation instructions field

prep_instruction_images

[ string ]

No

The images for preparation instruction

tag_entity_ids

[ string, object ]

No

An array of tag entity identifiers

alternate_plu_codes

[ string ]

No

Allows the user to add the product to an order using the added price look ups (PLUs)

is_liability_item

boolean

No

The flag that indicates if the product is a liability item, such as a gift card

liability_info

object

No

forbid_adding_via_lookup

boolean

No

The flag that prevents the product from being added to an order through Product Lookup in the ordering application

restricted_order_source_entity_ids

[ string, object]

No

An array of restricted Order Source entity identifiers

restricted_order_source_ids

[ string ]

No

An array of restricted Order Source identifiers

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

restrict_availability_order_source

boolean

No

The flag that indicates whether or not to restrict availability by the order source

voice_name

string

No

The primary product name for use with voice ordering

voice_description

string

No

Defines a detailed description of the voice ordering for the product

voice_synonyms

string

No

The typical pronunciations of the product name or alternate names for the product (comma separated)

enable_time_based_pricing

boolean

No

The flag that enables time-based pricing logic

external_identifiers

[ string ]

No

Identifiers that are used to reference the product from the external systems

tax_inclusive

boolean

No

The flag that defines whether new prices for the item are tax inclusive or not

field_data_kit_values

[ object ]

No

Contains names and identifiers for every changed section in the site specific document

weight_config

object

No

product_ingredients

[ object ]

No

The list of product ingredients

_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

Yes

The default name of the product

product_id

string

Yes

The unique identifier (UID) of the product

caption

string

No

The caption that is displayed on the button in the menu. The maximum of five (5) lines and 255 characters are allowed.

product_type

string

Yes

The type of product.

The possible values are"standard," "modifier," "comment," "placeholder," "modifier_placeholder," "gift_card," "gift_certificate," "fee," or "retail_item."

item_type

string

No

The product item type.

The possible values are"product," "modifier," "comment," "placeholder," "modifier_placeholder," "gift_card," "gift_certificate," "fee," or "retail_item."

revenue_class

string

No

include_on_item_count

boolean

No

Determines if the product affects the item count

include_on_item_count_value

integer

No

Determines the value that the item is counted as when added to an order

guest_count

integer

No

Defines the number of guests that are associated with an order when the product has been added

reporting_category

object

No

alt_item_name

string

No

item_description

string

No

is_open_price

boolean

Yes

The flag that determines if the user is prompted for a price when adding to the order

is_bundle

boolean

No

The flag that enables whether or not the product as a bundle

bundle_components_entity_ids

[ string,object ]

No

An array of bundle_component entity_ids

kitchen_routing_category_entity_ids

[ string,object ]

No

The categories that the product are routed to

modifier_collection_entity_id

string,object

No

Allows definition of the modifier collection for the product

display_modifier_selection_screen

string

No

Allows overriding the "Display Modifier Menu on Item Add" option in preferences for the current product.

The possible values are "use_company_preference," "when_product_is_added_to_order," or "do_not_display_automatically."

builds

[ object ]

No

tax_group_entity_id

string,object

No

The group of tax rates to be applied on an order

default_cost

number (currency)

No

The default cost of the product

unit_size

integer

No

Allows the user to set the size for each unit for the price that is configured

unit_type

string

No

Allows the user to select the type of the unit that makes up the item.

The possible values are"none," "pack," "each," "case," "bottle," "can," "gallon," "quart," "milliliter," "liter," "pound," "ounce," "gram," or "kilograms."

always_print_in_red

boolean

No

The flag that indicates whether or not the modifier always prints in red (overrides modifier group setting)

include_in_plain_builds

boolean

No

The flag that indicates whether or not the modifier is included by default in a build

allow_quantity

boolean

No

The flag that indicates whether or not the modifier allows changing quantities

increment_modifier_quantity_by

number

No

The possible values are 1, 0.5, 0.33333, or 0.25

fractional_increment_modifier_quantity_by

object

No

fractional_secondary_increment_modifier_quantity_by

object

No

variation_info

object

No

show_confirmaion_prompt

boolean

No

Determines if the user is prompted to confirm combining order item components into a bundle when the bundle components are added to the order separately

advance_on_component_fulfillment

string

No

Allows overriding the "Advance on Component Fulfillment" option in preferences for the current product.

The possible values are "use_company_preference," "on_final_component_choice," or "do_not_automatically_advance."

prompt_item_conversio_on_change

boolean

No

Determines if the bundle is changed based on the size of the components added

allow_plain_builds

boolean

No

external_category_ids

[ string ]

No

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

external_tag_ids

[ string ]

No

The external tag identifiers

images

[ object ]

No

An array of product related images

nutritional_data

[ object ]

No

The nutrition values for the product

allergens

[ object ]

No

The allergens presence information

product_category_entity_ids

[ string,object ]

No

An array of Product Category entity identifiers

product_tag_entity_ids

[ string,object ]

No

The tags that are currently added to the product

prompt_for_quantity

boolean

No

The flag that determines if the user is prompted to enter the quantity when adding to the order

kitchen_routing_type

string

No

Determines how the product is routed to the kitchen.

The possible values are"by_category" or  "by_destination."

order_destination_entity_id

string,object

No

The order destination entity identifier

kitchen_routing_categories_by_destination

[ object ]

No

An array of objects with kitchen_routing_category_entity_ids by order_destination_entity_id

alternate_kitchen_name

string

No

The optimized shorter name for kitchen printing and video

display_modifier_priority_entity_id

string,object

No

The priority in which the modifier displays in relation to other modifiers in the kitchen displays

preparation_instructions

string

No

The preparation instructions field

prep_instruction_images

[ string ]

No

The images for preparation Instruction

tag_entity_ids

[ string,object ]

No

An array of tag entity identifiers

alternate_plu_codes

[ string ]

No

Allows the user to add the product to an order using the added price look ups (PLUs)

is_liability_item

boolean

No

The flag that indicates if the product is a liability item, such as a gift card

liability_info

object

No

forbid_adding_via_lookup

boolean

No

Prevents the product from being added to an order through Product Lookup in the ordering application

restricted_order_source_entity_ids

[ string,object ]

No

An array of restricted Order Source entity identifiers

restricted_order_source_ids

[ string ]

No

An array of restricted Order Source identifiers

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

restrict_availability_order_source

boolean

No

The flag that indicates whether or not to restrict availability by the order source

voice_name

string

No

The primary product name for use with voice ordering

voice_description

string

No

Defines a detailed description of the voice ordering for the product

voice_synonyms

string

No

The typical pronunciations of the product name or alternate names for the product (comma separated)

enable_time_based_pricing

boolean

No

The flag that enables time-based pricing logic

external_identifiers

[ string ]

No

Identifiers that are used to reference the product from the external systems

tax_inclusive

boolean

No

The flag that defines whether or not new prices for this item are tax inclusive

field_data_kit_values

[ object ]

No

Contains names and identifiers for every changed section in the site specific document

weight_config

object

No

product_ingredients

[ object ]

No

The list of product ingredients

entity_id

entity_id

No

external_id

external_id

No

name

string

The default name of the product

product_id

string

The unique identifier (UID) of the product

caption

string

The caption that is displayed on the button in the menu. The maximum of five (5) lines and 255 characters are allowed.

product_type

string

The type of product.

The possible values are"standard," "modifier," "comment," "placeholder," "modifier_placeholder," "gift_card," "gift_certificate," "fee," or "retail_item."

item_type

string

The product item type.

The possible values are"product," "modifier," "comment," "placeholder," "modifier_placeholder," "gift_card," "gift_certificate," "fee," or "retail_item."

revenue_class

string

include_on_item_count

boolean

The flag that determines if the product affects the item count

include_on_item_count_value

integer

The flag that determines the value that the item is counted as when added to an order

guest_count

integer

The flag that defines the number of guests that is associated with an order when the product has been added

reporting_category

object

alt_item_name

string

item_description

string

is_open_price

boolean

The flag that determines if the user is prompted for a price when adding to the order

is_bundle

boolean

The flag that enables the product as a bundle

bundle_components_entity_ids

[ string, object ]

An array of bundle_component entity_ids

kitchen_routing_category_entity_ids

[ string, object ]

The categories that the product is routed to

modifier_collection_entity_id

string, object

Allows the definition of the modifier collection for the product

display_modifier_selection_screen

string

Allows overriding the "Display Modifier Menu on Item Add" option in preferences for the current product.

The possible values are"use_company_preference," "when_product_is_added_to_order," or "do_not_display_automatically."

builds

[ object ]

tax_group_entity_id

string, object

The group of tax rates to be applied on an order

default_cost

number (currency)

The default cost of the product

unit_size

integer

Allows the user to set the size for each unit for the price that is configured

unit_type

string

Allows the user to select the type of the unit that makes up the item.

The possible values are"none," "pack," "each," "case," "bottle," "can," "gallon," "quart," "milliliter," "liter," "pound," "ounce," "gram," or "kilograms."

always_print_in_red

boolean

The flag that indicates whether or not the modifier always prints in red (overrides modifier group setting)

include_in_plain_builds

boolean

The flag that indicates whether or not the modifier is included by default in a build

allow_quantity

boolean

The flag that indicates whether or not the modifier allows changing quantities

increment_modifier_quantity_by

number

The possible values are1, 0.5, 0.33333, or 0.25

fractional_increment_modifier_quantity_by

object

fractional_secondary_increment_modifier_quantity_by

object

variation_info

object

show_confirmaion_prompt

boolean

The flag that decides if the user is prompted to confirm combining order item components into a bundle when the bundle components are added to the order separately

advance_on_component_fulfillment

string

Allows overriding the "Advance on Component Fulfillment" option in preferences for the current product.

The possible values are"use_company_preference," "on_final_component_choice," or "do_not_automatically_advance."

prompt_item_conversio_on_change

boolean

The flag that determines if the bundle is changed based on the size of the components added

allow_plain_builds

boolean

external_category_ids

[ string ]

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

external_tag_ids

[ string ]

The external tag identifiers

images

[ object ]

An array of product related images

nutritional_data

[ object ]

The nutrition values for the product

allergens

[ object ]

The allergens presence information

product_category_entity_ids

[ string, object ]

An array of Product Category entity identifiers

product_tag_entity_ids

[ string, object ]

The tags that are currently added to the product

prompt_for_quantity

boolean

The flag that determines if the user is prompted to enter the quantity when adding to the order

kitchen_routing_type

string

Determines how the product is routed to the kitchen.

The possible values are"by_category" or  "by_destination."

order_destination_entity_id

string, object

The order destination entity identifier

kitchen_routing_categories_by_destination

[ object ]

An array of objects with kitchen_routing_category_entity_ids by order_destination_entity_id

alternate_kitchen_name

string

The optimized shorter name for kitchen printing and video

display_modifier_priority_entity_id

string, object

The priority in which the modifier displays in relation to other modifiers in the kitchen displays

preparation_instructions

string

The preparation instructions field

prep_instruction_images

[ string ]

The images for preparation instruction

tag_entity_ids

[ string, object ]

An array of tag entity identifiers

alternate_plu_codes

[ string ]

Allows the user to add the product to an order using the added price look ups (PLUs)

is_liability_item

boolean

The flag that indicates if the product is a liability item, such as a gift card

liability_info

object

forbid_adding_via_lookup

boolean

The flag that prevents the product from being added to an order through Product Lookup in the ordering application

restricted_order_source_entity_ids

[ string, object ]

An array of restricted Order Source entity identifiers

restricted_order_source_ids

[ string ]

An array of restricted Order Source identifiers

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

restrict_availability_order_source

boolean

The flag that indicates whether or not to restrict availability by the order source

voice_name

string

The primary product name for use with voice ordering

voice_description

string

Defines a detailed description of the voice ordering for the product

voice_synonyms

string

The typical pronunciations of the product name or alternate names for the product (comma separated)

enable_time_based_pricing

boolean

The flag that enables time-based pricing logic

external_identifiers

[ string ]

Identifiers that are used to reference the product from the external systems

tax_inclusive

boolean

The flag that defines whether new prices for the item are tax inclusive or not

field_data_kit_values

[ object ]

Contains names and identifiers for every changed section in the site specific document

weight_config

object

product_ingredients

[ object ]

The list of product ingredients

external_id

external_id

total

integer

items

[product ]

product_name

string

Yes

The name of the product that is available or not

product_id

string

Yes

The product identifier of the product that is available or not

product_entity_id

string, object

Yes

The entity identifier of the product that is available or not

is_available

boolean

Yes

The flag that indicates the product's availability

comment

string

No

An optional reason string relating to the availability of the product

_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

product_name

string

Yes

The name of the product that is available or not

product_id

string

Yes

The product identifier of the product that is available or not

product_entity_id

string, object

Yes

The entity identifier of the product that is available or not

is_available

boolean

Yes

The flag that indicates the product's availability

comment

string

No

An optional reason string relating to the availability of the product

entity_id

entity_id

No

external_id

external_id

No

product_name

string

The name of the product that is available or not

product_id

string

The product identifier of the product that is available or not

product_entity_id

string, object

The entity identifier of the product that is available or not

is_available

boolean

The flag that indicates the product's availability

comment

string

An optional reason string relating to the availability of the product

external_id

external_id

total

integer

items

[product_availability ]

name

string

category_id

string

external_id

external_id

total

integer

items

product_category

name

string

The product ingredient name

external_id

external_id

total

integer

items

[product_ingredient ]

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 this price

range_start

integer

No

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

range_end

integer

No

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

tax_inclusive

boolean

No

The 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 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

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 defines 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

The 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

entity_id

entity_id

No

external_id

external_id

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. It 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 this 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 the prices of one type

external_id

external_id

total

integer

items

product_price

name

string

bundle_components_entity_ids

array

An array of bundle_component entity_ids

kitchen_routing_category_entity_ids

array

An array of kitchen_routing_category entity_ids

order_destination_entity_id

string, object

An array of order_destination entity_ids

_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