HIhitpayapp

Update the order

Update the order

patch/v1/orders/{order_id}

Request

  • Base URL
    https://api.hit-pay.com
  • URL
    https://api.hit-pay.com/v1/orders/{order_id}
  • Auth
    none declared. Required headers: X-BUSINESS-API-KEY

Path parameters

order_idstring required

It's required field

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

amountnumber required

The total amount of the order

currencystring required

The currency of the order

remarkstring required

The remark of the order

location_idstring required

The location id of the order

customer_idstring required

The customer id of the order

customer_pickupboolean required

The customer pickup of the order

channelstring required

The channel of the order

business_user_idstring required

The business user id of the order

discount_reasonstring required

The discount reason of the order

discount_amountnumber required

The discount amount of the order

versionstring required

The version of the order

Example request

{
  "amount": 100,
  "currency": "sgd",
  "remark": "Order Remark HitPay",
  "location_id": "9ae46141-c930-4613-b5a0-241206b9c215",
  "customer_id": "9ae46141-c930-4613-b5a0-241206b9c215",
  "customer_pickup": true,
  "channel": "point_of_sale",
  "business_user_id": "34",
  "discount_reason": "Discount Reason",
  "discount_amount": 10,
  "version": "1.0"
}

Response

200

idstring
order_display_numberinteger
business_idstring
channelstring
versionstring
customer_idunknown
business_customer_idunknown
customerunknown
customer_pickupboolean
currencystring
order_discount_nameunknown
statusstring
remarkstring
created_atstring
updated_atstring
closed_atunknown
location_idunknown
locationunknown
business_user_idstring
slot_dateunknown
slot_timeunknown
messagesunknown
couponunknown
payment_statusunknown
fulfilment_statusstring
line_items_totalinteger
order_discount_amountinteger
line_item_discount_amountinteger
line_item_tax_amountinteger
additional_discount_amountinteger
total_discount_amountinteger
line_item_priceinteger
shipping_amountinteger
total_coupon_amountinteger
amountinteger
subtotalinteger

Changes

No recorded changes to this operation across all 8 revisions of this API.