GuidesDiscussionsAPI ReferenceChangelogMy Application
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesDiscussionsAPI ReferenceChangelogMy ApplicationLog In
API Reference

Updates an OrderItem object

put
https://qa2.revelup.com/resources/OrderItem//

Updates an OrderItem object specified by ID

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

ID of OrderItem to update

Body Params

OrderItem object that needs to be updated

applied_discounts
array of objects

List of related AppliedDiscountOrderItem API rendered objects (present if applied)

applied_discounts
applied_service_fee
array of objects

List of related AppliedServiceFee API rendered objects (present if applied)

applied_service_fee
applied_taxes
array of objects

List of related AppliedTaxOrderItem API rendered objects (present if applied)

applied_taxes
uri

URI of related Appointment API object (if exists, otherwise 'null')

uuid

UUID of an Appointment API object specified in the 'appointment' property (same as 'uuid' property of the Appointment API object)

uri

URI of the parent OrderItem API object billed this order item (if exists)

boolean

Flag value specifying the completion of catering ('true' if completed)

date-time

Date and time when catering is completed

uri

URI of an ComboProductSet API object if this item makes a combo

string

Value of the combo discount (if combo present)

integer
enum

Types of combos

Combo Types:

  • 0 - Not a Combo
  • 1 - Group Combo
  • 2 - Split Combo
Allowed:
integer

-> combo_fraction_part can be 2/3/4 for Split Combo (equals to number of splits in combo). For group combo or non-combo items will be 1 (no parts, whole unit)

uri

URI of an Product API object related to the combo (same as 'product' property of the ComboProductSet API object)

uuid

UUID of an ComboProductSet API object specified in the 'combo_product_set' property

string

Value of the commission amount on the order item

commissions
array of objects

List of related OrderItemCommission API rendered objects (present if commission applied, i.e. 'commission_amount' property is not zero)

commissions
string

Cost of the ordered item

integer

Number of dishes served together (course)

uri
required

URI of an User API object which is responsible for this order item creation

date-time
required

Date and time when order item is created

float

California Redemption Value (CRV) fee

integer

Number of cups of beverage ordered

float

Weight of the ordered beverage cup

date-time

Payment date of the order item

boolean

Flag value specifying deletion status of the order item, 'true' if deleted

date-time

Date and time of the ordered item deletion

integer
enum
required

ID of dining option, e.g. delivery, take out, eat-in, etc (defined in Establishment/Stations)

Dining option:

  • 0 - TOGO
  • 1 - EATIN
  • 2 - DELIVERY
  • 3 - CATERING
  • 4 - DRIVETHROUGH
  • 5 - ONLINE
  • 6 - OTHER
  • 7 - SHIPPING
  • 8 - PICKUP
uri

URI of the related Discount API object (if exists)

number

Amount of the discount applied

string

Discount code (could be an empty string, 'null' or some number)

string

Description/hint of the applied discount

float

Value of the discount specified by discount rule (see 'discount_rule_type' property)

integer
enum

ID of discount type, i.e. percentage discount, amount of dollars discount, repricing each item, etc (defined in Products/Discounts)

Discount Rule Types:

  • 0 - AMOUNT
  • 1 - PERCENT
  • 2 - RE_PRICE
  • 3 - ALT_PRICE
Allowed:
string

Amount of discount tax

boolean

Flag value specifying whether the discount is taxed or not, 'true' if taxed

uri

URI of an User API object which is responsible for this order item discount

uri

URI of a DynamicCombo API object representing upsell combo if applied to this order item (defined in Products/Upsell combos)

uri

URI of DynamicComboSlot API object related to the dynamic combo provided

integer
enum

ID of Exchange/Refund/Void/Comparables operation type, i.e. 'exchange return to inventory', 'void waste', 'exchange waste', etc (defined in POS items ordering menu)

Ervc Types:

  • 0 - NONE
  • 1 - EXCHANGE_RETURN_TO_INVENTORY
  • 2 - EXCHANGE_WASTE
  • 3 - RETURN_RETURN_TO_INVENTORY
  • 4 - RETURN_WASTE
  • 5 - VOID_RETURN_TO_INVENTORY
  • 6 - VOID_WASTE
  • 7 - COMP_WASTE_NOT_UPDATE_COST
  • 8 - COMP_WASTE_UPDATE_COST
  • 9 - NO_INVENTORY_ACTIONS_ON_CREATE
  • 10 - SHIP_FROM_WAREHOUSE_RETURN_TO_INVENTORY
  • 11 - WAREHOUSE_VOID
  • 12 - WAREHOUSE_COMP
  • 13 - WAREHOUSE_RETURN
