# Customer

Operations related to customer data, including create, get, etc

## List Customers

 - [GET /Customer](https://developer.dealpos.com/openapi/openapi/customer/listcustomers.md): >Also available as HTTP POST (endpoint: /api/v3/Customer/p)


Get List of customers

Required Group Role: "Contacts" - "VIEW"

## Update a Customer by Email

 - [PUT /Customer](https://developer.dealpos.com/openapi/openapi/customer/updatecustomerbyemail.md): Update a Customer based on email

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

## Create a Customer

 - [POST /Customer](https://developer.dealpos.com/openapi/openapi/customer/createcustomer.md): Create a customer based on the name

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

## Delete a Customer by Email

 - [DELETE /Customer](https://developer.dealpos.com/openapi/openapi/customer/deletecustomerbyemail.md): Delete a customer based on email

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

## Update AppLastSignIn Customer by ID

 - [PUT /Customer/AppSignIn](https://developer.dealpos.com/openapi/openapi/customer/updateapplastsignincustomerbyid.md): Update Customer info by ID

## Get Customer By

 - [GET /Customer/Detail](https://developer.dealpos.com/openapi/openapi/customer/getcustomerdetail.md): Get customer detail based on customer  ID / Code / Email / MobilePhone

Required Group Role: "Contacts" - "VIEW"

## Update Customer By Code

 - [PUT /Customer/ByCode](https://developer.dealpos.com/openapi/openapi/customer/updatecustomerbycode.md): Update a customer based on customer code

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

## Update Customer By ID

 - [PUT /Customer/ByID](https://developer.dealpos.com/openapi/openapi/customer/updatecustomerbyid.md): Update a customer based on customer ID

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

## Get Customer By List ID

 - [GET /Customer/ListID](https://developer.dealpos.com/openapi/openapi/customer/getcustomerbylistid.md): >Get customer based on customer List ID

Required Group Role: "Contacts" - "VIEW"

## Update Customer By MobilePhone

 - [PUT /Customer/ByMobilePhone](https://developer.dealpos.com/openapi/openapi/customer/updatecustomerbymobilephone.md): Update a customer based on customer' mobile phone

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

## Verify Customer's Mobile

 - [PUT /Customer/VerifyMobile](https://developer.dealpos.com/openapi/openapi/customer/verifycustomermobile.md): Use to verify customer's mobile phone

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

## Verify Customer's Email

 - [PUT /Customer/VerifyEmail](https://developer.dealpos.com/openapi/openapi/customer/verifycustomeremail.md): Use to verify customer's email

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

## Delete Customer By Code

 - [DELETE /Customer/DeleteByCode](https://developer.dealpos.com/openapi/openapi/customer/deletecustomerbycode.md): Delete a customer based on customer code

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

## List Customer With Total Count

 - [GET /Customer/WithTotalCount](https://developer.dealpos.com/openapi/openapi/customer/listcustomerwithtotalcount.md): >Also available as HTTP POST with the same endpoint


List Customer With Total Count

Required Group Role: "Contacts" - "VIEW"

## Suspend a Customer

 - [PUT /Customer/Suspend](https://developer.dealpos.com/openapi/openapi/customer/suspendcustomer.md): 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

## Unsuspend a Customer

 - [PUT /Customer/Unsuspend](https://developer.dealpos.com/openapi/openapi/customer/unsuspendcustomer.md): 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

## Get New Customer Code

 - [GET /Customer/NewCode](https://developer.dealpos.com/openapi/openapi/customer/getnewcustomercode.md): 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.

## Merge Customer

 - [PUT /Customer/Merge](https://developer.dealpos.com/openapi/openapi/customer/put-customer-merge.md): This API use for merge several customer to be one customer

## Check Customer PIN Authenticate

 - [POST /Customer/PIN/Authenticate](https://developer.dealpos.com/openapi/openapi/customer/check-customer-pin-authenticate.md): Check Customer PIN Authenticate for redemption point

## Set Customer PIN

 - [PUT /Customer/PIN](https://developer.dealpos.com/openapi/openapi/customer/put-customer-pin.md): Set Customer PIN for redemption point