Deprecated

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
License
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

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

Get Customer By Email

Request

Also available as HTTP POST with the same endpoint


Get a customer based on customer email

Required Group Role: "Contacts" - "VIEW"

Bodyapplication/json
Emailstringrequired

Email address of customer. the primary key for the object

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Customer/Email \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Email": "tafta@dealpos.com"
  }'

Responses

Bodyapplication/json
IDstringrequired

ID of customer

Namestringrequired

Name of customer

Emailstringrequired

Email Address of customer

Titlestring

Title Name of customer

FirstNamestring

First name of customer

LastNamestring

Last name of customer

Genderstring

Gender of customer

Codestringrequired

Code of customer

Phonestring

Phone number of customer

MobilePhonestringrequired

Mobile number of customer. this is primary key for the object

Faxstring

Fax number of customer

Addressstring

Address of customer

Citystring

City of customer

Nationalitystring

Nationality of customer

ReferredBystring

Customer ID who referred this customer

Identificationstring

identification number of customer

Birthdaystring

Birthday of customer

JoinDatestring

Join date of customer

Groupstring

Group of customer

ExpiredGroupstring

Expired group of customer

SignUpOutletstring

Sign up oulet when created the new customer

ImageURLstring

Image url of customer

LoyaltyPointinteger

Loyalty point of customer

Statusstringrequired

Customer Activation Status

AppLastSignInstring(date-time)

Last sign in from Brand Loyalty app (Null if never sign in)

Response
application/json
{
  "Name": "Tafta tata",
  "Email": "Tafta@dealpos.com",
  "FirstName": "Tafta",
  "LastName": "tata",
  "Gender": true,
  "Code": "HW008",
  "Phone": "021-66698155",
  "Mobile": "081588818888",
  "Address": "Jl. Lenteng Agung",
  "ReferredBy": "449e35af-190d-4137-aa13-9cf2cf6af57a",
  "Group": "Gold",
  "ExpiredGroup": "31 Jul 2019",
  "SignUpOutlet": "Outlet1",
  "ImageURL": "//res.cloudinary.com/dealposdev/image/upload//Contact/ff63d5ad-b42b-4a84-a77f-eb40f0bd6dd8/0.jpg",
  "LoyaltyPoint": 88,
  "Status": "Active"
}

Get Variant ID By List Code

Request

Given a list of ProductSKU, the system will then return Internal ProductID+VariantID

Bodyapplication/jsonArray [
string
]
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Variant/GetIDByListCode \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    "1000",
    "1001",
    "1002"
  ]'

Responses

Bodyapplication/jsonArray [
IDstring

Variant ID

ProductIDstring

Product ID

Codestring

Variant Code

]
Response
application/json
[
  {
    "ID": "e156a0a9-1552-49d4-b597-d4ca09c3ed54",
    "ProductID": "418c0cde-1e5f-4c77-a9f4-312bc96939cb",
    "Code": "1000"
  },
  {
    "ID": "d2dfbf1a-da61-48e4-9d4d-a921ebfcb8f5",
    "ProductID": "6126764d-57aa-425d-ade6-bc3a847da98a",
    "Code": "1001"
  },
  {
    "ID": "1587b105-b8a9-404f-907a-f63326003558",
    "ProductID": "7d27dc9f-06f7-4765-bfd3-437903b020fa",
    "Code": "1002"
  }
]

Get Variant ID By List Code Discontinued

Request

Given a list of ProductSKU, the system will then return Internal ProductID+VariantID filter by Discontinued State

Bodyapplication/json
ListCodeArray of stringsrequired

Variant Code

Discontinuedstring

Discontinued status of variant

Default "No"
Example: "All / Yes / No"
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Variant/GetIDByListCodeDiscontinued \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ListCode": [
      "1342L",
      "1342M"
    ],
    "Discontinued": "All"
  }'

Responses

Successful operation

Bodyapplication/jsonArray [
IDstring

Variant ID

ProductIDstring

Product ID

Codestring

Variant Code

Discontinuedboolean

Discontinue Status

]
Response
application/json
[
  {
    "ID": "e156a0a9-1552-49d4-b597-d4ca09c3ed54",
    "ProductID": "418c0cde-1e5f-4c77-a9f4-312bc96939cb",
    "Code": "1342L",
    "Discontinued": false
  },
  {
    "ID": "d2dfbf1a-da61-48e4-9d4d-a921ebfcb8f5",
    "ProductID": "6126764d-57aa-425d-ade6-bc3a847da98a",
    "Code": "1342M",
    "Discontinued": true
  }
]

Get Customer By Code

Request

Also available as HTTP POST with the same endpoint


Get customer based on customer code

Required Group Role: "Contacts" - "VIEW"

Bodyapplication/json
Codestringrequired

Member Code of customer. this is primary key of the object

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

Responses

Bodyapplication/json
IDstringrequired

ID of customer

Namestringrequired

Name of customer

Emailstringrequired

Email Address of customer

Titlestring

Title Name of customer

FirstNamestring

First name of customer

LastNamestring

Last name of customer

Genderstring

Gender of customer

Codestringrequired

Code of customer

Phonestring

Phone number of customer

MobilePhonestringrequired

Mobile number of customer. this is primary key for the object

Faxstring

Fax number of customer

Addressstring

Address of customer

Citystring

City of customer

Nationalitystring

Nationality of customer

ReferredBystring

Customer ID who referred this customer

Identificationstring

identification number of customer

Birthdaystring

