POST api/Shipments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ShipmentDate	date	None.
ModeId	integer	Required
EquipmentTypeId	integer	None.
BasicPrice	decimal number	None.
BiddingEnabled	boolean	None.
BiddingTime	integer	None.
Value	decimal number	None.
SealNumber	string	None.
TrailerNumber	string	None.
TruckNumber	string	None.
PickupId	integer	None.
PickupNumber	string	None.
ShippingSpecialReq	Collection of string	None.
ReqShipDate	date	None.
PuAppointmentDate	date	None.
PuAppointmentToDate	date	None.
DestinationId	integer	None.
DestinationNumber	string	None.
Mabd	date	None.
DelAppointmentDate	date	None.
DelAppointmentToDate	date	None.
ReceivingSpecialReq	Collection of 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 AccessorialBindingViewModel	None.
IsPrivate	boolean	None.
Fields	Collection of AnswerFormViewModel	Required
ContainerNumber	string	None.
ReleaseNumber	string	None.
LastFreeDate	date	None.
VesselEta	date	None.
AvailableEta	date	None.
ReportedEmpty	date	None.
IsStayWith	boolean	None.
EquipmentSizeId	integer	None.
IsRequireProtection	boolean	None.
ProtectionId	integer	None.
RequiredTemperature	decimal number	None.
IsRequireLiftgate	boolean	None.
LiftgateMinWeight	integer	None.
IsHazardous	boolean	None.
HazmatClasses	Collection of integer	None.
BillToId	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "ShipmentDate": "2025-10-28T12:30:58.1542797Z",
  "ModeId": 1,
  "EquipmentTypeId": 1,
  "BasicPrice": 1.0,
  "BiddingEnabled": true,
  "BiddingTime": 1,
  "Value": 1.0,
  "SealNumber": "sample string 2",
  "TrailerNumber": "sample string 3",
  "TruckNumber": "sample string 4",
  "PickupId": 1,
  "PickupNumber": "sample string 5",
  "ShippingSpecialReq": [
    "sample string 1",
    "sample string 2"
  ],
  "ReqShipDate": "2025-10-28T12:30:58.1542797Z",
  "PuAppointmentDate": "2025-10-28T12:30:58.1542797Z",
  "PuAppointmentToDate": "2025-10-28T12:30:58.1542797Z",
  "DestinationId": 1,
  "DestinationNumber": "sample string 6",
  "Mabd": "2025-10-28T12:30:58.1542797Z",
  "DelAppointmentDate": "2025-10-28T12:30:58.1542797Z",
  "DelAppointmentToDate": "2025-10-28T12:30:58.1542797Z",
  "ReceivingSpecialReq": [
    "sample string 1",
    "sample string 2"
  ],
  "ShippingNote": "sample string 7",
  "ReceivingNote": "sample string 8",
  "AsDraft": true,
  "SignatureRequired": true,
  "RestTime": 1.0,
  "TotalWeight": 1.0,
  "WeightType": "sample string 10",
  "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
    }
  ],
  "ContainerNumber": "sample string 11",
  "ReleaseNumber": "sample string 12",
  "LastFreeDate": "2025-10-28T12:30:58.1542797Z",
  "VesselEta": "2025-10-28T12:30:58.1542797Z",
  "AvailableEta": "2025-10-28T12:30:58.1542797Z",
  "ReportedEmpty": "2025-10-28T12:30:58.1542797Z",
  "IsStayWith": true,
  "EquipmentSizeId": 1,
  "IsRequireProtection": true,
  "ProtectionId": 1,
  "RequiredTemperature": 1.0,
  "IsRequireLiftgate": true,
  "LiftgateMinWeight": 1,
  "IsHazardous": true,
  "HazmatClasses": [
    1,
    2
  ],
  "BillToId": 14
}

application/xml, text/xml

Sample:

<ShipmentsBindingViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShipperCore.ViewModels">
  <Accessorials>
    <AccessorialBindingViewModel>
      <IsPercentage>true</IsPercentage>
      <Name>sample string 1</Name>
      <Price>3</Price>
      <Quantity>4</Quantity>
    </AccessorialBindingViewModel>
    <AccessorialBindingViewModel>
      <IsPercentage>true</IsPercentage>
      <Name>sample string 1</Name>
      <Price>3</Price>
      <Quantity>4</Quantity>
    </AccessorialBindingViewModel>
  </Accessorials>
  <AsDraft>true</AsDraft>
  <AvailableEta>2025-10-28T12:30:58.1542797Z</AvailableEta>
  <BasicPrice>1</BasicPrice>
  <BiddingEnabled>true</BiddingEnabled>
  <BiddingTime>1</BiddingTime>
  <BillToId>14</BillToId>
  <ContainerNumber>sample string 11</ContainerNumber>
  <DelAppointmentDate>2025-10-28T12:30:58.1542797Z</DelAppointmentDate>
  <DelAppointmentToDate>2025-10-28T12:30:58.1542797Z</DelAppointmentToDate>
  <DestinationId>1</DestinationId>
  <DestinationNumber>sample string 6</DestinationNumber>
  <EquipmentSizeId>1</EquipmentSizeId>
  <EquipmentTypeId>1</EquipmentTypeId>
  <Fields>
    <AnswerFormViewModel>
      <Id>1</Id>
      <Required>true</Required>
      <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>
      </Value>
    </AnswerFormViewModel>
    <AnswerFormViewModel>
      <Id>1</Id>
      <Required>true</Required>
      <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>
      </Value>
    </AnswerFormViewModel>
  </Fields>
  <HazmatClasses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </HazmatClasses>
  <IsHazardous>true</IsHazardous>
  <IsPrivate>true</IsPrivate>
  <IsRequireLiftgate>true</IsRequireLiftgate>
  <IsRequireProtection>true</IsRequireProtection>
  <IsStayWith>true</IsStayWith>
  <LastFreeDate>2025-10-28T12:30:58.1542797Z</LastFreeDate>
  <LiftgateMinWeight>1</LiftgateMinWeight>
  <Mabd>2025-10-28T12:30:58.1542797Z</Mabd>
  <ModeId>1</ModeId>
  <PickupId>1</PickupId>
  <PickupNumber>sample string 5</PickupNumber>
  <ProtectionId>1</ProtectionId>
  <PuAppointmentDate>2025-10-28T12:30:58.1542797Z</PuAppointmentDate>
  <PuAppointmentToDate>2025-10-28T12:30:58.1542797Z</PuAppointmentToDate>
  <ReceivingNote>sample string 8</ReceivingNote>
  <ReceivingSpecialReq xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReceivingSpecialReq>
  <ReleaseNumber>sample string 12</ReleaseNumber>
  <ReportedEmpty>2025-10-28T12:30:58.1542797Z</ReportedEmpty>
  <ReqShipDate>2025-10-28T12:30:58.1542797Z</ReqShipDate>
  <RequiredTemperature>1</RequiredTemperature>
  <RestTime>1</RestTime>
  <SealNumber>sample string 2</SealNumber>
  <ShipmentDate>2025-10-28T12:30:58.1542797Z</ShipmentDate>
  <ShippingNote>sample string 7</ShippingNote>
  <ShippingSpecialReq xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ShippingSpecialReq>
  <SignatureRequired>true</SignatureRequired>
  <TotalWeight>1</TotalWeight>
  <TrailerNumber>sample string 3</TrailerNumber>
  <TruckNumber>sample string 4</TruckNumber>
  <Value>1</Value>
  <VesselEta>2025-10-28T12:30:58.1542797Z</VesselEta>
  <WeightType>sample string 10</WeightType>
</ShipmentsBindingViewModel>

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.