Skip to content
/
List of New Order Fulfill...

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

TransferOrder

Operations related to transfer order, including create, get, etc

Operations

Fulfillment

Operations related to fulfillment, including create, get, etc

Operations

List of New Order Fulfillment

Request

Get list of New Order Fulfillment that is not yet picked Required Group Role: "Fulfillment" - "VIEW"

Security
OAuth2_clientCredentials
Query
Fromstring(date)

From Date (format: yyyy/mm/dd)

Tostring(date)

To Date (format: yyyy/mm/dd)

PageNumberintegerrequired

The number of page data to be displayed

Example: PageNumber=1
PageSizeintegerrequired

The number of rows returned by the API

Example: PageSize=20
FulfillmentstringPartial / Unsent

Status of Fulfillment

curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Fulfillment/NewOrder?From=2019-08-24&To=2019-08-24&PageNumber=1&PageSize=20&Fulfillment=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
Outletstring

Outlet Name that fultillment later

Numberstring

Invoice Number

Customerstring

Customer's name

Createdstring

Invoice Created Time

SalesNTaxnumber

Total Amount of Sales and Tax

Paymentstring

Payment State

Fulfillmentstring

Fulfillment State

]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Number": "22.08.029",
    "Customer": "Hendry W",
    "Created": "2022-03-31T11:31:31.783",
    "SalesNTax": 1000000,
    "Payment": "Paid",
    "Fulfillment": "Partial"
  }
]

List of New Order Fulfillment With Product

Request

Get list of New Order Fulfillment with product that is not yet picked Required Group Role: "Fulfillment" - "VIEW"

Security
OAuth2_clientCredentials
Query
Fromstring(date)

From Date (format: yyyy/mm/dd)

Tostring(date)

To Date (format: yyyy/mm/dd)

PageNumberintegerrequired

The number of page data to be displayed

Example: PageNumber=1
PageSizeintegerrequired

The number of rows returned by the API

Example: PageSize=20
FulfillmentstringPartial / Unsent

Status of Fulfillment

curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Fulfillment/NewOrderWithProduct?From=2019-08-24&To=2019-08-24&PageNumber=1&PageSize=20&Fulfillment=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
Outletstring

Outlet Name that fultillment later

Numberstring

Invoice Number

Customerobject
Createdstring

Invoice Created Time

SalesNTaxnumber

Total Amount of Sales and Tax

Paymentstring

Payment State

Fulfillmentstring

Fulfillment State

LogisticServiceNamestring

Logistic Service Name

VariantsArray of objects
]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Number": "22.08.029",
    "Customer": { … },
    "Created": "2022-03-31T11:31:31.783",
    "SalesNTax": 1000000,
    "Payment": "Paid",
    "Fulfillment": "Partial",
    "LogisticServiceName": "JNE Regular",
    "Variants": [ … ]
  }
]

List of New Order Fulfillment With Product and Total Count

Request

Get list of New Order Fulfillment with product that is not yet picked Required Group Role: "Fulfillment" - "VIEW"

Security
OAuth2_clientCredentials
Query
Fromstring(date)

From Date (format: yyyy/mm/dd)

Tostring(date)

To Date (format: yyyy/mm/dd)

PageNumberintegerrequired

The number of page data to be displayed

Example: PageNumber=1
PageSizeintegerrequired

The number of rows returned by the API

Example: PageSize=20
FulfillmentstringPartial / Unsent

Status of Fulfillment

curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Fulfillment/NewOrderWithProduct/TotalCount?From=2019-08-24&To=2019-08-24&PageNumber=1&PageSize=20&Fulfillment=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total Count of New Order Fulfillment with product

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

Get PickList by Number

Request

Get PickList Detail by Number

Required Group Role: "Fulfillment" - "VIEW"

Security
OAuth2_clientCredentials
Query
Numberstringrequired

PickList Number

FulfillmentOutletstringrequired

Outlet that send the product of order created

OrderOutletstringrequired

Outlet that received order from customer

curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/PickList/Number?Number=string&FulfillmentOutlet=string&OrderOutlet=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
IDstring

PickList ID

Datestring

Picklist created time

Numberstring

PickList Number

OrderOutletstring

Outlet that received order from customer

FulfillmentOutletstring

Outlet that is assigned to send the Product

CreatorIDstring

User's picklist created

Statestring

State of Picklist (Picked /Assigned / Packed / Shipped)

Customerobject

Data of Customer

VariantsArray of objects

Variant of picklist

Recipientobject

