POST api/DLS/PostDlsLoad

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ShipperId	integer	Required
LoadBoardUserId	string	Required
LoadKey	string	Required
ShipmentDate	date	None.
LoadId	integer	None.
ModeId	integer	None.
EquipmentTypeId	integer	None.
BasicPrice	decimal number	None.
BiddingEnabled	boolean	None.
BiddingTime	integer	None.
Value	decimal number	None.
SealNumber	string	None.
TrailerNumber	string	None.
PickupAddress	LoadBoardAddressViewModel	None.
PickupNumber	string	None.
ShippingSpecialReq	string	None.
ReqShipDate	date	None.
PuAppointmentDate	date	None.
PuAppointmentToDate	date	None.
DestinationAddress	LoadBoardAddressViewModel	None.
DestinationNumber	string	None.
Mabd	date	None.
DelAppointmentDate	date	None.
DelAppointmentToDate	date	None.
ReceivingSpecialReq	string	None.
ShippingNote	string	None.
ReceivingNote	string	None.
AsDraft	boolean	None.
SignatureRequired	boolean	None.
RestTime	decimal number	None.
TotalWeight	decimal number	None.
WeightType	string	None.
Accessorials	Collection of AccessorialDlsViewModel	None.
IsPrivate	boolean	None.
Fields	Collection of AnswerFormViewModel	None.
Items	Collection of ItemsDlsViewModel	None.
Notes	Collection of NotesDlsViewModel	None.
Documents	Collection of DocumentsDlsViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "ShipperId": 1,
  "LoadBoardUserId": "sample string 2",
  "LoadKey": "sample string 3",
  "ShipmentDate": "2025-10-28T12:22:01.117909Z",
  "LoadId": 4,
  "ModeId": 5,
  "EquipmentTypeId": 1,
  "BasicPrice": 1.0,
  "BiddingEnabled": true,
  "BiddingTime": 1,
  "Value": 1.0,
  "SealNumber": "sample string 6",
  "TrailerNumber": "sample string 7",
  "PickupAddress": {
    "CompanyName": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "ZipCode": "sample string 6",
    "Country": "sample string 7",
    "ContactName": "sample string 8",
    "ContactPhone": "sample string 9",
    "ContactEmail": "sample string 10",
    "ContactFax": "sample string 11",
    "ContactPhone2": "sample string 12"
  },
  "PickupNumber": "sample string 8",
  "ShippingSpecialReq": "sample string 9",
  "ReqShipDate": "2025-10-28T12:22:01.1189083Z",
  "PuAppointmentDate": "2025-10-28T12:22:01.1189083Z",
  "PuAppointmentToDate": "2025-10-28T12:22:01.1189083Z",
  "DestinationAddress": {
    "CompanyName": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "ZipCode": "sample string 6",
    "Country": "sample string 7",
    "ContactName": "sample string 8",
    "ContactPhone": "sample string 9",
    "ContactEmail": "sample string 10",
    "ContactFax": "sample string 11",
    "ContactPhone2": "sample string 12"
  },
  "DestinationNumber": "sample string 10",
  "Mabd": "2025-10-28T12:22:01.1189083Z",
  "DelAppointmentDate": "2025-10-28T12:22:01.1189083Z",
  "DelAppointmentToDate": "2025-10-28T12:22:01.1189083Z",
  "ReceivingSpecialReq": "sample string 11",
  "ShippingNote": "sample string 12",
  "ReceivingNote": "sample string 13",
  "AsDraft": true,
  "SignatureRequired": true,
  "RestTime": 1.0,
  "TotalWeight": 1.0,
  "WeightType": "sample string 15",
  "Accessorials": [
    {
      "Name": "sample string 1",
      "IsPercentage": true,
      "Price": 3.0,
      "Quantity": 4.0
    },
    {
      "Name": "sample string 1",
      "IsPercentage": true,
      "Price": 3.0,
      "Quantity": 4.0
    }
  ],
  "IsPrivate": true,
  "Fields": [
    {
      "Id": 1,
      "Value": [
        "sample string 1",
        "sample string 2"
      ],
      "Required": true
    },
    {
      "Id": 1,
      "Value": [
        "sample string 1",
        "sample string 2"
      ],
      "Required": true
    }
  ],
  "Items": [
    {
      "DlsId": 1,
      "PurchaseOrder": "sample string 2",
      "Sku": "sample string 3",
      "PackagingId": 1,
      "PackagingTypeId": 1,
      "Commodity": "sample string 4",
      "Cube": 1.0,
      "CubeMode": "sample string 5",
      "CubeType": "sample string 6",
      "FreightClass": "sample string 7",
      "FreightNMFCClass": "sample string 8",
      "HandlingAmount": 1.0,
      "Pieces": 1,
      "SpaceReq": "sample string 9",
      "Weight": 1.0,
      "WeightMode": "sample string 10",
      "WeightType": "sample string 11",
      "PickupStopId": 1,
      "DropStopId": 1,
      "Length": 1.0,
      "Heigth": 1.0,
      "Width": 1.0,
      "DimensionsType": "sample string 12",
      "UnitOfMeasure": "sample string 13"
    },
    {
      "DlsId": 1,
      "PurchaseOrder": "sample string 2",
      "Sku": "sample string 3",
      "PackagingId": 1,
      "PackagingTypeId": 1,
      "Commodity": "sample string 4",
      "Cube": 1.0,
      "CubeMode": "sample string 5",
      "CubeType": "sample string 6",
      "FreightClass": "sample string 7",
      "FreightNMFCClass": "sample string 8",
      "HandlingAmount": 1.0,
      "Pieces": 1,
      "SpaceReq": "sample string 9",
      "Weight": 1.0,
      "WeightMode": "sample string 10",
      "WeightType": "sample string 11",
      "PickupStopId": 1,
      "DropStopId": 1,
      "Length": 1.0,
      "Heigth": 1.0,
      "Width": 1.0,
      "DimensionsType": "sample string 12",
      "UnitOfMeasure": "sample string 13"
    }
  ],
  "Notes": [
    {
      "DlsId": 1,
      "Body": "sample string 2",
      "userId": 1
    },
    {
      "DlsId": 1,
      "Body": "sample string 2",
      "userId": 1
    }
  ],
  "Documents": [
    {
      "DlsId": 1,
      "FileName": "sample string 2",
      "FilePath": "sample string 3",
      "userId": 1,
      "TypeId": 1
    },
    {
      "DlsId": 1,
      "FileName": "sample string 2",
      "FilePath": "sample string 3",
      "userId": 1,
      "TypeId": 1
    }
  ]
}

