POST Create load

Introduction

Create a new load in the YMS system. This API allows you to submit load information including carrier, customer, equipment details, order references, item lines, appointment data, and dynamic field values. The load will be registered and assigned a unique identifier upon successful creation.

POST /public/load/create

Body Request Parameters

{
  "uniqueKey": "string",
  "loadNo": "string",
  "shipMethod": "TRUCK_LOAD",
  "carrierId": "string",
  "externalCarrierId": "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
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
» uniqueKey	body	string	No	Client-provided unique key for idempotency. Used to prevent duplicate load creation
» loadNo	body	string	Yes	Human-readable load number or reference
» shipMethod	body	string	Yes	Shipping method,allowed values: TRUCK_LOAD,SMALL_PARCEL,LTL,WILL_CALL
» carrierId	body	string	No	Associated carrier identifier
» externalCarrierId	body	string	No	External carrier identifier from external systems
» appointmentTime	body	string	No	Appointment time
» appointmentId	body	string	No	Related appointment identifier, if any
» 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	Multi-select value list, takes priority over value
» equipmentType	body	string	No	Equipment type for the load,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 Search Orders by Paging POST Update Load