date-time

Date and time of the order item event if set otherwise 'null'

boolean

Flag value specifying whether Exchange Discount type is set or not 'true' if discount set (defined in Products/Discounts)

boolean

Flag value specifying exchange status of the order item, 'true' if item exchanged

boolean

Flag value specifying whether discount applied to this item or not, 'true' if discount is not applied

uri

Date and time when order item is shipped out

string

URI of an Address API object related to the external shipping address of the order item recipient (could be 'null' if not sed)

string

Gift card code

int64

ID of the order item (unique)

ingredientitems
array of uris

List of URI of Ingredient API objects related to the order item

ingredientitems
float

Initial price of the order item

uuid

UUID of the related invoice document

boolean

Flag value specifying 'is cold' type of an order item (to avoid taxation e.g.) 'true' if set

boolean

Flag value specifying whether the order item discounted or not, 'true' if discounted

boolean

Flag value specifying whether the order item layaway or not, 'true' if layaway (defined in Inventory/Products)

boolean

Flag value specifying whether the order item payed by store credit or not (enabled in Settings/Advanced POS settings)

integer

ID of the current order item type, i.e. normal, gift, donation, store credit, etc

date-time

Date and time when related to the order item dish is ready

float

Amount of price adjustment when price is overriding on the POS

float
required

Amount of the order item modifier applied

string

Cost of the order item modifier

modifieritems
array of objects

List of related ModifierItem API rendered objects (defined in Products/Modifiers)

modifieritems
boolean

Flag value specifying ability of the order item to be returned, 'true' if item can not be returned

boolean

Flag value specifying whether order item on hold or not, 'true' if item on hold (Hold Order on POS terminal)

string

Amount of items which are layaway

uri
required

URI of the related Order API object which contains this item

string

ID of the related order which contains this item

uri

URI of the related Package API object which contains this item

uuid

UUID of an Package API object specified in the 'package' parameter (same as 'uuid' property of the Package API object)

uuid

UUID of an order item which is parent for this item ('null' if parent item does not exist)

uuid

If this product is child element of Combor Product, uuid of that parent will be stored here

float
required

Price of the order item

string

Price of the order item to display

boolean

Flag value specifying whether the order item printed or not, 'true' if printed

uri

URI of the related Product API object to this order item

string

Name of the product for this order item, can be the same as 'name' property of the Product API object specified in the 'product' property or can differ. If empty then there is no associated product with this order item

date-time

Date and time of using pump station

integer

Number of used pump station

float

Amount of sales price

integer
required

Quantity of the product for this order item

uri

URI of the related Discount API object to this order item (if discount applied)

string

Representation of the applied discounts as dictionary for internal use, same info can be obtained from the Discount API object defined in 'discount' property

uri

URI of this OrderItem API object

uri

URI of an Establishment API object which is responsible for this order item return

string

Description/hint of the tax exemption reason

string

Barcode of this order item obtained from the scanner

integer

Seat number related to this order item

boolean

Flag value specifying whether the order item sent or not, 'true' if sent

uuid

UUID representing this order item Serial Number

string

Service fee tax for this order item (defined in Products/Service fee)

string

Amount of service fee taxed for this order item

string

Amount of service fee if order item untaxed

uri

URI of an User API object which is responsible for this order item service

integer

Value specifying whether the order item shared or not, '1' if shared, otherwise '0'

boolean

Flag value specifying whether the order item sold by weight or not, 'true' if sold by weight

string

Commentary for 'special request' modifier (defined in Products/Modifiers)

float

Number of split parts of the order item if splitted

integer

ID of the splitting type for this order item, e.g. first half, second half

integer

Splitting bill with seat

date-time

Date and time when order item accepted

uri
required

URI of an PosStation API object related to the POS processing this order item

float
required

Amount of the tax for this order item

boolean

Flag value specifying whether tax include into the order item or not, 'true' if tax included

float
required

Rate of the tax applied for this order item

float

Amount of the tax rebate for this order item

boolean

Flag value specifying whether the order item taxed or not, 'true' if taxed

int64
required
string

Unit of Measurement for this order item

uri
required

URI of an User API object which is responsible for this order item update

date-time
required

Date and time when the order item updated

uuid
required

UUID of this order item

uuid

UUID of the voided order item (or parent voided order item)

uri

URI of an User API object which is responsible for this order item void

date-time

Date and time when the order item is voided

string

Reason for void

float

Weight of the order item

string

Amount of wholesale saving for this order item

Responses

400

Invalid ID supplied

404

OrderItem not found

405

Validation exception

Updated over 2 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago