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

Servers

Production Server

https://{subdomain}/api/v3/

Token

Operations related to authentication tokens

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

Create TransferOrder

Request

Previous Endpoint: /api/v3/OutletDelivery. As for now, both the new & the old ones can be use.

Create an Outlet Delivery

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

Bodyapplication/json

One of:

Outletstringrequired

Outlet Source Name

Example: "Outlet1"

Destinationstringrequired

Outlet destination name

Example: "Outlet2"

Datestringrequired

Transfer order date

Example: "10/10/2018"

Numberstringrequired

Transfer order number

Example: "18.07.02.0000002"

Courierstring

Courier name

Example: "JNE"

Statestring

Delivery Status of Transfer Order

If "State" is filled, the value gets from API push
When "State" is empty, the value will be following config Transfer Order Workflow

Enum"Approved""Dispatched""Received"

Notestring

Delivery note

Example: "Yes Kirim"

VariantsArray of objectsrequired

Example: [{"Code":"2012","Quantity":"6","Price":150000,"Note":"Cotton Combet 30's"},{"Code":"2012","Quantity":"6","Price":150000,"Note":"Cotton Combet 30's"}]

Variants[].Codestringrequired

Variant code

Variants[].Quantitystringrequired

Variant quantity to be sent

Variants[].Pricenumberrequired

Variant price

Variants[].Notestring

Variant note

Variants[].SerialArray of objects(Variant Serial)

Use this property only for product type Serialized

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/TransferOrder \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Destination": "Outlet2",
    "Date": "10/10/2018",
    "Number": "18.07.02.0000002",
    "Courier": "JNE",
    "Note": "Yes Kirim",
    "Variants": [
      {
        "Code": "2012",
        "Quantity": "6",
        "Price": 150000,
        "Note": "Cotton Combet 30'\''s"
      },
      {
        "Code": "2012",
        "Quantity": "6",
        "Price": 150000,
        "Note": "Cotton Combet 30'\''s"
      }
    ]
  }'

Responses

Bodyapplication/json

IDstring

Transfer Order ID

Response

application/json

{
  "ID": "0b151d3f-e7ab-44dd-a63a-dbc4019d5cad"
}

Update TransferOrder

Request

Previous Endpoint: /api/v3/OutletDelivery. As for now, both the new & the old ones can be use.

Update an Outlet Delivery

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

Bodyapplication/json

One of:

Outletstringrequired

Outlet source name

Example: "Outlet1"

Destinationstringrequired

Outlet destination name

Example: "Outlet2"

Datestringrequired

Delivery date

Example: "10/10/2018"

Numberstringrequired

Invoice delivery number

Example: "18.07.02.0000002"

Courierstring

Courier name

Example: "JNE"

Notestring

Delivery note

Example: "Yes Kirim"

VariantsArray of objectsrequired

Example: [{"Code":"2012","Quantity":"6","Price":150000,"Note":"Cotton Combet 30's"},{"Code":"2012","Quantity":"6","Price":150000,"Note":"Cotton Combet 30's"}]

Variants[].Codestringrequired

Variant code

Variants[].Quantitystringrequired

Variant quantity to be delivered

Variants[].Pricenumberrequired

Variant price

Variants[].Notestring

Variant note

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/TransferOrder \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Destination": "Outlet2",
    "Date": "10/10/2018",
    "Number": "18.07.02.0000002",
    "Courier": "JNE",
    "Note": "Yes Kirim",
    "Variants": [
      {
        "Code": "2012",
        "Quantity": "6",
        "Price": 150000,
        "Note": "Cotton Combet 30'\''s"
      },
      {
        "Code": "2012",
        "Quantity": "6",
        "Price": 150000,
        "Note": "Cotton Combet 30'\''s"
      }
    ]
  }'

Responses

Bodyapplication/json

IDstring

Transfer Order ID

Response

application/json

{
  "ID": "0b151d3f-e7ab-44dd-a63a-dbc4019d5cad"
}

List TransferOrder

Request

Previous Endpoint: /api/v3/OutletDelivery. As for now, both the new & the old ones can be use.

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

Get List of Outlet Delivery

Required Group Role: "Logistic" - "VIEW"

Bodyapplication/json

Fromstring

Delivery date filter from

Example: "2019-01-01"

Tostring

Delivery Date filter To

Example: "2019-01-30"

PageNumbernumberrequired

Start page

Example: 1

PageSizenumberrequired

Total data delivery list that will be shown

Example: 20

Statusstring

Fulfillment Status (if value null / blank means show all status)

Example: "Request / Approved / Dispatched / Received"

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/TransferOrder \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2019-01-01",
    "To": "2019-01-30",
    "PageNumber": 1,
    "PageSize": 20,
    "Status": ""
  }'

