GuidesDiscussionsAPI ReferenceChangelogMy Application
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesDiscussionsAPI ReferenceChangelogMy ApplicationLog In
API Reference

Update Order by ID

patch
https://qa2.revelup.com/resources/Order//

Updates a single Order object

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

ID of Order to update

Body Params

Order data that needs to be changed

string

Tax number, if provided otherwise can be substituted on 'call_number' in tax detail information

boolean

If order is web order

boolean

BE internal flag if order has Items

registry_data
object
boolean

True means that order has exchange discount. Not used starting from POS v.2.31

string

JSON string with gift card processing results and loyalty card processing results.

string

Identifier of the loyalty account that was applied to the order. Note: This data is only populated for Paytronix orders at this time.

uuid
required

Universally unique identifier of this object

uri
required

User who created this Order

float

Total amount of order untaxed service fees

float

Tax amount of discount if tax included case

float

Amount of order discount (includes Tax in case of tax included)

boolean

True if order was sent to kitchen view

boolean

True means that order was exchanged. Not used for a long time

uri
required

User who updated this Order

string

Checksum

uri

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

float

Total crv amount from all order items

integer

Delivery time in seconds

uri

URI of an User API object which is owner of the related to this order table

float

Surcharge fee of the order payment that is excluded

float

Amount of the taxable surcharge fee which is excluded

integer

Number of people served or related to the order

string

Notes about the order

applied_discounts
array of objects

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

applied_discounts
string
enum
required
length ≤ 1

POS mode indicator (i.e. retial, kiosk, grocery, etc)

Pos Modes:

  • "T" - Table service
  • "Q" - Quick service
  • "R" - Retail
  • "K" - Kiosk
  • "P" - Pizza
  • "G" - Grocery
  • "D" - Donation
  • "E" - Register
  • "F" - Gas station
boolean

Flag indicates that order was paid by House Account

string

Information about deleted discounts, it could be a list or specific data representation of discount ID

integer

Amount of loyalty points awarded for the order.

string

Information about bills

float

Total amount of tax calculated from tax excluded items.

float

Auto gratuity percentage.

boolean

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

integer
enum

Tax rounding rule (per order or per item)

Tax Rounding Models:

  • 0 - ORDER_LEVEL
  • 1 - ITEM_LEVEL
Allowed:
boolean

Flag value specifying whether the email notification sent or not, 'true' if notification is sent

integer

Delivery distance in meters

integer
enum

Type of the gratuity used

Gratuity Types:

  • 0 - NONE
  • 1 - MANUAL
  • 2 - AUTO
Allowed:
order_history
array of uris

List of OrderHistories which assigned to this order

order_history
boolean

Flag if order was closed

string

Name of the country to which tax is related

string

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

date-time

Time when order should be be delivered to customer. Default is null (means that order should be printed/delivered when created).

pickup_data
object

Additional JSON data for pickup orders. Used when the dining_option is 8 (PICKUP). All fields are not required.

boolean

Marks that order does not have delivery time. Used for online orders.

boolean

The internal field to mark order deleted. If it's true it's not showed at UI and API.

boolean

Flag value specifying whether the order has delivery information or not, 'true' if yes it has

integer

Report ID related to this order

float

Discount on surcharge from untaxed tax included items. Is not used starting from POS v.2.39.

float

Total amount of surcharge from taxed items (from tax included and excluded items)

delivery_address
object

Relation to Address order should be delivered

float
required

Amount should be paid

uri

Relation to Discount was applied

boolean

Flag if order is still Invoice

date-time

Clock-In time for delivery driver

date-time
required

Date of this order creation

date-time

Clock-out time for delivery driver

float

Tax amount of discount

float

Money amount that contains cents rounding for cash payment. POS specific field

boolean

BE internal flag if order is not paid

float

Tax amount of rebate from tax (Canada Ontario specific rule).

uri

Relation to table. For table service mode.

string

Description/hint of the applied discount

boolean

Flag value specifying whether the text message notification sent or not, 'true' if notification is sent

uri

URI of an PosStation API object which is responsible for the updating of the order

float
required

Total by all Items from in the order

uri

URI of the CustomerVehicle API object related to this order

boolean

Flag shows if discount taxed

applied_taxes
array of objects

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

applied_taxes
float

Prevailing tax percentage

date-time

Date when invoice was created

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:
float

Service charge value for this order

uri

URI of the Customer API object related to this order

applied_service_fee
array of objects

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

applied_service_fee
package
array of uris

List of URI of Package API objects related to the order

package
float
required

Balance due of the order

boolean

BE internal flag if order has Order Histories

float
required

Tax amount for whole Order

integer

Bill number of order in case of split bills. Main order has bill number 0.

integer

Id of this object

float
required

Total amount of surcharge calculated for the order (included + excluded surcharge)

integer

Amount of loyalty points redeemed for the order.

integer

Sequential number assigned to the order.

integer

Delivery estimated distance in meters

uri

The main order relation from split bills parts

uri
required

Relation to Establishment where order was created

date-time
required

Date of this order updation

float

Surcharge percentage

float

Money amount of gratuity calculated for the order.

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
integer
enum

Specifying split bills type (by item, by number of people, etc)

Bills type:

  • 0 - NONE
  • 1 - EVEN
  • 2 - MANUAL
  • 3 - BY_ITEM
  • 4 - BY_SEAT
Allowed:
string

Information about call number

boolean

True if order was printed on kitchen printer

date-time

Birth date of the customer

uri

Device ID of POS Station related to this order

uri

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

float

Discount rule amount used for calculation money amount.

boolean

True means that POS should not recalculate tax. Used for online orders

float

Total amount of order taxed service fees

uri
required

URI of the PosStation API object which responsible for this order creation (if exists)

float

Tax amount on order service fee

float

Sum of order discount amount and discount amount from all order items.

boolean

True means that POS should calculate tax on crv amount

string

Order display number

integer

Value for external syncing (internal use)

uri

URI of this object resource

integer

Customer address distance

integer

Version of the order used for internal reporting.

json
Defaults to {}

JSON field used for storing additional order data for delivery. Internal use only.

Responses

400

Invalid ID supplied

404

Order not found

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