Danh sách đơn hàng

  • API này dùng để lấy danh sách đơn hàng.

  • Chú ý:

    • Hệ thống chỉ hỗ trợ lấy đơn hàng trong 31 ngày.

    • Hệ thống đang hỗ trợ lọc dữ liệu theo 3 loại ngày:

      • createdAtFrom, createdAtTo: Lọc theo ngày tạo đơn hàng.

      • deliveryAtFrom, deliveryAtTo: Lọc theo ngày giao hàng.

      • updatedAtFrom, updatedAtTo: Lọc theo ngày cập nhật đơn hàng.

    • Nếu bạn không truyền param createdAtFrom mặc định sẽ lấy 31 ngày gần nhất. Nếu bạn muốn lấy dữ liệu các ngày cũ hơn, xin vui lòng truyền createdAtFrom và createdAtTo trong khoảng 31 ngày.

    • Nếu bạn lọc theo id đơn hàng hoặc id khách hàng (hoặc số điện thoại khách hàng) thì có thể bỏ qua việc bắt buộc lọc createdAtFrom, createdAtTo.

    • Nếu bạn hay thường xuyên cần gọi toàn bộ đơn hàng, bạn nên lưu giá trị thời gian lần cuối cùng quét toàn bộ, sau đó dùng 2 request params là updatedAtFrom và updatedAtTo để chỉ lấy về các đơn hàng có cập nhật mới, không cần gọi lại toàn bộ đơn cũ không có thay đổi gì. updatedAtFrom và updatedAtTo cũng bị giới hạn trong vòng 31 ngày, khi bạn lọc theo updatedAtFrom và updatedAtTo sẽ không bị bắt buộc có createdAtFrom và createdAtTo nữa.

Request

curl --location --globoff 'https://pos.open.nhanh.vn/v3.0/order/list?appId={{appId}}&businessId={{businessId}}' \
--header 'Authorization: {{accessToken}}' \
--header 'Content-Type: application/json' \
--data '{
    "filters": {},
    "paginator": {
        "size": 50
    },
    "dataOptions": {}
}'

Filters

Key
Type
Description

createdAtFrom

int

Thời gian tạo từ ngày (định dạng timestamp)

createdAtTo

int

Thời gian tạo đến này (định dạng timestamp

deliveryAtFrom

int

Thời gian giao hàng từ ngày (định dạng timestamp)

deliveryAtTo

int

Thời gian giao hàng đến ngày (định dạng timestamp)

updatedAtFrom

int

Thời gian cập nhật từ ngày (định dạng timestamp)

updatedAtTo

int

Thời gian cập nhật đến ngày (định dạng timestamp)

ids

array

Mảng ID đơn hàng

statuses

array

saleChannels

array

Mảng ID kênh bán

depotIds

array

Mảng ID kho hàng

handoverId

int

ID biên bản bàn giao

carrier

array

shippingAddress

array

carrier

  • Thông tin vận chuyển

Key
Type
Description

id

int

ID hãng vận chuyển

code

string

Mã vận đơn hãng vận chuyển

shippingAddress

  • Thông tin người nhận hàng

Key
Type
Description

id

int

ID người nhận hàng

mobile

string

Số điện thoại

cityId

int

ID thành phố

districtId

int

ID quận/huyện

wardId

int

ID phường/xã

Paginator

DataOptions

  • Dữ liệu cần lấy thêm:

Key
Type
Description

marketing

int

1: Lấy thông tin utmSource, utmMedium, utmCampaign

comboItems

int

1: Lấy thông tin sản phẩm con trong combo

Response

Failed response

Successful response

Last updated