API Docs
YMS API
Data Models
Order
Page Result Order View

PageResultOrderView

{
  "list": [
    {
      "id": 0,
      "orderId": "string",
      "orderStatus": "string",
      "customerId": "string",
      "poNo": "string",
      "referenceNo": "string",
      "retailer": "string",
      "shipFrom": "string",
      "shipTo": "string",
      "totalPalletQty": 0,
      "totalCartonQty": 0,
      "itemInfos": [
        {
          "itemId": "string",
          "itemName": "string",
          "itemQty": "string",
          "palletQty": "string",
          "itemSpecDesc": "string",
          "itemSpecName": "string",
          "uomId": "string",
          "qty": "string"
        }
      ],
      "customerName": "string",
      "carrierName": "string",
      "shipToAddress": {
        "id": "string",
        "name": "string",
        "country": "string",
        "state": "string",
        "city": "string",
        "zipCode": "string",
        "fax": "string",
        "address1": "string",
        "address2": "string",
        "contact": "string",
        "phone": "string",
        "extension": "string",
        "email": "string",
        "orgId": "string",
        "orgName": "string",
        "referenceNo": "string",
        "batchCode": "string",
        "storeNo": "string",
        "shorthand": "string",
        "toHome": true,
        "tags": [
          "string"
        ],
        "latitude": "string",
        "longitude": "string",
        "crmAddressId": "string"
      },
      "shipFromAddress": {
        "id": "string",
        "name": "string",
        "country": "string",
        "state": "string",
        "city": "string",
        "zipCode": "string",
        "fax": "string",
        "address1": "string",
        "address2": "string",
        "contact": "string",
        "phone": "string",
        "extension": "string",
        "email": "string",
        "orgId": "string",
        "orgName": "string",
        "referenceNo": "string",
        "batchCode": "string",
        "storeNo": "string",
        "shorthand": "string",
        "toHome": true,
        "tags": [
          "string"
        ],
        "latitude": "string",
        "longitude": "string",
        "crmAddressId": "string"
      },
      "appointmentTime": "string",
      "dynamicFieldValues": [
        {
          "entityId": "string",
          "entityType": "RECEIPT",
          "fieldCode": "string",
          "value": "string",
          "fieldName": "string",
          "longValue": "string",
          "shortValue": "string"
        }
      ],
      "proNos": [
        "string"
      ],
      "invoicePros": [
        "string"
      ],
      "doNos": [
        "string"
      ],
      "tripNo": "string",
      "shippedTime": "string"
    }
  ],
  "totalCount": 0,
  "currentPage": 0,
  "pageSize": 0,
  "totalPage": 0
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
list[OrderView (opens in a new tab)]falsenonenone
totalCountinteger(int64)falsenonenone
currentPageinteger(int64)falsenonenone
pageSizeinteger(int64)falsenonenone
totalPageinteger(int64)falsenonenone