POST api/Route/Shipment/Create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	None.
ShipmentGUID	string	None.
CarrierID	integer	None.
RouteNumber	string	None.
DepartHubID	string	None.
ScheduledDepartDateTime	date	None.
UpdatedDepartDateTime	date	None.
ActualDepartDateTime	date	None.
ArriveHubID	string	None.
ScheduledArriveDateTime	date	None.
UpdatedArriveDateTime	date	None.
ActualArriveDateTime	date	None.
IsProblem	boolean	None.
ProblemDescription	string	None.
Status	string	None.
ExistingTransportLegID	integer	None.
LegType	string	None.
NewSequenceNumber	integer	None.
EquipmentType	string	None.
AutoTrack	boolean	None.
RouteConfirmed	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "ShipmentGUID": "sample string 2",
  "CarrierID": 3,
  "RouteNumber": "sample string 4",
  "DepartHubID": "sample string 5",
  "ScheduledDepartDateTime": "2024-12-27T15:29:19.1364504+00:00",
  "UpdatedDepartDateTime": "2024-12-27T15:29:19.1364504+00:00",
  "ActualDepartDateTime": "2024-12-27T15:29:19.1364504+00:00",
  "ArriveHubID": "sample string 6",
  "ScheduledArriveDateTime": "2024-12-27T15:29:19.1364504+00:00",
  "UpdatedArriveDateTime": "2024-12-27T15:29:19.1364504+00:00",
  "ActualArriveDateTime": "2024-12-27T15:29:19.1364504+00:00",
  "IsProblem": true,
  "ProblemDescription": "sample string 8",
  "Status": "sample string 9",
  "ExistingTransportLegID": 1,
  "LegType": "sample string 10",
  "NewSequenceNumber": 1,
  "EquipmentType": "sample string 11",
  "AutoTrack": true,
  "RouteConfirmed": true
}

application/xml, text/xml

Sample:

<CreateShipmentLegParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ActualArriveDateTime>2024-12-27T15:29:19.1364504+00:00</ActualArriveDateTime>
  <ActualDepartDateTime>2024-12-27T15:29:19.1364504+00:00</ActualDepartDateTime>
  <ArriveHubID>sample string 6</ArriveHubID>
  <AutoTrack>true</AutoTrack>
  <CarrierID>3</CarrierID>
  <DepartHubID>sample string 5</DepartHubID>
  <EquipmentType>sample string 11</EquipmentType>
  <ExistingTransportLegID>1</ExistingTransportLegID>
  <IsProblem>true</IsProblem>
  <LegType>sample string 10</LegType>
  <NewSequenceNumber>1</NewSequenceNumber>
  <ProblemDescription>sample string 8</ProblemDescription>
  <RouteConfirmed>true</RouteConfirmed>
  <RouteNumber>sample string 4</RouteNumber>
  <ScheduledArriveDateTime>2024-12-27T15:29:19.1364504+00:00</ScheduledArriveDateTime>
  <ScheduledDepartDateTime>2024-12-27T15:29:19.1364504+00:00</ScheduledDepartDateTime>
  <ShipmentGUID>sample string 2</ShipmentGUID>
  <Status>sample string 9</Status>
  <UpdatedArriveDateTime>2024-12-27T15:29:19.1364504+00:00</UpdatedArriveDateTime>
  <UpdatedDepartDateTime>2024-12-27T15:29:19.1364504+00:00</UpdatedDepartDateTime>
  <auth>sample string 1</auth>
</CreateShipmentLegParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

Name	Description	Type	Additional information
IsSuccessful		boolean	None.
ErrorMessage		string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>