Deprecated API

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

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

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 API

Operations

Delete Promotion Coupon List by Key

Request

Bulk Delete Promotion by Promotion Coupon Key. Please not that we use NEW LINE as the separator.

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

Bodyapplication/jsonArray [
string
]
curl -i -X DELETE \
  https://subdomain.dealpos.net/api/v3/PromotionCoupon/ListKey \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    "string"
  ]'

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "2 Coupon Key has been deleted successfully!"
}

Get Token by Client Secret

Request

Get Oauth 2.0 to access our API using username and API client...

Bodyapplication/json

Get Token from User Name and API Client Secret

client_idstringrequired

Username

client_secretstringrequired

API Client Secret generated from My Profile page

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Token/ClientSecret \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "string",
    "client_secret": "string"
  }'

Responses

Bodyapplication/json
token_typestring
expires_ininteger

Lifetime of the access_token in seconds

expiredAtstring

Date when the access_token expired

access_tokenstring

string issued by the authorization server to access our API

Response
application/json
{
  "token_type": "Bearer",
  "expires_in": 172800,
  "expiredAt": "2021-01-23T10:01:55.7638103",
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiZGVhbHBvcyIsIlVzZXJJRCI6ImZmNzg0OGM5LTIxZjEtNGMwNS1hYzllLTFlNzFkODI5Y2M5YyIsIlNhbGVzSUQiOiIzNzQxNmNiMy1lYjEyLTQ2MTItOTcwZC1hNTcyN2MxNDRlZjkiLCJMaXZlQ2hhdEVuYWJsZWQiOiJUcnVlIiwiVHlwZSI6IlN5c3RlbSIsImRhdGFEYXlzUmFuZ2UiOjAsIlNlc3Npb25JRCI6IjZiNjE1ZjdhLTM2N2QtNDAzNi04NDU0LTQzNTMwOGU4YTg1NyIsIkVtYWlsIjoibG9jYWxob3N0LmRlYWxwb3NAZ21haWwuY29tIiwiRW50aXR5QWNjZXNzSlNPTiI6Ilt7XCJlXCI6XCJhMzk4ZTU1MC0xMTJkLTRhOTgtOGUyZi0wM2RkMjc5Y2FiMGNcIixcImFcIjozfSx7XCJlXCI6XCI4N2I3ZWM0MC0xNjgxLTQ0ZWMtOWIzOS0wZjIxODhkOGQxOTdcIixcImFcIjozfSx7XCJlXCI6XCI5YWQxZDZmYy0yOGFlLTRmZjMtOWY2NC0xNDQyYjc2ZDUxMThcIixcImFcIjozfSx7XCJlXCI6XCIxNWJkNWY1OS00ODlmLTQ5OGQtOWNlMC0xNTdiZWI0MGUzMTFcIixcImFcIjozfSx7XCJlXCI6XCI2Yjc4MGVmZC01ZTlhLTQ5ODQtYmI3Zi0xZTY1ZmM3N2Q3NGRcIixcImFcIjozfSx7XCJlXCI6XCJmMDQ1MTg3NC01NWNmLTQ2YjgtYThiZC0yMGE1ZDFhZTQ0ZGFcIixcImFcIjozfSx7XCJlXCI6XCI4YzM4MGVlMi0zMzY0LTRmNTItYmM4Zi0yYjcwY2M2ZDgxZjVcIixcImFcIjozfSx7XCJlXCI6XCIzYWQxYTc3Yi02NzBkLTQ0MjMtYTI0Ni00NTExYjFmYzM4MmJcIixcImFcIjozfSx7XCJlXCI6XCJmMDI3OWJlNy01YTRkLTRkZWMtYTk3ZC00N2IyNTYwMzE1NTZcIixcImFcIjozfSx7XCJlXCI6XCJlZTZhMDk0OC0wYmZlLTQzMWQtYWFmMS01MGEyZmM1NDJiYzVcIixcImFcIjozfSx7XCJlXCI6XCI2MmMzYjdhOS1kNDFjLTQ2MTUtOGY0My01NzJkOGZlNDc3OGJcIixcImFcIjozfSx7XCJlXCI6XCJlNzY0NTFlMy00MTM5LTQxZjAtYTNjYy02NDMyYzMzZDQ0Y2FcIixcImFcIjozfSx7XCJlXCI6XCJmMDUzZDhiNC1mYzZjLTRhMGMtYmM2NC02YWU0MzQ5ODg4YWVcIixcImFcIjozfSx7XCJlXCI6XCIyNzcxZDcxMS1lZmRhLTRhMTMtYjgwMy02YjcwZDgyZmE0YzZcIixcImFcIjozfSx7XCJlXCI6XCIzOWUxOThmOC02OWQxLTRjZjktOWFjOC02ZTg0N2YxNmY5YjhcIixcImFcIjozfSx7XCJlXCI6XCI1OTFlZGE4Ny1lNDUyLTQxZTYtOWZlOS03MjVjZjM4NjQ3NGFcIixcImFcIjozfSx7XCJlXCI6XCI2NjU0MjliOS00NTBmLTQ5NTMtYjY5My03YmJlYTI1YmQyYWFcIixcImFcIjozfSx7XCJlXCI6XCJiMTBkMjlkZi0zNTg4LTQzZTYtOGUzOS04Y2FiNDlhZjAzYWFcIixcImFcIjozfSx7XCJlXCI6XCJkYTg2ZWIxZS05OTQ1LTRkN2MtOGQwNC05NDNjMmQyN2U1NDFcIixcImFcIjozfSx7XCJlXCI6XCJhMWM4MTdkMS04YmVkLTQzYjItODJkNy05OTVhNDk0M2I5ZjdcIixcImFcIjozfSx7XCJlXCI6XCJhZThkZWM3Yi05YmM2LTRlNDctOTViNC1hN2YxMjk1OWFhZjlcIixcImFcIjozfSx7XCJlXCI6XCJiZGQzMTU4My1jNWNhLTQ1NjYtODE2Yy1hOTEwNzVhNThjNDdcIixcImFcIjozfSx7XCJlXCI6XCIzOTFjZGIyNi1hMGFiLTQ0NTMtYjFjZi1hOWIxNjc5YjRkNzRcIixcImFcIjozfSx7XCJlXCI6XCJmNjA2YzE5YS0zZjc3LTQxOTgtODJkMy1hYTYyODBhZWI1MTRcIixcImFcIjozfSx7XCJlXCI6XCI1OWMwZjBmZi1mYWM1LTRlYzctYjkzNS1iMjdlZDI3YmU0MDJcIixcImFcIjozfSx7XCJlXCI6XCIyMjNkODJjMy04YmFhLTQyM2MtOTc1My1iM2MwYWNhODU4OThcIixcImFcIjozfSx7XCJlXCI6XCJiYTNmNTRjZC04Y2Q4LTQ1MGItOTFlNS1iNjI4YmRiOGFhODRcIixcImFcIjozfSx7XCJlXCI6XCJlMTYzMmEzNi1iNDU0LTRlNzktOTEzYS1iZTViYzc0YTc3YjZcIixcImFcIjozfSx7XCJlXCI6XCJlZTZiZTQ2ZC1kMDE4LTRmZjAtYmEwMC1jNGZlY2VlYmUyMjVcIixcImFcIjozfSx7XCJlXCI6XCJjOTMzYjIwNS1lMzk0LTRhNTEtOTkwYS1jNTNhODljMmYyNmVcIixcImFcIjozfSx7XCJlXCI6XCI3NjYxZTYxOC1iYTY5LTQ5NTUtODFmMS1jOGVkYmQ1ZDU2ZDJcIixcImFcIjozfSx7XCJlXCI6XCJiMWZkOGMyMy1lZTRjLTRmYzMtOGVjMS1kNWM4MmE4YzdiMjdcIixcImFcIjozfSx7XCJlXCI6XCJmOTg4YzM0Yy0yNGVkLTRmNWEtOWMyNy1lOTMzNWU0YmZmNjBcIixcImFcIjozfSx7XCJlXCI6XCJmY2FhN2YxYi1hMzM0LTQ0NjAtODIxMy1lOTk5ZjM4NGUzMDlcIixcImFcIjozfSx7XCJlXCI6XCJjMzVjOGNjZS0xMWZlLTQyZmItOTY3Ni1mMzJkMmQxYWQ3M2NcIixcImFcIjozfSx7XCJlXCI6XCIwZThiYWFiOS0xOGI1LTRhM2EtYWExMi1mYjdjMjc3MzIwOWVcIixcImFcIjozfV0iLCJFbnRpdHlBY2Nlc3NTdG9yYWdlIjoiSldUVG9rZW4iLCJTdG9yZU5hbWUiOiJIZW5kcnkiLCJJc0F1dGhlbnRpY2F0ZWQiOiJ0cnVlIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjpbIkVzdGltYXRlIiwiRXN0aW1hdGVFZGl0b3IiLCJDdXN0b21lckRpc3BsYXkiLCJQcm9maWxlIiwiUHJvbW90aW9uIiwiUmVwb3J0MiIsIlRvb2xzIiwiU2V0dXAiLCJLaXRjaGVuRGlzcGxheSIsIk91dGxldHMiLCJJbnZlbnRvcnkiLCJTZXJ2aWNlIiwiQmlyIiwiUmVwb3J0IiwiQWRqdXN0bWVudCIsIkdsb2JhbEVkaXRvciIsIkFjdGl2aXR5IiwiUGF5bWVudCIsIlByb2R1Y3RzIiwiU2hpZnQiLCJEZWJ0IiwiQWNjb3VudGluZyIsIlRyZWF0bWVudCIsIkNvbnRhY3RzIiwiTWFudWZhY3R1cmUiLCJEZXZlbG9wZXJUb29scyIsIk9yZGVycyIsIkNoYXJ0IiwiTWFya2V0cGxhY2UiLCJVc2VycyIsIkNhbGVuZGFyIiwiUGF5bWVudEVkaXRvciIsIkFkanVzdG1lbnRFZGl0b3IiLCJTaGlmdENyZWF0ZSIsIkRlYnRDcmVhdGUiLCJNYW51ZmFjdHVyZUNyZWF0ZSIsIlN1YnNjcmlwdGlvbiIsIkJ1eSIsIlJlcG9ydEFkdmFuY2VkIiwiQ29udGFjdHNDcmVhdGUiLCJJbnZlbnRvcnlFZGl0b3IiLCJPdXRsZXRzQ3JlYXRlIiwiU2VsbCIsIkFjY291bnRpbmdDcmVhdGUiLCJQcm9kdWN0c0NyZWF0ZSIsIlByb21vdGlvbkNyZWF0ZSIsIk5vdGlmaWNhdGlvbiIsIkRlbGl2ZXJ5IiwiVHJlYXRtZW50Q3JlYXRlIiwiQWNjb3VudGluZ0VtcHR5T3V0bGV0IiwiSnVybmFsIiwiVXNlcnNDcmVhdGUiLCJTZXR1cENyZWF0ZSIsIlRyZWF0bWVudEVkaXRvciIsIlZvaWRJbnZvaWNlIiwiU2hpZnRFZGl0b3IiLCJQcm9tb3Rpb25FZGl0b3IiLCJBZGp1c3RtZW50Q3JlYXRlIiwiU2V0dXBFZGl0b3IiLCJTZWxsRGVsZXRlIiwiVXNlcnNFZGl0b3IiLCJPdXRsZXRzRWRpdG9yIiwiRGVsaXZlcnlFZGl0b3IiLCJQcm9maXQiLCJBY2NvdW50aW5nRWRpdG9yIiwiRXN0aW1hdGVEZWxldGUiLCJCdXlEZWxldGUiLCJNYW51ZmFjdHVyZUVkaXRvciIsIkNvbnRhY3RzRWRpdG9yIiwiRGVidEVkaXRvciIsIlByb2R1Y3RzRWRpdG9yIiwiVHJlYXRtZW50RGVsZXRlIiwiU2V0dXBEZWxldGUiLCJQYXltZW50RGVsZXRlIiwiRGF0ZUVkaXRvciIsIkFjY291bnRpbmdEZWxldGUiLCJTZWxsRWRpdG9yIiwiRGVidERlbGV0ZSIsIkludmVudG9yeVByb2R1Y3RDb3VudCIsIlByb21vdGlvbkRlbGV0ZSIsIk91dGxldHNEZWxldGUiLCJDb250YWN0c0RlbGV0ZSIsIk1hbnVmYWN0dXJlRGVsZXRlIiwiQWRqdXN0bWVudERlbGV0ZSIsIkRlbGl2ZXJ5RGVsZXRlIiwiU2hpZnREZWxldGUiLCJVc2Vyc0RlbGV0ZSIsIkJ1eUVkaXRvciIsIlByb2R1Y3RzRGVsZXRlIiwiV2ViaG9va1NldHVwIiwiR3JvdXBzIiwiV2ViaG9va0NvbmZpZ3VyYXRpb25WaWV3IiwiUGF5bWVudENyZWF0ZSIsIkxveWFsdHlQb2ludEVkaXRvciIsIk51bWJlckVkaXRvciIsIkNvc3QiLCJUcmVhdG1lbnRJbmNlbnRpdmUiLCJQcm9tb3Rpb25Db3Vwb24iLCJJbWFnZUVkaXRvciIsIlNoYXJlUGFja2FnZUVkaXRvciIsIkRldmVsb3BlclNldHVwIiwiQWNjb3VudGluZ0xlZGdlciIsIkRlbGl2ZXJ5Q3JlYXRlIiwiU2FsZXNtYW5FZGl0b3IiLCJSZXR1cm4iLCJEZWxpdmVyeURhdGVFZGl0b3IiLCJUcmVhdG1lbnROb3RlIiwiUHJpY2Vib29rIiwiRXhwZW5zZSIsIkRpc2NvdW50IiwiRGVsaXZlcnlSZWNlaXZlciIsIlVuaXRQcmljZUVkaXRvciIsIkJ1bmRsaW5nUHJpY2UiLCJEYXNoYm9hcmQiLCJEb2N0b3IiLCJFeHBvcnQiLCJNb25leSIsIlNlYXJjaCIsIkJlc3RTZWxsZXIiLCJUb3BDdXN0b21lcnMiLCJBdXRob3JpemF0aW9uS2V5IiwiTW9uaXRvciIsIlB1cmNoYXNlT3JkZXIiLCJTYWxlc1RyYW5zYWN0aW9uIiwiU2hpcHBpbmdFZGl0b3IiLCJBY2NvdW50aW5nUmVwb3J0IiwiQWNjb3VudGluZ0Nhc2hiYWxhbmNlIiwiRGVsZXRlQWxsT3V0bGV0UHJpY2UiLCJBZGp1c3RtZW50QXBwcm92YWwiLCJCdXlEYXRlRWRpdG9yIiwiUXVhbnRpdHkiLCJSZWN1cnJpbmciLCJQcmljZWJvb2tTZWxlY3RvciJdLCJleHAiOjE2MTEzNzA5MTUsImlzcyI6ImNocmlzdG9waGVyLmRlYWxwb3MubmV0IiwiYXVkIjoiY2hyaXN0b3BoZXIuZGVhbHBvcy5uZXQifQ.Zie2cYtqg4xmssBWFC6h6v_XAYSZrtdv22vL8npHdy0"
}

