Skip to content
/
Check Out for Prepaid Pac...

DealPOS API (3.1.0)

Welcome Developer

This page lists the reference documentation for DealPOS APIs. For guides and tutorials.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://www.dealpos.com
Customer Support
info@dealpos.com
Languages
Servers
Production Server
https://{subdomain}/api/v3/

Token

Operations related to authentication tokens

Operations

Category

Operations related to category, including create, get, etc

Operations

Product

Operations related to product, including create, get, etc

Operations

Variant

Operations related to variant, including create, get, etc

Operations

Serial

Operation related to Serial product type

Operations

Estimate

Operations related to estimate, including create, get, etc

Operations

Sales Order

Operations related to sales order, including create, get, etc

Operations

Invoice

Operations related to invoice, including create, get, etc

Operations

Shift

Operation related to shift, including create, get, etc

Operations

Report

Operations related to report page, including create, get, etc

Operations

Customer

Operations related to customer data, including create, get, etc

Operations

Comment

Operations related to comment (Contact Feedback), including create, get, etc

Operations

Supplier

Operations related to supplier data, including create, get, etc

Operations

Invoice Payment

Operations related to invoice payment, including create, get, etc

Operations

Bill Payment

Operations related to bill payment, including create, get, etc

Operations

Invoice Write Off

Operations related to invoice write off, including create, get, etc

Operations

Inventory

Operations related to inventory, including create, get, etc

Operations

Inventory Log

Operations related to inventory log, including create, get, etc

Operations

Inventory Adjustment

Operations related to inventory adjustment, including create, get, etc

Operations

Bill

Operations related to bill, including create, get, etc

Operations

OutboundLogistic

Operations related to outbound logistic, including create, get, etc

Operations

InboundLogistic

Operations related to inbound logistic, including create, get, etc

Operations

TransferOrder

Operations related to transfer order, including create, get, etc

Operations

Fulfillment

Operations related to fulfillment, including create, get, etc

Operations

Prepaid Package

Operations related to prepaid package, including create, get, etc

Operations

Check In for Prepaid Package

Request

Check In prepaid packages

You must have "CREATE" role in "Prepaid Packages" Module

Security
OAuth2_clientCredentials
Bodyapplication/json
MemberCodestringrequired

Code member of customer

Packagestring

Prepaid package that the customer want to use (Optional)

Doctorstring

The doctor/trainer that do the prepaid package (optional)

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/PrepaidPackage/CheckIn \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "MemberCode": "12345",
    "Package": "Gym Package",
    "Doctor": "Dr. Smith"
  }'

Responses

Bodyapplication/json
Messagestring

Member has been checked in

Response
application/json
{
  "Message": "Success register with number 20.03.00024 And Use Package Amd Gym(1x) With Customer Achmad raizaldi"
}

Check Out for Prepaid Package

Request

Check Out prepaid packages

You must have "CREATE" role in "Prepaid Packages" Module

Security
OAuth2_clientCredentials
Bodyapplication/json
MemberCodestringrequired

Code member of customer

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/PrepaidPackage/CheckOut \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "MemberCode": "123456"
  }'

Responses

Bodyapplication/json
Messagestring

Member has been checked out

Response
application/json
{
  "Message": " Check Out : 16:35 - Mr Achmad raizaldi - 65478 - P:1029348 - ID:4455221445 - Point(s) remaining :4,781.8  Expired on :16 Mar 2020 (4 Days),"
}

Get Prepaid Package History

Request

Get prepaid packages history.

You must have "VIEW" role in "Prepaid Packages" Module

Security
OAuth2_clientCredentials
Query
Outletstringrequired

Prepaid package outlet

Example: Outlet=Outlet1
PageNumberintegerrequired

The number of page data to be displayed (Each page will display 20 records)

Example: PageNumber=1
PageSizeinteger

The number of rows returned by the API

Example: PageSize=20
CustomerCodestring

Customer's code

Example: CustomerCode=CUST-001
Emailstring

Customer's email

Example: Email=teguhwarsini@gmail.com
Doctorstring

The doctor in charge

Example: Doctor=Dr. Panji Gumilang
Fromstring

Prepaid package date started

Example: From=2018-09-07
Tostring

End of prepaid package date (for filter)

Example: To=2018-10-17
curl -i -X POST \
  'https://subdomain.dealpos.net/api/v3/PrepaidPackage/History?Outlet=Outlet1&PageNumber=1&PageSize=20&CustomerCode=CUST-001&Email=teguhwarsini%40gmail.com&Doctor=Dr.+Panji+Gumilang&From=2018-09-07&To=2018-10-17' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Body
Array [
Outletstringrequired

Prepaid package outlet

Numberstringrequired

The prepaid package number

Datestringrequired

The treatment date

Customerstringrequired

The doctor in charge

Doctorstringrequired

The doctor / the employee insentive

Incentiveintegerrequired

The package name / prepaid package product name

Packagestringrequired

The package name / prepaid package product name

Typestringrequired

The treatment type

Statestringrequired

Treatment state / progress

]
Response
[
  {
    "Outlet": "Outlet1",
    "Number": "Prepaid-001",
    "Date": "2018-09-07",
    "Customer": "Teguh Warsini",
    "Doctor": "Dr. Panji Gumilang",
    "Incentive": 30000,
    "Package": "Cutting Package",
    "Type": "Hair Cutting with Style",
    "State": "Waiting"
  },
  {
    "Outlet": "Outlet1",
    "Number": "Prepaid-002",
    "Date": "2018-09-08",
    "Customer": "Stephen Wijaya",
    "Doctor": "Dr. Prabowo Widodo",
    "Incentive": 60000,
    "Package": "Laser Package",
    "Type": "Laser Treatment by Lion King",
    "State": "Finish"
  }
]

