Checkout API
Create checkout to outlet. Required permissions: checkout_api
post/v1/outlets/{outlet_id}/checkouts
Path parameters
outlet_idinteger required
The merchant's outlet ID
Request body
Example request
{
"checkout": {
"note": "cash",
"client_created_at": "2019-07-09T14:22:00.000+07:00",
"total_collected": 1800,
"amount_pay": 1800,
"items": [
{
"quantity": 1,
"item_id": 1,
"item_name": "Ice cream",
"item_variant_id": 1,
"item_variant_name": "large",
"item_variant_sku": "ICE-1234",
"sales_type_id": 130449,
"sales_type_name": "GoFood",
"category_id": 1,
"category_name": "Desert",
"client_price": 10000,
"discount_amount": 100,
"tax": 10,
"gratuity": 10,
"gross_sales": 10000,
"net_sales": 900,
"modifiers": [
{
"modifier_id": 1,
"modifier_option_id": 10,
"modifier_name": "Topping",
"modifier_option_name": "Mozarella",
"modifier_option_price": 8000,
"modifier_discounts": [
{
"discount_amount": 1000,
"discount_cash": 1000,
"discount_id": 1,
"discount_name": "New Years Discount",
"discount_percentage": 10,
"discount_type": "percentage",
"discount_guid": "d8359ece-5841-44a0-96f0-ebeb3b71ff25"
}
],
"discount_amount": 1000,
"gross_sales": 180000,
"net_sales": 165000
}
]
}
],
"gratuities": [
{
"gratuity_id": 1,
"gratuity_name": "American Favourite",
"gratuity_percentage": 12,
"gratuity_amount": 12000
}
],
"taxes": [
{
"tax_id": 1,
"tax_name": "American Favourite",
"tax_percentage": 5,
"taxable_amount": 10,
"tax_amount": 10
}
],
"discounts": [
{
"discount_id": 1,
"discount_name": "Promo 10",
"discount_cash": 1000,
"discount_amount": 1000,
"discount_percentage": 5
}
]
}
}Response
Checkout response
Example response
{
"meta": {
"code": 200
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.