Get Token by Google ID

Request

Get Oauth 2.0 to access our API using Google ID Token

Bodyapplication/json

Get Token from User Name and API Client Secret

IDTokenstring

Obtained from logging in with Google Account

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Token/GoogleIDToken \
  -H 'Content-Type: application/json' \
  -d '{
    "IDToken": "string"
  }'

Responses

Bodyapplication/json
token_typestring
expires_ininteger

Lifetime of the access_token in seconds

expiredAtstring

Date when the access_token expired

access_tokenstring

string issued by the authorization server to access our API

Response
application/json
{
  "token_type": "Bearer",
  "expires_in": 172800,
  "expiredAt": "2022-09-24T10:01:55.7638103",
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiZGVhbHBvcyIsIlVzZXJJRCI6ImZmNzg0OGM5LTIxZjEtNGMwNS1hYzllLTFlNzFkODI5Y2M5YyIsIlNhbGVzSUQiOiIzNzQxNmNiMy1lYjEyLTQ2MTItOTcwZC1hNTcyN2MxNDRlZjkiLCJMaXZlQ2hhdEVuYWJsZWQiOiJUcnVlIiwiVHlwZSI6IlN5c3RlbSIsImRhdGFEYXlzUmFuZ2UiOjAsIlNlc3Npb25JRCI6IjZiNjE1ZjdhLTM2N2QtNDAzNi04NDU0LTQzNTMwOGU4YTg1NyIsIkVtYWlsIjoibG9jYWxob3N0LmRlYWxwb3NAZ21haWwuY29tIiwiRW50aXR5QWNjZXNzSlNPTiI6Ilt7XCJlXCI6XCJhMzk4ZTU1MC0xMTJkLTRhOTgtOGUyZi0wM2RkMjc5Y2FiMGNcIixcImFcIjozfSx7XCJlXCI6XCI4N2I3ZWM0MC0xNjgxLTQ0ZWMtOWIzOS0wZjIxODhkOGQxOTdcIixcImFcIjozfSx7XCJlXCI6XCI5YWQxZDZmYy0yOGFlLTRmZjMtOWY2NC0xNDQyYjc2ZDUxMThcIixcImFcIjozfSx7XCJlXCI6XCIxNWJkNWY1OS00ODlmLTQ5OGQtOWNlMC0xNTdiZWI0MGUzMTFcIixcImFcIjozfSx7XCJlXCI6XCI2Yjc4MGVmZC01ZTlhLTQ5ODQtYmI3Zi0xZTY1ZmM3N2Q3NGRcIixcImFcIjozfSx7XCJlXCI6XCJmMDQ1MTg3NC01NWNmLTQ2YjgtYThiZC0yMGE1ZDFhZTQ0ZGFcIixcImFcIjozfSx7XCJlXCI6XCI4YzM4MGVlMi0zMzY0LTRmNTItYmM4Zi0yYjcwY2M2ZDgxZjVcIixcImFcIjozfSx7XCJlXCI6XCIzYWQxYTc3Yi02NzBkLTQ0MjMtYTI0Ni00NTExYjFmYzM4MmJcIixcImFcIjozfSx7XCJlXCI6XCJmMDI3OWJlNy01YTRkLTRkZWMtYTk3ZC00N2IyNTYwMzE1NTZcIixcImFcIjozfSx7XCJlXCI6XCJlZTZhMDk0OC0wYmZlLTQzMWQtYWFmMS01MGEyZmM1NDJiYzVcIixcImFcIjozfSx7XCJlXCI6XCI2MmMzYjdhOS1kNDFjLTQ2MTUtOGY0My01NzJkOGZlNDc3OGJcIixcImFcIjozfSx7XCJlXCI6XCJlNzY0NTFlMy00MTM5LTQxZjAtYTNjYy02NDMyYzMzZDQ0Y2FcIixcImFcIjozfSx7XCJlXCI6XCJmMDUzZDhiNC1mYzZjLTRhMGMtYmM2NC02YWU0MzQ5ODg4YWVcIixcImFcIjozfSx7XCJlXCI6XCIyNzcxZDcxMS1lZmRhLTRhMTMtYjgwMy02YjcwZDgyZmE0YzZcIixcImFcIjozfSx7XCJlXCI6XCIzOWUxOThmOC02OWQxLTRjZjktOWFjOC02ZTg0N2YxNmY5YjhcIixcImFcIjozfSx7XCJlXCI6XCI1OTFlZGE4Ny1lNDUyLTQxZTYtOWZlOS03MjVjZjM4NjQ3NGFcIixcImFcIjozfSx7XCJlXCI6XCI2NjU0MjliOS00NTBmLTQ5NTMtYjY5My03YmJlYTI1YmQyYWFcIixcImFcIjozfSx7XCJlXCI6XCJiMTBkMjlkZi0zNTg4LTQzZTYtOGUzOS04Y2FiNDlhZjAzYWFcIixcImFcIjozfSx7XCJlXCI6XCJkYTg2ZWIxZS05OTQ1LTRkN2MtOGQwNC05NDNjMmQyN2U1NDFcIixcImFcIjozfSx7XCJlXCI6XCJhMWM4MTdkMS04YmVkLTQzYjItODJkNy05OTVhNDk0M2I5ZjdcIixcImFcIjozfSx7XCJlXCI6XCJhZThkZWM3Yi05YmM2LTRlNDctOTViNC1hN2YxMjk1OWFhZjlcIixcImFcIjozfSx7XCJlXCI6XCJiZGQzMTU4My1jNWNhLTQ1NjYtODE2Yy1hOTEwNzVhNThjNDdcIixcImFcIjozfSx7XCJlXCI6XCIzOTFjZGIyNi1hMGFiLTQ0NTMtYjFjZi1hOWIxNjc5YjRkNzRcIixcImFcIjozfSx7XCJlXCI6XCJmNjA2YzE5YS0zZjc3LTQxOTgtODJkMy1hYTYyODBhZWI1MTRcIixcImFcIjozfSx7XCJlXCI6XCI1OWMwZjBmZi1mYWM1LTRlYzctYjkzNS1iMjdlZDI3YmU0MDJcIixcImFcIjozfSx7XCJlXCI6XCIyMjNkODJjMy04YmFhLTQyM2MtOTc1My1iM2MwYWNhODU4OThcIixcImFcIjozfSx7XCJlXCI6XCJiYTNmNTRjZC04Y2Q4LTQ1MGItOTFlNS1iNjI4YmRiOGFhODRcIixcImFcIjozfSx7XCJlXCI6XCJlMTYzMmEzNi1iNDU0LTRlNzktOTEzYS1iZTViYzc0YTc3YjZcIixcImFcIjozfSx7XCJlXCI6XCJlZTZiZTQ2ZC1kMDE4LTRmZjAtYmEwMC1jNGZlY2VlYmUyMjVcIixcImFcIjozfSx7XCJlXCI6XCJjOTMzYjIwNS1lMzk0LTRhNTEtOTkwYS1jNTNhODljMmYyNmVcIixcImFcIjozfSx7XCJlXCI6XCI3NjYxZTYxOC1iYTY5LTQ5NTUtODFmMS1jOGVkYmQ1ZDU2ZDJcIixcImFcIjozfSx7XCJlXCI6XCJiMWZkOGMyMy1lZTRjLTRmYzMtOGVjMS1kNWM4MmE4YzdiMjdcIixcImFcIjozfSx7XCJlXCI6XCJmOTg4YzM0Yy0yNGVkLTRmNWEtOWMyNy1lOTMzNWU0YmZmNjBcIixcImFcIjozfSx7XCJlXCI6XCJmY2FhN2YxYi1hMzM0LTQ0NjAtODIxMy1lOTk5ZjM4NGUzMDlcIixcImFcIjozfSx7XCJlXCI6XCJjMzVjOGNjZS0xMWZlLTQyZmItOTY3Ni1mMzJkMmQxYWQ3M2NcIixcImFcIjozfSx7XCJlXCI6XCIwZThiYWFiOS0xOGI1LTRhM2EtYWExMi1mYjdjMjc3MzIwOWVcIixcImFcIjozfV0iLCJFbnRpdHlBY2Nlc3NTdG9yYWdlIjoiSldUVG9rZW4iLCJTdG9yZU5hbWUiOiJIZW5kcnkiLCJJc0F1dGhlbnRpY2F0ZWQiOiJ0cnVlIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjpbIkVzdGltYXRlIiwiRXN0aW1hdGVFZGl0b3IiLCJDdXN0b21lckRpc3BsYXkiLCJQcm9maWxlIiwiUHJvbW90aW9uIiwiUmVwb3J0MiIsIlRvb2xzIiwiU2V0dXAiLCJLaXRjaGVuRGlzcGxheSIsIk91dGxldHMiLCJJbnZlbnRvcnkiLCJTZXJ2aWNlIiwiQmlyIiwiUmVwb3J0IiwiQWRqdXN0bWVudCIsIkdsb2JhbEVkaXRvciIsIkFjdGl2aXR5IiwiUGF5bWVudCIsIlByb2R1Y3RzIiwiU2hpZnQiLCJEZWJ0IiwiQWNjb3VudGluZyIsIlRyZWF0bWVudCIsIkNvbnRhY3RzIiwiTWFudWZhY3R1cmUiLCJEZXZlbG9wZXJUb29scyIsIk9yZGVycyIsIkNoYXJ0IiwiTWFya2V0cGxhY2UiLCJVc2VycyIsIkNhbGVuZGFyIiwiUGF5bWVudEVkaXRvciIsIkFkanVzdG1lbnRFZGl0b3IiLCJTaGlmdENyZWF0ZSIsIkRlYnRDcmVhdGUiLCJNYW51ZmFjdHVyZUNyZWF0ZSIsIlN1YnNjcmlwdGlvbiIsIkJ1eSIsIlJlcG9ydEFkdmFuY2VkIiwiQ29udGFjdHNDcmVhdGUiLCJJbnZlbnRvcnlFZGl0b3IiLCJPdXRsZXRzQ3JlYXRlIiwiU2VsbCIsIkFjY291bnRpbmdDcmVhdGUiLCJQcm9kdWN0c0NyZWF0ZSIsIlByb21vdGlvbkNyZWF0ZSIsIk5vdGlmaWNhdGlvbiIsIkRlbGl2ZXJ5IiwiVHJlYXRtZW50Q3JlYXRlIiwiQWNjb3VudGluZ0VtcHR5T3V0bGV0IiwiSnVybmFsIiwiVXNlcnNDcmVhdGUiLCJTZXR1cENyZWF0ZSIsIlRyZWF0bWVudEVkaXRvciIsIlZvaWRJbnZvaWNlIiwiU2hpZnRFZGl0b3IiLCJQcm9tb3Rpb25FZGl0b3IiLCJBZGp1c3RtZW50Q3JlYXRlIiwiU2V0dXBFZGl0b3IiLCJTZWxsRGVsZXRlIiwiVXNlcnNFZGl0b3IiLCJPdXRsZXRzRWRpdG9yIiwiRGVsaXZlcnlFZGl0b3IiLCJQcm9maXQiLCJBY2NvdW50aW5nRWRpdG9yIiwiRXN0aW1hdGVEZWxldGUiLCJCdXlEZWxldGUiLCJNYW51ZmFjdHVyZUVkaXRvciIsIkNvbnRhY3RzRWRpdG9yIiwiRGVidEVkaXRvciIsIlByb2R1Y3RzRWRpdG9yIiwiVHJlYXRtZW50RGVsZXRlIiwiU2V0dXBEZWxldGUiLCJQYXltZW50RGVsZXRlIiwiRGF0ZUVkaXRvciIsIkFjY291bnRpbmdEZWxldGUiLCJTZWxsRWRpdG9yIiwiRGVidERlbGV0ZSIsIkludmVudG9yeVByb2R1Y3RDb3VudCIsIlByb21vdGlvbkRlbGV0ZSIsIk91dGxldHNEZWxldGUiLCJDb250YWN0c0RlbGV0ZSIsIk1hbnVmYWN0dXJlRGVsZXRlIiwiQWRqdXN0bWVudERlbGV0ZSIsIkRlbGl2ZXJ5RGVsZXRlIiwiU2hpZnREZWxldGUiLCJVc2Vyc0RlbGV0ZSIsIkJ1eUVkaXRvciIsIlByb2R1Y3RzRGVsZXRlIiwiV2ViaG9va1NldHVwIiwiR3JvdXBzIiwiV2ViaG9va0NvbmZpZ3VyYXRpb25WaWV3IiwiUGF5bWVudENyZWF0ZSIsIkxveWFsdHlQb2ludEVkaXRvciIsIk51bWJlckVkaXRvciIsIkNvc3QiLCJUcmVhdG1lbnRJbmNlbnRpdmUiLCJQcm9tb3Rpb25Db3Vwb24iLCJJbWFnZUVkaXRvciIsIlNoYXJlUGFja2FnZUVkaXRvciIsIkRldmVsb3BlclNldHVwIiwiQWNjb3VudGluZ0xlZGdlciIsIkRlbGl2ZXJ5Q3JlYXRlIiwiU2FsZXNtYW5FZGl0b3IiLCJSZXR1cm4iLCJEZWxpdmVyeURhdGVFZGl0b3IiLCJUcmVhdG1lbnROb3RlIiwiUHJpY2Vib29rIiwiRXhwZW5zZSIsIkRpc2NvdW50IiwiRGVsaXZlcnlSZWNlaXZlciIsIlVuaXRQcmljZUVkaXRvciIsIkJ1bmRsaW5nUHJpY2UiLCJEYXNoYm9hcmQiLCJEb2N0b3IiLCJFeHBvcnQiLCJNb25leSIsIlNlYXJjaCIsIkJlc3RTZWxsZXIiLCJUb3BDdXN0b21lcnMiLCJBdXRob3JpemF0aW9uS2V5IiwiTW9uaXRvciIsIlB1cmNoYXNlT3JkZXIiLCJTYWxlc1RyYW5zYWN0aW9uIiwiU2hpcHBpbmdFZGl0b3IiLCJBY2NvdW50aW5nUmVwb3J0IiwiQWNjb3VudGluZ0Nhc2hiYWxhbmNlIiwiRGVsZXRlQWxsT3V0bGV0UHJpY2UiLCJBZGp1c3RtZW50QXBwcm92YWwiLCJCdXlEYXRlRWRpdG9yIiwiUXVhbnRpdHkiLCJSZWN1cnJpbmciLCJQcmljZWJvb2tTZWxlY3RvciJdLCJleHAiOjE2MTEzNzA5MTUsImlzcyI6ImNocmlzdG9waGVyLmRlYWxwb3MubmV0IiwiYXVkIjoiY2hyaXN0b3BoZXIuZGVhbHBvcy5uZXQifQ.Zie2cYtqg4xmssBWFC6h6v_XAYSZrtdv22vL8npHdy0"
}

