POST Update load

Introduction

Update an existing load by its load ID. This API allows you to modify load details such as carrier, customer, equipment information, order references, item lines, and dynamic field values. Only the fields provided in the request body will be updated.

POST /load/{loadId}/update

Body Request Parameters

{
  "loadStatus": "NEW",
  "loadNo": "string",
  "shipMethod": "TRUCK_LOAD",
  "carrierId": "string",
  "appointmentTime": "2025-08-08T10:00:00",
  "appointmentId": "string",
  "orderIds": [
    "string"
  ],
  "customerId": "string",
  "masterBol": "string",
  "sealNo": "123456",
  "dynamicFieldValues": [
    {
      "fieldCode": "string",
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "equipmentType": "TRAILER",
  "equipmentNo": "string"
}

Request Parameters

Name	Location	Type	Required	Description
loadId	path	string	Yes	Load 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
» loadStatus	body	string	No	Current status of the load. Allowed values: NEW, WINDOW_CHECKIN_DONE, LOADING, LOADED, SHIPPED, CANCELLED
» loadNo	body	string	No	Human-readable load number or reference
» shipMethod	body	string	No	Shipping method
» carrierId	body	string	No	Associated carrier identifier
» appointmentTime	body	string	No	Appointment time
» appointmentId	body	string	No	Related appointment identifier
» orderIds	body	[string]	No	List of related order identifiers
» customerId	body	string	No	Associated customer identifier
» masterBol	body	string	No	Master bill of lading number
» sealNo	body	string	No	Seal number used on the trailer or container
» dynamicFieldValues	body	[object]	No	Dynamic field values for custom attributes
»» fieldCode	body	string	Yes	Field code
»» value	body	string	No	none
»» values	body	[string]	No	多选值列表，优先于 value 使用
» equipmentType	body	string	No	Equipment type,allowed values: TRAILER,CONTAINER,CHASSIS,FLATBED,OTHER
» equipmentNo	body	string	No	Equipment number

Enum Values

Property	Value
» shipMethod	TRUCK_LOAD
» shipMethod	SMALL_PARCEL
» shipMethod	LTL
» shipMethod	WILL_CALL
» equipmentType	VEHICLE
» equipmentType	TRAILER
» equipmentType	CHASSIS
» equipmentType	CONTAINER
» equipmentType	FLATBED
» equipmentType	OTHER
» equipmentType	NO_EQUIPMENT

Response Example

{
  "code": 0,
  "msg": "",
  "success": false,
  "data": {
    "id": "",
    "loadId": "",
    "loadStatus": "",
    "loadNo": "",
    "shipMethod": "",
    "carrierId": "",
    "appointmentTime": "",
    "appointmentId": "",
    "orderIds": [
      ""
    ],
    "customerId": "",
    "masterBol": "",
    "sealNo": "",
    "customerName": "",
    "carrierName": "",
    "orderViews": [
      {
        "id": 0,
        "orderId": "",
        "orderStatus": "",
        "customerId": "",
        "poNo": "",
        "referenceNo": "",
        "retailer": "",
        "shipFrom": "",
        "shipTo": "",
        "totalPalletQty": 0,
        "totalCartonQty": 0,
        "itemInfos": [
          {
            "itemId": "",
            "itemName": "",
            "itemQty": "",
            "palletQty": "",
            "itemSpecDesc": "",
            "itemSpecName": "",
            "uomId": "",
            "qty": ""
          }
        ],
        "customerName": "",
        "carrierName": "",
        "shipToAddress": {
          "id": "",
          "name": "",
          "country": "",
          "state": "",
          "city": "",
          "zipCode": "",
          "fax": "",
          "address1": "",
          "address2": "",
          "contact": "",
          "phone": "",
          "extension": "",
          "email": "",
          "orgId": "",
          "orgName": "",
          "referenceNo": "",
          "batchCode": "",
          "storeNo": "",
          "shorthand": "",
          "toHome": false,
          "tags": [
            ""
          ],
          "latitude": "",
          "longitude": "",
          "crmAddressId": ""
        },
        "shipFromAddress": {
          "id": "",
          "name": "",
          "country": "",
          "state": "",
          "city": "",
          "zipCode": "",
          "fax": "",
          "address1": "",
          "address2": "",
          "contact": "",
          "phone": "",
          "extension": "",
          "email": "",
          "orgId": "",
          "orgName": "",
          "referenceNo": "",
          "batchCode": "",
          "storeNo": "",
          "shorthand": "",
          "toHome": false,
          "tags": [
            ""
          ],
          "latitude": "",
          "longitude": "",
          "crmAddressId": ""
        },
        "appointmentTime": "",
        "dynamicFieldValues": [
          {
            "entityId": "",
            "entityType": "",
            "fieldCode": "",
            "value": "",
            "fieldName": "",
            "longValue": "",
            "shortValue": ""
          }
        ],
        "proNos": [
          ""
        ],
        "invoicePros": [
          ""
        ],
        "doNos": [
          ""
        ],
        "tripNo": "",
        "shippedTime": ""
      }
    ],
    "dynamicFieldValues": [
      {
        "entityId": "",
        "entityType": "",
        "fieldCode": "",
        "value": "",
        "fieldName": "",
        "longValue": "",
        "shortValue": ""
      }
    ],
    "equipmentType": "",
    "equipmentNo": "",
    "referenceNoList": [
      ""
    ],
    "poNoList": [
      ""
    ],
    "templateLoadKey": "",
    "proNos": [
      ""
    ],
    "invoicePros": [
      ""
    ],
    "doNos": [
      ""
    ],
    "tripNos": [
      ""
    ],
    "loadType": "",
    "stagingLocationName": "",
    "shippedTime": ""
  }
}

{
  "code": 0,
  "msg": "",
  "success": false,
  "data": {
    "id": "",
    "loadId": "",
    "loadStatus": "",
    "loadNo": "",
    "shipMethod": "",
    "carrierId": "",
    "appointmentTime": "",
    "appointmentId": "",
    "orderIds": [
      ""
    ],
    "customerId": "",
    "masterBol": "",
    "sealNo": "",
    "customerName": "",
    "carrierName": "",
    "orderViews": [
      {
        "id": 0,
        "orderId": "",
        "orderStatus": "",
        "customerId": "",
        "poNo": "",
        "referenceNo": "",
        "retailer": "",
        "shipFrom": "",
        "shipTo": "",
        "totalPalletQty": 0,
        "totalCartonQty": 0,
        "itemInfos": [
          {
            "itemId": "",
            "itemName": "",
            "itemQty": "",
            "palletQty": "",
            "itemSpecDesc": "",
            "itemSpecName": "",
            "uomId": "",
            "qty": ""
          }
        ],
        "customerName": "",
        "carrierName": "",
        "shipToAddress": {
          "id": "",
          "name": "",
          "country": "",
          "state": "",
          "city": "",
          "zipCode": "",
          "fax": "",
          "address1": "",
          "address2": "",
          "contact": "",
          "phone": "",
          "extension": "",
          "email": "",
          "orgId": "",
          "orgName": "",
          "referenceNo": "",
          "batchCode": "",
          "storeNo": "",
          "shorthand": "",
          "toHome": false,
          "tags": [
            ""
          ],
          "latitude": "",
          "longitude": "",
          "crmAddressId": ""
        },
        "shipFromAddress": {
          "id": "",
          "name": "",
          "country": "",
          "state": "",
          "city": "",
          "zipCode": "",
          "fax": "",
          "address1": "",
          "address2": "",
          "contact": "",
          "phone": "",
          "extension": "",
          "email": "",
          "orgId": "",
          "orgName": "",
          "referenceNo": "",
          "batchCode": "",
          "storeNo": "",
          "shorthand": "",
          "toHome": false,
          "tags": [
            ""
          ],
          "latitude": "",
          "longitude": "",
          "crmAddressId": ""
        },
        "appointmentTime": "",
        "dynamicFieldValues": [
          {
            "entityId": "",
            "entityType": "",
            "fieldCode": "",
            "value": "",
            "values": [
              ""
            ],
            "fieldName": "",
            "longValue": "",
            "shortValue": "",
            "valueType": "",
            "optionsType": "",
            "options": [
              ""
            ]
          }
        ],
        "proNos": [
          ""
        ],
        "invoicePros": [
          ""
        ],
        "doNos": [
          ""
        ],
        "tripNo": "",
        "shippedTime": ""
      }
    ],
    "dynamicFieldValues": [
      {
        "entityId": "",
        "entityType": "",
        "fieldCode": "",
        "value": "",
        "values": [
          ""
        ],
        "fieldName": "",
        "longValue": "",
        "shortValue": "",
        "valueType": "",
        "optionsType": "",
        "options": [
          ""
        ]
      }
    ],
    "equipmentType": "",
    "equipmentNo": "",
    "referenceNoList": [
      ""
    ],
    "poNoList": [
      ""
    ],
    "templateLoadKey": "",
    "proNos": [
      ""
    ],
    "invoicePros": [
      ""
    ],
    "doNos": [
      ""
    ],
    "tripNos": [
      ""
    ],
    "loadType": "",
    "stagingLocationName": "",
    "shippedTime": "",
    "entryId": "",
    "bolDriverSigned": false
  }
}

Response

Status Code	Definition	Description	Data Model
200	OK (opens in a new tab)	none	RLoadView

POST Create Load POST Delete Load