DealPOS API (3.1.0)

Welcome Developer

This page lists the reference documentation for DealPOS APIs. For guides and tutorials.

Download OpenAPI description
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

Get Inventory Log

Request

Also available as HTTP POST with the same endpoint


Get an Inventory Log based on Code

Required Group Role: "Inventory" - "VIEW"

Query
Codestringrequired

Variant Code of product. Use this if there in no property query VariantID

VariantIDstringrequired

Variant ID of product. Use this if there in no property query Code

Outletstring

Outlet's Name

OutletIDstring(guid)

Guid of Outlet ID

Fromstring(date)

Start Date filter

Tostring(date)

End Date filter

Bodyapplication/json
One of:
Codestringrequired

Variant Code of product. this is primary key for the object

Example: "2016"
Outletstring

Outlet's Name

Example: "Outlet1"
Fromstring

Start Date filter

Example: "2019-01-04"
Tostring

End Date filter

Example: "2019-12-31"
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Inventory/Log?Code=string&From=2019-08-24&Outlet=string&OutletID=string&To=2019-08-24&VariantID=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Code": "2016",
    "Outlet": "Outlet1",
    "From": "2019-01-04",
    "To": "2019-12-31"
  }'

Responses

Bodyapplication/jsonArray [
Outletstring

outlet's name

TransDatestring

transaction date was created

Numberstring

transaction number of the invoice

Namestring

Customer's name

Costinteger

the cost of the variant

Priceinteger

the price of the variant

LogTypestring

the type of the transaction that make inventory movement

Notestring

Transaction note

Ininteger

total incoming stock of the variant

Outinteger

total outcoming stock of the variant

Inventoryinteger

On Hand Quantity

EntryDatestring

the date and time of the transaction

UserNamestring

user who create this transaction

]
Response
application/json
[ { "Outlet": "Outlet1", "TransDate": "14 Nov 2019", "Number": "05002", "Name": "Hendry", "Cost": 20000, "Price": 50000, "LogType": "InventoryAdjustment", "Note": "05002", "In": 10, "Out": 0, "Inventory": 10, "EntryDate": "2019-11-14T15:19:17.743", "UserName": "dealpos" }, { "Outlet": "Outlet1", "TransDate": "14 Nov 2019", "Number": "05002", "Name": "Fer D Rahman", "Cost": 20000, "Price": 50000, "LogType": "InventoryAdjustment", "Note": "05002", "In": 2, "Out": 0, "Inventory": 1, "EntryDate": "2019-11-14T15:18:39.483", "UserName": "dealpos" }, { "Outlet": "Outlet1", "TransDate": "23 May 2018", "Number": "Testts2", "Name": "", "Cost": 0, "Price": 0, "LogType": "InventoryAdjustment", "Note": "Testts2", "In": 0, "Out": 1, "Inventory": -1, "EntryDate": "2019-11-14T13:35:42.12", "UserName": "dealpos" }, { "Outlet": "Outlet1", "TransDate": "23 May 2018", "Number": "Testts2", "Name": "Ezza", "Cost": 20000, "Price": 50000, "LogType": "InventoryAdjustment", "Note": "testts2", "In": 2, "Out": 0, "Inventory": 1, "EntryDate": "2019-11-14T13:29:59.64", "UserName": "dealpos" }, { "Outlet": "Outlet1", "TransDate": "23 Oct 2019", "Number": "05.23.2018.000002", "Name": "Zan", "Cost": 20000, "Price": 50000, "LogType": "InventoryAdjustment", "Note": "05.23.2018.000002", "In": 0, "Out": 1, "Inventory": -1, "EntryDate": "2019-11-07T09:45:03.877", "UserName": "dealpos" } ]

Get Inventory Log Modified Since Date

Request

Get an Inventory Log modified since the given date-time

Required Group Role: "Inventory" - "VIEW" get: summary: Get inventory details

Query
PageNumberintegerrequired

Page number for pagination

Example: PageNumber=1
PageSizeintegerrequired

Number of items per page

Example: PageSize=20
Sincestring(date-time)required

Filter records since the given date-time

Example: Since=2025-01-08T07:01:21
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Inventory/Log/Modified?PageNumber=0&PageSize=0&Since=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

A list of inventory items

Bodyapplication/jsonArray [
Outletstring

Name of the outlet

Codestring

Variant Code of the product

OnHandinteger

Quantity on hand

Modifiedstring(date-time)

Date and time of the last modify

]
Response
application/json
[ { "Outlet": "Kemang", "Code": "001", "OnHand": 50, "Modified": "2025-01-08T07:01:21" }, { "Outlet": "PIK", "Code": "001", "OnHand": 35, "Modified": "2025-01-08T07:01:21" }, { "Outlet": "PIK", "Code": "002", "OnHand": 35, "Modified": "2025-01-08T07:01:21" } ]

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

Picklist

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