Responses

Bodyapplication/jsonArray [

Numberstring

Outlet Delivery Order Number

Datestring

Date time of outlet delivery

Courierstring

Courier Name

Outletstring

Source of outlet delivery

OutletCodestring

Code of source outlet delivery

Destinationstring

Destination of outlet delivery

DestinationCodestring

Code of destination outlet delivery

TypeNamestring

Outlet Delivery Type

Statusstring

Outlet delivery status

Createdstring

Datetime of outlet delivery order

Quantityinteger

Total quantity outlet delivery order

Pricenumber

Total price for the outlet delivery

]

Response

application/json

[
  {
    "Number": "19.01.18.000000002",
    "Date": "2019-01-18T00:00:00",
    "Courier": "JsonSerializerOptions",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Received",
    "Created": "2019-01-18T15:14:48.64",
    "Quantity": 2
  },
  {
    "Number": "19.01.18.000000001",
    "Date": "2019-01-18T00:00:00",
    "Courier": "JsonSerializerOptions",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Dispatched",
    "Created": "2019-01-18T15:13:27.377",
    "Quantity": 2
  },
  {
    "Number": "19.01.17.000000005",
    "Date": "2019-01-17T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Received",
    "Created": "2019-01-17T16:48:30.813",
    "Quantity": 8
  },
  {
    "Number": "19.01.17.000000004",
    "Date": "2019-01-17T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Dispatched",
    "Created": "2019-01-17T16:47:09.893",
    "Quantity": 5
  },
  {
    "Number": "19.01.17.000000003",
    "Date": "2019-01-17T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Received",
    "Created": "2019-01-17T13:59:16.77",
    "Quantity": 1
  },
  {
    "Number": "19.01.17.000000001",
    "Date": "2019-01-17T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Received",
    "Created": "2019-01-17T10:08:34.61",
    "Quantity": 1
  },
  {
    "Number": "19.01.17.000000002",
    "Date": "2019-01-17T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 2",
    "OutletCode": "OT2",
    "Destination": "Outlet 3",
    "DestinationCode": "OT3",
    "TypeName": "Restock",
    "Status": "Received",
    "Created": "2019-01-17T15:57:50.71",
    "Quantity": 7
  },
  {
    "Number": "19.01.17.000000001",
    "Date": "2019-01-17T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 2",
    "OutletCode": "OT2",
    "Destination": "Outlet 3",
    "DestinationCode": "OT3",
    "TypeName": "Restock",
    "Status": "Dispatched",
    "Created": "2019-01-17T15:49:20.533",
    "Quantity": 7
  },
  {
    "Number": "19.01.15.000000004",
    "Date": "2019-01-15T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Received",
    "Created": "2019-01-15T11:15:57.027",
    "Quantity": 3
  },
  {
    "Number": "19.01.15.000000003",
    "Date": "2019-01-15T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Received",
    "Created": "2019-01-15T11:14:21.953",
    "Quantity": 7
  },
  {
    "Number": "19.01.15.000000002",
    "Date": "2019-01-15T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Received",
    "Created": "2019-01-15T11:07:44.59",
    "Quantity": 3
  },
  {
    "Number": "19.01.15.000000001",
    "Date": "2019-01-15T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Received",
    "Created": "2019-01-15T10:43:41.89",
    "Quantity": 2
  },
  {
    "Number": "19.01.14.000000001",
    "Date": "2019-01-14T00:00:00",
    "Courier": "JNI",
    "Outlet": "Outlet 1",
    "OutletCode": "OT1",
    "Destination": "Outlet 2",
    "DestinationCode": "OT2",
    "TypeName": "Restock",
    "Status": "Received",
    "Created": "2019-01-14T16:08:48.027",
    "Quantity": 10
  }
]

Delete TransferOrder

Request

Previous Endpoint: /api/v3/OutletDelivery. As for now, both the new & the old ones can be use.

Delete Outlet Delivery

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

Bodyapplication/json

OutletSourcestringrequired

Outlet source name

Numberstringrequired

Delivery number

DealPOS API (3.1.0)

Welcome Developer

Token

Category

Product

Variant

Serial

Estimate

Sales Order

Invoice

Shift

Report

Customer

Comment

Supplier

Invoice Payment

Bill Payment

Invoice Write Off

Inventory

Inventory Log

Inventory Adjustment

Bill

OutboundLogistic

InboundLogistic

TransferOrder

Create TransferOrder

Request

Responses

Was this helpful?

Update TransferOrder

Request

Responses

Was this helpful?

List TransferOrder

Request

Responses

Was this helpful?

Delete TransferOrder

Request