Get List Order - Lấy thông tin đơn hàng theo khung thời gian

API lấy thông tin đơn hàng theo một khoảng thời gian:

  • Mặc định không truyền dữ liệu thời gian sẽ được lấy mặc định trong vòng 7 ngày của ngày đặt đơn(order_date) (từ ngày hiện tại lùi về 7 ngày)

            VD: order_date_from: 2020/06/21 (từ 00 giờ 00 phút 00 giây),  order_date_to: 2020/06/27 (đến 23 giờ 59 phút 59 giây)

  • Tìm kiếm theo order_status_date sẽ chỉ được phép trong phạm vi 3 ngày.

            VD: order_status_date_from: 2020/06/21 (từ 00 giờ 00 phút 00 giây),  order_status_date_to: 2020/06/23 (đến 23 giờ 59 phút 59 giây)

  • Tìm kiếm theo Token sẽ lấy điều kiện tìm kiếm theo thông tin trên Tokenbỏ qua các thông tin khác trên bộ lọc.

  • Token có thời gian hết hạn, phải bỏ token hết hạn ra để có thể tiếp tục tìm kiếm.

Changed history

Description

Date

Author

Description

Date

Author

Add field shop_program_name (sales_order)

Add field shop_program_amount (sales_order)

Aug 3, 2020

@Nguyen Tran Buu (Unlicensed)

Add field receiver_email (sales_order)

Apr 6, 2021

@Nguyen Tran Buu (Unlicensed)

Tham số:

Parameter

Mô tả

Bắt buộc

Ví dụ

Parameter

Mô tả

Bắt buộc

Ví dụ

order_date_from

Bắt đầu từ ngày (ngày đặt hàng), định dạng yyyy/MM/dd

Không

string, example: 2020/06/01

order_date_to

Đến ngày (ngày đặt hàng), định dạng yyyy/MM/dd

Không

string, example: 2020/06/30

order_status_date_from

Bắt đầu từ ngày (ngày thay đổi trạng thái đơn hàng), định dạng yyyy/MM/dd

Không

string, example: 2020/06/01

order_status_date_to

Đến ngày (ngày thay đổi trạng thái đơn hàng), định dạng yyyy/MM/dd

Không

string, example: 2020/06/03

order_status

