Customer

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

List Customers

Request

Also available as HTTP POST (endpoint: /api/v3/Customer/p)


Get List of customers

Required Group Role: "Contacts" - "VIEW"

Bodyapplication/json
Namestring

Name of the Customer

Outletstring

Name of the Outlet

PageNumberintegerrequired

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

PageSizeintegerrequired

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

Fromstring

Contact Join from

Tostring

Contact Join to

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Customer \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Name": "Ferdiansyah Rahman",
    "Outlet": "Outlet1",
    "PageNumber": 1,
    "PageSize": 20,
    "From": "2021-01-01",
    "To": "2021-01-28"
  }'

Responses

Bodyapplication/jsonArray [
Namestring

the name of customer has been showed

Codestring

the customer code of the customer to be showed

Mobilestring

the mobile phone number of customer to be showed

Emailstring

the email of the customer to be showed

BirthDatestring

Birthdate Customer

JoinDatestring

Customer's Join Date

IDstring

Unique ID of the customer

]
Response
application/json
[
  {
    "Name": "A WI",
    "Code": "TIA20887",
    "Mobile": "089621973221",
    "Email": "secyliac@gmail.com",
    "BirthDate": "1995-03-01T00:00:00",
    "JoinDate": "2021-01-31T00:00:00",
    "ID": "298bb6ce-d337-43ab-9c9f-5b289f0f5c95"
  },
  {
    "Name": "a. asyura alikha",
    "Code": "TIA9981",
    "Mobile": "0896219732212",
    "Email": "asyuraalikha@gmail.com",
    "BirthDate": "1994-12-17T00:00:00",
    "JoinDate": "2021-02-28T00:00:00",
    "ID": "4d055ee5-6c92-4862-8c8d-d62cef19dce5"
  },
  {
    "Name": "A. Dalaisa A. Beso",
    "Code": "TIA21264",
    "Mobile": "089621973223",
    "Email": "ndisabeni@yahoo.com",
    "BirthDate": "1996-06-22T00:00:00",
    "JoinDate": "2021-03-25T00:00:00",
    "ID": "620bf557-14ff-48ff-aeea-2ab769435830"
  }
]

Update a Customer by Email

Request

Update a Customer based on email

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

Bodyapplication/json
Emailstringrequired

Email address of customer. This is primary key for the object.

Namestringrequired

Name of customer.

FirstNamestring

First name of customer

LastNamestring

Last name of customer

Birthdatestring

Birthdate of customer

Phonestring

Phone number of customer

Mobilestringrequired

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

Addressstring

Customer Address

Genderboolean

Gender of customer

Enumfalsetrue
Codestringrequired

Code number of customer

Groupstring

Group of customer

ExpiredGroupstring

Customer Group Expired Date

LoyaltyPointinteger

Loyalty point of customer

ImageURLstring

Customer's photo URL

Statusstringrequired

Customer Activation Status

Default "Active / WaitingForApproval / Suspended"
ReferralCodestring

Existing Customer code that refers the new customer

SignUpOutletstring

Outlet Name when customer create new transaction from

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Customer \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Email": "thomy@dealpos.com",
    "Name": "Thomy Kurniawan",
    "FirstName": "Thomy",
    "LastName": "Kurniawan",
    "Birthdate": "1989-04-20",
    "Phone": "085710977713",
    "Mobile": "085710977713",
    "Address": "Jl. Muara Karang P3T No.30",
    "Gender": false,
    "Code": "Tk1010",
    "Group": "Gold",
    "ExpiredGroup": "2018-12-31",
    "LoyaltyPoint": 88,
    "Status": "Active"
  }'

Responses

Bodyapplication/json
IDstring
Messagestring
Response
application/json
{
  "ID": "c27bfb13-4936-43e5-bd7d-410dc8d041c2",
  "Message": "Record updated"
}

Create a Customer

Request

Create a customer based on the name

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

Bodyapplication/json
Emailstringrequired

Email address of customer. This is primary key for the object.

Namestringrequired

Name of customer.

FirstNamestring

First name of customer

LastNamestring

Last name of customer

Birthdatestring

Birthdate of customer

Phonestring

Phone number of customer

Mobilestringrequired

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

Addressstring

Customer Address

Genderboolean

Gender of customer

Enumfalsetrue
Codestringrequired

Code number of customer

Groupstring

Group of customer

ExpiredGroupstring

Customer Group Expired Date

LoyaltyPointinteger

Loyalty point of customer

ImageURLstring

Customer's photo URL

Statusstringrequired

Customer Activation Status

Default "Active / WaitingForApproval / Suspended"
ReferralCodestring

Existing Customer code that refers the new customer

SignUpOutletstring

Outlet Name when customer create new transaction from

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Customer \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Email": "Hendry@dealpos.com",
    "Name": "Hendry",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Birthdate": "1994-03-21",
    "Phone": "0215865894",
    "Mobile": "08569314515",
    "Address": "Jl. Muara Karang P3T No.30",
    "Gender": false,
    "Status": "Active",
    "Code": "HW001",
    "Group": "Gold",
    "ExpiredGroup": "2019-12-31",
    "LoyaltyPoint": 88,
    "ImageURL": "https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcR5MITQo_ngwwEGEZqlw7PQLiaO21AoYmLRSkSF5Q2UwJuPgYZx",
    "SignUpOutlet": "Outlet1"
  }'

Responses

Bodyapplication/json
IDstring

the ID of customer was created

Response
application/json
{
  "ID": "2ce78ff3-a07d-4205-ba93-1a9d22172985"
}

Delete a Customer by Email

Request

Delete a customer based on email

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

Bodyapplication/json
Emailstringrequired

The customer email address to be deleted.

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

Responses

Bodyapplication/json
string

the customer has been deleted

Response
application/json
"Customer has been deleted successfully."

Get Customer by ID

Request

Get Customer info by ID

Required Group Role: "Contacts" - "VIEW"

Path
idstringrequired

ID of customer

Example: 5acffe34-346f-4888-afd8-0a551e556681