Skip to content
/
Get User By List

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

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

Create User

Request

Create a new user with the specified details. Required Group Role: "Users" - "Create"

Security
OAuth2_clientCredentials
Bodyapplication/jsonrequired
LoginIDstringrequired
Example: "tafta"
Emailstringrequired
Example: "tafta@dealpos.com"
Passwordstringrequired
Example: "4321"
GroupArray of stringsrequired
Example: ["Group1","Group2"]
ListOutletsArray of objectsrequired
Example: [{"Outlet":"Outlet1","Access":"Read"},{"Outlet":"Outlet2","Access":"Write"}]
ListOutlets[].​Outletstringrequired
Example: "Outlet1"
ListOutlets[].​Accessstringrequired
Enum"NoAccess""Peek""Read""Write"
Example: "Read"
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/User \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "LoginID": "tafta",
    "Email": "tafta@dealpos.com",
    "Password": "4321",
    "Group": [
      "Group1",
      "Group2"
    ],
    "ListOutlets": [
      {
        "Outlet": "Outlet1",
        "Access": "Read"
      },
      {
        "Outlet": "Outlet2",
        "Access": "Write"
      }
    ]
  }'

Responses

Bodyapplication/json
Messagestring

Message success created

Response
application/json
{
  "Message": "User Tafta created successfully"
}

Create Group

Request

Create a new group with the specified details. Required Group Role: "Users" - "Group"

Security
OAuth2_clientCredentials
Bodyapplication/jsonrequired
Groupstringrequired
Example: "Cashier"
RoleArray of stringsrequired
Example: ["Sell","SellE","SellD"]
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Group \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Group": "Cashier",
    "Role": [
      "Sell",
      "SellE",
      "SellD"
    ]
  }'

Responses

Bodyapplication/json
Messagestring

Message success created

Response
application/json
{
  "Message": "Group Cashier created successfully"
}

Get User By List ID

Request

Get User Name By List ID

Required Group Role: "Users" - "VIEW"

Security
OAuth2_clientCredentials
Query
ListIDstring(guid)required

ListID of user

Example: ListID=227427f5-fb25-4f47-9e39-2370fa70d156,227427f5-fb25-4f47-9e39-2370fa70d156
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/User/ID?ListID=227427f5-fb25-4f47-9e39-2370fa70d156%2C227427f5-fb25-4f47-9e39-2370fa70d156' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
IDstring(guid)

User ID

Namestring

User's name

]
Response
application/json
[
  {
    "ID": "550e8400-e29b-41d4-a716-446655440000",
    "Name": "Admin"
  },
  {
    "ID": "7b27bbfe-71c4-4f3d-9957-fd1cd57c5f1c",
    "Name": "Cashier"
  }
]

Get User By List

Request

Get User Name List By status and role

Required Group Role: "Users" - "VIEW"

Security
OAuth2_clientCredentials
Query
Statusstringrequired

Status of user

Default "Unsuspend"
Value"All/Suspend/Unsuspend"
Example: Status=Unsuspend
Rolestring

Role of user

Example: Role=Books
Namestring

Name of user / LoginID

Example: Name=Ahmad
PageNumberinteger

Page number for pagination

Default 1
Example: PageNumber=1
PageSizeinteger

Number of items per page

Default 20
Example: PageSize=20
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/User/List?Status=Unsuspend&Role=Books&Name=Ahmad&PageNumber=1&PageSize=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
LoginIDstring

User's login name to use when login

IDstring(guid)

User ID

Namestring

User's name

Emailstring

User's email

Typeinteger

User's type (0 for Normal user, 1 for Root user, 2 for System User)

]
Response
application/json
[
  {
    "LoginID": "Admin",
    "ID": "550e8400-e29b-41d4-a716-446655440000",
    "Name": "Ahmad",
    "Email": "admin@example.com",
    "Type": 1
  },
  {
    "LoginID": "Cashier",
    "ID": "7b27bbfe-71c4-4f3d-9957-fd1cd57c5f1c",
    "Name": "Nurul",
    "Email": "cashier@example.com",
    "Type": 1
  }
]

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

Barcode

Operations related to barcode, 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