Get Token by TOTP Code (Coming Soon)

Request

Get Oauth 2.0 token to access our API using TOTP

Bodyapplication/json

Get Token from User Name and API Client Secret

UserIDstring

Username

TOTPCodestring

OTP genarated from authenticator app

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Token/TOTP \
  -H 'Content-Type: application/json' \
  -d '{
    "UserID": "string",
    "TOTPCode": "string"
  }'

Responses

Bodyapplication/json
token_typestring
expires_ininteger

Lifetime of the access_token in seconds

expiredAtstring

Date when the access_token expired

access_tokenstring

string issued by the authorization server to access our API

Response
application/json
{
  "token_type": "Bearer",
  "expires_in": 172800,
  "expiredAt": "2022-09-24T10:01:55.7638103",
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiZGVhbHBvcyIsIlVzZXJJRCI6ImZmNzg0OGM5LTIxZjEtNGMwNS1hYzllLTFlNzFkODI5Y2M5YyIsIlNhbGVzSUQiOiIzNzQxNmNiMy1lYjEyLTQ2MTItOTcwZC1hNTcyN2MxNDRlZjkiLCJMaXZlQ2hhdEVuYWJsZWQiOiJUcnVlIiwiVHlwZSI6IlN5c3RlbSIsImRhdGFEYXlzUmFuZ2UiOjAsIlNlc3Npb25JRCI6IjZiNjE1ZjdhLTM2N2QtNDAzNi04NDU0LTQzNTMwOGU4YTg1NyIsIkVtYWlsIjoibG9jYWxob3N0LmRlYWxwb3NAZ21haWwuY29tIiwiRW50aXR5QWNjZXNzSlNPTiI6Ilt7XCJlXCI6XCJhMzk4ZTU1MC0xMTJkLTRhOTgtOGUyZi0wM2RkMjc5Y2FiMGNcIixcImFcIjozfSx7XCJlXCI6XCI4N2I3ZWM0MC0xNjgxLTQ0ZWMtOWIzOS0wZjIxODhkOGQxOTdcIixcImFcIjozfSx7XCJlXCI6XCI5YWQxZDZmYy0yOGFlLTRmZjMtOWY2NC0xNDQyYjc2ZDUxMThcIixcImFcIjozfSx7XCJlXCI6XCIxNWJkNWY1OS00ODlmLTQ5OGQtOWNlMC0xNTdiZWI0MGUzMTFcIixcImFcIjozfSx7XCJlXCI6XCI2Yjc4MGVmZC01ZTlhLTQ5ODQtYmI3Zi0xZTY1ZmM3N2Q3NGRcIixcImFcIjozfSx7XCJlXCI6XCJmMDQ1MTg3NC01NWNmLTQ2YjgtYThiZC0yMGE1ZDFhZTQ0ZGFcIixcImFcIjozfSx7XCJlXCI6XCI4YzM4MGVlMi0zMzY0LTRmNTItYmM4Zi0yYjcwY2M2ZDgxZjVcIixcImFcIjozfSx7XCJlXCI6XCIzYWQxYTc3Yi02NzBkLTQ0MjMtYTI0Ni00NTExYjFmYzM4MmJcIixcImFcIjozfSx7XCJlXCI6XCJmMDI3OWJlNy01YTRkLTRkZWMtYTk3ZC00N2IyNTYwMzE1NTZcIixcImFcIjozfSx7XCJlXCI6XCJlZTZhMDk0OC0wYmZlLTQzMWQtYWFmMS01MGEyZmM1NDJiYzVcIixcImFcIjozfSx7XCJlXCI6XCI2MmMzYjdhOS1kNDFjLTQ2MTUtOGY0My01NzJkOGZlNDc3OGJcIixcImFcIjozfSx7XCJlXCI6XCJlNzY0NTFlMy00MTM5LTQxZjAtYTNjYy02NDMyYzMzZDQ0Y2FcIixcImFcIjozfSx7XCJlXCI6XCJmMDUzZDhiNC1mYzZjLTRhMGMtYmM2NC02YWU0MzQ5ODg4YWVcIixcImFcIjozfSx7XCJlXCI6XCIyNzcxZDcxMS1lZmRhLTRhMTMtYjgwMy02YjcwZDgyZmE0YzZcIixcImFcIjozfSx7XCJlXCI6XCIzOWUxOThmOC02OWQxLTRjZjktOWFjOC02ZTg0N2YxNmY5YjhcIixcImFcIjozfSx7XCJlXCI6XCI1OTFlZGE4Ny1lNDUyLTQxZTYtOWZlOS03MjVjZjM4NjQ3NGFcIixcImFcIjozfSx7XCJlXCI6XCI2NjU0MjliOS00NTBmLTQ5NTMtYjY5My03YmJlYTI1YmQyYWFcIixcImFcIjozfSx7XCJlXCI6XCJiMTBkMjlkZi0zNTg4LTQzZTYtOGUzOS04Y2FiNDlhZjAzYWFcIixcImFcIjozfSx7XCJlXCI6XCJkYTg2ZWIxZS05OTQ1LTRkN2MtOGQwNC05NDNjMmQyN2U1NDFcIixcImFcIjozfSx7XCJlXCI6XCJhMWM4MTdkMS04YmVkLTQzYjItODJkNy05OTVhNDk0M2I5ZjdcIixcImFcIjozfSx7XCJlXCI6XCJhZThkZWM3Yi05YmM2LTRlNDctOTViNC1hN2YxMjk1OWFhZjlcIixcImFcIjozfSx7XCJlXCI6XCJiZGQzMTU4My1jNWNhLTQ1NjYtODE2Yy1hOTEwNzVhNThjNDdcIixcImFcIjozfSx7XCJlXCI6XCIzOTFjZGIyNi1hMGFiLTQ0NTMtYjFjZi1hOWIxNjc5YjRkNzRcIixcImFcIjozfSx7XCJlXCI6XCJmNjA2YzE5YS0zZjc3LTQxOTgtODJkMy1hYTYyODBhZWI1MTRcIixcImFcIjozfSx7XCJlXCI6XCI1OWMwZjBmZi1mYWM1LTRlYzctYjkzNS1iMjdlZDI3YmU0MDJcIixcImFcIjozfSx7XCJlXCI6XCIyMjNkODJjMy04YmFhLTQyM2MtOTc1My1iM2MwYWNhODU4OThcIixcImFcIjozfSx7XCJlXCI6XCJiYTNmNTRjZC04Y2Q4LTQ1MGItOTFlNS1iNjI4YmRiOGFhODRcIixcImFcIjozfSx7XCJlXCI6XCJlMTYzMmEzNi1iNDU0LTRlNzktOTEzYS1iZTViYzc0YTc3YjZcIixcImFcIjozfSx7XCJlXCI6XCJlZTZiZTQ2ZC1kMDE4LTRmZjAtYmEwMC1jNGZlY2VlYmUyMjVcIixcImFcIjozfSx7XCJlXCI6XCJjOTMzYjIwNS1lMzk0LTRhNTEtOTkwYS1jNTNhODljMmYyNmVcIixcImFcIjozfSx7XCJlXCI6XCI3NjYxZTYxOC1iYTY5LTQ5NTUtODFmMS1jOGVkYmQ1ZDU2ZDJcIixcImFcIjozfSx7XCJlXCI6XCJiMWZkOGMyMy1lZTRjLTRmYzMtOGVjMS1kNWM4MmE4YzdiMjdcIixcImFcIjozfSx7XCJlXCI6XCJmOTg4YzM0Yy0yNGVkLTRmNWEtOWMyNy1lOTMzNWU0YmZmNjBcIixcImFcIjozfSx7XCJlXCI6XCJmY2FhN2YxYi1hMzM0LTQ0NjAtODIxMy1lOTk5ZjM4NGUzMDlcIixcImFcIjozfSx7XCJlXCI6XCJjMzVjOGNjZS0xMWZlLTQyZmItOTY3Ni1mMzJkMmQxYWQ3M2NcIixcImFcIjozfSx7XCJlXCI6XCIwZThiYWFiOS0xOGI1LTRhM2EtYWExMi1mYjdjMjc3MzIwOWVcIixcImFcIjozfV0iLCJFbnRpdHlBY2Nlc3NTdG9yYWdlIjoiSldUVG9rZW4iLCJTdG9yZU5hbWUiOiJIZW5kcnkiLCJJc0F1dGhlbnRpY2F0ZWQiOiJ0cnVlIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjpbIkVzdGltYXRlIiwiRXN0aW1hdGVFZGl0b3IiLCJDdXN0b21lckRpc3BsYXkiLCJQcm9maWxlIiwiUHJvbW90aW9uIiwiUmVwb3J0MiIsIlRvb2xzIiwiU2V0dXAiLCJLaXRjaGVuRGlzcGxheSIsIk91dGxldHMiLCJJbnZlbnRvcnkiLCJTZXJ2aWNlIiwiQmlyIiwiUmVwb3J0IiwiQWRqdXN0bWVudCIsIkdsb2JhbEVkaXRvciIsIkFjdGl2aXR5IiwiUGF5bWVudCIsIlByb2R1Y3RzIiwiU2hpZnQiLCJEZWJ0IiwiQWNjb3VudGluZyIsIlRyZWF0bWVudCIsIkNvbnRhY3RzIiwiTWFudWZhY3R1cmUiLCJEZXZlbG9wZXJUb29scyIsIk9yZGVycyIsIkNoYXJ0IiwiTWFya2V0cGxhY2UiLCJVc2VycyIsIkNhbGVuZGFyIiwiUGF5bWVudEVkaXRvciIsIkFkanVzdG1lbnRFZGl0b3IiLCJTaGlmdENyZWF0ZSIsIkRlYnRDcmVhdGUiLCJNYW51ZmFjdHVyZUNyZWF0ZSIsIlN1YnNjcmlwdGlvbiIsIkJ1eSIsIlJlcG9ydEFkdmFuY2VkIiwiQ29udGFjdHNDcmVhdGUiLCJJbnZlbnRvcnlFZGl0b3IiLCJPdXRsZXRzQ3JlYXRlIiwiU2VsbCIsIkFjY291bnRpbmdDcmVhdGUiLCJQcm9kdWN0c0NyZWF0ZSIsIlByb21vdGlvbkNyZWF0ZSIsIk5vdGlmaWNhdGlvbiIsIkRlbGl2ZXJ5IiwiVHJlYXRtZW50Q3JlYXRlIiwiQWNjb3VudGluZ0VtcHR5T3V0bGV0IiwiSnVybmFsIiwiVXNlcnNDcmVhdGUiLCJTZXR1cENyZWF0ZSIsIlRyZWF0bWVudEVkaXRvciIsIlZvaWRJbnZvaWNlIiwiU2hpZnRFZGl0b3IiLCJQcm9tb3Rpb25FZGl0b3IiLCJBZGp1c3RtZW50Q3JlYXRlIiwiU2V0dXBFZGl0b3IiLCJTZWxsRGVsZXRlIiwiVXNlcnNFZGl0b3IiLCJPdXRsZXRzRWRpdG9yIiwiRGVsaXZlcnlFZGl0b3IiLCJQcm9maXQiLCJBY2NvdW50aW5nRWRpdG9yIiwiRXN0aW1hdGVEZWxldGUiLCJCdXlEZWxldGUiLCJNYW51ZmFjdHVyZUVkaXRvciIsIkNvbnRhY3RzRWRpdG9yIiwiRGVidEVkaXRvciIsIlByb2R1Y3RzRWRpdG9yIiwiVHJlYXRtZW50RGVsZXRlIiwiU2V0dXBEZWxldGUiLCJQYXltZW50RGVsZXRlIiwiRGF0ZUVkaXRvciIsIkFjY291bnRpbmdEZWxldGUiLCJTZWxsRWRpdG9yIiwiRGVidERlbGV0ZSIsIkludmVudG9yeVByb2R1Y3RDb3VudCIsIlByb21vdGlvbkRlbGV0ZSIsIk91dGxldHNEZWxldGUiLCJDb250YWN0c0RlbGV0ZSIsIk1hbnVmYWN0dXJlRGVsZXRlIiwiQWRqdXN0bWVudERlbGV0ZSIsIkRlbGl2ZXJ5RGVsZXRlIiwiU2hpZnREZWxldGUiLCJVc2Vyc0RlbGV0ZSIsIkJ1eUVkaXRvciIsIlByb2R1Y3RzRGVsZXRlIiwiV2ViaG9va1NldHVwIiwiR3JvdXBzIiwiV2ViaG9va0NvbmZpZ3VyYXRpb25WaWV3IiwiUGF5bWVudENyZWF0ZSIsIkxveWFsdHlQb2ludEVkaXRvciIsIk51bWJlckVkaXRvciIsIkNvc3QiLCJUcmVhdG1lbnRJbmNlbnRpdmUiLCJQcm9tb3Rpb25Db3Vwb24iLCJJbWFnZUVkaXRvciIsIlNoYXJlUGFja2FnZUVkaXRvciIsIkRldmVsb3BlclNldHVwIiwiQWNjb3VudGluZ0xlZGdlciIsIkRlbGl2ZXJ5Q3JlYXRlIiwiU2FsZXNtYW5FZGl0b3IiLCJSZXR1cm4iLCJEZWxpdmVyeURhdGVFZGl0b3IiLCJUcmVhdG1lbnROb3RlIiwiUHJpY2Vib29rIiwiRXhwZW5zZSIsIkRpc2NvdW50IiwiRGVsaXZlcnlSZWNlaXZlciIsIlVuaXRQcmljZUVkaXRvciIsIkJ1bmRsaW5nUHJpY2UiLCJEYXNoYm9hcmQiLCJEb2N0b3IiLCJFeHBvcnQiLCJNb25leSIsIlNlYXJjaCIsIkJlc3RTZWxsZXIiLCJUb3BDdXN0b21lcnMiLCJBdXRob3JpemF0aW9uS2V5IiwiTW9uaXRvciIsIlB1cmNoYXNlT3JkZXIiLCJTYWxlc1RyYW5zYWN0aW9uIiwiU2hpcHBpbmdFZGl0b3IiLCJBY2NvdW50aW5nUmVwb3J0IiwiQWNjb3VudGluZ0Nhc2hiYWxhbmNlIiwiRGVsZXRlQWxsT3V0bGV0UHJpY2UiLCJBZGp1c3RtZW50QXBwcm92YWwiLCJCdXlEYXRlRWRpdG9yIiwiUXVhbnRpdHkiLCJSZWN1cnJpbmciLCJQcmljZWJvb2tTZWxlY3RvciJdLCJleHAiOjE2MTEzNzA5MTUsImlzcyI6ImNocmlzdG9waGVyLmRlYWxwb3MubmV0IiwiYXVkIjoiY2hyaXN0b3BoZXIuZGVhbHBvcy5uZXQifQ.Zie2cYtqg4xmssBWFC6h6v_XAYSZrtdv22vL8npHdy0"
}

