Lewati ke konten utama

Pasello API Docs (1.0.0)

Download OpenAPI specification:Download

REST API for Pasello POS Android client.

Auth

auth.workspace

query Parameters
workspace
required
string <= 255 characters

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

auth.login

Request Body schema: application/json
required
email
required
string <email>
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

auth.logout

Authorizations:
http

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Berhasil logout."
}

auth.me

Authorizations:
http

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Member

member.index

Authorizations:
http
query Parameters
search
string or null <= 255 characters
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

member.store

Authorizations:
http
Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "address": "string",
  • "member_region_id": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "Member berhasil didaftarkan."
}

member.show

Authorizations:
http
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Product

product.index

Authorizations:
http
query Parameters
available_only
string or null
category_id
integer or null
search
string or null <= 255 characters
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

product.categories

Authorizations:
http
query Parameters
with_counts
string or null

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

product.show

Authorizations:
http
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Setting

setting.index

Authorizations:
http

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Sync

sync.sync

Authorizations:
http
Request Body schema: application/json
required
device_id
required
string <= 100 characters
required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "device_id": "string",
  • "transactions": [
    ]
}

Response samples

Content type
application/json
"string"

sync.status

Authorizations:
http
query Parameters
device_id
required
string <= 100 characters
since
integer or null

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Transaction

transaction.index

Authorizations:
http
query Parameters
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 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

transaction.store

Authorizations:
http
Request Body schema: application/json
required
member_id
integer or null
name
string or null <= 255 characters
phone
string or null <= 30 characters
email
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

Responses

Request samples

Content type
application/json
{
  • "member_id": 0,
  • "name": "string",
  • "phone": "string",
  • "email": "user@example.com",
  • "order_type": "dine_in",
  • "payment_method": "cash",
  • "cash_received": 0,
  • "items": [
    ],
  • "manual_discount_type": "nominal",
  • "manual_discount_value": 0,
  • "manual_discount_note": "string",
  • "voucher_code": "string",
  • "points_to_redeem": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "Transaksi berhasil disimpan."
}

transaction.show

Authorizations:
http
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

transaction.void

Authorizations:
http
path Parameters
id
required
integer
Request Body schema: application/json
required
reason
required
string <= 500 characters
manager_pin
string or null = 6 characters

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "manager_pin": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Transaksi berhasil dibatalkan."
}

transaction.calculate

Authorizations:
http
Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "member_id": 0,
  • "items": [
    ],
  • "manual_discount_type": "nominal",
  • "manual_discount_value": 0,
  • "voucher_code": "string",
  • "points_to_redeem": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}