Birthday of customer

JoinDatestring

Join date of customer

Groupstring

Group of customer

ExpiredGroupstring

Expired group of customer

SignUpOutletstring

Sign up oulet when created the new customer

ImageURLstring

Image url of customer

LoyaltyPointinteger

Loyalty point of customer

Statusstringrequired

Customer Activation Status

AppLastSignInstring(date-time)

Last sign in from Brand Loyalty app (Null if never sign in)

Response
application/json
{
  "ID": "5acffe34-346f-4888-afd8-0a551e556681",
  "Name": "Tafta tata",
  "Email": "Tafta@dealpos.com",
  "Title": "Mr.",
  "FirstName": "Tafta",
  "LastName": "tata",
  "Gender": "Male",
  "Code": "HW008",
  "Phone": "021-66698155",
  "MobilePhone": "081588818888",
  "Fax": "6325894",
  "Address": "Jl. Lenteng Agung",
  "City": "Jakarta",
  "Nationality": "Indonesian",
  "ReferredBy": "449e35af-190d-4137-aa13-9cf2cf6af57a",
  "Identification": "3173656111",
  "Birthday": "18 Mar 1994",
  "JoinDate": "22 Jul 2019",
  "Group": "Gold",
  "ExpiredGroup": "31 Jul 2019",
  "SignUpOutlet": "Outlet1",
  "ImageURL": "//res.cloudinary.com/dealposdev/image/upload//Contact/ff63d5ad-b42b-4a84-a77f-eb40f0bd6dd8/0.jpg",
  "LoyaltyPoint": 88,
  "Status": "Active"
}

Get Customer By MobilePhone

Request

Also available as HTTP POST with the same endpoint


Get a customer based on customer mobile phone number

Required Group Role: "Contacts" - "VIEW"

Bodyapplication/json
MobilePhonestringrequired

Phone / Mobile Phone Number of customer

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Customer/MobilePhone \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "MobilePhone": "081588818888"
  }'

Responses

Bodyapplication/json
IDstring

ID of customer

Namestring

Name of customer

Emailstring

Email Address of customer

Titlestring

Title Name of customer

FirstNamestring

First name of customer

LastNamestring

Last name of customer

Genderstring

Gender of customer

Codestring

Code of customer

Phonestring

Phone number of customer

MobilePhonestring

Mobile number of customer. this is primary key for the object

Faxstring

Fax number of customer

Addressstring

Address of customer

Citystring

City of customer

Nationalitystring

Nationality of customer

ReferredBystring

Customer ID who referred this customer

Identificationstring

identification number of customer

Birthdaystring

Birthday of customer

JoinDatestring

Join date of customer

Groupstring

Group of customer

ExpiredGroupstring

Expired group of customer

SignUpOutletstring

Sign up oulet when created the new customer

ImageURLstring

Image url of customer

LoyaltyPointinteger

Loyalty point of customer

Statusstring

Customer Activation Status

Default "Active / WaitingForApproval / Suspended"
Response
application/json
{
  "ID": "5acffe34-346f-4888-afd8-0a551e556681",
  "Name": "Tafta tata",
  "Email": "Tafta@dealpos.com",
  "Title": "Mr.",
  "FirstName": "Tafta",
  "LastName": "tata",
  "Gender": "Male",
  "Code": "HW008",
  "Phone": "021-66698155",
  "MobilePhone": "081588818888",
  "Fax": "6325894",
  "Address": "Jl. Lenteng Agung",
  "City": "Jakarta",
  "Nationality": "Indonesian",
  "ReferredBy": "449e35af-190d-4137-aa13-9cf2cf6af57a",
  "Identification": "3173656111",
  "Birthday": "18 Mar 1994",
  "JoinDate": "22 Jul 2019",
  "Group": "Gold",
  "ExpiredGroup": "31 Jul 2019",
  "SignUpOutlet": "Outlet1",
  "ImageURL": "//res.cloudinary.com/dealposdev/image/upload//Contact/ff63d5ad-b42b-4a84-a77f-eb40f0bd6dd8/0.jpg",
  "LoyaltyPoint": 88,
  "Status": "Active"
}

Update Sales Order Reference Number

Request

Update the Reference Number of an existing Sales Order.

You must have "Edit" role in "Sell" Module OR "EDIT" role in "Global" Module

Bodyapplication/json
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Invoice Number

Example: "20.06.00001"
ReferenceNumberstringrequired

Number related to this Order ex: logistic tracking_number or purchase_order number (If this property is null or empty, it will not update the Reference Number)

Example: "TKPD-001"
LogisticServiceCodestring

Code of the logistic service (if this property is null or empty, it will not update the Logistic Service Code)

Example: "JNE123"
Notestring

Sales Order Note (if this property is null or empty, it will not update the Note)

Example: "This is a note for Sales Order"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/SalesOrder/ReferenceNumber \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "20.06.00001",
    "ReferenceNumber": "TKPD-001",
    "LogisticServiceCode": "JNE123",
    "Note": "This is a note for Sales Order"
  }'

Responses

Bodyapplication/json
Messagestring
Example: "reference number for sales order 20.06.00001 has been updated"
Response
application/json
{
  "Message": "reference number for sales order 20.06.00001 has been updated"
}

Get Customer PIN

Request

Get Customer PIN for redemption point

Query
IDstringrequired

Customer ID

curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Customer/PIN?ID=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
PINstring
Example: "123654"
Response
application/json
{
  "PIN": "123654"
}