Get Token by PasswordDeprecated

Request

Get OAuth2 AccessToken to access our API

We provide 2 ways to obtain the access_token

  1. Send client credentials in body

    Content-Type: application/json

  2. Send as Basic Auth Header

    Content-Type: application/x-www-form-urlencoded

    Concatenate client_id:client_secret then encode to base64 string, use Basic Authentication

Body

Get Token from Username and Password

client_idstringrequired

Username

client_secretstringrequired

Password

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Token \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "string",
    "client_secret": "string"
  }'

Responses

Bodyapplication/json
token_typestring
expires_ininteger

Lifetime of the access_token in seconds

expiredAtstring

Date when the access_token expired

access_tokenstring

string issued by the authorization server to access our API

Response
application/json
{
  "token_type": "Bearer",
  "expires_in": 43200,
  "expiredAt": "2020-05-13T04:52:04.5969178+07:00",
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiYWRtaW4iLCJVc2VySUQiOiJmYjIyOTJkNy01Mjk3LTRjOTQtYjEzMy1lY2MxYTk4NTlhZjYiLCJTYWxlc0lEIjoiIiwiTGl2ZUNoYXRFbmFibGVkIjoiRmFsc2UiLCJUeXBlIjoiTm9ybWFsIiwiZGF0YVJhbmdlVHlwZSI6IkRheXMiLCJkYXRhRGF5c1JhbmdlIjowLCJkYXRhRGF0ZUZyb20iOiIwMS8wMS8wMDAxIiwiZGF0YURhdGVUbyI6IjAxLzAxLzAwMDEiLCJTZXNzaW9uSUQiOiI5NzI1ZDU5Ny04N2Y4LTQwZGUtOTlmNS1hMTdjNThjODc3YjMiLCJFbWFpbCI6InRlc3RAZGVhbHBvcy5jb20iLCJFbnRpdHlBY2Nlc3NKU09OIjoiW3tcImVcIjpcIjhiZGEwYTg0LWQ2NDYtNDFhZi1iNTFmLTQ0YmE0OGEwZjIxNFwiLFwiYVwiOjN9LHtcImVcIjpcIjYyYzNiN2E5LWQ0MWMtNDYxNS04ZjQzLTU3MmQ4ZmU0Nzc4YlwiLFwiYVwiOjN9LHtcImVcIjpcIjMzYThiNTliLTlkZjgtNDU3Mi05NTUyLTdhNmRlM2RmYThjYVwiLFwiYVwiOjN9LHtcImVcIjpcIjhkOTEzY2NjLTBiZDAtNGZlYi1iODUyLTg5ZjIwNzgyNDkzNVwiLFwiYVwiOjN9LHtcImVcIjpcImRhODZlYjFlLTk5NDUtNGQ3Yy04ZDA0LTk0M2MyZDI3ZTU0MVwiLFwiYVwiOjF9LHtcImVcIjpcIjJmYzlhMGY4LTg5Y2ItNGRmOS04MTgyLWFjM2U2ZmU2MGFkY1wiLFwiYVwiOjN9LHtcImVcIjpcIjk0Mzc1NmI4LTU4MDItNDA2ZC1iZjUyLWIxMzU2MTVkODdhN1wiLFwiYVwiOjN9LHtcImVcIjpcImJhM2Y1NGNkLThjZDgtNDUwYi05MWU1LWI2MjhiZGI4YWE4NFwiLFwiYVwiOjN9LHtcImVcIjpcIjhmZTBmODJhLTRkNDItNDM3YS1hMmM0LWM0N2NjYWRhYjUyN1wiLFwiYVwiOjN9LHtcImVcIjpcImY5ODhjMzRjLTI0ZWQtNGY1YS05YzI3LWU5MzM1ZTRiZmY2MFwiLFwiYVwiOjN9LHtcImVcIjpcIjBlOGJhYWI5LTE4YjUtNGEzYS1hYTEyLWZiN2MyNzczMjA5ZVwiLFwiYVwiOjN9XSIsIkVudGl0eUFjY2Vzc1N0b3JhZ2UiOiJKV1RUb2tlbiIsIklzQXV0aGVudGljYXRlZCI6InRydWUiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiUHJvZml0IiwiQ29udGFjdHMiLCJNYW51ZmFjdHVyZSIsIkRldmVsb3BlclRvb2xzIiwiQ3VzdG9tZXJEaXNwbGF5IiwiT3JkZXJzIiwiVXNlcnMiLCJQYXltZW50IiwiU2VsbCIsIlByb2R1Y3RzIiwiSW52ZW50b3J5MiIsIkFjdGl2aXR5IiwiS2l0Y2hlbkRpc3BsYXkiLCJTZXR1cCIsIkRlYnQiLCJBY2NvdW50aW5nIiwiUHJvbW90aW9uIiwiVHJlYXRtZW50IiwiQnV5IiwiVG9vbHMiLCJEZWxpdmVyeSIsIlByb2ZpbGUiLCJPdXRsZXRzIiwiSW52ZW50b3J5IiwiU2VydmljZSIsIkJpciIsIlJlcG9ydCIsIkFkanVzdG1lbnQiLCJHbG9iYWxFZGl0b3IiLCJFeHBvcnQiLCJBZGp1c3RtZW50RWRpdG9yIiwiQ29udGFjdHNFZGl0b3IiLCJEZWJ0RWRpdG9yIiwiUGF5bWVudEVkaXRvciIsIkludmVudG9yeUVkaXRvciIsIkFjY291bnRpbmdFZGl0b3IiLCJEZWxpdmVyeUVkaXRvciIsIlJlcG9ydEFkdmFuY2VkIiwiVHJlYXRtZW50RWRpdG9yIiwiUHJvbW90aW9uRWRpdG9yIiwiUHJpY2Vib29rRWRpdG9yIiwiRGVsaXZlcnlSZXF1ZXN0RWRpdG9yIiwiQWNjb3VudGluZ0VtcHR5T3V0bGV0IiwiVHJlYXRtZW50SW5jZW50aXZlIiwiQ29zdCIsIlBheW1lbnRJbnB1dCIsIkxveWFsdHlQb2ludEVkaXRvciIsIlZvaWRJbnZvaWNlIiwiSW52ZW50b3J5UHJvZHVjdENvdW50IiwiU2hhcmVQYWNrYWdlRWRpdG9yIiwiU2FsZXNtYW5FZGl0b3IiLCJBY2NvdW50aW5nUmVwb3J0IiwiVHJlYXRtZW50Tm90ZSIsIlJldHVybiIsIkRlbGl2ZXJ5RGF0ZUVkaXRvciIsIkRpc2NvdW50IiwiQnVuZGxpbmdQcmljZSIsIkNvbW1pc3Npb24iLCJDT0FSZXN0cmljdGlvbiJdLCJleHAiOjE1ODkzMjAzMjQsImlzcyI6ImRlYWxwb3MuY29tIiwiYXVkIjoiZGVhbHBvcy5jb20ifQ.2ysQj53ZveYxj8DvrX22mc6WFJe7KDcQt0adXRo-Btg"
}

