API Docs
YMS API
Data Models
Receipt
Receipt Create CMD

ReceiptCreateCmd

{
  "receiptId": "string",
  "receiptType": "string",
  "poNo": "string",
  "carrierId": "string",
  "customerId": "string",
  "referenceNo": "string",
  "equipmentType": "string",
  "equipmentNo": "string",
  "totalPalletQty": 0,
  "itemLines": [
    {
      "itemId": "string",
      "itemName": "string",
      "itemQty": "string",
      "palletQty": "string",
      "itemSpecDesc": "string",
      "itemSpecName": "string",
      "uomId": "string",
      "qty": "string"
    }
  ],
  "appointmentTime": "string",
  "appointmentId": "string",
  "sealNo": "string",
  "dataChannel": "YMS",
  "eventTime": "string",
  "extraData": "string",
  "carrierName": "string",
  "customerName": "string",
  "dynamicFieldValues": [
    {
      "entityId": "string",
      "entityType": "RECEIPT",
      "fieldCode": "string",
      "shortValue": "string",
      "longValue": "string",
      "value": "string"
    }
  ]
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
receiptIdstringfalsenoneReceipt ID (RN-xxx)
receiptTypestringtruenoneReceipt type (Required)
Regular Receipt/Material Receive/Return
poNostringtruenonePurchase order number (Required)
carrierIdstringtruenoneCarrier ID (Required)
customerIdstringtruenoneCustomer ID (Required)
referenceNostringtruenoneReference number
equipmentTypestringfalsenoneEquipment type (Required)
equipmentNostringfalsenoneEquipment number (Required)
totalPalletQtyintegerfalsenoneTotal pallet quantity
itemLines[ItemInfo (opens in a new tab)]falsenoneItem information list
appointmentTimestringfalsenoneAppointment time (Required)
appointmentIdstringfalsenoneAppointment ID
sealNostringfalsenonenone
dataChannelstringfalsenoneData source channel
eventTimestringfalsenoneEvent time for idempotency control
extraDatastringfalsenoneExtra data in JSON format
carrierNamestringfalsenoneCarrier name
customerNamestringfalsenoneCustomer name
dynamicFieldValues[DynamicFieldValueCreateCmd (opens in a new tab)]falsenoneDynamic field values

Enum Values

PropertyValue
dataChannelYMS
dataChannelWMS
dataChannelOMS
dataChannelTMS
dataChannelFMS