Customer
/
Unsuspend a 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
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Customer/id/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

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"
}

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

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

Status Customer

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"
}

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

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

Status Customer

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"
}

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 Customer By Code

Request

Update a customer based on customer code

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

Bodyapplication/json
Codestringrequired

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

Namestring

the name of customer

FirstNamestring

first name of the customer

LastNamestring

last name of the customer

Birthdatestring

birthdate of the customer

Emailstring

email of the customer

Phonestring

phone number of the customer

Mobilestring

mobile phone of the customer

Addressstring

address of the customer

Genderstring

gender of the customer

Groupstring

group of the customer

ExpiredGroupstring

expiry date of the customer group

LoyaltyPointinteger

loyalty point of the customer

ImageURLstring

picture of the customer

Statusstring

Status Customer

Enum"Active""WaitingForApproval""Suspended"
ReferredByIDstring(guid)

the ID of the customer who refer this customer

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Customer/ByCode \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Code": "0011",
    "Name": "Hendry Wijaya",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Birthdate": "1994-03-21",
    "Email": "hendryw@gmail.com",
    "Phone": "0216892235",
    "Mobile": "081589632178",
    "Address": "Jl.Pluit Karang Jelita no 51",
    "Gender": "Male",
    "Group": "Gold",
    "ExpiredGroup": "2020-12-12",
    "LoyaltyPoint": 80,
    "Status": "Active",
    "ReferredByID": "c27bfb13-4936-43e5-bd7d-410dc8d041c2"
  }'

Responses

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

Update Customer By ID

Request

Update a customer based on customer ID

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

Bodyapplication/json
IDstring

Customer ID

Namestring

the name of customer

Codestring

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

FirstNamestring

first name of the customer

LastNamestring

last name of the customer

Birthdatestring

birthdate of the customer

Emailstring

email of the customer

Phonestring

phone number of the customer

Mobilestring

mobile phone of the customer

Addressstring

address of the customer

Genderstring

gender of the customer

Groupstring

group of the customer

ExpiredGroupstring

expiry date of the customer group

LoyaltyPointinteger

loyalty point of the customer

ImageURLstring

picture of the customer

Statusstring

Status Customer

Enum"Active""WaitingForApproval""Suspended"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Customer/ByID \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ID": "c27bfb13-4936-43e5-bd7d-410dc8d041c2",
    "Name": "Hendry Wijaya",
    "Code": "0011",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Birthdate": "1994-03-21",
    "Email": "hendryw@gmail.com",
    "Phone": "0216892235",
    "Mobile": "081589632178",
    "Address": "Jl.Pluit Karang Jelita no 51",
    "Gender": "Male",
    "Group": "Gold",
    "ExpiredGroup": "2020-12-12",
    "LoyaltyPoint": 80,
    "Status": "Active"
  }'

Responses

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

Update Customer By MobilePhone

Request

Update a customer based on customer' mobile phone

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

Bodyapplication/json
Mobilestringrequired

mobile phone of the customer

Namestring

the name of customer

FirstNamestring

first name of the customer

LastNamestring

last name of the customer

Birthdatestring

birthdate of the customer

Codestring

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

Emailstring

email of the customer

Phonestring

phone number of the customer

Addressstring

address of the customer

Genderstring

gender of the customer

Groupstring

group of the customer

ExpiredGroupstring

expiry date of the customer group

LoyaltyPointinteger

loyalty point of the customer

ImageURLstring

picture of the customer

Statusstring

Status Customer.

Enum"Active""WaitingForApproval""Suspended"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Customer/ByMobilePhone \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Code": "0011",
    "Name": "Hendry Wijaya",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Birthdate": "1994-03-21",
    "Email": "hendryw@gmail.com",
    "Phone": "0216892235",
    "Mobile": "081589632178",
    "Address": "Jl.Pluit Karang Jelita no 51",
    "Gender": "Male",
    "Group": "Gold",
    "ExpiredGroup": "2020-12-12",
    "LoyaltyPoint": 80,
    "Status": "Active"
  }'

Responses

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

Verify Customer's Mobile

Request

Use to verify customer's mobile phone

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

Bodyapplication/json
Mobilestringrequired

MobilePhone of the customer

Example: "081574945443"
MobileVerifiedbooleanrequired

true means customer's mobile phone is valid, false means customer's mobile phone is invalid

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Customer/VerifyMobile \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Mobile": "081574945443",
    "MobileVerified": false
  }'

Responses

Bodyapplication/json
Messagestring
Example: "Update Mobile Verified is success"
Response
application/json
{
  "Message": "Update Mobile Verified is success"
}

Verify Customer's Email

Request

Use to verify customer's email

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

