Skip to content

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

List Supplier

Request

Security
OAuth2_clientCredentials
Bodyapplication/json
PageNumberintegerrequired

Number of page begin. this is primary key for the object

Example: 1
PageSizeintegerrequired

Page size of list supplier. this is primary key for the object

Example: 20
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Supplier \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "PageNumber": 1,
    "PageSize": 20
  }'

Responses

Bodyapplication/jsonArray [
Namestring

the name of supplier to be shown

Codestring

the supplier code of the supplier to be shown

Phonestring

the phone number of supplier to be shown

Mobilestring

the mobile phone number of supplier to be shown

Emailstring

the email of the supplier to be shown

]
Response
application/json
[
  {
    "Name": "A WI",
    "Code": "TIA20887",
    "Phone": "0811698616",
    "Mobile": "0811698616",
    "Email": "secyliac@gmail.com"
  },
  {
    "Name": "a. asyura alikha",
    "Code": "TIA9981",
    "Phone": "082188891313",
    "Mobile": "082188891313",
    "Email": "asyuraalikha@gmail.com"
  },
  {
    "Name": "A. Dalaisa A. Beso",
    "Code": "TIA21264",
    "Phone": "087884993345",
    "Mobile": "087884993345",
    "Email": "ndisabeni@yahoo.com"
  }
]

Create Supplier

Request

Create a supplier based on the name

You must have “CREATE” role in “Contacts” Module

Security
OAuth2_clientCredentials
Bodyapplication/json
Emailstringrequired

Email address of Supplier

Namestringrequired

Name of supplier. This is primary key for the object

FirstNamestring

First name of supplier

LastNamestring

Last name of supplier

Phonestring

Phone number of supplier

Mobilestringrequired

Mobile number of supplier

Addressstring

Address of Supplier

Genderstring

Gender of supplier

Enum"Male""Female"
Codestringrequired

Code member of supplier

Groupstring

Group of supplier

ImageURLstring

Supplier's photo URL

Statusstringrequired
Default "Active / WaitingForApproval / Suspended"
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Supplier \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Email": "hendry@outlook.com",
    "Name": "Hendry Wijaya",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Phone": "0216892235",
    "Mobile": "0815896321227",
    "Address": "Jl.Pluit Karang Jelita no 51",
    "Gender": "Male",
    "Status": "Active",
    "Code": "HW0021",
    "Group": "Gold",
    "ImageURL": "https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcR5MITQo_ngwwEGEZqlw7PQLiaO21AoYmLRSkSF5Q2UwJuPgYZx"
  }'

Responses

Bodyapplication/json
IDstring

ID of supplier created

Response
application/json
{
  "ID": "8e92164f-4826-4984-8d1d-7a7280851170"
}

Update Supplier By Code

Request

Update a supplier based on customer code

You must have "EDIT" role in "Contacts" Module OR "EDIT" role in "Global" Module

Security
OAuth2_clientCredentials
Bodyapplication/json
Emailstringrequired

Email address of Supplier

Namestringrequired

Name of supplier. This is primary key for the object

FirstNamestring

First name of supplier

LastNamestring

Last name of supplier

Phonestring

Phone number of supplier

Mobilestringrequired

Mobile number of supplier

Addressstring

Address of Supplier

Genderstring

Gender of supplier

Enum"Male""Female"
Codestringrequired

Code member of supplier

Groupstring

Group of supplier

ImageURLstring

Supplier's photo URL

Statusstringrequired
Default "Active / WaitingForApproval / Suspended"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Supplier/ByCode \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Code": "0011",
    "Name": "Hendry Wijaya",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Email": "hendryw@gmail.com",
    "Phone": "0216892235",
    "Mobile": "081589632178",
    "Address": "Jl.Pluit Karang Jelita no 51",
    "Gender": "Male",
    "Group": "Gold",
    "Status": "Active"
  }'

Responses

Bodyapplication/json
IDstring

Supplier has been deleted successfully

Response
application/json
{
  "ID": "4b237266-a20d-4979-87e9-685b8fd41658"
}

Delete Supplier By Code

Request

Delete a supplier based on customer code

You must have "DELETE" role in "Contacts" Module

Security
OAuth2_clientCredentials
Bodyapplication/json
Codestringrequired

Supplier code of the customer. this is primary key for the object