application/xml, text/xml

Sample:

<ShipmentsDlsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShipperCore.ViewModels.DLS">
  <Accessorials>
    <AccessorialDlsViewModel>
      <IsPercentage>true</IsPercentage>
      <Name>sample string 1</Name>
      <Price>3</Price>
      <Quantity>4</Quantity>
    </AccessorialDlsViewModel>
    <AccessorialDlsViewModel>
      <IsPercentage>true</IsPercentage>
      <Name>sample string 1</Name>
      <Price>3</Price>
      <Quantity>4</Quantity>
    </AccessorialDlsViewModel>
  </Accessorials>
  <AsDraft>true</AsDraft>
  <BasicPrice>1</BasicPrice>
  <BiddingEnabled>true</BiddingEnabled>
  <BiddingTime>1</BiddingTime>
  <DelAppointmentDate>2025-10-28T12:22:01.1189083Z</DelAppointmentDate>
  <DelAppointmentToDate>2025-10-28T12:22:01.1189083Z</DelAppointmentToDate>
  <DestinationAddress>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <City>sample string 4</City>
    <CompanyName>sample string 1</CompanyName>
    <ContactEmail>sample string 10</ContactEmail>
    <ContactFax>sample string 11</ContactFax>
    <ContactName>sample string 8</ContactName>
    <ContactPhone>sample string 9</ContactPhone>
    <ContactPhone2>sample string 12</ContactPhone2>
    <Country>sample string 7</Country>
    <State>sample string 5</State>
    <ZipCode>sample string 6</ZipCode>
  </DestinationAddress>
  <DestinationNumber>sample string 10</DestinationNumber>
  <Documents>
    <DocumentsDlsViewModel>
      <DlsId>1</DlsId>
      <FileName>sample string 2</FileName>
      <FilePath>sample string 3</FilePath>
      <TypeId>1</TypeId>
      <userId>1</userId>
    </DocumentsDlsViewModel>
    <DocumentsDlsViewModel>
      <DlsId>1</DlsId>
      <FileName>sample string 2</FileName>
      <FilePath>sample string 3</FilePath>
      <TypeId>1</TypeId>
      <userId>1</userId>
    </DocumentsDlsViewModel>
  </Documents>
  <EquipmentTypeId>1</EquipmentTypeId>
  <Fields xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShipperCore.ViewModels">
    <d2p1:AnswerFormViewModel>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Required>true</d2p1:Required>
      <d2p1:Value xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Value>
    </d2p1:AnswerFormViewModel>
    <d2p1:AnswerFormViewModel>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Required>true</d2p1:Required>
      <d2p1:Value xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Value>
    </d2p1:AnswerFormViewModel>
  </Fields>
  <IsPrivate>true</IsPrivate>
  <Items>
    <ItemsDlsViewModel>
      <Commodity>sample string 4</Commodity>
      <Cube>1</Cube>
      <CubeMode>sample string 5</CubeMode>
      <CubeType>sample string 6</CubeType>
      <DimensionsType>sample string 12</DimensionsType>
      <DlsId>1</DlsId>
      <DropStopId>1</DropStopId>
      <FreightClass>sample string 7</FreightClass>
      <FreightNMFCClass>sample string 8</FreightNMFCClass>
      <HandlingAmount>1</HandlingAmount>
      <Heigth>1</Heigth>
      <Length>1</Length>
      <PackagingId>1</PackagingId>
      <PackagingTypeId>1</PackagingTypeId>
      <PickupStopId>1</PickupStopId>
      <Pieces>1</Pieces>
      <PurchaseOrder>sample string 2</PurchaseOrder>
      <Sku>sample string 3</Sku>
      <SpaceReq>sample string 9</SpaceReq>
      <UnitOfMeasure>sample string 13</UnitOfMeasure>
      <Weight>1</Weight>
      <WeightMode>sample string 10</WeightMode>
      <WeightType>sample string 11</WeightType>
      <Width>1</Width>
    </ItemsDlsViewModel>
    <ItemsDlsViewModel>
      <Commodity>sample string 4</Commodity>
      <Cube>1</Cube>
      <CubeMode>sample string 5</CubeMode>
      <CubeType>sample string 6</CubeType>
      <DimensionsType>sample string 12</DimensionsType>
      <DlsId>1</DlsId>
      <DropStopId>1</DropStopId>
      <FreightClass>sample string 7</FreightClass>
      <FreightNMFCClass>sample string 8</FreightNMFCClass>
      <HandlingAmount>1</HandlingAmount>
      <Heigth>1</Heigth>
      <Length>1</Length>
      <PackagingId>1</PackagingId>
      <PackagingTypeId>1</PackagingTypeId>
      <PickupStopId>1</PickupStopId>
      <Pieces>1</Pieces>
      <PurchaseOrder>sample string 2</PurchaseOrder>
      <Sku>sample string 3</Sku>
      <SpaceReq>sample string 9</SpaceReq>
      <UnitOfMeasure>sample string 13</UnitOfMeasure>
      <Weight>1</Weight>
      <WeightMode>sample string 10</WeightMode>
      <WeightType>sample string 11</WeightType>
      <Width>1</Width>
    </ItemsDlsViewModel>
  </Items>
  <LoadBoardUserId>sample string 2</LoadBoardUserId>
  <LoadId>4</LoadId>
  <LoadKey>sample string 3</LoadKey>
  <Mabd>2025-10-28T12:22:01.1189083Z</Mabd>
  <ModeId>5</ModeId>
  <Notes>
    <NotesDlsViewModel>
      <Body>sample string 2</Body>
      <DlsId>1</DlsId>
      <userId>1</userId>
    </NotesDlsViewModel>
    <NotesDlsViewModel>
      <Body>sample string 2</Body>
      <DlsId>1</DlsId>
      <userId>1</userId>
    </NotesDlsViewModel>
  </Notes>
  <PickupAddress>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <City>sample string 4</City>
    <CompanyName>sample string 1</CompanyName>
    <ContactEmail>sample string 10</ContactEmail>
    <ContactFax>sample string 11</ContactFax>
    <ContactName>sample string 8</ContactName>
    <ContactPhone>sample string 9</ContactPhone>
    <ContactPhone2>sample string 12</ContactPhone2>
    <Country>sample string 7</Country>
    <State>sample string 5</State>
    <ZipCode>sample string 6</ZipCode>
  </PickupAddress>
  <PickupNumber>sample string 8</PickupNumber>
  <PuAppointmentDate>2025-10-28T12:22:01.1189083Z</PuAppointmentDate>
  <PuAppointmentToDate>2025-10-28T12:22:01.1189083Z</PuAppointmentToDate>
  <ReceivingNote>sample string 13</ReceivingNote>
  <ReceivingSpecialReq>sample string 11</ReceivingSpecialReq>
  <ReqShipDate>2025-10-28T12:22:01.1189083Z</ReqShipDate>
  <RestTime>1</RestTime>
  <SealNumber>sample string 6</SealNumber>
  <ShipmentDate>2025-10-28T12:22:01.117909Z</ShipmentDate>
  <ShipperId>1</ShipperId>
  <ShippingNote>sample string 12</ShippingNote>
  <ShippingSpecialReq>sample string 9</ShippingSpecialReq>
  <SignatureRequired>true</SignatureRequired>
  <TotalWeight>1</TotalWeight>
  <TrailerNumber>sample string 7</TrailerNumber>
  <Value>1</Value>
  <WeightType>sample string 15</WeightType>
</ShipmentsDlsViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.