Sales Order

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

Create Sales Order

Request

Create Sales Order

You must have "Create" role in "Sell" Module OR "EDIT" role in "Global" Module

Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
Registerstring

Register Name

Example: "Cashier 1"
Numberstringrequired

Invoice Number

Example: "20.06.00001"
Datestringrequired

Date of customer invoice created (YYYY-MM-DD)

Example: "2020-06-24"
Tagstring

Sales Order Tag

Example: "Tokopedia"
SalesPersonstring

Sales Person name

Example: "Sales 1"
TaxTypestring

Tax Type

Example: "No Tax"
Discount1integer

Discount 1 percentage

Discount2integer

Discount 2 percentage

DiscountAmountinteger

Discount amount

OrderNotestring

Note for internal use

Example: "Order from Omnichannel"
LogisticServiceCodestring

Code of Logistic Service Option

Example: "JNE-R"
ReferenceNumberstring

Number that associated with a specific invoice issued to a customer which gets from invoice Marketplace channel. (Backwards Compatibility with property PurchaseOrderNumber)

Example: "TKPD-001"
Customerobject
Example: {"Name":"Hendry Wijaya","Email":"Hendry@dealpos.com","Phone":"02165498468","Mobile":"081514515156","Code":"HW021"}
VariantsArray of objects
Example: [{"Code":"200536","Quantity":"10","Price":"3500","Discount":0,"Note":"Item 1"},{"Code":"1315L","Quantity":"10","Price":"4000","Discount":0,"Note":"Item 2"}]
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/SalesOrder \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Register": "Cashier 1",
    "Number": "20.06.00001",
    "Date": "2020-06-24",
    "Tag": "Tokopedia",
    "SalesPerson": "Sales 1",
    "TaxType": "No Tax",
    "Discount1": 0,
    "Discount2": 0,
    "DiscountAmount": 0,
    "OrderNote": "Order from Omnichannel",
    "LogisticServiceCode": "JNE-R",
    "ReferenceNumber": "TKPD-001",
    "Customer": {
      "Name": "Hendry Wijaya",
      "Email": "Hendry@dealpos.com",
      "Phone": "02165498468",
      "Mobile": "081514515156",
      "Code": "HW021"
    },
    "Variants": [
      {
        "Code": "200536",
        "Quantity": "10",
        "Price": "3500",
        "Discount": 0,
        "Note": "Item 1"
      },
      {
        "Code": "1315L",
        "Quantity": "10",
        "Price": "4000",
        "Discount": 0,
        "Note": "Item 2"
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring

Sales order ID which has been made

Numberstring

Sales Order Number which has been made

Response
application/json
{
  "ID": "21e0dbb6-f240-4bda-8f03-769362f88d10",
  "Number": "20.06.00001"
}

Delete Sales Order

Request

Delete Sales Order

You must have "Delete" role in "Sell" Module

Bodyapplication/json
One of:
Outletstringrequired

Outlet name

Example: "Outlet1"
Numberstringrequired

Invoice number to be deleted

Example: "20.06.00001"
OutletIDstringrequired

Guid of Outlet ID

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

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "SalesOrder  21.02.00011 has been deleted"
}

Convert Sales Order to Invoice

Request

Convert Sales Order to Invoice

You must have “Create” role in “Sell” Module OR “EDIT” role in “Global” Module

Bodyapplication/json
One of:
OutletIDstring

Guid of Outlet ID

Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Sales Order Number

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

Responses

Bodyapplication/json
IDstring

Invoice ID

Numberstring

Invoice Number

Response
application/json
{
  "ID": "21e0dbb6-f240-4bda-8f03-769362f88d10",
  "Number": "20.06.00001"
}

Update Sales Order Fields

Request

Update the fields (Reference Number, Logistic Service Code, Note) of an existing Sales Order.

You must have "Edit" role in "Sell" Module OR "EDIT" role in "Global" Module

POS Condition

  • The system sets the fulfillment state to AWAITING_COLLECTION when a payload containing "Fulfillment": "AwaitingCollection" is received.

  • A transition to AWAITING_COLLECTION occurs only if the current fulfillment state is UNSENT or any earlier state.

  • When duplicate updates are received, the existing fulfillment state remains unchanged. Metadata fields (ReferenceNumber and/or LogisticServiceCode) are updated only when new values are provided.

Channel Service Condition

  • "Fulfillment": "AwaitingCollection" is emitted to the Channel Service only when at least one of the following fields is included:

    • ReferenceNumber

    • LogisticServiceCode

Headers
IgnoreFulfillmentboolean

To ignore fulfillment rules when updating the Sales Order fields, set this header to true

Default false
Example: true
Bodyapplication/json
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Invoice Number

Example: "20.06.00001"
ReferenceNumberstring

Number related to this Order ex: logistic tracking_number or purchase_order number (If this property is null or empty, it will not update the Reference Number)

Example: "TKPD-001"
LogisticServiceCodestring

Code of the logistic service (if this property is null or empty, it will not update the Logistic Service Code)

Example: "JNE123"
Notestring

Sales Order Note (if this property is null or empty, it will not update the Note)

Example: "This is a note for Sales Order"
Fulfillmentstring

Fulfillment status of the Sales Order from Unsent to 'AwaitingCollection' (if this property is null or empty, it will not update the Fulfillment status)

Example: "AwaitingCollection"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/SalesOrder/Field \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'IgnoreFulfillment: true' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "20.06.00001",
    "ReferenceNumber": "TKPD-001",
    "LogisticServiceCode": "JNE123",
    "Note": "This is a note for Sales Order",
    "Fulfillment": "AwaitingCollection"
  }'

