Item Logo
Yms apiData modelsOrder

Order Qurey

OrderQuery

Properties

Name

Type

Required

Constraints

Chinese Name

Description

currentPage

integer

false

none


none

pageSize

integer

false

none


none

sortingFields

[SortingField]

false

none


none

orderId

string

false

none


Specific order identifier

orderIds

[string]

false

none


List of order identifiers for batch query

orderStatus

string

false

none


Order status filter

orderStatuses

[string]

false

none


List of order statuses for batch query

customerId

string

false

none


Specific customer identifier

customerIds

[string]

false

none


List of customer identifiers

poNo

string

false

none


Purchase order number

referenceNo

string

false

none


Reference number (exact match)

referenceNoLike

string

false

none


Reference number (fuzzy match)

retailer

string

false

none


Retailer name filter

shippedTimePeriod

[string]

false

none


Shipped time period for filtering [start, end]

keyword

string

false

none


Keyword fuzzy search across orderId, poNo, referenceNo

loadNos

[string]

false

none


Load Nos

loadNo

string

false

none


Load No

orPoNo

string

false

none


orPoNo

orLoadNo

string

false

none


orLoadNo

orReferenceNo

string

false

none


orReferenceNo

orBolNo

string

false

none


orBolNo

On this page