Detail of Recipient

Notestring

Picklist note

]
Response
application/json
[
  {
    "ID": "aad4a789-b802-49c1-b66f-f45fbc7ce17f",
    "Date": "2022-08-31T13:29:07.29",
    "Number": "22.12.0001",
    "OrderOutlet": "Outlet1",
    "FulfillmentOutlet": "Outlet2",
    "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
    "State": "Picked /Packed /Shipped",
    "Customer": { … },
    "Variants": [ … ],
    "Recipient": { … },
    "Note": "Ready to send"
  },
  {
    "ID": "aad4a789-b802-49c1-b66f-f45fbc7ce17f",
    "Date": "2022-08-31T13:29:07.29",
    "Number": "22.12.0001",
    "OrderOutlet": "Outlet1",
    "FulfillmentOutlet": "Outlet2",
    "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
    "State": "Picked /Packed /Shipped",
    "Customer": { … },
    "Variants": [ … ],
    "Recipient": { … },
    "Note": "Ready to send"
  }
]

Get PickList with Product and Total Count

Request

Get list of Picklist Fulfillment with product Required Group Role: "Fulfillment" - "VIEW"

Security
OAuth2_clientCredentials
Query
Fromstring(date)

From Date (format: yyyy/mm/dd)

Tostring(date)

To Date (format: yyyy/mm/dd)

PageNumberintegerrequired

The number of page data to be displayed

PageSizeintegerrequired

The number of rows returned by the API

FulfillmentOutletstring

Outlet that is assigned to send the Product

OrderOutletstring

Outlet that received order from customer

StatestringPicked / Assigned / Packed / Shipped

State of Fulfillment. If property not send, it will shown state of All fulfillment list

curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/PickList/TotalCount?From=2019-08-24&To=2019-08-24&PageNumber=0&PageSize=0&FulfillmentOutlet=string&OrderOutlet=string&State=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total Count of New Order Fulfillment with product

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

Get PickList

Request

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


Get list of PickList

Required Group Role: "Fulfillment" - "VIEW"

Security
OAuth2_clientCredentials
Query
Fromstring(date)required

From Date (format: yyyy/mm/dd)

Tostring(date)required

To Date (format: yyyy/mm/dd)

PageNumberintegerrequired

The number of page data to be displayed

PageSizeintegerrequired

The number of rows returned by the API

FulfillmentOutletstring

Outlet that is assigned to send the Product

OrderOutletstring

Outlet that received order from customer

StatestringPicked / Assigned / Packed / Shipped

State of Fulfillment. If property not send, it will shown state of All fulfillment list

curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/PickList?From=2019-08-24&To=2019-08-24&+PageNumber=0&PageSize=0&FulfillmentOutlet=string&OrderOutlet=string&State=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
FulfillmentOutletstring

Outlet that is assigned to send the Product

OrderOutletstring

Outlet that received order from customer

Numberstring

Order Number

Customerstring

Customer's name

Createdstring

Pick Created Time

]
Response
application/json
[
  {
    "FulfillmentOutlet": "Outlet2",
    "OrderOutlet": "Outlet1",
    "Number": "22.08.029",
    "Customer": "Hendry W",
    "Created": "2022-03-31T11:31:31.783"
  }
]

Create PickList

Request

Create New Pick from Order Outlet

Required Group Role: "Fulfillment" - "CREATED"

Security
OAuth2_clientCredentials
Bodyapplication/json
OrderOutletstringrequired

Outlet that received order from customer

Numberstringrequired

Order Number

AssignToIDstring(Guid)

User ID that is assigned to create Pick

Notestring

Note of Pick

VariantsArray of objectsrequired
Variants[].​Codestringrequired

Variant Code

Variants[].​Fulfillmentstringrequired

