HitPay Product Guide and API docs.

PATCH

orders

{order_id}

Update the order

curl --request PATCH \
  --url https://api.sandbox.hit-pay.com/v1/orders/{order_id} \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "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"
}'

{
  "id": "9b4bc2a2-4721-4636-a6dc-4effec3b00fc",
  "order_display_number": 5660,
  "business_id": "9130c422-bf97-4bd1-b370-07a3a6f40708",
  "channel": "point_of_sale",
  "version": "1.0",
  "customer_id": null,
  "business_customer_id": null,
  "customer": null,
  "customer_pickup": true,
  "currency": "sgd",
  "order_discount_name": null,
  "status": "draft",
  "remark": "Razaq is a fool",
  "created_at": "2024-02-10T00:41:42+08:00",
  "updated_at": "2024-02-10T00:41:42+08:00",
  "closed_at": null,
  "location_id": null,
  "location": null,
  "business_user_id": "34",
  "slot_date": null,
  "slot_time": null,
  "messages": null,
  "products": [],
  "charges": [],
  "line_items": [],
  "order_form": {
    "membership_id": {
      "type": "input",
      "title": "Membership ID",
      "deleted": false,
      "include": true,
      "required": true
    }
  },
  "order_form_response": [],
  "coupon": null,
  "payment_status": null,
  "fulfilment_status": "",
  "line_items_total": 0,
  "order_discount_amount": 0,
  "line_item_discount_amount": 0,
  "line_item_tax_amount": 0,
  "additional_discount_amount": 0,
  "total_discount_amount": 0,
  "line_item_price": 0,
  "shipping_amount": 0,
  "total_coupon_amount": 0,
  "amount": 0,
  "subtotal": 0
}

Headers

X-BUSINESS-API-KEY

string

required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

order_id

string

required

It's required field

Body

application/json

amount

number

default:0

required

The total amount of the order

Examples:

100

currency

string

default:sgd

required

The currency of the order

Examples:

"sgd"

remark

string

required

The remark of the order

Examples:

"Order Remark HitPay"

location_id

string

required

The location id of the order

Examples:

"9ae46141-c930-4613-b5a0-241206b9c215"

customer_id

string

required

The customer id of the order

Examples:

"9ae46141-c930-4613-b5a0-241206b9c215"

customer_pickup

boolean

default:true

required

The customer pickup of the order

Examples:

true

channel

string

default:point_of_sale

required

The channel of the order

Examples:

"point_of_sale"

business_user_id

string

required

The business user id of the order

Examples:

"34"

discount_reason

string

required

The discount reason of the order

Examples:

"Discount Reason"

discount_amount

number

default:0

required

The discount amount of the order

Examples:

10

version

string

default:1.0

required

The version of the order

Examples:

"1.0"

Response

200

string

order_display_number

integer

business_id

string

channel

string

version

string

customer_id

null

business_customer_id

null

customer

null

customer_pickup

boolean

currency

string

order_discount_name

null

status

string

remark

string

created_at

string

updated_at

string

closed_at

null

location_id

null

location

null

business_user_id

string

slot_date

null

slot_time

null

messages

null

products

any[]

charges

any[]

line_items

any[]

order_form

object

Show child attributes

order_form_response

any[]

coupon

null

payment_status

null

fulfilment_status

string

line_items_total

integer

order_discount_amount

integer

line_item_discount_amount

integer

line_item_tax_amount

integer

additional_discount_amount

integer

total_discount_amount

integer

line_item_price

integer

shipping_amount

integer

total_coupon_amount

integer

amount

integer

subtotal

integer

Update the order

curl --request PATCH \
  --url https://api.sandbox.hit-pay.com/v1/orders/{order_id} \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "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"
}'

{
  "id": "9b4bc2a2-4721-4636-a6dc-4effec3b00fc",
  "order_display_number": 5660,
  "business_id": "9130c422-bf97-4bd1-b370-07a3a6f40708",
  "channel": "point_of_sale",
  "version": "1.0",
  "customer_id": null,
  "business_customer_id": null,
  "customer": null,
  "customer_pickup": true,
  "currency": "sgd",
  "order_discount_name": null,
  "status": "draft",
  "remark": "Razaq is a fool",
  "created_at": "2024-02-10T00:41:42+08:00",
  "updated_at": "2024-02-10T00:41:42+08:00",
  "closed_at": null,
  "location_id": null,
  "location": null,
  "business_user_id": "34",
  "slot_date": null,
  "slot_time": null,
  "messages": null,
  "products": [],
  "charges": [],
  "line_items": [],
  "order_form": {
    "membership_id": {
      "type": "input",
      "title": "Membership ID",
      "deleted": false,
      "include": true,
      "required": true
    }
  },
  "order_form_response": [],
  "coupon": null,
  "payment_status": null,
  "fulfilment_status": "",
  "line_items_total": 0,
  "order_discount_amount": 0,
  "line_item_discount_amount": 0,
  "line_item_tax_amount": 0,
  "additional_discount_amount": 0,
  "total_discount_amount": 0,
  "line_item_price": 0,
  "shipping_amount": 0,
  "total_coupon_amount": 0,
  "amount": 0,
  "subtotal": 0
}

API Reference

Headers

Path Parameters

Body

Response