curl --request PATCH \
--url https://api.hit-pay.com/v1/orders/{order_id} \
--header 'Content-Type: application/json' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--data '
{
"amount": 0,
"currency": "sgd",
"remark": "<string>",
"location_id": "<string>",
"customer_id": "<string>",
"customer_pickup": true,
"channel": "point_of_sale",
"business_user_id": "<string>",
"discount_reason": "<string>",
"discount_amount": 0,
"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
}Update order details or status
curl --request PATCH \
--url https://api.hit-pay.com/v1/orders/{order_id} \
--header 'Content-Type: application/json' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--data '
{
"amount": 0,
"currency": "sgd",
"remark": "<string>",
"location_id": "<string>",
"customer_id": "<string>",
"customer_pickup": true,
"channel": "point_of_sale",
"business_user_id": "<string>",
"discount_reason": "<string>",
"discount_amount": 0,
"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
}"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
It's required field
The total amount of the order
100
The currency of the order
"sgd"
The remark of the order
"Order Remark HitPay"
The location id of the order
"9ae46141-c930-4613-b5a0-241206b9c215"
The customer id of the order
"9ae46141-c930-4613-b5a0-241206b9c215"
The customer pickup of the order
true
The channel of the order
"point_of_sale"
The business user id of the order
"34"
The discount reason of the order
"Discount Reason"
The discount amount of the order
10
The version of the order
"1.0"
200
Show child attributes
Was this page helpful?