Create Order
POST
/api/v2/orders/createOrder type list:
ID | Type |
---|---|
1 | Pickup |
2 | Delivery |
3 | Eat in |
x | Specified to App Provided by the merchant |
Payment method list:
ID | Method |
---|---|
1 | Cash |
2 | Credit Card |
3 | Not paid |
Request
Body Params application/json
order_type_id
string
required
branch_id
string
required
due_at
string
required
customer_id
string
required
customer_address_id
string
required
discount
object
required
code
string
required
amount
string
required
meta
object
required
3rd_party_order_number
string
required
charges
object
required
charge_id
string
required
amount
integer
required
taxes
array [object {3}]
required
products
array [object {9}]
required
product_id
string
optional
variant_id
string
optional
quantity
string
optional
unit_price
integer
optional
total_price
integer
optional
discount_amount
integer
optional
tax_amount
string
optional
note
string
optional
modifiers
array [object {4}]
optional
payments
array [object {2}]
required
payment_id
string
optional
amount
integer
optional
note
string
required
tax
string
required
subtotal_price
integer
required
paid
integer
required
total_price
integer
required
Example
{
"order_type_id": "string|required",
"branch_id": "string|required",
"due_at": "datatime|optional|Y-m-d H:i:s",
"customer_id": "string|optional",
"customer_address_id": "string|optional", // add with customers
// "giftcard":{
// "code":"string|optional",
// "amount":"decimal|required with giftcard_code"
// },
"discount":{
"code":"string|optional", // "bonat_xxxxx"
"amount":"decimal|required with discount_code"
},
"meta": {
"3rd_party_order_number": "123"
},
"charges": {
"charge_id": "1",
"amount": 15,
"taxes": [
{
"id": "1",
"rate": 15,
"amount": 3
}
]
},
"products": [
{
"product_id": "string|optional",
"variant_id": "string|optional",
"quantity": "decimal|optional",
"unit_price": 22,
"total_price": 22,
"discount_amount": 0,
"tax_amount": "decimal|optional",
"note": "string|optional",
"modifiers": [
{
"modifier_id": "1",
"quantity": 1,
"unit_price": 2,
"total_price": 2
}
]
}
],
"payments": [
{
"payment_id": "1",
"amount": 100
}
],
"note": "string|optional",
"tax": "decimal|optional",
"subtotal_price": 22,
"paid": 22,
"total_price": 200
}
/**
Orders Sources
1- POS
2- Digital menu
3- Call center
4- API
**/
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
object {0}
Example
{}
Modified at 9 months ago