List InvoicesDeprecated

Request

Bodyapplication/json
Fromstring

From Date. this is primary key for the object

Default "format : yyyy-mm-dd"
Tostring

To Date. this is primary key for the object

Default "format: yyyy-mm-dd"
PageNumberintegerrequired

The number of page data to be displayed

PageSizeintegerrequired

The number of rows returned by the API

OutletIDstring

Guid of Outlet ID

Outletstring

Outlet name. (Only for access outlet Read/Write that given to the user)

TagArray of objects

Channel Tagging system. (ex:Offline / Whatsapp / Shopee / Tokopedia) used in marketplace.dealpos.app.

Paymentstring

Payment State

Default "Paid , Partial , Unpaid"
Fulfillmentstring

Fulfillment State

Default "Sent, Unsent"
Emailstring

Email address of customer

Mobilestring

Phone or mobile phone number of customer

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Invoice \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "format : yyyy-mm-dd",
    "To": "format: yyyy-mm-dd",
    "PageNumber": 0,
    "PageSize": 0,
    "OutletID": "string",
    "Outlet": "string",
    "Tag": [
      {}
    ],
    "Payment": "Paid , Partial , Unpaid",
    "Fulfillment": "Sent, Unsent",
    "Email": "string",
    "Mobile": "string"
  }'

