OutboundLogistic

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

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

Create OutboundLogistic

Request

Use this API to send an Outbound Logistic from an Invoice.

NOTE: We have 3 hierarchy for Inventory stock reduction.

  1. If [Dispatch] = true, then the inventory will reduce from the selected outlets in Pick Pack Ship, read more about it here: https://support.dealpos.com/en/articles/5990583-create-fulfillment-pick-pack-and-ship

  2. If [Dispatch] = false, then the inventory will reduce from FulfillmentOutlet configuration.

  3. If Fulfillment Outlet is null or empty, then the inventory will reduce from [Outlet] or in which Outlet the Inventory was made.

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

Flowchart of Send Outbound Logistic:

Flowchart Outbound Logistic

Bodyapplication/json
One of:
OutletIDstring

Guid of Outlet ID

Outletstring

Name of the outlet that make a transaction

Example: "Outlet1"
Numberstring

Invoice number. this is primary key for the object

Example: "18.10.00009"
FulfillmentArray of objects

Backwards compatibility with property FulfillmentOutlet"

Example: {"Outlet":"Outlet2","Date":"2024-06-20"}
PicklistArray of objects
VariantsArray of objects

If object Variants filled with empty array or not send, it will sent all products

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/OutboundLogistic \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "18.10.00009",
    "Fulfillment": {
      "Outlet": "Outlet2",
      "Date": "2024-06-20"
    },
    "PickList": {
      "Dispatch": false
    }
  }'

Responses

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

List OutboundLogistic

Request

Previous Endpoint: https://brand.dealpos.net/api/v3/CustomerDelivery. As for now, both the new & the old ones can be use.

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


Get list of Customer Delivery

Required Group Role: "Logistic" - "VIEW"

Bodyapplication/json
One of:
Fromstring

From date

Example: "2020-04-01"
Tostring

To Date

Example: "2020-04-30"
PageNumbernumberrequired

The Page of data to be displayed

Example: 1
PageSizenumberrequired

The number of rows returned by the API

Example: 20
Outletstring

Outlet name that you want to filter

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

Responses

Bodyapplication/jsonArray [
Outletstring

Outlet where the transaction is created

Numberstring

Invoice Number

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",
    "Customer": "Ferdi",
    "Date": "2020-04-17T00:00:00",
    "Delivery": "Sent",
    "Time": "2020-04-17T15:01:00"
  },
  {
    "Outlet": "Outlet1",
    "Number": "20.04.00081",
    "Customer": "Ferdi",
    "Date": "2020-04-17T00:00:00",
    "Delivery": "Sent",
    "Time": "2020-04-17T14:30:00"
  }
]

Delete OutboundLogistic

Request

Previous Endpoint: https://brand.dealpos.net/api/v3/CustomerDelivery. As for now, both the new & the old ones can be use.

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

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!"
}

Get OutboundLogistic By Number

Request

Previous Endpoint: https://brand.dealpos.net/api/v3/CustomerDelivery/Number. As for now, both the new & the old ones can be use.

Also available as HTTP POST with the same endpoint


Get Customer Delivery By Number

Required Group Role: "Logistic" - "VIEW"

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/Number \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "20.04.00018"
  }'

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"

Bodyapplication/json
One of:
Outletstringrequired

Outlet name of customer delivery

Example: "Outlet1"
Numberstringrequired

Number of customer delivery

Example: "20.04.00018"