Skip to content
/
List OutboundLogistic Wit...

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

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

List OutboundLogistic

Request

Get a list of customer deliveries within a date range. Requires the "VIEW" role in the "Logistic" module.

Security
OAuth2_clientCredentials
Query
Fromstringrequired

From Date (format: yyyy-mm-dd)

Example: From=2020-04-01
Tostringrequired

To Date (format: yyyy-mm-dd)

Example: To=2020-04-30
PageNumbernumberrequired

The number of page data to be displayed

Example: PageNumber=1
PageSizenumberrequired

The number of rows returned by the API

Example: PageSize=10
Outletstring

Name of the outlet. if Outlet provided, OutletID will be ignored

Example: Outlet=Outlet1
OutletIDstring

Guid of Outlet ID. if OutletID provided, Outlet name will be ignored

Example: OutletID=30b10eae-8a4e-43de-8a37-4bb2b1807280
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/OutboundLogistic?From=2020-04-01&To=2020-04-30&PageNumber=1&PageSize=10&Outlet=Outlet1&OutletID=30b10eae-8a4e-43de-8a37-4bb2b1807280' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
Outletstring

Outlet where the transaction is created

Numberstring

Invoice Number

OrderOutletstring

Outlet where the Order is created

OrderNumberstring

Order Number get from Invoice

Customerstring

Customer's name

Datestring

Transaction date

Deliverystring

Delivery status

Enum"Sent""Unsent""Partial"
Timestring

Delivery time

]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Number": "20.04.00082",
    "OrderOutlet": "Outlet1",
    "OrderNumber": "JX20.04.00082",
    "Customer": "Ferdi",
    "Date": "2020-04-17T00:00:00",
    "Delivery": "Sent",
    "Time": "2020-04-17T15:01:00"
  },
  {
    "Outlet": "Outlet1",
    "Number": "20.04.00081",
    "OrderOutlet": "Outlet1",
    "OrderNumber": "JX20.04.00081",
    "Customer": "Ferdi",
    "Date": "2020-04-17T00:00:00",
    "Delivery": "Sent",
    "Time": "2020-04-17T14:30:00"
  }
]

Delete OutboundLogistic

Request

Delete a customer delivery by number and outlet or outlet ID. Requires the "DELETE" role in the "Logistic" module.

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Delivery Number

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

Responses

Bodyapplication/json
Messagestring

Success message

Response
application/json
{
  "Message": "Customer Delivery 925a9ce8-96a0-4c38-92d5-f8b5a9599bc2 has been deleted!"
}

Create OutboundLogistic New

Request

Use this API to send an Outbound Logistic from an Invoice and set tracking number

Security
OAuth2_clientCredentials
Bodyapplication/json
Outletstringrequired

Name of the outlet that the Outbound Logistic is being sent from

Example: "Outlet1"
Numberstringrequired

Number for the Outbound Logistic, such as a tracking number

Example: "JX5015988509"
Datestring(date)required

Date of the Outbound Logistic

Example: "2024-06-20"
OrderOutletstringrequired

Name of the outlet where the Invoice is created

Example: "Outlet1"
OrderNumberstringrequired

Invoice Number for the Outbound Logistic

Example: "578768195128690624"
DispatchFromPickListOutletboolean

When true we will first check whether PickList is created for the Order.It will then use the Outlet that is specified in the PickList not the Outlet that is specified in the json payload

Example: false
MultipleEnabledFromPickListOutletboolean

When multiple picklist detected and MultipleEnabled set to false, OutboundLogistic is not processed

Example: true
VariantsArray of objects

