Download OpenAPI specification:Download
REST API for Pasello POS Android client.
| email required | string <email> |
| password required | string |
{- "email": "user@example.com",
- "password": "string"
}{- "success": true,
- "data": {
- "token": "string",
- "token_type": "Bearer",
- "user": {
- "id": 0,
- "name": "string",
- "email": "string",
- "roles": [
- {
- "relations": [
- "roles"
]
}
]
}
}
}| search | string or null <= 255 characters |
| per_page | integer [ 1 .. 100 ] |
{- "data": [
- {
- "id": 0,
- "name": "string",
- "email": "string",
- "phone": "string",
- "points": 0,
- "member_type": "string",
- "region": {
- "id": 0,
- "name": "string"
}, - "email_verified_at": "string",
- "created_at": "string"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 1,
- "from": 1,
- "last_page": 1,
- "links": [
- {
- "url": "string",
- "label": "string",
- "active": true
}
], - "path": "string",
- "per_page": 0,
- "to": 1,
- "total": 0
}
}| name required | string <= 255 characters |
| email required | string <email> <= 255 characters |
| phone required | string <= 30 characters |
| address | string or null <= 500 characters |
| member_region_id | integer or null |
{- "name": "string",
- "email": "user@example.com",
- "phone": "string",
- "address": "string",
- "member_region_id": 0
}{- "success": true,
- "data": {
- "id": 0,
- "name": "string",
- "email": "string",
- "phone": "string",
- "points": 0,
- "created_at": "string"
}, - "message": "Member berhasil didaftarkan."
}{- "success": true,
- "data": {
- "id": 0,
- "name": "string",
- "email": "string",
- "phone": "string",
- "address": "string",
- "points": 0,
- "member_type": "string",
- "region": {
- "id": 0,
- "name": "string"
}, - "email_verified_at": "string",
- "created_at": "string",
- "stats": {
- "total_spent": 0,
- "transactions_count": 0,
- "average_transaction": 0
}, - "recent_transactions": [
- {
- "id": 0,
- "code": "string",
- "total": 0,
- "payment_status": "string",
- "points_earned": 0,
- "points_redeemed": 0,
- "created_at": "string"
}
]
}
}| available_only | string or null |
| category_id | integer or null |
| search | string or null <= 255 characters |
| per_page | integer [ 1 .. 100 ] |
{- "data": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "image": "string",
- "is_available": true,
- "is_promo": true,
- "is_favorite": true,
- "is_package": true,
- "package_type": "string",
- "category": {
- "id": 0,
- "name": "string"
}, - "variants": [
- {
- "id": 0,
- "name": "string",
- "price": 0,
- "price_afterdiscount": 0,
- "has_discount": "string"
}
], - "total_sold": 0,
- "created_at": "string"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 1,
- "from": 1,
- "last_page": 1,
- "links": [
- {
- "url": "string",
- "label": "string",
- "active": true
}
], - "path": "string",
- "per_page": 0,
- "to": 1,
- "total": 0
}
}{- "success": true,
- "data": {
- "id": 0,
- "name": "string",
- "description": "string",
- "image": "string",
- "is_available": true,
- "is_promo": true,
- "is_favorite": true,
- "is_package": true,
- "package_type": "string",
- "total_sold": 0,
- "category": {
- "id": 0,
- "name": "string"
}, - "variants": [
- {
- "id": 0,
- "name": "string",
- "price": 0,
- "price_afterdiscount": 0,
- "percent": 0,
- "has_discount": "string"
}
], - "options": [
- {
- "id": 0,
- "name": "string",
- "is_required": true,
- "sort_order": 0,
- "values": [
- {
- "id": 0,
- "name": "string",
- "price": 0,
- "is_default": true,
- "sort_order": 0
}
]
}
], - "discounts": [
- {
- "id": 0,
- "name": "string",
- "discount_type": "string",
- "discount_value": 0,
- "ends_at": "string"
}
]
}
}{- "success": true,
- "data": {
- "store_name": "string",
- "phone": "string",
- "address": "string",
- "social_media": [
- null
], - "store_logo": "string",
- "primary_color": "string",
- "secondary_color": "string",
- "tax_rate": 0,
- "rounding_base": 0,
- "point_earning_rate": 0,
- "point_redemption_value": 0,
- "min_redemption_points": 0,
- "discount_applies_before_tax": true,
- "payment_gateway_enabled": true,
- "qris_enabled": true,
- "pos_default_customer_name": "string",
- "pos_default_payment_method": "string",
- "corrections_void_pending_requires_approval": true,
- "corrections_refund_requires_approval_for_cash": true,
- "corrections_refund_quick_max_amount": 0,
- "corrections_refund_quick_max_count_per_day": 0,
- "corrections_void_quick_max_count_per_day": 0,
- "corrections_void_quick_window_minutes": 0
}
}| device_id required | string <= 100 characters |
required | Array of objects non-empty |
{- "device_id": "string",
- "transactions": [
- {
- "local_id": "string",
- "server_id": 0,
- "code": "string",
- "action": "create",
- "data": {
- "channel": "string",
- "member_id": 0,
- "name": "string",
- "phone": "string",
- "email": "string",
- "order_type": "string",
- "payment_method": "string",
- "payment_status": "string",
- "subtotal": 0,
- "total": 0,
- "cash_received": 0,
- "cash_change": 0,
- "items": [
- {
- "product_id": 0,
- "product_variant_id": 0,
- "quantity": 1,
- "price": 0,
- "subtotal": 0,
- "note": "string"
}
], - "manual_discount_type": "string",
- "manual_discount_value": 0,
- "manual_discount_amount": 0,
- "manual_discount_note": "string",
- "points_to_redeem": 0,
- "points_earned": 0,
- "points_redeemed": 0,
- "voucher_discount_amount": 0,
- "voucher_code": "string",
- "paid_at": "2019-08-24T14:15:22Z",
- "void_reason": "string"
}, - "client_timestamp": 0,
- "server_timestamp": 0
}
]
}"string"| device_id required | string <= 100 characters |
| since | integer or null |
{- "success": true,
- "data": {
- "server_time": "string",
- "server_timestamp": 0,
- "transactions_since": 0,
- "transactions": [
- {
- "id": 0,
- "code": "string",
- "payment_status": "string",
- "total": 0,
- "updated_at": "string"
}
]
}
}| date_from | string or null <date-time> |
| date_to | string or null <date-time> |
| status | string or null Enum: "paid" "pending" "voided" "refunded" null |
| payment_method | string or null Enum: "cash" "qris" "qris_midtrans" "online" null |
| per_page | integer [ 1 .. 100 ] |
{- "data": [
- {
- "id": 0,
- "code": "string",
- "channel": "string",
- "order_type": "string",
- "payment_method": "string",
- "payment_status": "string",
- "customer": {
- "name": "string",
- "phone": "string",
- "email": "string"
}, - "member": {
- "id": 0,
- "name": "string",
- "phone": "string"
}, - "subtotal": 0,
- "voucher_discount_amount": 0,
- "manual_discount_amount": 0,
- "manual_discount_type": "string",
- "manual_discount_value": 0,
- "manual_discount_note": "string",
- "point_discount_amount": 0,
- "points_redeemed": 0,
- "points_earned": 0,
- "discount_total_amount": 0,
- "tax_percentage": "string",
- "tax_amount": 0,
- "rounding_amount": 0,
- "total": 0,
- "cash_received": 0,
- "cash_change": 0,
- "paid_at": "string",
- "voided_at": "string",
- "void_reason": "string",
- "items": [
- {
- "id": 0,
- "product_id": 0,
- "product_variant_id": 0,
- "product_name": "string",
- "variant_name": "string",
- "quantity": 0,
- "price": 0,
- "subtotal": 0,
- "product_discount_amount": 0,
- "note": "string"
}
], - "created_at": "string",
- "updated_at": "string"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 1,
- "from": 1,
- "last_page": 1,
- "links": [
- {
- "url": "string",
- "label": "string",
- "active": true
}
], - "path": "string",
- "per_page": 0,
- "to": 1,
- "total": 0
}
}| member_id | integer or null |
| name | string or null <= 255 characters |
| phone | string or null <= 30 characters |
string or null <email> <= 255 characters | |
| order_type required | string Enum: "dine_in" "take_away" |
| payment_method required | string Enum: "cash" "qris" "qris_midtrans" |
| cash_received | integer or null >= 0 |
required | Array of objects non-empty |
| manual_discount_type | string or null Enum: "nominal" "percentage" null |
| manual_discount_value | integer or null >= 0 |
| manual_discount_note | string or null <= 500 characters |
| voucher_code | string or null <= 100 characters |
| points_to_redeem | integer or null >= 0 |
{- "member_id": 0,
- "name": "string",
- "phone": "string",
- "email": "user@example.com",
- "order_type": "dine_in",
- "payment_method": "cash",
- "cash_received": 0,
- "items": [
- {
- "product_id": 0,
- "product_variant_id": 0,
- "quantity": 1,
- "note": "string"
}
], - "manual_discount_type": "nominal",
- "manual_discount_value": 0,
- "manual_discount_note": "string",
- "voucher_code": "string",
- "points_to_redeem": 0
}{- "success": true,
- "data": {
- "id": 0,
- "code": "string",
- "channel": "string",
- "order_type": "string",
- "payment_method": "string",
- "payment_status": "string",
- "customer": {
- "name": "string",
- "phone": "string",
- "email": "string"
}, - "member": {
- "id": 0,
- "name": "string",
- "phone": "string"
}, - "subtotal": 0,
- "voucher_discount_amount": 0,
- "manual_discount_amount": 0,
- "manual_discount_type": "string",
- "manual_discount_value": 0,
- "manual_discount_note": "string",
- "point_discount_amount": 0,
- "points_redeemed": 0,
- "points_earned": 0,
- "discount_total_amount": 0,
- "tax_percentage": "string",
- "tax_amount": 0,
- "rounding_amount": 0,
- "total": 0,
- "cash_received": 0,
- "cash_change": 0,
- "paid_at": "string",
- "voided_at": "string",
- "void_reason": "string",
- "items": [
- {
- "id": 0,
- "product_id": 0,
- "product_variant_id": 0,
- "product_name": "string",
- "variant_name": "string",
- "quantity": 0,
- "price": 0,
- "subtotal": 0,
- "product_discount_amount": 0,
- "note": "string"
}
], - "created_at": "string",
- "updated_at": "string"
}, - "message": "Transaksi berhasil disimpan."
}{- "success": true,
- "data": {
- "id": 0,
- "code": "string",
- "channel": "string",
- "order_type": "string",
- "payment_method": "string",
- "payment_status": "string",
- "customer": {
- "name": "string",
- "phone": "string",
- "email": "string"
}, - "member": {
- "id": 0,
- "name": "string",
- "phone": "string"
}, - "subtotal": 0,
- "voucher_discount_amount": 0,
- "manual_discount_amount": 0,
- "manual_discount_type": "string",
- "manual_discount_value": 0,
- "manual_discount_note": "string",
- "point_discount_amount": 0,
- "points_redeemed": 0,
- "points_earned": 0,
- "discount_total_amount": 0,
- "tax_percentage": "string",
- "tax_amount": 0,
- "rounding_amount": 0,
- "total": 0,
- "cash_received": 0,
- "cash_change": 0,
- "paid_at": "string",
- "voided_at": "string",
- "void_reason": "string",
- "items": [
- {
- "id": 0,
- "product_id": 0,
- "product_variant_id": 0,
- "product_name": "string",
- "variant_name": "string",
- "quantity": 0,
- "price": 0,
- "subtotal": 0,
- "product_discount_amount": 0,
- "note": "string"
}
], - "created_at": "string",
- "updated_at": "string"
}
}| id required | integer |
| reason required | string <= 500 characters |
| manager_pin | string or null = 6 characters |
{- "reason": "string",
- "manager_pin": "string"
}{- "success": true,
- "message": "Transaksi berhasil dibatalkan."
}| member_id | integer or null |
required | Array of objects non-empty |
| manual_discount_type | string or null Enum: "nominal" "percentage" null |
| manual_discount_value | integer or null >= 0 |
| voucher_code | string or null <= 100 characters |
| points_to_redeem | integer or null >= 0 |
{- "member_id": 0,
- "items": [
- {
- "product_id": 0,
- "product_variant_id": 0,
- "quantity": 1
}
], - "manual_discount_type": "nominal",
- "manual_discount_value": 0,
- "voucher_code": "string",
- "points_to_redeem": 0
}{- "success": true,
- "data": {
- "items": [
- null
], - "gross_subtotal": 0,
- "voucher_discount_amount": 0,
- "manual_discount_amount": 0,
- "point_discount_amount": null,
- "discount_total_amount": 0,
- "net_subtotal": null,
- "tax_percentage": 0,
- "tax_amount": 0,
- "rounding_amount": "string",
- "total": "string",
- "points_to_redeem": 0,
- "points_earned": "string",
- "member": {
- "id": 0,
- "name": "string",
- "phone": "string",
- "current_points": 0,
- "points_after_redeem": 0,
- "points_earned": "string"
}
}
}