Skip to content
/
Create InboundLogistic

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

InboundLogistic

Operations related to inbound logistic, including create, get, etc

Operations

List InboundLogistic

Request

Get a list of inbound logistics (supplier deliveries) with optional date and outlet filters. Requires the "View" role in the "Logistic" module.

Security
OAuth2_clientCredentials
Query
Fromstring

From Date

Example: From=2024-02-01
Tostring

To Date

Example: To=2024-02-28
PageNumberintegerrequired

The Page of data to be displayed

Example: PageNumber=1
PageSizeintegerrequired

The number of rows returned by the API

Example: PageSize=20
Outletstring

Outlet name that you want to filter

Example: Outlet=Outlet1
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/InboundLogistic?From=2024-02-01&To=2024-02-28&PageNumber=1&PageSize=20&Outlet=Outlet1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [
Outletstring

Outlet's Name

Numberstring

Transaction Number

Supplierstring

Supplier's Name

PONumberstring

Purchase Order Number

Datestring

Date of Inbound Logistics created

]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Number": "20.04.00082",
    "Supplier": "Stephen",
    "PONumber": "20.04.00082",
    "Date": "2024-02-20T15:01:00"
  },
  {
    "Outlet": "Outlet1",
    "Number": "20.04.00081",
    "Supplier": "Stephen",
    "PONumber": "20.04.00081",
    "Date": "2024-02-18T14:30:00"
  }
]

Create InboundLogistic

Request

Receive a supplier delivery (inbound logistic) by number. Requires the "DelC" role in the "Logistic" module; if purchase workflow approval is configured, the "PurA" role in the "Buy" module may be required.

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Outletstringrequired

Name of the outlet

Example: "Outlet1"
Numberstringrequired

Number of the Customer Delivery

Example: "21.05.00007"
FulfillmentOutletstringrequired

Stock in this outlet will be reduced. Backwards compatibility with property "DeliveryOutlet"

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

Responses

Bodyapplication/json
IDstring
OrderFulfillmentStatestring
Example: "Received / Partial"
Response
application/json
{
  "ID": "712098c6-0703-4e36-9679-c14dbeb4e3fe",
  "OrderFulfillmentState": "Received"
}

Delete Inbound Logistic

Request

Delete an inbound logistic entry. Requires the "DELETE" role in the "Logistic" module.

Security
OAuth2_clientCredentials
Bodyapplication/json
Outletstringrequired

Outlet Name

Numberstringrequired

Fulfillment Number

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

Responses

OK

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Inbound Logistic number 21.12.00123 has been deleted!"
}

List InboundLogistic by BillID

Request

Get a list of inbound logistics (supplier deliveries) filtered by BillID

Security
OAuth2_clientCredentials
Query
IDstringrequired

Bill ID

Example: ID=bcb2fff2-916a-4f60-9e12-36735d0790a9
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/InboundLogistic/BillID?ID=bcb2fff2-916a-4f60-9e12-36735d0790a9' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
DataArray of objects

List of Inbound Logistics by BillID

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

Get InboundLogistic By Number

Request

Get inbound logistic details by number for a specific outlet. Requires the "VIEW" role in the "Logistic" group.

Security
OAuth2_clientCredentials
Query
Outletstringrequired

Outlet name of Inbound Logistics

Example: Outlet=Outlet1
Numberstringrequired

Number of Inbound Logistics

Example: Number=24.02.00018
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/InboundLogistic/Number?Outlet=Outlet1&Number=24.02.00018' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
Outletstring

Outlet name on the transaction created

Numberstring

Transaction Number

Datestring

Transaction Date

Supplierobject

Supplier's Data

CreatorIDstring

User ID who made the transaction

Createdstring

Transaction created date

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

Get InboundLogistic By Order Number

Request

Get supplier delivery records by order or invoice number. Requires the "VIEW" role in the "Logistic" group.

Security
OAuth2_clientCredentials
Query
Numberstring

Order / Invoice Number of Inbound Logistics

Example: Number=24.02.00012
Outletstring

Outlet name of Inbound Logistics

Example: Outlet=Outlet1
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/InboundLogistic/byOrderNumber?Number=24.02.00012&Outlet=Outlet1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [
Outletstring

Outlet Name

Numberstring

Invoice Number Inbound Logistics

Datestring

Invoice date

Createdstring

Date invoice was created

]
Response
application/json
[
  {
    "Outlet": "Outlet3",
    "Number": "SB.TNG.24.01.0012",
    "Date": "2024-01-21T00:00:00",
    "Created": "2024-01-21T09:37:53.937"
  },
  {
    "Outlet": "Outlet2",
    "Number": "SB.TNG.24.01.0012_2",
    "Date": "2024-01-21T00:00:00",
    "Created": "2024-01-21T09:38:05.857"
  }
]

Get InboundLogistic With Total Count

Request

Get a list of supplier deliveries with total count. Requires the "VIEW" role in the "Logistic" group.

Security
OAuth2_clientCredentials
Query
Fromstringrequired

From Date (format: yyyy-mm-dd)

Example: From=2024-01-17
Tostringrequired

To Date (format: yyyy-mm-dd)

Example: To=2024-01-30
PageNumberintegerrequired

The number of page data to be displayed

Example: PageNumber=1
PageSizeintegerrequired

The number of rows returned by the API

Example: PageSize=20
Outletstringrequired

Outlet Name

Example: Outlet=Outlet1
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/InboundLogistic/WithTotalCount?From=2024-01-17&To=2024-01-30&PageNumber=1&PageSize=20&Outlet=Outlet1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total count of the result

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

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