Resource URL

https://oms.sokochan.com/api/1.0/orders

---

Parameter(s)

Name	Description	Type	Length
created	Date of creation format YYYY-mm-dd example 2016-12-01	date	-
status	Order status (default is any) any draft pending processed picked packed shipped cancelled	string	30
limit	Number of items per page (max 100)
offset	Result set offset

Example, get order by External ID

curl -X GET -H "Authorization: Basic ZnJlZDpmcmVk="\
"https://oms.sokochan.com/api/1.0/orders"

Example, get order by Sokochan order code

curl -X GET -H "Authorization: Basic ZnJlZDpmcmVk="\
"https://oms.sokochan.com/api/1.0/orders"

Documentation

The fields of the result have the following type and meaning:

Name	Description
orders[]	Array of order object
paging	Paging object

Paging Object

Name	Description
paging.total	Total number of items
paging.limit	Number of items per page
paging.offset	Result set offset

Order Object

Name	Description	Type	Length
external_id	External ID is a unique key that allows you to link Sokochan order with the Order ID from your system.	string	50
order_number	Order number	string	20
comment	Order comment.	string	50
special_order	Special requirement to this order.	string	50
representative	Your representative	string	50
cod_amount	COD amount	decimal	7,2
insert_qty	Insert-item quantity	number	2
wrap	Wrap is 1. No wrap is 0.	number	1
shipping	The shipping method code. EMS is ไปรษณีย์ไทย Express / ThaiPost EMS REG is ไปรษณีย์ไทย ลงทะเบียน / ThaiPost Registered KND is Kerry Express (วันรุ่งขึ้น/Next Day) K2D is Kerry Express (2 วัน/2 Day)	string	3
tracking_no	Tracking No.	string	20
package	Order package	string	6
created	Created Date/Time	datetime	-
updated	Updated Date/Time	datetime	-
status	Order Status draft pending processed picked packed shipped cancelled	string	30
shipping_status	Order Status pending shipping delivered delay	string	30
customer	Customer object
order_items[]	Array of item(s) in order
order_history[]	Array of history item
billing	Billing detail

Customer Object

Name	Description	Type	Length
name	Customer full name	string	200
address	Customer address	string	255
district	District name	string	50
province	Province name	string	50
postal_code	Postal Code	string	20
mobile_no	Mobile number	string	50
phone_no	Phone number	string	20
email	Email	string	180

Order Item Object

Name	Description	Type	Length
item_sku	Item SKU	string	60
item_code	Item code	string	60
item_name	Item name	string	100
item_qty	Item quantity	number	11

History Item Object

Name	Description	Type	Length
date_time	Display date time (fixed format)	number	30
location	Location	string	180
remark	Remark	string	180
timestmap	Unix timestamp	timestamp	-

Billing Object

Name	Description	Type	Length
no_of_item_1	No. of 1st item	number	-
no_of_item_2	No. of item 2-10	number	-
no_of_item_3	No. of item 11+	number	-
picking_fee	Picking Fee	decimal	-
packing_fee	Packing Fee	decimal	-
charge_bubble_wrap	Bubble wrap charge	number	1
charge_insert_time	Insert item charge	timestamp	-
shipping_fee	Shipping Fee	decimal	-
cod_fee	COD Fee	decimal	-
total_fee	Total Fee	decimal	-