Responses

Bodyapplication/json
Messagestring
Example: "reference number for sales order 20.06.00001 has been updated"
Response
application/json
{
  "Message": "reference number for sales order 20.06.00001 has been updated"
}

Get Sales Order By List Number

Request

Also available as HTTP POST with the same endpoint


Get Sales Order List based on Number

Required Group Role: "Orders" - "View"

Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
NumberArray of stringsrequired

Sales Order Numbers

Example: ["20.11.00003","20.11.00002","20.11.00001"]
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/SalesOrder/GetByListNumber \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": [
      "20.11.00003",
      "20.11.00002",
      "20.11.00001"
    ]
  }'

Responses

Bodyapplication/jsonArray [
IDstring

Sales Order ID

Outletstring

Outlet name

Datestring

Sales order date

Numberstring

Sales order number

ReferenceNumberstring

Reference number of the sales order

InvoicedStatestring

status progress of the sales order

DeliveryStatestring

delivery status progres of the sales order

Enum"Sent""Unsent""Partial"
PaymentStatestring

payment status progress of the sales order

Binboolean

Recycle bin status of the sales order

]
Response
application/json
[
  {
    "ID": "d5f8e8b3-1c4e-4f7a-9f3a-2b8e5d6c7a9b",
    "Outlet": "Outlet1",
    "Date": "2020-11-05T00:00:00",
    "Number": "20.11.00003",
    "ReferenceNumber": "JX2020110500001",
    "InvoicedState": "Complete",
    "DeliveryState": "Sent",
    "PaymentState": "Paid",
    "Bin": false
  },
  {
    "ID": "a3c9e7b2-2d4f-4e8b-8f3b-3c9e6d7e8b0c",
    "Outlet": "Outlet1",
    "Date": "2020-11-05T00:00:00",
    "Number": "20.11.00002",
    "ReferenceNumber": "JX2020110500002",
    "InvoicedState": "Complete",
    "DeliveryState": "Sent",
    "PaymentState": "Paid",
    "Bin": false
  },
  {
    "ID": "b4d0f9c3-3e5f-4f9c-9f4c-4d0f7e8f9c1d",
    "Outlet": "Outlet1",
    "Date": "2020-11-05T00:00:00",
    "Number": "20.11.00001",
    "ReferenceNumber": "JX2020110500003",
    "InvoicedState": "Complete",
    "DeliveryState": "Sent",
    "PaymentState": "Paid",
    "Bin": false
  }
]

Get Sales Order ID by Number

Request

Also available as HTTP POST with the same endpoint


Get Sales Order ID by Number

Required Group Role: "Orders" - "View"

Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Sales Order Number

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

Responses

Bodyapplication/json
IDstring

Sales order ID

Response
application/json
{
  "ID": "90ad0fb6-0340-4254-90f5-15e213b95a82"
}

Get Sales Order Total Count

Request

Also available as HTTP POST with the same endpoint


Get Sales Order Total Count based on selected outlet(s).

Required Group Role: "Orders" - "View"

Bodyapplication/json
One of:
Fromstring(date)

Start Date of Sales Order Created

Tostring(date)

Till Date of Sales Order Created

ListOutletIDArray of strings

Array of List OutletID

OutletArray of strings

Outlet Name

Example: ["Outlet1","Outlet2"]
TagArray of strings

Channel Tagging System

