API Reference
- Payment Request
- Recurring Billing
- Charges
- Balance
- Payout
- Account
- Orders
- Products
- Product Category
- Customers
- Staffs
- Invoice
- Webhook Events
- Static QR Codes
- Notifications
- Terminal
Update the order
Update the order
PATCH
/
v1
/
orders
/
{order_id}
Update the order
Copy
Ask AI
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"
}'
Copy
Ask AI
{
"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
Example:
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
Path Parameters
It's required field
Body
application/json
Response
200
application/json
200
The response is of type object
.
Was this page helpful?
Update the order
Copy
Ask AI
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"
}'
Copy
Ask AI
{
"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
}
Assistant
Responses are generated using AI and may contain mistakes.