Skip to content
/
Get Parked Orders Grouped...

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

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

Update State

Request

Updates the state of multiple items using query parameters.

Security
OAuth2_clientCredentials
Bodyapplication/jsonrequired
ListIDArray of strings(guid)

List of variant GUIDs to update

Example: ["f7b3b3b3-4b1b-4b3b-8b3b-3b3b3b3b3b3b","abcwb4b6-8gh9-xyu3-poi8-yt4b3b3b3b4b"]
StateIDintegerrequired

New state ID to set for the variants (0=New, 1=Pick, 2=Pack, 3=Ship)

Enum0123
Example: 1
ShipToFulfillboolean

default false (Coming Soon - For create outbound logistic when state updated to Ship)

Example: true
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/ParkedOrderDisplay/UpdateState \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ListID": [
      "f7b3b3b3-4b1b-4b3b-8b3b-3b3b3b3b3b3b",
      "abcwb4b6-8gh9-xyu3-poi8-yt4b3b3b3b4b"
    ],
    "StateID": 1,
    "ShipToFulfill": true
  }'

Responses

State updated successfully.

Bodyapplication/json
Messagestring
Example: "Variant in park orders has been updated to Pick"
Response
application/json
{
  "Message": "Variant in park orders has been updated to Pick"
}

Get Parked Order Summary Default

Request

Retrieves a summary of parked orders based on Outlet and Category by Entry Time

Security
OAuth2_clientCredentials
Query
OutletIDstring(guid)required

Unique identifier for the outlet.

Example: OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f
CategoryIDstring(guid)required

Unique identifier for the category.

Example: CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/ParkedOrderDisplay/Summary/Default?OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f&CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully retrieved order summary.

Bodyapplication/json
SummaryArray of objects
Response
application/json
{
  "Summary": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Get Parked Order Summary Group By Order

Request

Retrieves a summary of parked orders based on Outlet and Category group by order.

Security
OAuth2_clientCredentials
Query
OutletIDstring(guid)required

Unique identifier for the outlet.

Example: OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f
CategoryIDstring(guid)required

Unique identifier for the category.

Example: CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/ParkedOrderDisplay/Summary/GroupByOrder?OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f&CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully retrieved order summary.

Bodyapplication/json
SummaryArray of objects
Response
application/json
{
  "Summary": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Get Parked Order Summary Group By Variant

Request

Retrieves a summary of parked orders based on Outlet and Category group by variant.

Security
OAuth2_clientCredentials
Query
OutletIDstring(guid)required

Unique identifier for the outlet.

Example: OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f
CategoryIDstring(guid)required

Unique identifier for the category.

Example: CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/ParkedOrderDisplay/Summary/GroupByVariant?OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f&CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully retrieved order summary.

Bodyapplication/json
SummaryArray of objects
Response
application/json
{
  "Summary": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Get Parked Orders Grouped by Variant

Request

Retrieves parked orders grouped by variant, filtered by state, outlet, and category.

Security
OAuth2_clientCredentials
Query
OutletIDstring(guid)

Unique identifier for the outlet.

Example: OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f
CategoryIDstring(guid)

Unique identifier for the category.

Example: CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f
StateIDinteger

Order state filter (0=New, 1=Pick, 2=Pack, 3=Ship).

Enum0123
Example: StateID=0
PageNumberintegerrequired

Page number for pagination.

Example: PageNumber=1
PageSizeintegerrequired

Number of items per page for pagination.

Example: PageSize=20
MaxHoursinteger

Maximum hours to filter parked orders. (If not provided, default is 24 hours)

Example: MaxHours=24
OrderTypestring

Type of order will be shown in the display. (Parked / All). If not provided, default is "Parked".
Parked => Only for Invoice Pending
All => Display all pending and processed invoices

Default "Parked"
Enum"Parked""All"
Example: OrderType=Parked
Sortstring

Sort result by Descending or Ascending. If not provided, default is "Desc".

Default "Desc"
Enum"Desc""Asc"
Example: Sort=Desc
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/ParkedOrderDisplay/GroupByVariant?OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f&CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f&StateID=0&PageNumber=1&PageSize=20&MaxHours=24&OrderType=Parked&Sort=Desc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully retrieved parked orders grouped by variant.

Bodyapplication/json
DataArray of objects
Response
application/json
{
  "Data": [
    { … }
  ]
}

Get Parked Orders Grouped by Order

Request

Retrieves parked orders grouped by order, filtered by state, outlet, and category.

Security
OAuth2_clientCredentials
Query
OutletIDstring(guid)

Unique identifier for the outlet.

Example: OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f
CategoryIDstring(guid)

Unique identifier for the category.

Example: CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f
StateIDinteger

Order state filter (0=New, 1=Pick, 2=Pack, 3=Ship).

Enum0123
Example: StateID=0
PageNumberintegerrequired

Page number for pagination.

Example: PageNumber=1
PageSizeintegerrequired

Number of items per page for pagination.

Example: PageSize=20
MaxHoursinteger

Maximum hours to filter parked orders. (If not provided, default is 24 hours)

Example: MaxHours=24
OrderTypestring

Type of order will be shown in the display. (Parked / All). If not provided, default is "Parked".
Parked => Only for Invoice Pending
All => Display all pending and processed invoices

Default "Parked"
Enum"Parked""All"
Example: OrderType=Parked
Sortstring

Sort result by Descending or Ascending. If not provided, default is "Desc".

Default "Desc"
Enum"Desc""Asc"
Example: Sort=Desc
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/ParkedOrderDisplay/GroupByOrder?OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f&CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f&StateID=0&PageNumber=1&PageSize=20&MaxHours=24&OrderType=Parked&Sort=Desc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully retrieved parked orders grouped by order.

Bodyapplication/json
DataArray of objects
Response
application/json
{
  "Data": [
    { … }
  ]
}

Get Parked Orders Default

Request

Retrieves a list of parked orders with filtering options.

Security
OAuth2_clientCredentials
Query
OutletIDstring(guid)

Unique identifier for the outlet.

Example: OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f
CategoryIDstring(guid)

Unique identifier for the category.

Example: CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f
StateIDinteger

Order state filter (0=New, 1=Pick, 2=Pack, 3=Ship).

Enum0123
Example: StateID=0
PageNumberintegerrequired

Page number for pagination.

Example: PageNumber=1
PageSizeintegerrequired

Number of items per page for pagination.

Example: PageSize=20
MaxHoursinteger

Maximum hours to filter parked orders. (If not provided, default is 24 hours)

Example: MaxHours=24
OrderTypestring

Type of order will be shown in the display. (Parked / All). If not provided, default is "Parked".
Parked => Only for Invoice Pending
All => Display all pending and processed invoices

Default "Parked"
Enum"Parked""All"
Example: OrderType=Parked
Sortstring

Sort result by Descending or Ascending. If not provided, default is "Desc".

Default "Desc"
Enum"Desc""Asc"
Example: Sort=Desc
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/ParkedOrderDisplay/Default?OutletID=ff3c515e-c2b7-4309-8c29-30e44cecb23f&CategoryID=ba003c7a-b7ed-410d-8c0d-af32ef08443f&StateID=0&PageNumber=1&PageSize=20&MaxHours=24&OrderType=Parked&Sort=Desc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully retrieved parked orders.

Bodyapplication/json
DataArray of objects
Response
application/json
{
  "Data": [
    { … }
  ]
}

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