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

InboundLogistic

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

Operations

List InboundLogistic

Request

Get list of Inbound Logistics

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

Bodyapplication/json
Fromstring

From Date

Tostring

To Date

PageNumberinteger

The Page of data to be displayed

PageSizeinteger

The number of rows returned by the API

Outletstring

Outlet name that you want to filter

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

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

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

Receive supplier delivery based on number

You must have "DelC" role in "Logistic" Module if config Workflow Buy Approve need "PurA" role in "Buy" Module

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

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

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

Get InboundLogistic By Number

Request

Get Inbound Logistic By Number Required Group Role: "Logistic" - "VIEW"

Bodyapplication/json
Outletstringrequired

Outlet name of Inbound Logistics

Numberstringrequired

Number of Inbound Logistics

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

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 By Order / Invoice Number Required Group Role: "Logistic" - "VIEW"

Bodyapplication/json
Outletstringrequired

Outlet name

Numberstringrequired

Invoice Number