Bodyapplication/json
Emailstringrequired

Email of the customer

Example: "raizaldi.achmad@gmail.com"
EmailVerifiedbooleanrequired

true means customer's email is valid, false means customer's email is invalid

Example: true
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Customer/VerifyEmail \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Email": "raizaldi.achmad@gmail.com",
    "EmailVerified": true
  }'

Responses

Bodyapplication/json
Messagestring
Example: "Update Email Verified is success"
Response
application/json
{
  "Message": "Update Email Verified is success"
}

Delete Customer By Code

Request

Delete a customer based on customer code

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

Bodyapplication/json
Codestringrequired

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

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

Responses

Bodyapplication/json
Messagestring

Customer has been deleted successfully.

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

List Customer With Total Count

Request

Also available as HTTP POST with the same endpoint


List Customer With Total Count

Required Group Role: "Contacts" - "VIEW"

Bodyapplication/json
PageNumberintegerrequired

The Number of page data to be displayed

PageSizeintegerrequired

The number of rows returned by the API

Fromstring

Selected start of a date prefix range

Tostring

Selected end of a date prefix range

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

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total count of the result

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

Suspend a Customer

Request

Suspend a Customer by their ID, Code, Email, & Phone. You can choose ONE of those options because those options have this hierarchy tier:

  1. ID
  2. Code
  3. Email
  4. Phone

If ID is not found, we will search for the Code, and so on base on those hierarchy

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

Bodyapplication/json
IDstring
Example: "c27bfb13-4936-43e5-bd7d-410dc8d041c2"
Codestring
Example: "HWCISAP"
Emailstring
Example: "hendryw@gmail.com"
Phonestring
Example: "0216892235"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Customer/Suspend \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ID": "c27bfb13-4936-43e5-bd7d-410dc8d041c2",
    "Code": "HWCISAP",
    "Email": "hendryw@gmail.com",
    "Phone": "0216892235"
  }'

Responses

OK

Body
Response
{
  "Message": "The contact has been successfully suspended."
}

Unsuspend a Customer

Request

Unsuspend a Customer by their ID, Code, Email, & Phone. You can choose ONE of those options because those options have this hierarchy tier:

  1. ID
  2. Code
  3. Email
  4. Phone

If ID is not found, we will search for the Code, and so on base on those hierarchy

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

Bodyapplication/json
IDstring
Example: "c27bfb13-4936-43e5-bd7d-410dc8d041c2"
Codestring
Example: "HWCISAP"
Emailstring
Example: "hendryw@gmail.com"
Phonestring
Example: "0216892235"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Customer/Unsuspend \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ID": "c27bfb13-4936-43e5-bd7d-410dc8d041c2",
    "Code": "HWCISAP",
    "Email": "hendryw@gmail.com",
    "Phone": "0216892235"
  }'

Responses

OK

Body
Response
{
  "Message": "The contact has been successfully unsuspended."
}

Get New Customer Code

Request

This API is only working if you use Customer Code Generator (auto increment customer code Learn more Here).

With this API, you can get the Next Customer code that the generator could assign. For example, the last customer code existed is MM-003, the API will return "MM-004" as the response.

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Customer/NewCode \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
Messagestring
Example: "The contact has been successfully suspended."
Response
application/json
{
  "Message": "The contact has been successfully suspended."
}

Merge Customer

Request

This API use for merge several customer to be one customer

Bodyapplication/json
mergeTargetstringrequired

Customer ID that want to merged

Example: "f930a0ba-21da-47fd-99a4-5dcc98fb10c8"
deletedArray of stringsrequired

Customer ID that will be deleted after merged complete

Example: ["7156869b-6c3d-4761-8118-77efafca87cc","7156869b-6c3d-4761-8118-77efafca87cb"]
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Customer/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

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

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"
}

Set Customer PIN

Request

Set Customer PIN for redemption point

Bodyapplication/json
IDstringrequired

Customer ID

Example: "2b4c7d76-6ac7-49a3-a1f2-6022439d7958"
PINstringrequired

PIN use for redemption point. (Max-length= 6 digits and only number)

Example: "123456"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Customer/PIN \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ID": "2b4c7d76-6ac7-49a3-a1f2-6022439d7958",
    "PIN": "123456"
  }'

Responses

OK

Bodyapplication/json
Messagestring
Example: "PIN for Customer 2b4c7d76-6ac7-49a3-a1f2-6022439d7958 already"
Response
application/json
{
  "Message": "PIN for Customer 2b4c7d76-6ac7-49a3-a1f2-6022439d7958 already set"
}

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

Outlet

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

Logistics Service

Operations related to logistics service, 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 API

Operations