Responses

Bodyapplication/jsonArray [
IDstring

Invoice ID

Outletstring

Outlet Name

Numberstring

Number Of invoice info

Customerstring

Customer Name

Datestring

Invoice Date Transaction Date

EventDatestring

Due date of shipping delivery

Duestring

Due date of invoice

Amountnumber

Total amount transaction

Paymentstring

Payment State of invoice

Enum"Unpaid""Partial""Paid""Exceed"
Fulfillmentstring

Fulfillment Status of the invoice

Enum"Sent""Unsent"
Createdstring

Invoice created time

]
Response
application/json
[
  {
    "ID": "3de705c4-53a0-4a66-8ab1-f9737e3ad6fb",
    "Outlet": "Outlet1",
    "Number": "18.10.00009",
    "Customer": "Ferdi",
    "Date": "2018-10-17T00:00:00",
    "EventDate": "0001-01-01T00:00:00",
    "Due": "0001-01-01T00:00:00",
    "Amount": 120000,
    "Payment": "Paid",
    "Fulfillment": "Sent",
    "Created": "2019-08-28T11:00:20.34"
  },
  {
    "ID": "3de7eve4-53a0-tsw6-8ab1-f9737e3adweb",
    "Outlet": "Outlet1",
    "Number": "18.10.00002",
    "Customer": "Ferdi",
    "Date": "2018-10-16T00:00:00",
    "EventDate": "0001-01-01T00:00:00",
    "Due": "0001-01-01T00:00:00",
    "Amount": 150000,
    "Payment": "Paid",
    "Fulfillment": "Sent",
    "Created": "2019-08-28T11:00:20.34"
  }
]