curl -i -X DELETE \
  https://subdomain.dealpos.net/api/v3/Supplier/DeleteByCode \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Code": "000015"
  }'

Responses

Bodyapplication/json
Messagestring

the supplier has been deleted

Response
application/json
{
  "Message": "Customer ID: 4b237266-a20d-4979-87e9-685b8fd41658 has been deleted successfully."
}

Get Supplier By Code

Request

Get supplier based on supplier code

Required Group Role: "Contacts" - "VIEW"

Security
OAuth2_clientCredentials
Query
Codestringrequired

Supplier Code of supplier. this is primary key of the object

Example: Code=AR012345
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Supplier/Code?Code=AR012345' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
Namestring

Supplier's name

Emailstring

Supplier's email

Titlestring or null

Supplier's title

FirstNamestring

Supplier's first name

LastNamestring

Supplier's last name

Genderstring

Supplier's gender

Codestring

Supplier's code

Phonestring

Supplier's phone

MobilePhonestring

Supplier's mobile phone

Addressstring

Supplier's address

ImageURLstring

Supplier's imageURL

Statusstring

Supplier's status

Response
application/json
{
  "Name": "Hendry",
  "Email": "hendry@outlook.comm",
  "Title": "Mr",
  "FirstName": "Hendry",
  "LastName": "Wijaya",
  "Gender": "Male",
  "Code": "AR012345",
  "Phone": "0216892235",
  "MobilePhone": "081574945443111",
  "Address": "Jl.Pluit Karang Jelita no 51",
  "ImageURL": "//res.cloudinary.com/dealposdev/image/upload/Contact/7d8bb3dc-cbd1-4b56-98a7-ff3557347817/images",
  "Status": "Active"
}

List Supplier With Total Count

Request

Also available as HTTP POST with the same endpoint


List Supplier With Total Count

Required Group Role: "Orders" - "VIEW"

Security
OAuth2_clientCredentials
Bodyapplication/json
PageNumberintegerrequired

The number of page data to be displayed

Example: 1
PageSizeintegerrequired

The number of rows returned by the API

Example: 20
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Supplier/WithTotalCount \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "PageNumber": 1,
    "PageSize": 20
  }'

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

the total result

Response
application/json
{
  "Data": [
    { … },
    { … },
    { … }
  ],
  "TotalCount": 100
}

Get Supplier By List ID

Request

Get supplier based on supploer List ID

Required Group Role: "Contacts" - "VIEW"

Security
OAuth2_clientCredentials
Query
ListIDArray of strings(guid)required

List of SupplierID

Example: ListID=227427f5-fb25-4f47-9e39-2370fa70d156,212347f5-gt52-4127-8148-7780fabcd123
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Supplier/ListID?ListID=227427f5-fb25-4f47-9e39-2370fa70d156%2C212347f5-gt52-4127-8148-7780fabcd123' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
IDstring

ID of Supplier

Namestring

Name of Supplier

Emailstring

Email Address of Supplier

Codestring

Code of Supplier

MobilePhonestring

Mobile number of Supplier

Statusstring

Status Supplier

Default "Active / WaitingForApproval / Suspended"
]
Response
application/json
[
  {
    "ID": "5acffe34-346f-4888-afd8-0a551e556681",
    "Name": "Tafta tata",
    "Email": "Tafta@dealpos.com",
    "Code": "DP036",
    "MobilePhone": "081588818888",
    "Status": "Active"
  },
  {
    "ID": "c9b9e5d6-78ce-413d-a02b-1de97e7cd125",
    "Name": "Hendry",
    "Email": "Hendry@dealpos.com",
    "Code": "DP008",
    "MobilePhone": "08158881823423",
    "Status": "Active"
  }
]

Merge Supplier

Request

This API use for merge several Supplie to be one customer

Security
OAuth2_clientCredentials
Bodyapplication/json
mergeTargetstringrequired

Supplier ID that want to merged

deletedArray of stringsrequired

Supplier ID that will be deleted after merged complete

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Supplier/Merge \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "mergeTarget": "f930a0ba-21da-47fd-99a4-5dcc98fb10c8",
    "deleted": [
      "7156869b-6c3d-4761-8118-77efafca87cc",
      "7156869b-6c3d-4761-8118-77efafca87cb"
    ]
  }'

Responses

OK

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Merge Completed"
}

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

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