Picklist

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

TransferOrder

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

Operations

Picklist

Operations related to picklist, including create, get, etc

Operations

Get PickList by Number

Request

Get PickList Detail by Number

Required Group Role: "Fulfillment" - "VIEW"

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?FulfillmentOutlet=string&Number=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

Request

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


Get list of PickList

Required Group Role: "Fulfillment" - "VIEW"

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?%20PageNumber=0&From=2019-08-24&FulfillmentOutlet=string&OrderOutlet=string&PageSize=0&State=string&To=2019-08-24' \
  -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"

Bodyapplication/json
OrderOutletstringrequired

Outlet that received order from customer

Numberstringrequired

Order Number

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

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"

Path
idstringrequired

PickListID