Get Promotion Coupon Detail by Coupon KeyDeprecated

Request

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

Get Promotion Coupon Detail by Coupon Code

Required Group Role: "Promotion" - "VIEW"

Bodyapplication/json
Keystring
Example: "Disc99"
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/PromotionCoupon/ByKey \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Key": "Disc99"
  }'

Responses

Bodyapplication/json
Keystring

The Promotion Coupon Key/Code

Limitinteger

The usage limit of the promotion coupon key

Balanceinteger

Remaining balance of the promotion coupon key

Discountinteger

The discount applied to the promotion coupon

Createdstring

The promotion coupon created time

StartDatestring

Start Date of Promotion Coupon

ExpiryDatestring

The promotion coupon expiry date

Typestring

The promotion coupon discount type

Descriptionstring

Description of the promotion coupon

CustomerCodestring

Code of Customer (Member Code)

Response
application/json
{
  "Coupons": [
    { … },
    { … }
  ]
}

Send OutboundLogistic from Multiple OutletDeprecated

Request

Previous Endpoints: https://brand.dealpos.net/api/v3/CustomerDelivery/Split. As for now, both the new & the old ones can be use.

When an order is fulfilled from multiple locations. Multiple Outbound Logistic is created from DISTINCT outlet names

Bodyapplication/json
OutletIDstringrequired