Get Prepaid Package History Detail

Request

Get single prepaid packages history with detail.

You must have "VIEW" role in "Prepaid Packages" Module

Security
OAuth2_clientCredentials
Query
Outletstringrequired

Prepaid package outlet

Example: Outlet=Outlet1
Numberstringrequired

The number of prepaid package / treatment number

Example: Number=Prepaid-001
curl -i -X POST \
  'https://subdomain.dealpos.net/api/v3/PrepaidPackage/History/Detail?Outlet=Outlet1&Number=Prepaid-001' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Body
Outletstringrequired

The prepaid package outlet

Example: "Outlet1"
Numberstringrequired

The prepaid package number / treatment number

Example: "Prepaid-001"
Datestringrequired

The treatment date

Example: "2018-09-07"
Startstringrequired

Treatment start time

Example: "12:10"
Finishstringrequired

Treatment end time

Example: "14:30"
Durationstringrequired

Treatment duration (in hour and minutes)

Example: "2 hr 20 min"
Customerstringrequired

Customers receiving treatment

Example: "Teguh Warsini"
Doctorstringrequired

The doctor in charge (main performer)

Example: "Dr. Panji Gumilang"
Assistantstringrequired

The doctor assistant in charge (performer assistant)

Example: "Dr. Gayus Tabunan"
RecommendedBystringrequired

Who can recommend or provide recommendations

Example: "Hendry Wijaya"
Incentiveintegerrequired

The doctor incentive

Example: 30000
Packagestringrequired

The package name / prepaid package product name

Example: "Cutting Package"
Typestringrequired

Prepaid package type / treatment type

Example: "Hair Cutting with Style"
Statestringrequired

Treatment state / progress

Example: "Waiting"
DoctorNotestringrequired

The doctor note for the customer

Example: "Keep the hair dry"
AssistantNotestringrequired

The doctor assistant note for the customer

Example: "Do not use too much shampoo"
Response
{
  "Outlet": "Outlet1",
  "Number": "Prepaid-001",
  "Date": "2018-09-07",
  "Start": "12:10",
  "Finish": "14:30",
  "Duration": "2 hr 20 min",
  "Customer": "Teguh Warsini",
  "Doctor": "Dr. Panji Gumilang",
  "Assistant": "Dr. Gayus Tabunan",
  "RecommendedBy": "Hendry Wijaya",
  "Incentive": 30000,
  "Package": "Cutting Package",
  "Type": "Hair Cutting with Style",
  "State": "Waiting",
  "DoctorNote": "Keep the hair dry",
  "AssistantNote": "Do not use too much shampoo"
}

Get Prepaid Package List

Request

Get Prepaid Package List

You must have "VIEW" role in "Prepaid Packages" Module

Security
OAuth2_clientCredentials
Query
Outletstring

Prepaid package outlet

Example: Outlet=Outlet1
Customerstring

Customer's name

Example: Customer=Achmad Taftazani
Fromstring

Prepaid package date started

Example: From=2023-12-05
Tostring

End of prepaid package date (for filter)

Example: To=2024-12-31
curl -i -X POST \
  'https://subdomain.dealpos.net/api/v3/PrepaidPackage/List?Outlet=Outlet1&Customer=Achmad+Taftazani&From=2023-12-05&To=2024-12-31' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
Outletstring
Packagestring
Customerstring
Pointstring
Startstring
Activatedstring
Expiredstring
Pricestring
Invoicestring
SalesnTaxstring
Response
application/json
{
  "Outlet": "Outlet1",
  "Package": "GYM",
  "Customer": "Achmad Taftazani",
  "Point": "118",
  "Start": "120",
  "Activated": "2023-12-05",
  "Expired": "2024-12-31",
  "Price": "100000",
  "Invoice": "23.11.00021",
  "SalesnTax": "12000000"
}

Promotion Coupon

Operations related to promotion coupon, including create, get, etc

Operations

Promotion Event

Operations related to promotion event, including create, get, etc

Operations

Pricebook

Operations related to promotion event, including create, get, etc

Operations

Outlet

Operations related to outlet, including create, get, etc

Operations

User

Operations related to user, including create, get, etc

Operations

Outlet Price

Operations related to outlet price, including create, get, etc

Operations

Loyalty Point

Operations related to loyalty point, including create, get, etc

Operations

Notification

Operations related to notification, including create, get, etc

Operations

Payment Method

Operations related to payment method, including create, get, etc

Operations

Invoice Write Off Option

Operations related to invoice write off option, including create, get, etc

Operations

Tax

Operations related to tax, including create, get, etc

Operations

Expense

Operations related to get expense

Operations

Logistics Service

Operations related to logistics service, including create, get, etc

Operations

Park Order Display

Operations related to parked order display, including create, get, etc

Operations

Midtrans Payment Gateway

Operations related to Midtrans Payment Gateway, including create, get, etc

Operations

Apps

Operations related to Apps, including create, get, etc

Operations

Client Secret

Operations related to client secret, including create, get, etc

Operations

Rate Limit

Operations related to rate limit, including create, get, etc

Operations

Deprecated

Operations