Outlet
/
Get Outlet Detail

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

List Outlets

Request

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


Get List of Outlets

Required Group Role: "Outlets" - "VIEW"

Query
Namestring

Outlet Name (Can be searched keyword contain of outlet name)

Example: Name=Outlet1
Accessstring

Access Restriction

Example: Access=All
SuspendedStatusstring

Outlet status

Example: SuspendedStatus=No / Yes / All
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Outlet?Access=string&Name=string&SuspendedStatus=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
IDstring

Outlet ID

Namestring

Outlet's name

Codestring

Outlet's code

Suspendedboolean

Outlet's status

]
Response
application/json
[
  {
    "ID": "227427f5-fb25-4f47-9e39-2370fa70d156",
    "Name": "Outlet1",
    "Code": "001",
    "Suspended": false
  },
  {
    "ID": "28342qw5-fb25-4287-3259-2210faaf156",
    "Name": "Outlet2",
    "Code": "002",
    "Suspended": false
  },
  {
    "ID": "30e4a41d-7fc6-46f5-9945-fd5e0642w3e3",
    "Name": "Outlet3",
    "Code": "003",
    "Suspended": false
  }
]

Update an Outlet

Request

Update an Outlet

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

Bodyapplication/json
Outletstringrequired

Outlet name that will be updated

Codestringrequired

Code of outlet

Receiptstring

Code Of receipt

NegativeInventorystring

Negative inventory configuration

Enum"Yes""No"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Outlet \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Emporium Pluit",
    "Code": "001",
    "Receipt": "001",
    "NegativeInventory": "Yes"
  }'

Responses

Bodyapplication/json
Messagestring

Outlet has been updated

Response
application/json
{
  "Message": "Outlet has been updated"
}

Create an Outlet

Request

Create an Outlet

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

Bodyapplication/json
Namestringrequired

Outlet's name that will be created

Codestring

Code of new outlet

Receiptstring

Code Of receipt

NegativeInventorystring

Negative inventory configuration

Enum"Yes""No"
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Outlet \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Name": "Emporium Pluit",
    "Code": "001",
    "Receipt": "001",
    "NegativeInventory": "Yes"
  }'

Responses

Bodyapplication/json
Messagestring

Outlet has been created

Response
application/json
{
  "Message": "Outlet has been created"
}

Delete an Outlet

Request

Delete an Outlet

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

Bodyapplication/json
Codestringrequired

Code of outlet that will be deleted

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

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Outlet Emporium Pluit has been deleted"
}

Get Outlet By ID

Request

Get Outlet Name and Code By ID

Required Group Role: "Outlets" - "VIEW"

Path
idstring(guid)required

ID of outlet

Example: 227427f5-fb25-4f47-9e39-2370fa70d156
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Outlet/ID/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
IDstring

Outlet ID

Namestring

Outlet's name

Codestring

Outlet's code

Suspendedboolean

Outlet's status

Response
application/json
{
  "ID": "227427f5-fb25-4f47-9e39-2370fa70d156",
  "Name": "Outlet1",
  "Code": "001",
  "Suspended": false
}

Get Outlet List By List ID

Request

Get Outlet Name and Code By ID

Required Group Role: "Outlets" - "VIEW"

Query
ListIDArray of strings(guid)required

List of OutletID

Example: ListID=227427f5-fb25-4f47-9e39-2370fa70d156, 212347f5-gt52-4127-8148-7780fabcd123
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Outlet/ListID?ListID=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
IDstring

Outlet ID

Namestring

Outlet's name

Codestring

Outlet's code

Suspendedboolean

Outlet's status

]
Response
application/json
[
  {
    "ID": "227427f5-fb25-4f47-9e39-2370fa70d156",
    "Name": "Outlet1",
    "Code": "001",
    "Suspended": false
  },
  {
    "ID": "212347f5-gt52-4127-8148-7780fabcd123",
    "Name": "Outlet1",
    "Code": "001",
    "Suspended": false
  }
]

Get Outlet Detail

Request

Also available as HTTP POST with the same endpoint

Get Outlet Detail

Required Group Role: "Outlet" - "VIEW"

Bodyapplication/json
Namestringnon-emptyrequired

Outlet Name

Codestringnon-emptyrequired

Outlet Code

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Outlet/Detail \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Name": "Shopee",
    "Code": "Outlet2"
  }'

Responses

Bodyapplication/json
IDstring

Outlet ID

Codestring

Outlet Code

Namestring

Outlet Name

Emailstring

Outlet's Email

SalesTargetinteger

Target sales per outlet

Suspendedboolean

Status of Outlet (false = unsuspend, true = suspend)

MinimumInventoryinteger

Reorder Point

EnabledKitchenDisplayboolean

Kitchen Display status

ReceiptTemplateobject
Response
application/json
{
  "ID": "410ba2b7-8eff-4759-b5f1-cf47b33ef1cc",
  "Code": "OTL1",
  "Name": "Outlet1",
  "Email": "hendry@gmail.com",
  "SalesTarget": 50000,
  "Suspended": false,
  "MinimumInventory": 0,
  "EnabledKitchenDisplay": false,
  "ReceiptTemplate": {
    "Code": "B1",
    "OutletName": "Outlet1",
    "Address": "Muara Karang P 3 Timur No 30\r\nJakarta Utara, Indonesia",
    "ContactInfo": "Phone: 021-66600886"
  }
}

Get Register by Outlet

Request

Get Register List by Outlet

Bodyapplication/json
One of:
Outletstringrequired

The outlet name. If filled in with blank value it will display registers from all outlet.

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

Responses

OK

Bodyapplication/jsonArray [
Outletstring

The outlet name.

RegisterArray of strings

The register name from the requested outlet

]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Register": [ … ]
  }
]

Get Register By OutletID

Request

Get Register By OutletID

Required Group Role: "Outlets" - "VIEW"

Query
ListIDArray of strings(guid)required

List of OutletID

Example: ListID=227427f5-fb25-4f47-9e39-2370fa70d156, 212347f5-gt52-4127-8148-7780fabcd123
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Outlet/Register/ID?ListID=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

A list of outlets with register details.

Bodyapplication/jsonArray [
Outletstring

The name of the outlet.

RegisterArray of objects
]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Register": [ … ]
  },
  {
    "Outlet": "Outlet2",
    "Register": [ … ]
  }
]

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