Item Logo
Yms apiData models

Order View

OrderView

Properties

Name

Type

Required

Constraints

Chinese Name

Description

id

integer(int64)

false

none


Unique numeric identifier for the order record

orderId

string

false

none


Order identifier

orderStatus

string

false

none


Current status of the order

customerId

string

false

none


Customer identifier

poNo

string

false

none


Purchase order number

referenceNo

string

false

none


Reference number

retailer

string

false

none


Retailer name

shipFrom

string

false

none


Ship-from location (name or code)

shipTo

string

false

none


Ship-to location (name or code)

totalPalletQty

integer

false

none


Total number of pallets

totalCartonQty

integer

false

none


Total number of cartons

itemInfos

[ItemInfo]

false

none


Items included in the order

customerName

string

false

none


Customer name

carrierName

string

false

none


Carrier name

shipToAddress

AddressExt

false

none


Ship-to address

shipFromAddress

AddressExt

false

none


Ship-from address

appointmentTime

string

false

none


Related appointment time, if any

dynamicFieldValues

[DynamicFieldValueView]

false

none


Dynamic field values for custom attributes

proNos

[string]

false

none


List of PRO numbers

invoicePros

[string]

false

none


List of invoice PRO numbers

doNos

[string]

false

none


List of delivery order numbers

tripNo

string

false

none


Trip number, if applicable

shippedTime

string

false

none


Shipped time - when the order was shipped/dispatched

On this page