POST api/edi/definetrip
Set trip/shipment details
Request Information
URI Parameters
None.
Body Parameters
DefineTripRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| TripID | string |
None. |
|
| TripAction | LTTripAction |
None. |
|
| TrackerID | string |
None. |
|
| LaneDescription | string |
None. |
|
| CarrierTcode | string |
None. |
|
| CustomerCode | string |
None. |
|
| TempLowCritical | decimal number |
None. |
|
| TempHighCritical | decimal number |
None. |
|
| TempLowWarning | decimal number |
None. |
|
| TempHighWarning | decimal number |
None. |
|
| Locations | Collection of StopLocation |
None. |
|
| RepID | string |
None. |
|
| RepFirstName | string |
None. |
|
| RepLastName | string |
None. |
|
| RepPhone | string |
None. |
|
| RepEmail | string |
None. |
|
| ShipperName | string |
None. |
|
| ReceiverName | string |
None. |
|
| CarrierName | string |
None. |
|
| CarrierEmails | Collection of string |
None. |
|
| ShipperEmails | Collection of string |
None. |
|
| ReceiverEmails | Collection of string |
None. |
|
| DriverName | string |
None. |
|
| DriverPhone | string |
None. |
|
| RetailerID | string |
None. |
|
| EstimatedFlightMinutes | integer |
None. |
|
| EstimatedLoadingMinutes | integer |
None. |
|
| DisableLoadStatus | boolean |
None. |
|
| PlateNum | string |
None. |
|
| ReceiverPONum | string |
None. |
|
| ContainerNum | string |
None. |
Request Validation Notes
DefineTripRequest| Name | Rule Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Locations | Locations cannot be null | ||||||||||||||||||||||||
StopLocation
|
|||||||||||||||||||||||||
| TripID | TripID cannot be empty and maximum length is 50 | ||||||||||||||||||||||||
| TrackerID | TrackerID cannot be empty and maximum length is 50 | ||||||||||||||||||||||||
| LaneDescription | LaneDescription maximum length is 255 | ||||||||||||||||||||||||
| CarrierTcode | CarrierTcode maximum length is 50 | ||||||||||||||||||||||||
| CustomerCode | CustomerCode maximum length is 50 | ||||||||||||||||||||||||
| RepID | RepID maximum length is 50 | ||||||||||||||||||||||||
| RepFirstName | RepFirstName maximum length is 100 | ||||||||||||||||||||||||
| RepLastName | RepLastName maximum length is 100 | ||||||||||||||||||||||||
| RepPhone | RepPhone maximum length is 50 | ||||||||||||||||||||||||
| RepEmail | RepEmail maximum length is 250 | ||||||||||||||||||||||||
| ShipperName | ShipperName maximum length is 100 | ||||||||||||||||||||||||
| ReceiverName | ReceiverName maximum length is 100 | ||||||||||||||||||||||||
| CarrierName | CarrierName maximum length is 100 | ||||||||||||||||||||||||
| DriverName | DriverName maximum length is 100 | ||||||||||||||||||||||||
| DriverPhone | DriverPhone maximum length is 50 | ||||||||||||||||||||||||
| TripAction | TripAction valid values: 0(New), 1(cancel), 2(EndTrip), 3(Update) | ||||||||||||||||||||||||
| TempLowCritical | If you specify a temperature, you must specify both TempLowCritical and TempHighCritical | ||||||||||||||||||||||||
| TempHighCritical | If you specify a temperature, you must specify both TempLowCritical and TempHighCritical | ||||||||||||||||||||||||
Request Formats
application/json
Sample:
{
"TripID": "sample string 1",
"TripAction": 0,
"TrackerID": "sample string 2",
"LaneDescription": "sample string 3",
"CarrierTcode": "sample string 4",
"CustomerCode": "sample string 5",
"TempLowCritical": 1.1,
"TempHighCritical": 1.1,
"TempLowWarning": 1.1,
"TempHighWarning": 1.1,
"Locations": [
{
"LocationName": "sample string 1",
"LocationID": "sample string 2",
"Address1": "sample string 3",
"Address2": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip": "sample string 7",
"Country": "sample string 8",
"LocationContact": "sample string 9",
"LocationPhoneNumber": "sample string 10",
"LocationType": 0,
"StopDateUTC": "sample string 11",
"StopTypeCode": 1
},
{
"LocationName": "sample string 1",
"LocationID": "sample string 2",
"Address1": "sample string 3",
"Address2": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip": "sample string 7",
"Country": "sample string 8",
"LocationContact": "sample string 9",
"LocationPhoneNumber": "sample string 10",
"LocationType": 0,
"StopDateUTC": "sample string 11",
"StopTypeCode": 1
}
],
"RepID": "sample string 6",
"RepFirstName": "sample string 7",
"RepLastName": "sample string 8",
"RepPhone": "sample string 9",
"RepEmail": "sample string 10",
"ShipperName": "sample string 11",
"ReceiverName": "sample string 12",
"CarrierName": "sample string 13",
"CarrierEmails": [
"sample string 1",
"sample string 2"
],
"ShipperEmails": [
"sample string 1",
"sample string 2"
],
"ReceiverEmails": [
"sample string 1",
"sample string 2"
],
"DriverName": "sample string 14",
"DriverPhone": "sample string 15",
"RetailerID": "sample string 16",
"EstimatedFlightMinutes": 1,
"EstimatedLoadingMinutes": 1,
"DisableLoadStatus": true,
"PlateNum": "sample string 17",
"ReceiverPONum": "sample string 18",
"ContainerNum": "sample string 19"
}
Response Information
Resource Description
DefineTripResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorCode | integer |
None. |
|
| ErrorDescription | string |
None. |
|
| Memo | string |
None. |
Response Formats
application/json
Sample:
Sample not available.