Guid of Outlet ID

Outletstringrequired

Outlet name where the invoice created

Numberstringrequired

The invoice number

VariantsArray of objectsrequired

the variants in the invoice

Variants[].​Codestringrequired

Variant code

Variants[].​Quantityintegerrequired

Quantity of the variant

Variants[].​Outletstringrequired

Outlet name for sent the variant

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/OutboundLogistic/Split \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "OutletID": "string",
    "Outlet": "string",
    "Number": "string",
    "Variants": [
      {
        "Code": "string",
        "Quantity": 0,
        "Outlet": "string"
      }
    ]
  }'

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "6e424252-ffe3-4a75-98b8-d0917acc487d"
}

Receive Partial InboundLogisticDeprecated

Request

Previous Endpoint: https://brand.dealpos.net/api/v3/SupplierDelivery/Partial. As for now, both the new & the old ones can be use.

Receive Partial delivery for Purchase Order from Supplier

Bodyapplication/json
Outletstringrequired

Outlet Name

Numberstringrequired

Bill Number

DeliveryOutletstringrequired

Outlet that will be received the purchase order

VariantsArray of objects
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/InboundLogistic/Partial \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "string",
    "Number": "string",
    "DeliveryOutlet": "string",
    "Variants": [
      {
        "Code": "string",
        "Quantity": "string",
        "Note": "string"
      }
    ]
  }'

Responses

Bodyapplication/json
object
Response
application/json
{
  "Message": "Supplier Bill Delivery Number Bill001 created!"
}