Example: ["Tokopedia","Shopee"]
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/SalesOrder/TotalCount \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": [
      "Outlet1",
      "Outlet2"
    ],
    "Tag": [
      "Tokopedia",
      "Shopee"
    ]
  }'

Responses

Bodyapplication/json
Countinteger

Total Sales Order of selected outlet

Response
application/json
{
  "Count": 550
}

Get Parked Order

Request

Also available as HTTP POST with the same endpoint


Get Parked Order List with multiple outlet
Bodyapplication/json
One of:
Fromstringrequired

From Date Sales Order created

Example: "2021-01-01"
Tostringrequired

Till Date Sales Order created

Example: "2021-01-31"
PageNumberintegerrequired

The number of page data to be displayed

Example: 1
PageSizeintegerrequired

The number of rows returned by the API

Example: 20
ListOutletIDArray of stringsrequired

Array of List OutletID

OutletArray of stringsrequired

Outlet Name

Example: ["Outlet1","Outlet2"]
TagArray of stringsrequired

Channel Tagging System.(ex: Tokopedia, Shopee)

Example: ["Tokopedia","Shopee"]
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/SalesOrder/GetParked \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2021-01-01",
    "To": "2021-01-31",
    "PageNumber": 1,
    "PageSize": 20,
    "Outlet": [
      "Outlet1",
      "Outlet2"
    ],
    "Tag": [
      "Tokopedia",
      "Shopee"
    ]
  }'

Responses

Bodyapplication/jsonArray [
IDstring

Sales Order (Parked Order) ID

Outletstring

Outlet name

Numberstring

Sales order (parked order) number

Datestring

Sales order (parked order) date

Createdstring

Sales order (parked order) created date

Customerstring

Sales order (parked order) customer name

Tagstring

Channel Tagging system. (ex: Tokopedia, Shopee)

]
Response
application/json
[
  {
    "ID": "21a4168b-d2b5-48e8-8d60-ff63cd5e30f6",
    "Outlet": "Outlet2",
    "Number": "21.01.00002",
    "Date": "2021-01-21T00:00:00",
    "Created": "2021-01-21T09:36:14.07",
    "Customer": "hendry",
    "Tag": "Tokopedia"
  },
  {
    "ID": "21a4we8b-d995-48ty-8880-ff6abc5e30f6",
    "Outlet": "Outlet2",
    "Number": "21.01.00001",
    "Date": "2021-01-21T00:00:00",
    "Created": "2021-01-21T09:14:56.447",
    "Customer": "Tafta",
    "Tag": "Shopee"
  },
  {
    "ID": "21yu169b-dio5-48e8-8pp0-ff63bh5e30f6",
    "Outlet": "Outlet1",
    "Number": "21.01.00093",
    "Date": "2021-01-07T00:00:00",
    "Created": "2021-01-07T16:18:30.837",
    "Customer": "Aldi",
    "Tag": "Tokopedia"
  },
  {
    "ID": "21a41vvb-d2b5-4ve8-8ven-ff63cd5ev0f6",
    "Outlet": "Outlet1",
    "Number": "21.01.00092",
    "Date": "2021-01-07T00:00:00",
    "Created": "2021-01-07T16:13:27.2",
    "Customer": "Syakri",
    "Tag": "Tokopedia"
  }
]

Get Reference Number By Sales Order ID

Request

Get List of Reference Number By Sales Order ID

Bodyapplication/json
ListIDArray of strings

Array of List Sales Order ID

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/SalesOrder/GetReferenceNumber \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ListID": [
      "1e9c45af-9916-4131-a138-01ffd0ec1eba",
      "0b9657f4-5e12-4d4a-89d6-c104a55c6c49"
    ]
  }'

Responses

OK

Bodyapplication/jsonArray [
IDstring

ID of Sales Order

ReferenceNumberstring

Number that associated with a specific invoice issued to a customer which gets from invoice Marketplace channel

]
Response
application/json
[
  {
    "ID": "1e9c45af-9916-4131-a138-01ffd0ec1eba",
    "ReferenceNumber": "TKPD-001"
  },
  {
    "ID": "0b9657f4-5e12-4d4a-89d6-c104a55c6c49",
    "ReferenceNumber": "TKPD-002"
  }
]

Get Sales Order Next Number

Request

This API use to check sales order next number that generated from our system

Bodyapplication/json
Outletstringrequired

Outlet Name

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

Responses

OK

Bodyapplication/json
Numberstring

Next Sales Order number that generated from system

Response
application/json
{
  "Number": "B1.24.06.00013"
}

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

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