Trạng thái đơn hàng (info: http://prntscr.com/olu3xh)

Không

int, example: 2  

page_size

Giới hạn số lượng trên 1 trang, mặc định là 10 và tối đa là 50

Không

int, example: 10

token

Shop lấy dữ cho trang tiếp theo hoặc trang trước đó shop cần điền thông tin vào token tương ứng ở output:

  • token = next_token: trang tiếp theo

  • token = previous_token: Trang trước đó

Hệ thống sẽ ưu tiên lấy data theo thông tin nhập vào token và bỏ qua các thông tin: order_date_from, order_date_to, order_status_date_from, order_status_date_to, order_status, page_size. Trường hợp token = "" hệ thống sẽ mặc định lấy trang đầu tiên với các thông tin yêu cầu order_date_from, order_date_to, order_status_date_from, order_status_date_to, order_status, page_size

Không

string, example: "qPupq15TljMzG6Vtf14MYEN/oRIe2TS........."

Fields

Tên field

Diễn giải/ viết tắt

Tên field

Diễn giải/ viết tắt

boolean

Dữ liệu có thể tồn tại:

  • true/false 

  • yes/no 

  • Có/Không

sp

sản phẩm

 

Tên field

Tên diễn giải

kiểu dữ liệu

Mô tả

Tên field

Tên diễn giải

kiểu dữ liệu

Mô tả

order_number

Mã đơn hàng

string

Mã đơn hàng

order_status

Trạng thái đơn hàng

int

Xem chi tiết

payment_method

Phương thức thanh toán

int

Xem chi tiết

total_amount

Tổng tiền hàng

float64

Tổng tiền hàng >=0

sub_total - seller_shipping_fee + sendo_support_fee - senpay_free_shipping - voucher_value (voucher_value = 0 nếu is_shop_voucher == false ) - buyer_loyalty_amount - mobile_discount_amount - installment_fee - affiliate_total_amount - senpay_fee - declare_value_fee

total_amount_buyer

Tổng tiền người mua phải trả

float64

 

sub_total

Tổng tiền sản phẩm

float64

 

buyer_phone

Số điện thoại người mua

string

 

buyer_address

Địa chỉ người mua

text

 

ship_from_address

Địa chỉ lấy hàng

text

 

ship_to_address

Địa chỉ người nhận

text

 

ship_to_region_id

ID vùng nhận (vùng miền trong nước)

int

 

ship_to_district_id

ID quận nhận

int

 

ship_to_ward

Phường xã nhận hàng

text

 

receiver_full_address

Địa chỉ người nhận (đầy đủ)

text

Địa chỉ, phường xã, quận huyện, tỉnh thành

shipping_contact_phone

Số điện thoại người nhận

string

 

receiver_name

Tên người nhận

text

 

sale_product_type

Loại đơn hàng

int

1: Vật lý, 2: Voucher, 3: E-Voucher 

order_date_time_stamp

Ngày tạo đơn

int64

Kiểu Unix Timestamp (https://www.epochconverter.com/)

fds_expired_time

Thời gian đơn hàng kiểm tra gian lận

int

fds_expired_time = 5 => 5 phút (5 minutes)

sales_order_details

Chi tiết đơn hàng

object

Xem thông tin mô tả sku_details

shop_program_name

Tên trương trình Shop đăng kí

string

VD: “ShopPlus”

shop_program_amount

Giá tiền shop đăng kí theo trương trình

float64

Phụ thuộc vào shop_program_name

receiver_email

Email người nhận

string

Chỉ hiện thị thông tin đối với đơn hàng E-voucher (sale_product_type = 3)

sku_details

Tên field

Diễn giải

Kiểu dữ liệu

Mô tả

Tên field

Diễn giải

Kiểu dữ liệu

Mô tả

product_name

product_nameTên sản phẩm

text

 

sku

Mã sản phẩm

text

 

quantity

Số lượng

int

 

price

Giá sản phẩm

float64

 

product_variant_id

Id sản phẩm

int

 

Code Snippet request

CURL
curl -X POST \ https://open.sendo.vn/api/partner/salesorder/search \ -H 'Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTdG9yZUlkIjoiMTAwMDc1IiwiVXNlck5hbWUiOiIiLCJTdG9yZVN0YXR1cyI6IjIiLCJTaG9wVHlwZSI6IjEiLCJTdG9yZUxldmVsIjoiIiwiZXhwIjoxNTkxMDk1MzgxLCJpc3MiOiIxMDAwNzUiLCJhdWQiOiIxMDAwNzUifQ.WPABNcaAI5Y0opBDISlgAqrefEIatZ2XUZxu803Blvk' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "page_size": 10, "order_status": 2, "order_date_from": "2020/06/21", "order_date_to": "2020/06/27", "order_status_date_from": null, "order_status_date_to": null, "token": null }'

Code Snippet response

  • total_records: Tổng số đơn hàng khớp điều kiện tìm kiếm

  • next_token : Token để nhập vào điều kiện tìm kiếm để lấy danh sách kế tiếp (Điều kiện: Vẫn còn kết quả tìm kiếm ở trang kế tiếp).

  • previous_token: Token để nhập vào điều kiện tìm kiếm để lấy danh sách trước đó (Điều kiện: Bắt đầu từ trang thứ 2).

Sample response
{ "result": { "data": [ { "sales_order": { "order_number": "14681432381", "order_status": 13, "payment_status": 1, "payment_method": 1, "total_amount": 389000, "total_amount_buyer": 402000, "sub_total": 402000, "buyer_phone": "0903607111", "buyer_address": "Tòa nhà FPT Tân Thuận, Lô L29B-31B—33B, đường số 8, KCX Tân Thuận", "ship_from_address": "123 Nguyễn Đình Chiểu", "ship_to_address": "Tòa nhà FPT Tân Thuận, Lô L29B-31B—33B, đường số 8, KCX Tân Thuận", "ship_to_region_id": 1, "ship_to_district_id": 7, "ship_to_ward": "Phường Tân Thuận Đông", "receiver_full_address": "", "shipping_contact_phone": "0903601234", "receiver_name": "Nguyen Tran", "sale_product_type": 3, "order_date_time_stamp": 1592710705, "can_action": true, "fds_expired_time": null, "shop_program_name": "", "shop_program_amount": 0, "receiver_email": "aloha@gmail.edu.com" }, "sku_details": [ { "product_variant_id": 28146364, "product_name": "[SPTest] Bông Tẩy Trang BeoLa", "sku": "nl29032020357", "quantity": 1, "price": 201000 }, { "product_variant_id": 28146364, "product_name": "[SPTest] Bông Tẩy Trang BeoLa", "sku": "nl29032020357", "quantity": 1, "price": 201000 } ] }, { "sales_order": { "order_number": "142873638562", "order_status": 2, "payment_status": 1, "payment_method": 1, "total_amount": 1000000, "total_amount_buyer": 1023000, "sub_total": 1000000, "buyer_phone": "0903601234", "buyer_address": "18", "ship_from_address": "123 Nguyễn Đình Chiểu", "ship_to_address": "18", "ship_to_region_id": 1, "ship_to_district_id": 1, "ship_to_ward": "Phường Cầu Kho", "receiver_full_address": "18 ,Phường Cầu Kho ,Quận 1 ,Hồ Chí Minh", "shipping_contact_phone": "0903601234", "receiver_name": "Nguyen Tran", "sale_product_type": 1, "order_date_time_stamp": 1590501285, "can_action": false, "fds_expired_time": 15, "shop_program_name": "", "shop_program_amount": 0, "receiver_email": "" }, "sku_details": [ { "product_name": "Áo sơ mi 1", "sku": "huygenhuygen-Free size_Nâu", "quantity": 1, "price": 1000000, "product_variant_id": 16673653 } ] } ], "total_records": 6, "next_token": "TqPupq15TljMzG6Vtf14MYEN/oRIe2TSY6QMicUg4+Av8atS095d4/mosGapTjQDx6cHT2WUQX338ssJXqC5GOA2wphFmrXfXzIJxqV2cfIEDXW7TjcoU6+u0jV/oS2snLGXURwSzpzhL5GNn4g+jr55vhDUX+Qh/fQ+f/9o4dliwgBhuz5IRmCiUMTxqbpUm/nTIeIXAKph/O5bCG2wSyg2fqcPFn5tzlQkuU7b2c+BnlPClr/oI/tuXPPY1Wgndgwsg+k6Nrqm/KtE+hzKrSwN1ggSxD1OeJ2aFfwt8pR7g/UNiV+YOsPjtqlhJUreRghEO2ezb1O1jAECPAJRc39zYD/QfZ+1UWxmPSJpVCjt413qmHAT9WUm+0Gq0UwSvIkxKY0FaaETDbO+DcxDt+9X/X14sYopzq08RXs/tXRXhw6YrUkpm5Ht4rHqrrbTXnPXRg7tRR8272OCZsOt+cWh7ZuooG0+wnljUajZyQQdQ8y8MAPAgY9MGC9NQBAF9J2M/S4aUYphCwj5GSha5xLBnIZ3E6dyT3NOuuBwEdXup134sB0+k35P4XMtDOT/39cD2Zu8TT7KVxnnHtbjcYQy0PU6VZTDuphp0ET2egFRYd9YmJpCwgLlRohNPJqbn3tmThMGMNNhNUQq+SvB5IRhOPZ/fKPVjjYVkHu6+wvwhIwzlbZ5Z/ClEGdtjeX0is6bq9hp6jCJorXhIA26sR8OmxXrTKcCykDDAnm0zupyb0nP1H5srWGr4ah89/VaQBq67LXzw9oQapQKhGlG8zxQtF//lWjLlUz/rdwamiLYImMKRALARPQx+BHbAjB9tRBK37PbvGhYrXv84FPMjFdAwevifdhrRALITlvGukLg5gvyx8fCZgypOMFfyPCK3pyHIHwbNPoB65Ovk/KFxV2LncfVFCvCDQtPLADQLfDJAFdZx4eBEyVgg3wXrkjCC3hv95GPaRLEAzoNhmzFtQaPlWth5lYWMv3kS+Eitum0MaWmCuWR19i7kX7m9E5CGz6k6zhagz/lDQEGbRtmzuvy5FC4/eGyoFBA94qzhqFXBQeYEzSjbFLeNbYnQElplhJXpe8OjKqYDwrzQR1yaA==", "previous_token": "TqPupq15TljMzG6Vtf14MYEN/oRIe2TSY6QMicUg4+Av8atS095d4/mosGapTjQDx6cHT2WUQX338ssJXqC5GOA2wphFmrXfXzIJxqV2cfIEDXW7TjcoU6+u0jV/oS2snLGXURwSzpzhL5GNn4g+jr55vhDUX+Qh/fQ+f/9o4dliwgBhuz5IRmCiUMTxqbpUm/nTIeIXAKph/O5bCG2wSyg2fqcPFn5tzlQkuU7b2c+BnlPClr/oI/tuXPPY1Wgndgwsg+k6Nrqm/KtE+hzKrSwN1ggSxD1OeJ2aFfwt8pR7g/UNiV+YOsPjtqlhJUreRghEO2ezb1O1jAECPAJRc39zYD/QfZ+1UWxmPSJpVCjt413qmHAT9WUm+0Gq0UwSvIkxKY0FaaETDbO+DcxDt+9X/X14sYopzq08RXs/tXRXhw6YrUkpm5Ht4rHqrrbTXnPXRg7tRR8272OCZsOt+cWh7ZuooG0+wnljUajZyQQdQ8y8MAPAgY9MGC9NQBAF9J2M/S4aUYphCwj5GSha5xLBnIZ3E6dyT3NOuuBwEdXup134sB0+k35P4XMtDOT/39cD2Zu8TT7KVxnnHtbjcYQy0PU6VZTDuphp0ET2egFRYd9YmJpCwgLlRohNPJqbn3tmThMGMNNhNUQq+SvB5IRhOPZ/fKPVjjYVkHu6+wv+pJ5jntbLF21MCEDk0asB1zQQjuwUBuX6ZyavbLCgmPWdZmSVzWs/UIPTUhJDmPHrp8xZA9e4dG/yVb8koLkI/MT+s63TOJsWGkfWtesOpAEtk/4LuaNE3Ar1MDxZz4JoODh/Ibnlc4GFgyXKNtu1TucMDFQ2Vr07za5tKCbV9aX8EXI7ls/4sDvjDtwoQ4gfa1I2/mTLoiy7QoVtwVjVcANItmZaHtmn0eIEAdjQhcjZ9qoILNZoGD47o1U939Nz+HyrL2B0DvNC8ZsbUCuF8EwT+o/LWgO0UGYnb2LWgVTNR6yT6gj9YJJSvvDYXWhuvdzOD2OZCaDta9AUxjpCp8D8kRx53v6TU1PHaGDAKJFqH8zA7JDvCg4SJjrPZq2Flg9+/NBo+4eH2kLfQHZwn5myCscRVTPrQqPJgY2CfzC5cdyJejWQJl1udkS5BlQ=" }, "success": true, "error": null, "status_code": 200 }