API Docs
YMS API
Data Models
Order View

OrderView

{
  "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"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
idinteger(int64)falsenoneUnique numeric identifier for the order record
orderIdstringfalsenoneOrder identifier
orderStatusstringfalsenoneCurrent status of the order
customerIdstringfalsenoneCustomer identifier
poNostringfalsenonePurchase order number
referenceNostringfalsenoneReference number
retailerstringfalsenoneRetailer name
shipFromstringfalsenoneShip-from location (name or code)
shipTostringfalsenoneShip-to location (name or code)
totalPalletQtyintegerfalsenoneTotal number of pallets
totalCartonQtyintegerfalsenoneTotal number of cartons
itemInfos[ItemInfo (opens in a new tab)]falsenoneItems included in the order
customerNamestringfalsenoneCustomer name
carrierNamestringfalsenoneCarrier name
shipToAddressAddressExt (opens in a new tab)falsenoneShip-to address
shipFromAddressAddressExt (opens in a new tab)falsenoneShip-from address
appointmentTimestringfalsenoneRelated appointment time, if any
dynamicFieldValues[DynamicFieldValueView (opens in a new tab)]falsenoneDynamic field values for custom attributes
proNos[string]falsenoneList of PRO numbers
invoicePros[string]falsenoneList of invoice PRO numbers
doNos[string]falsenoneList of delivery order numbers
tripNostringfalsenoneTrip number, if applicable
shippedTimestringfalsenoneShipped time - when the order was shipped/dispatched