POST Update receipt
Introduction
Update an existing receipt by its receipt ID. This API allows you to modify receipt details such as carrier, customer, equipment information, item lines, appointment data, and dynamic field values. Only the fields provided in the request body will be updated.
POST /receipt/{receiptId}/update
Body Request Parameters
{
"receiptStatus": "string",
"receiptType": "string",
"poNo": "string",
"carrierId": "string",
"customerId": "string",
"referenceNo": "string",
"equipmentType": "VEHICLE",
"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": [
{
"fieldCode": "string",
"value": "string",
"values": [
"string"
]
}
],
"preferenceLocationType": "SPOT",
"nullFields": [
"string"
]
}Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| receiptId | path | string | Yes | Receipt ID |
| X-Tenant-ID | header | string | No | none |
| X-Yard-ID | header | string | No | none |
| Item-Time-Zone | header | string | No | none |
| Authorization | header | string | No | none |
| Item-Bam-Client | header | string | No | none |
| x-facility-id | header | string | No | none |
| body | body | object | No | none |
| » receiptStatus | body | string | No | Receipt status |
| » receiptType | body | string | No | Receipt type |
| » poNo | body | string | No | Purchase order number |
| » carrierId | body | string | No | Carrier ID |
| » customerId | body | string | No | Customer ID |
| » referenceNo | body | string | No | Reference number |
| » equipmentType | body | string | No | Equipment type |
| » equipmentNo | body | string | No | Equipment number |
| » totalPalletQty | body | integer | No | Total pallet quantity |
| » itemLines | body | [ItemInfo] | No | Item information list |
| »» itemId | body | string | No | Item identifier |
| »» itemName | body | string | No | Item name |
| »» itemQty | body | string | No | Item quantity |
| »» palletQty | body | string | No | Item pallet Qty |
| »» itemSpecDesc | body | string | No | Item spec desc |
| »» itemSpecName | body | string | No | Item spec name |
| »» uomId | body | string | No | item uomId |
| »» qty | body | string | No | qty |
| » appointmentTime | body | string | No | Appointment time |
| » appointmentId | body | string | No | Appointment ID |
| » sealNo | body | string | No | Seal number |
| » dataChannel | body | string | No | Data source channel |
| » eventTime | body | string | No | Event time for idempotency control |
| » extraData | body | string | No | Extra data in JSON format |
| » carrierName | body | string | No | Carrier name |
| » customerName | body | string | No | Customer name |
| » dynamicFieldValues | body | [object] | No | Dynamic field values |
| »» fieldCode | body | string | Yes | Field code |
| »» value | body | string | No | none |
| »» values | body | [string] | No | 多选值列表，优先于 value 使用 |
| » preferenceLocationType | body | string | No | Preference location type (SPOT / DOCK / null) |
| » nullFields | body | [string] | No | none |
Enum Values
| Property | Value |
|---|---|
| » equipmentType | VEHICLE |
| » equipmentType | TRAILER |
| » equipmentType | CHASSIS |
| » equipmentType | CONTAINER |
| » equipmentType | FLATBED |
| » equipmentType | OTHER |
| » equipmentType | NO_EQUIPMENT |
| » dataChannel | YMS |
| » dataChannel | WMS |
| » dataChannel | OMS |
| » dataChannel | TMS |
| » dataChannel | FMS |
| » preferenceLocationType | SPOT |
| » preferenceLocationType | DOCK |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": {
"id": 0,
"receiptId": "",
"receiptStatus": "",
"receiptType": "",
"poNo": "",
"carrierId": "",
"customerId": "",
"referenceNo": "",
"equipmentType": "",
"equipmentNo": "",
"totalPalletQty": 0,
"itemLines": [
{
"itemId": "",
"itemName": "",
"itemQty": "",
"palletQty": "",
"itemSpecDesc": "",
"itemSpecName": "",
"uomId": "",
"qty": ""
}
],
"appointmentTime": "",
"appointmentId": "",
"sealNo": "",
"dataChannel": "",
"eventTime": "",
"extraData": "",
"carrierName": "",
"customerName": "",
"dynamicFieldValues": [
{
"entityId": "",
"entityType": "",
"fieldCode": "",
"value": "",
"values": [
""
],
"fieldName": "",
"longValue": "",
"shortValue": "",
"valueType": "",
"optionsType": "",
"options": [
""
]
}
],
"proNos": [
""
],
"invoicePros": [
""
],
"doNos": [
""
],
"tripNo": "",
"entryId": "",
"preferenceLocationType": ""
}
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RReceiptView |