When this property is not available, the system will create Outbound Logistic with all variants in the Invoice. When this property is available, the system will only create Outbound Logistic with the specified variants and quantity in this property.

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/OutboundLogistic/New \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "JX5015988509",
    "Date": "2024-06-20",
    "OrderOutlet": "Outlet1",
    "OrderNumber": "578768195128690624",
    "DispatchFromPickListOutlet": false,
    "MultipleEnabledFromPickListOutlet": true,
    "Variants": [
      {
        "Code": "2012",
        "Quantity": 6
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring(guid)

ID of the created Outbound Logistic

Example: "712098c6-0703-4e36-9679-c14dbeb4e3fe"
Response
application/json
{
  "ID": "712098c6-0703-4e36-9679-c14dbeb4e3fe"
}

Get OutboundLogistic By Number

Request

Get customer delivery (outbound logistic) details by delivery number. Requires the "VIEW" role in the "Logistic" group.

Security
OAuth2_clientCredentials
Query
Numberstringrequired

Number of customer delivery

Example: Number=20.04.00018
Outletstring

Outlet name of customer delivery. if Outlet provided, OutletID will be ignored

Example: Outlet=Outlet1
OutletIDstring

Guid of Outlet ID. if OutletID provided, Outlet name will be ignored

Example: OutletID=30b10eae-8a4e-43de-8a37-4bb2b1807280
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/OutboundLogistic/Number?Number=20.04.00018&Outlet=Outlet1&OutletID=30b10eae-8a4e-43de-8a37-4bb2b1807280' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
Outletstring

Outlet where the transaction is created

Numberstring

Transaction Number

Datestring

Transaction date

Customerobject

Customer's data

CreatorIDstring

User who create the transaction

Createdstring

Transaction created date

VariantsArray of objects
Response
application/json
{
  "Outlet": "Outlet1",
  "Number": "20.04.00018",
  "Date": "2020-04-29T00:00:00",
  "Customer": {},
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-04-29T12:02:26.903",
  "Variants": [
    { … }
  ]
}

Get OutboundLogistic By Order Number

Request

Also available as HTTP POST with the same endpoint


Get Customer Delivery By Order / Invoice Number

Required Group Role: "Logistic" - "VIEW"

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Outletstringrequired

Outlet name of customer delivery

Example: "Outlet1"
Numberstringrequired

Number of customer delivery

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

Responses

Successful operation

Bodyapplication/json
One of:
Array [
Outletstring

Destination Outlet Name

Numberstring

Outbound Logistic Number

Datestring

Transaction date

Createdstring

Transaction created date

]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Number": "1-OLT1/22/07/0021",
    "Date": "2022-07-06T00:00:00",
    "Created": "2022-07-06T09:37:53.937"
  },
  {
    "Outlet": "Outlet1",
    "Number": "1-OLT1/22/07/0021_2",
    "Date": "2022-07-06T00:00:00",
    "Created": "2022-07-06T09:38:05.857"
  }
]

List OutboundLogistic With Total Count

Request

Get a list of customer deliveries (outbound logistics) with total count. Requires the "VIEW" role in the "Logistic" group.

Security
OAuth2_clientCredentials
Query
Fromstringrequired

From Date (format: yyyy-mm-dd)

Example: From=2020-04-01
Tostringrequired

To Date (format: yyyy-mm-dd)

Example: To=2020-04-30
PageNumbernumberrequired

The number of page data to be displayed

Example: PageNumber=1
PageSizenumberrequired

The number of rows returned by the API

Example: PageSize=10
Outletstring

Name of the outlet. if Outlet provided, OutletID will be ignored

Example: Outlet=Outlet1
OutletIDstring

Guid of Outlet ID. if OutletID provided, Outlet name will be ignored

Example: OutletID=30b10eae-8a4e-43de-8a37-4bb2b1807280
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/OutboundLogistic/WithTotalCount?From=2020-04-01&To=2020-04-30&PageNumber=1&PageSize=10&Outlet=Outlet1&OutletID=30b10eae-8a4e-43de-8a37-4bb2b1807280' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total Count of the result

Response
application/json
{
  "Data": [
    { … },
    { … }
  ],
  "TotalCount": 100
}

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

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