API Docs
YMS API
Data Models
Order
Order Qurey

OrderQuery

{
  "currentPage": 0,
  "pageSize": 0,
  "sortingFields": [
    {
      "field": "string",
      "orderBy": "NONE"
    }
  ],
  "orderId": "string",
  "orderIds": [
    "string"
  ],
  "orderStatus": "string",
  "orderStatuses": [
    "string"
  ],
  "customerId": "string",
  "customerIds": [
    "string"
  ],
  "poNo": "string",
  "referenceNo": "string",
  "referenceNoLike": "string",
  "retailer": "string",
  "shippedTimePeriod": [
    "string"
  ],
  "keyword": "string",
  "loadNos": [
    "string"
  ],
  "loadNo": "string",
  "orPoNo": "string",
  "orLoadNo": "string",
  "orReferenceNo": "string",
  "orBolNo": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
currentPageintegerfalsenonenone
pageSizeintegerfalsenonenone
sortingFields[SortingField (opens in a new tab)]falsenonenone
orderIdstringfalsenoneSpecific order identifier
orderIds[string]falsenoneList of order identifiers for batch query
orderStatusstringfalsenoneOrder status filter
orderStatuses[string]falsenoneList of order statuses for batch query
customerIdstringfalsenoneSpecific customer identifier
customerIds[string]falsenoneList of customer identifiers
poNostringfalsenonePurchase order number
referenceNostringfalsenoneReference number (exact match)
referenceNoLikestringfalsenoneReference number (fuzzy match)
retailerstringfalsenoneRetailer name filter
shippedTimePeriod[string]falsenoneShipped time period for filtering [start, end]
keywordstringfalsenoneKeyword fuzzy search across orderId, poNo, referenceNo
loadNos[string]falsenoneLoad Nos
loadNostringfalsenoneLoad No
orPoNostringfalsenoneorPoNo
orLoadNostringfalsenoneorLoadNo
orReferenceNostringfalsenoneorReferenceNo
orBolNostringfalsenoneorBolNo