Outlet that is assigned to send the Product

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/PickList \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "OrderOutlet": "Outlet1",
    "Number": "22.08.029",
    "AssignToID": "ddbde8f8-152f-12a4-989b-98b999cccbad",
    "Note": "",
    "Variants": [
      {
        "Code": "CAP01",
        "Fulfillment": "Outlet2"
      },
      {
        "Code": "SHI01",
        "Fulfillment": "Outlet4"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
ListIDArray of strings
Messagestring
Response
application/json
{
  "ListID": [
    "aad4a789-b802-49c1-b66f-f45fbc7ce17f",
    "ccd4a789-3w02-4931-a66f-f45fbwf2e17f"
  ],
  "Message": "2 records created"
}

Delete PickList

Request

Delete existing Picklist

Security
OAuth2_clientCredentials
Bodyapplication/json
FulfillmentOutletstringrequired

Outlet that is assigned to send the Product

OrderOutletstringrequired

Outlet that received order from customer

Numberstringrequired

Order Number

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

Responses

OK

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Pick Fulfillment deleted"
}

Get PickList by ID

Request

Get PickList Detail by ID

Required Group Role: "Fulfillment" - "VIEW"

Security
OAuth2_clientCredentials
Path
idstringrequired

PickListID

curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/PickList/ID/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
IDstring

PickList ID

Datestring

Picklist created time

Numberstring

PickList Number

OrderOutletstring

Outlet that received order from customer

FulfillmentOutletstring

Outlet that is assigned to send the Product

CreatorIDstring

User's picklist created

Statestring

State of Picklist (Picked /Assigned / Packed / Shipped)

AssignTostring

LoginID that assigned a pick

Customerobject

Data of Customer

VariantsArray of objects

Variant of picklist

Recipientobject

Detail of Recipient

Notestring

Picklist note

Response
application/json
{
  "ID": "aad4a789-b802-49c1-b66f-f45fbc7ce17f",
  "Date": "2022-08-31T13:29:07.29",
  "Number": "22.12.0001",
  "OrderOutlet": "Outlet1",
  "FulfillmentOutlet": "Outlet2",
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "State": "Picked /Assigned / Packed /Shipped",
  "Customer": {
    "Name": "Ventines",
    "Mobile": "0811541541",
    "Email": "ventines@gmail.com",
    "Address": "Jl. Muara Karang Raya"
  },
  "Variants": [
    { … },
    { … }
  ],
  "Recipient": {
    "Name": "Ventines",
    "Phone": "0811541541",
    "City": "Jakarta",
    "Address": "Jl. Muara Karang Raya"
  },
  "Note": "Ready to send"
}

Assign Picklist

Request

Assigned User.LoginID picklist

Required Group Role: "Fulfillment" - "EDIT"

*Recommended to use Request example by PickListID cause it more faster and specific

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Array [
PickListIDstringrequired

PickList ID

AssignTostringrequired

Name of User.LoginID that assigned the picklist (if property empty, it will be assigned to active UserID)

]
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/PickList/Assign \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "PickListID": "2a346a70-d7c5-4e4b-947c-300f516b1560",
      "AssignTo": "Nayeon"
    },
    {
      "PickListID": "d0d8dc77-2b28-49a9-b78a-de102a3081b7",
      "AssignTo": "Jihyo"
    }
  ]'

Responses

OK

Bodyapplication/json
Messagestringnon-emptyrequired
Response
application/json
{
  "Message": "2 data successfully updated from pick to assigned"
}

Pack PickList

Request

Set Assigned to Pack or Pick to Pack PickList

Required Group Role: "Fulfillment" - "CREATED"

Security
OAuth2_clientCredentials
Bodyapplication/jsonArray [
FulfillmentOutletstringrequired

Outlet that is assigned to send the Product

OrderOutletstringrequired

Outlet that received order from customer

Numberstringrequired

Number of Order Created

]
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/PickList/Pack \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "FulfillmentOutlet": "Outlet2",
      "OrderOutlet": "Outlet1",
      "Number": "22.08.029"
    },
    {
      "FulfillmentOutlet": "Outlet1",
      "OrderOutlet": "Outlet1",
      "Number": "22.08.029"
    }
  ]'

Responses

OK

Bodyapplication/json
Messagestringnon-emptyrequired
Response
application/json
{
  "Message": "3 data successfully updated from pick to pack"
}

Ship PickList

Request

Set Pack to Ship PickList

Required Group Role: "Fulfillment" - "CREATED"

Security
OAuth2_clientCredentials
Bodyapplication/jsonArray [
FulfillmentOutletstringrequired

Outlet that is assigned to send the Product

OrderOutletstringrequired

Outlet that received order from customer

Numberstringrequired

Number of Order Created

]
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/PickList/Ship \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "FulfillmentOutlet": "Outlet2",
      "OrderOutlet": "Outlet1",
      "Number": "22.08.029"
    },
    {
      "FulfillmentOutlet": "Outlet1",
      "OrderOutlet": "Outlet1",
      "Number": "22.08.029"
    }
  ]'

Responses

OK

Bodyapplication/json
Messagestringnon-emptyrequired
Response
application/json
{
  "Message": "3 data successfully updated from pick to pack"
}

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

Barcode

Operations related to barcode, 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