Bookings API
List Booking Expected Stops
Returns expected stops from bookings, including reservations without assigned equipment.
POST
/
t
/
v1
/
trip-plans
/
list-booking-expected-stops
List Booking Expected Stops
curl --request POST \
--url https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops \
--header 'Carrier: <carrier>' \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"arrivedAt": {
"end": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
},
"start": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
}
},
"attributeFilter": {
"arrivalTrainName": "<string>",
"departureTrainName": "<string>",
"stationGroupingIds": [
123
]
},
"bookingNumber": "<string>",
"carNumbers": [
{
"equipmentInitial": "<string>",
"equipmentNumber": "<string>"
}
],
"currentStation": "<string>",
"currentTrack": "<string>",
"departedAt": {
"end": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
},
"start": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
}
},
"destinationStation": "<string>",
"equipmentUuids": [
"<string>"
],
"eventTitle": "<string>",
"hasEquipment": true,
"includeSummary": true,
"page": {
"nextToken": "<string>",
"pageSize": "<string>",
"prevToken": "<string>"
},
"sortColumns": [
{
"column": "<string>",
"direction": "ASCENDING"
}
],
"stationFilter": {
"name": "<string>",
"railroad": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"statuses": [
"<string>"
]
}
'import requests
url = "https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops"
payload = {
"arrivedAt": {
"end": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
},
"start": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
}
},
"attributeFilter": {
"arrivalTrainName": "<string>",
"departureTrainName": "<string>",
"stationGroupingIds": [123]
},
"bookingNumber": "<string>",
"carNumbers": [
{
"equipmentInitial": "<string>",
"equipmentNumber": "<string>"
}
],
"currentStation": "<string>",
"currentTrack": "<string>",
"departedAt": {
"end": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
},
"start": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
}
},
"destinationStation": "<string>",
"equipmentUuids": ["<string>"],
"eventTitle": "<string>",
"hasEquipment": True,
"includeSummary": True,
"page": {
"nextToken": "<string>",
"pageSize": "<string>",
"prevToken": "<string>"
},
"sortColumns": [
{
"column": "<string>",
"direction": "ASCENDING"
}
],
"stationFilter": {
"name": "<string>",
"railroad": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"statuses": ["<string>"]
}
headers = {
"Carrier": "<carrier>",
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Carrier: '<carrier>',
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
arrivedAt: {
end: {boundary: 'UNSPECIFIED', timestamp: '2023-11-07T05:31:56Z'},
start: {boundary: 'UNSPECIFIED', timestamp: '2023-11-07T05:31:56Z'}
},
attributeFilter: {
arrivalTrainName: '<string>',
departureTrainName: '<string>',
stationGroupingIds: [123]
},
bookingNumber: '<string>',
carNumbers: [{equipmentInitial: '<string>', equipmentNumber: '<string>'}],
currentStation: '<string>',
currentTrack: '<string>',
departedAt: {
end: {boundary: 'UNSPECIFIED', timestamp: '2023-11-07T05:31:56Z'},
start: {boundary: 'UNSPECIFIED', timestamp: '2023-11-07T05:31:56Z'}
},
destinationStation: '<string>',
equipmentUuids: ['<string>'],
eventTitle: '<string>',
hasEquipment: true,
includeSummary: true,
page: {nextToken: '<string>', pageSize: '<string>', prevToken: '<string>'},
sortColumns: [{column: '<string>', direction: 'ASCENDING'}],
stationFilter: {
name: '<string>',
railroad: '<string>',
splc: '<string>',
stateOrProvince: '<string>'
},
statuses: ['<string>']
})
};
fetch('https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'arrivedAt' => [
'end' => [
'boundary' => 'UNSPECIFIED',
'timestamp' => '2023-11-07T05:31:56Z'
],
'start' => [
'boundary' => 'UNSPECIFIED',
'timestamp' => '2023-11-07T05:31:56Z'
]
],
'attributeFilter' => [
'arrivalTrainName' => '<string>',
'departureTrainName' => '<string>',
'stationGroupingIds' => [
123
]
],
'bookingNumber' => '<string>',
'carNumbers' => [
[
'equipmentInitial' => '<string>',
'equipmentNumber' => '<string>'
]
],
'currentStation' => '<string>',
'currentTrack' => '<string>',
'departedAt' => [
'end' => [
'boundary' => 'UNSPECIFIED',
'timestamp' => '2023-11-07T05:31:56Z'
],
'start' => [
'boundary' => 'UNSPECIFIED',
'timestamp' => '2023-11-07T05:31:56Z'
]
],
'destinationStation' => '<string>',
'equipmentUuids' => [
'<string>'
],
'eventTitle' => '<string>',
'hasEquipment' => true,
'includeSummary' => true,
'page' => [
'nextToken' => '<string>',
'pageSize' => '<string>',
'prevToken' => '<string>'
],
'sortColumns' => [
[
'column' => '<string>',
'direction' => 'ASCENDING'
]
],
'stationFilter' => [
'name' => '<string>',
'railroad' => '<string>',
'splc' => '<string>',
'stateOrProvince' => '<string>'
],
'statuses' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Carrier: <carrier>",
"Content-Type: application/json",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops"
payload := strings.NewReader("{\n \"arrivedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"attributeFilter\": {\n \"arrivalTrainName\": \"<string>\",\n \"departureTrainName\": \"<string>\",\n \"stationGroupingIds\": [\n 123\n ]\n },\n \"bookingNumber\": \"<string>\",\n \"carNumbers\": [\n {\n \"equipmentInitial\": \"<string>\",\n \"equipmentNumber\": \"<string>\"\n }\n ],\n \"currentStation\": \"<string>\",\n \"currentTrack\": \"<string>\",\n \"departedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"destinationStation\": \"<string>\",\n \"equipmentUuids\": [\n \"<string>\"\n ],\n \"eventTitle\": \"<string>\",\n \"hasEquipment\": true,\n \"includeSummary\": true,\n \"page\": {\n \"nextToken\": \"<string>\",\n \"pageSize\": \"<string>\",\n \"prevToken\": \"<string>\"\n },\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ],\n \"stationFilter\": {\n \"name\": \"<string>\",\n \"railroad\": \"<string>\",\n \"splc\": \"<string>\",\n \"stateOrProvince\": \"<string>\"\n },\n \"statuses\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Carrier", "<carrier>")
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops")
.header("Carrier", "<carrier>")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"arrivedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"attributeFilter\": {\n \"arrivalTrainName\": \"<string>\",\n \"departureTrainName\": \"<string>\",\n \"stationGroupingIds\": [\n 123\n ]\n },\n \"bookingNumber\": \"<string>\",\n \"carNumbers\": [\n {\n \"equipmentInitial\": \"<string>\",\n \"equipmentNumber\": \"<string>\"\n }\n ],\n \"currentStation\": \"<string>\",\n \"currentTrack\": \"<string>\",\n \"departedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"destinationStation\": \"<string>\",\n \"equipmentUuids\": [\n \"<string>\"\n ],\n \"eventTitle\": \"<string>\",\n \"hasEquipment\": true,\n \"includeSummary\": true,\n \"page\": {\n \"nextToken\": \"<string>\",\n \"pageSize\": \"<string>\",\n \"prevToken\": \"<string>\"\n },\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ],\n \"stationFilter\": {\n \"name\": \"<string>\",\n \"railroad\": \"<string>\",\n \"splc\": \"<string>\",\n \"stateOrProvince\": \"<string>\"\n },\n \"statuses\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Carrier"] = '<carrier>'
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"arrivedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"attributeFilter\": {\n \"arrivalTrainName\": \"<string>\",\n \"departureTrainName\": \"<string>\",\n \"stationGroupingIds\": [\n 123\n ]\n },\n \"bookingNumber\": \"<string>\",\n \"carNumbers\": [\n {\n \"equipmentInitial\": \"<string>\",\n \"equipmentNumber\": \"<string>\"\n }\n ],\n \"currentStation\": \"<string>\",\n \"currentTrack\": \"<string>\",\n \"departedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"destinationStation\": \"<string>\",\n \"equipmentUuids\": [\n \"<string>\"\n ],\n \"eventTitle\": \"<string>\",\n \"hasEquipment\": true,\n \"includeSummary\": true,\n \"page\": {\n \"nextToken\": \"<string>\",\n \"pageSize\": \"<string>\",\n \"prevToken\": \"<string>\"\n },\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ],\n \"stationFilter\": {\n \"name\": \"<string>\",\n \"railroad\": \"<string>\",\n \"splc\": \"<string>\",\n \"stateOrProvince\": \"<string>\"\n },\n \"statuses\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"bookingExpectedStops": [
{
"destinationStation": {
"distance": 123,
"endTime": "2023-11-07T05:31:56Z",
"eventTitle": "<string>",
"eventType": "UNSPECIFIED",
"location": {
"attributes": {},
"latLng": {
"latitude": 123,
"longitude": 123
},
"locationType": "UNKNOWN",
"station": {
"name": "<string>",
"railroad": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
}
},
"priority": 123,
"startTime": "2023-11-07T05:31:56Z",
"totalDistance": 123
},
"equipment": {
"arrivalState": "AS_INBOUND",
"equipmentId": 123,
"equipmentInitial": "<string>",
"equipmentNumber": "<string>",
"equipmentUuid": "<string>",
"groupings": [
{
"attributes": {},
"customerLocation": {
"abbreviatedName": "<string>",
"address": {
"addressId": "<string>",
"addressType": "AT_UNKNOWN",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"state": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"streetLine4": "<string>",
"zipCode": "<string>"
},
"addressName": "<string>",
"blockCode": "<string>",
"currencyCode": "<string>",
"customer": {
"customerId": "<string>",
"customerUuid": "<string>",
"locations": "<array>",
"name": "<string>"
},
"customerIdentificationNumbers": [
"<string>"
],
"customerLocationId": "<string>",
"customerLocationUuid": "<string>",
"email": "<string>",
"freightBillEdiReceiver": "<string>",
"generalLedgerNumber": "<string>",
"isDefault": true,
"isReportingLocation": true,
"name": "<string>",
"phoneNumber": "<string>",
"serviceTypeIds": [
"<string>"
],
"usedForBilling": true
},
"equipmentIndexEnabled": true,
"frozen": true,
"groupingId": "<string>",
"groupingType": "<string>",
"name": "<string>",
"sortOrder": 123,
"status": "ACTIVE"
}
],
"loadStatus": "<string>",
"location": {
"index": 123,
"track": {
"name": "<string>",
"trackId": "<string>"
}
},
"parentGroupings": [
{
"attributes": {},
"grouping": {
"attributes": {},
"customerLocation": {
"abbreviatedName": "<string>",
"address": {
"addressId": "<string>",
"addressType": "AT_UNKNOWN",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"state": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"streetLine4": "<string>",
"zipCode": "<string>"
},
"addressName": "<string>",
"blockCode": "<string>",
"currencyCode": "<string>",
"customer": {
"customerId": "<string>",
"customerUuid": "<string>",
"locations": "<array>",
"name": "<string>"
},
"customerIdentificationNumbers": [
"<string>"
],
"customerLocationId": "<string>",
"customerLocationUuid": "<string>",
"email": "<string>",
"freightBillEdiReceiver": "<string>",
"generalLedgerNumber": "<string>",
"isDefault": true,
"isReportingLocation": true,
"name": "<string>",
"phoneNumber": "<string>",
"serviceTypeIds": [
"<string>"
],
"usedForBilling": true
},
"equipmentIndexEnabled": true,
"frozen": true,
"groupingId": "<string>",
"groupingType": "<string>",
"name": "<string>",
"sortOrder": 123,
"status": "ACTIVE"
},
"groupingIndex": 123
}
],
"umler": {
"abt57YrDueDate": "<string>",
"abtDueDate": "<string>",
"articulated": "<string>",
"attributes": {},
"axleCount": 123,
"bodyMaterial": "<string>",
"boxSideDoorOrientation": "<string>",
"brakeShoeType": "<string>",
"brakeWeightLb": 123,
"brakeWeightUnit": "UOM_UNSPECIFIED",
"carGrade": "<string>",
"couplerStyle": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"cubicFeetCapacity": 123,
"doorLubeDueDate": "<string>",
"elementEquipmentGroup": "<string>",
"endOfTrainOnly": "<string>",
"equipmentInitial": "<string>",
"equipmentNumber": "<string>",
"floorStrengthClassification": "<string>",
"gallonageCapacity": 123,
"grossRailWeight": 123,
"grossRailWeightLb": 123,
"grossRailWeightUnit": "UOM_UNSPECIFIED",
"insideHeight": 123,
"insideHeightFt": 123,
"insideHeightUnit": "UOM_UNSPECIFIED",
"insideLength": 123,
"insideLengthFt": 123,
"insideLengthUnit": "UOM_UNSPECIFIED",
"inspectionDueDate": "<string>",
"lengthFt": 123,
"lessee": "<string>",
"loadLimit": 123,
"loadLimitLb": 123,
"loadLimitUnit": "UOM_UNSPECIFIED",
"markOwnerCategory": "<string>",
"mechanicalDesignation": "<string>",
"netWeightLb": 123,
"netWeightUnit": "UOM_UNSPECIFIED",
"operatingBrakes": 123,
"outerExtremeHeight": 123,
"outerExtremeHeightFt": 123,
"outerExtremeHeightUnit": "UOM_UNSPECIFIED",
"outsideExtremeWidth": 123,
"outsideExtremeWidthFt": 123,
"outsideExtremeWidthUnit": "UOM_UNSPECIFIED",
"outsideHeightExtremeWidth": 123,
"outsideHeightExtremeWidthFt": 123,
"outsideHeightExtremeWidthUnit": "UOM_UNSPECIFIED",
"outsideLength": 123,
"outsideLengthFt": 123,
"outsideLengthUnit": "UOM_UNSPECIFIED",
"owner": "<string>",
"plateCode": "<string>",
"poolNumber": "<string>",
"residualSideBearings": "<string>",
"shoveAdjCarToRest": "<string>",
"shoveCarToRest": "<string>",
"sideDoorHeight": 123,
"sideDoorHeightFt": 123,
"sideDoorHeightUnit": "UOM_UNSPECIFIED",
"sideDoorType": "<string>",
"sideDoorWidth": 123,
"sideDoorWidthFt": 123,
"sideDoorWidthUnit": "UOM_UNSPECIFIED",
"tareWeight": 123,
"tareWeightLb": 123,
"tareWeightUnit": "UOM_UNSPECIFIED",
"trainPositionSensitive": "<string>",
"umet": "<string>",
"umlerUpdatedAt": "2023-11-07T05:31:56Z",
"unitEquipmentGroup": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"verificationKey": "<string>",
"verificationKeys": [
{
"compartment": 123,
"key": "<string>"
}
],
"waybill": {
"armsTrackingId": "<string>",
"billOfLadingNumber": "<string>",
"capacityLoadCode": "CAPACITY_LOAD_CODE_UNSPECIFIED",
"crossReferenceEquipment": [
{
"checkDigit": 123,
"crossReferenceTypeCode": "CROSS_REFERENCE_TYPE_CODE_UNSPECIFIED",
"equipmentInitial": "<string>",
"equipmentIsDamaged": true,
"equipmentLength": "<string>",
"equipmentNumber": "<string>",
"equipmentOperatorScac": "<string>",
"equipmentOwnerScac": "<string>",
"referenceId": "<string>",
"referenceIdQualifier": "<string>"
}
],
"defaultReceiver": "<string>",
"destinationJunction": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"destinationStation": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"equipmentDetails": [
{
"aarCarType": "<string>",
"canadianGrainInformation": [
{
"canadianWheatBoardMarketingClassCode": "<string>",
"canadianWheatBoardMarketingClassTypeCode": "<string>",
"commodityCode": "<string>",
"directHiToDepartureWharfForVesselLoading": true,
"fumigatedCleanedIndicator": "<string>",
"grainBlockNumber": "<string>",
"grainBlockQualifier": "<string>",
"inspectedWeighedIndicatorCode": "<string>",
"machineSeparableIndicatorCode": "<string>",
"numberOfCarsClaimedForIncentiveRate": 123,
"percentQualifier": "<string>",
"percentage": 123,
"stateOrProvinceCode": "<string>",
"terminalOrStagingAreaName": "<string>",
"unloadDate": "<string>",
"unloadTerminalElevatorCode": "<string>",
"week": 123
}
],
"carrierCode": "<string>",
"chassisInitial": "<string>",
"chassisNumber": "<string>",
"checkDigit": 123,
"descriptionCode": "<string>",
"dunnage": 123,
"dunnageMeasure": {
"unit": "<string>",
"value": 123
},
"equipmentInitial": "<string>",
"equipmentName": "<string>",
"equipmentNumber": "<string>",
"equipmentOrdered": {
"aarCarType": "<string>",
"cubicCapacity": 123,
"heightInches": 123,
"lengthInches": 123,
"weightCapacity": 123
},
"grossWeightLbs": 123,
"grossWeightMeasure": {
"unit": "<string>",
"value": 123
},
"heightIn": 123,
"heightMeasure": {
"unit": "<string>",
"value": 123
},
"interchangeMoveAuthorities": [
{
"carrierCode": "<string>",
"movementAuthorityCode": "<string>",
"rejectReasonCode": "<string>",
"stateTariffApplicationCode": "<string>",
"terminalTariffApplicationCode": "<string>"
}
],
"isoContainerCode": "<string>",
"lengthIn": 123,
"lengthMeasure": {
"unit": "<string>",
"value": 123
},
"netWeightLbs": 123,
"netWeightMeasure": {
"unit": "<string>",
"value": 123
},
"ownershipCode": "<string>",
"owningCarrierCode": "<string>",
"position": "<string>",
"sealNumbers": [
"<string>"
],
"shipmentInfo": [
{
"description": "<string>",
"extendedReferenceInfo": [
{
"description": "<string>",
"referenceId": "<string>",
"referenceIdQualifier": "<string>",
"referenceTimestamp": "2023-11-07T05:31:56Z"
}
],
"lineItems": [
{
"cbpBarcodeNumber": "<string>",
"commodityCode": "<string>",
"commodityCodeQualifier": "<string>",
"commodityDescription": "<string>",
"currencyCode": "<string>",
"customsShipmentValue": 123,
"destinationCountryCode": "<string>",
"marksAndNumbers": "<string>",
"originCountryCode": "<string>",
"quantity": 123,
"smallestExteriorPackageType": "<string>",
"weight": 123,
"weightUnitCode": "<string>"
}
],
"referenceId": "<string>",
"referenceIdQualifier": "<string>"
}
],
"tareQualifierCode": "<string>",
"tareWeightLbs": 123,
"tareWeightMeasure": {
"unit": "<string>",
"value": 123
},
"terminals": [
{
"locationIdentifier": "<string>",
"locationQualifier": "<string>",
"portName": "<string>",
"terminalFunctionCode": "<string>"
}
],
"weightAllowance": 123,
"weightAllowanceMeasure": {
"unit": "<string>",
"value": 123
},
"weightType": "WT_ESTIMATED",
"widthIn": 123,
"widthMeasure": {
"unit": "<string>",
"value": 123
}
}
],
"extendedReferenceInfo": [
{
"description": "<string>",
"referenceId": "<string>",
"referenceIdQualifier": "<string>",
"referenceTimestamp": "2023-11-07T05:31:56Z"
}
],
"lineItems": [
{
"descriptions": [
{
"commodityCode": "<string>",
"commodityCodeQualifier": "CCQ_UNKNOWN",
"compartmentIdCode": "<string>",
"hazmatRatingCommodityCode": "<string>",
"hazmatRatingCommodityCodeQualifier": "<string>",
"ladingDescription": "<string>",
"marksAndNumbers": "<string>",
"marksAndNumbersQualifier": "<string>",
"packagingCode": "<string>"
}
],
"measurements": [
{
"codeListQualifier": "<string>",
"industryCode": "<string>",
"measurementAttributeCode": "<string>",
"measurementMethodOrDevice": "<string>",
"measurementQualifier": "<string>",
"measurementSignificanceCode": "<string>",
"measurementValue": 123,
"rangeMaximum": 123,
"rangeMinimum": 123,
"referenceIdCode": "<string>",
"surfaceLayerPositionCode": "<string>",
"unitCode": "<string>"
}
],
"number": 123,
"priceAuthorities": [
{
"effectiveDate": "<string>",
"expirationDate": "<string>",
"issuingCarrierIdentifier": "<string>",
"itemNumber": "<string>",
"itemNumberSuffix": "<string>",
"primaryPublicationAuthority": "<string>",
"referenceId": "<string>",
"referenceIdQualifier": "<string>",
"regulatoryAgencyCode": "<string>",
"sectionNumber": "<string>",
"suffix": "<string>",
"supplementIdentifier": "<string>",
"tariffAgencyCode": "<string>"
}
],
"quantity": {
"billedAsQualifier": "<string>",
"billedAsQuantity": 123,
"dunnageDescription": "<string>",
"ladingQuantity": 123,
"packagingFormCode": "<string>",
"typeOfServiceCode": "<string>",
"volume": 123,
"volumeUnitQualifier": "<string>",
"weight": 123,
"weightQualifier": "WQ_UNKNOWN",
"weightUnitCode": "<string>"
}
}
],
"originCarrierCode": "<string>",
"originJunction": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"originStation": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"originSystem": "WAYBILL_ORIGIN_SYSTEM_UNSPECIFIED",
"parties": [
{
"additionalNames": [
"<string>"
],
"address": [
"<string>"
],
"administrativeContacts": [
{
"communicationNumbers": [
{
"number": "<string>",
"qualifier": "<string>"
}
],
"contactFunctionCode": "<string>",
"contactInquiryReference": "<string>",
"name": "<string>"
}
],
"billingInfo": [
{
"carrierCodes": [
"<string>"
],
"destination": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"origin": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"rebillReasonCode": "REBILL_REASON_CODE_UNSPECIFIED"
}
],
"cityName": "<string>",
"countryCode": "<string>",
"countrySubdivisionCode": "<string>",
"entitySubIdentifierCode": "<string>",
"entitySubIdentifierRelationshipCode": "<string>",
"idCode": "<string>",
"idCodeQualifier": "PARTY_IDENTIFICATION_CODE_QUALIFIER_UNSPECIFIED",
"locationIdentifier": "<string>",
"locationQualifier": "<string>",
"locationUuid": "<string>",
"name": "<string>",
"partyType": "PARTY_ENTITY_IDENTIFIER_CODE_UNSPECIFIED",
"postalCode": "<string>",
"referenceInfo": [
{
"description": "<string>",
"referenceId": "<string>",
"referenceIdQualifier": "<string>"
}
],
"stateOrProvince": "<string>"
}
],
"revisionNumber": 123,
"revisionSourceType": "WAYBILL_REVISION_SOURCE_TYPE_UNSPECIFIED",
"revisionTime": "2023-11-07T05:31:56Z",
"route": [
{
"additionalSwitchCarrierCodes": [
"<string>"
],
"carrierCode": "<string>",
"intermodalServiceCode": "<string>",
"isBreakpoint": true,
"junctionCode": "<string>",
"rebillReasonCode": "<string>",
"routingSequenceCode": "ROUTING_SEQUENCE_CODE_UNSPECIFIED",
"rule11PartyId": "<string>",
"splc": "<string>"
}
],
"shipmentId": "<string>",
"shipmentPaymentMethod": "SHIPMENT_PAYMENT_METHOD_UNSPECIFIED",
"shipmentQualifier": "SHIPMENT_QUALIFIER_UNSPECIFIED",
"specialHandlingCodes": [
"<string>"
],
"transportationMethod": "TRANSPORTATION_METHOD_UNSPECIFIED",
"waybillDate": "2023-11-07T05:31:56Z",
"waybillId": 123,
"waybillNumber": 123,
"waybillStatus": "WAYBILL_STATUS_UNSPECIFIED",
"weightUnitCode": "WEIGHT_UNIT_CODE_UNSPECIFIED"
}
},
"expectedStop": {
"distance": 123,
"endTime": "2023-11-07T05:31:56Z",
"eventTitle": "<string>",
"eventType": "UNSPECIFIED",
"location": {
"attributes": {},
"latLng": {
"latitude": 123,
"longitude": 123
},
"locationType": "UNKNOWN",
"station": {
"name": "<string>",
"railroad": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
}
},
"priority": 123,
"startTime": "2023-11-07T05:31:56Z",
"totalDistance": 123
},
"tripPlanHandle": {
"bookingNumber": "<string>",
"predictedLengthMm": 123,
"predictedWeightKg": 123,
"status": "<string>",
"suborderNumber": "<string>",
"tripPlanId": "<string>",
"wagonLetter": "<string>"
}
}
],
"page": {
"nextToken": "<string>",
"pageSize": "<string>",
"prevToken": "<string>"
},
"summary": {
"equipmentCarNames": [
"<string>"
],
"equipmentCount": "<string>",
"totalCount": "<string>"
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Headers
Carrier ID
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Equipment-assignment filter. Omit to return both assigned and booking-only reservations; true returns assigned bookings; false returns booking-only reservations.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
List Booking Expected Stops
curl --request POST \
--url https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops \
--header 'Carrier: <carrier>' \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"arrivedAt": {
"end": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
},
"start": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
}
},
"attributeFilter": {
"arrivalTrainName": "<string>",
"departureTrainName": "<string>",
"stationGroupingIds": [
123
]
},
"bookingNumber": "<string>",
"carNumbers": [
{
"equipmentInitial": "<string>",
"equipmentNumber": "<string>"
}
],
"currentStation": "<string>",
"currentTrack": "<string>",
"departedAt": {
"end": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
},
"start": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
}
},
"destinationStation": "<string>",
"equipmentUuids": [
"<string>"
],
"eventTitle": "<string>",
"hasEquipment": true,
"includeSummary": true,
"page": {
"nextToken": "<string>",
"pageSize": "<string>",
"prevToken": "<string>"
},
"sortColumns": [
{
"column": "<string>",
"direction": "ASCENDING"
}
],
"stationFilter": {
"name": "<string>",
"railroad": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"statuses": [
"<string>"
]
}
'import requests
url = "https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops"
payload = {
"arrivedAt": {
"end": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
},
"start": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
}
},
"attributeFilter": {
"arrivalTrainName": "<string>",
"departureTrainName": "<string>",
"stationGroupingIds": [123]
},
"bookingNumber": "<string>",
"carNumbers": [
{
"equipmentInitial": "<string>",
"equipmentNumber": "<string>"
}
],
"currentStation": "<string>",
"currentTrack": "<string>",
"departedAt": {
"end": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
},
"start": {
"boundary": "UNSPECIFIED",
"timestamp": "2023-11-07T05:31:56Z"
}
},
"destinationStation": "<string>",
"equipmentUuids": ["<string>"],
"eventTitle": "<string>",
"hasEquipment": True,
"includeSummary": True,
"page": {
"nextToken": "<string>",
"pageSize": "<string>",
"prevToken": "<string>"
},
"sortColumns": [
{
"column": "<string>",
"direction": "ASCENDING"
}
],
"stationFilter": {
"name": "<string>",
"railroad": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"statuses": ["<string>"]
}
headers = {
"Carrier": "<carrier>",
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Carrier: '<carrier>',
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
arrivedAt: {
end: {boundary: 'UNSPECIFIED', timestamp: '2023-11-07T05:31:56Z'},
start: {boundary: 'UNSPECIFIED', timestamp: '2023-11-07T05:31:56Z'}
},
attributeFilter: {
arrivalTrainName: '<string>',
departureTrainName: '<string>',
stationGroupingIds: [123]
},
bookingNumber: '<string>',
carNumbers: [{equipmentInitial: '<string>', equipmentNumber: '<string>'}],
currentStation: '<string>',
currentTrack: '<string>',
departedAt: {
end: {boundary: 'UNSPECIFIED', timestamp: '2023-11-07T05:31:56Z'},
start: {boundary: 'UNSPECIFIED', timestamp: '2023-11-07T05:31:56Z'}
},
destinationStation: '<string>',
equipmentUuids: ['<string>'],
eventTitle: '<string>',
hasEquipment: true,
includeSummary: true,
page: {nextToken: '<string>', pageSize: '<string>', prevToken: '<string>'},
sortColumns: [{column: '<string>', direction: 'ASCENDING'}],
stationFilter: {
name: '<string>',
railroad: '<string>',
splc: '<string>',
stateOrProvince: '<string>'
},
statuses: ['<string>']
})
};
fetch('https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'arrivedAt' => [
'end' => [
'boundary' => 'UNSPECIFIED',
'timestamp' => '2023-11-07T05:31:56Z'
],
'start' => [
'boundary' => 'UNSPECIFIED',
'timestamp' => '2023-11-07T05:31:56Z'
]
],
'attributeFilter' => [
'arrivalTrainName' => '<string>',
'departureTrainName' => '<string>',
'stationGroupingIds' => [
123
]
],
'bookingNumber' => '<string>',
'carNumbers' => [
[
'equipmentInitial' => '<string>',
'equipmentNumber' => '<string>'
]
],
'currentStation' => '<string>',
'currentTrack' => '<string>',
'departedAt' => [
'end' => [
'boundary' => 'UNSPECIFIED',
'timestamp' => '2023-11-07T05:31:56Z'
],
'start' => [
'boundary' => 'UNSPECIFIED',
'timestamp' => '2023-11-07T05:31:56Z'
]
],
'destinationStation' => '<string>',
'equipmentUuids' => [
'<string>'
],
'eventTitle' => '<string>',
'hasEquipment' => true,
'includeSummary' => true,
'page' => [
'nextToken' => '<string>',
'pageSize' => '<string>',
'prevToken' => '<string>'
],
'sortColumns' => [
[
'column' => '<string>',
'direction' => 'ASCENDING'
]
],
'stationFilter' => [
'name' => '<string>',
'railroad' => '<string>',
'splc' => '<string>',
'stateOrProvince' => '<string>'
],
'statuses' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Carrier: <carrier>",
"Content-Type: application/json",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops"
payload := strings.NewReader("{\n \"arrivedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"attributeFilter\": {\n \"arrivalTrainName\": \"<string>\",\n \"departureTrainName\": \"<string>\",\n \"stationGroupingIds\": [\n 123\n ]\n },\n \"bookingNumber\": \"<string>\",\n \"carNumbers\": [\n {\n \"equipmentInitial\": \"<string>\",\n \"equipmentNumber\": \"<string>\"\n }\n ],\n \"currentStation\": \"<string>\",\n \"currentTrack\": \"<string>\",\n \"departedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"destinationStation\": \"<string>\",\n \"equipmentUuids\": [\n \"<string>\"\n ],\n \"eventTitle\": \"<string>\",\n \"hasEquipment\": true,\n \"includeSummary\": true,\n \"page\": {\n \"nextToken\": \"<string>\",\n \"pageSize\": \"<string>\",\n \"prevToken\": \"<string>\"\n },\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ],\n \"stationFilter\": {\n \"name\": \"<string>\",\n \"railroad\": \"<string>\",\n \"splc\": \"<string>\",\n \"stateOrProvince\": \"<string>\"\n },\n \"statuses\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Carrier", "<carrier>")
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops")
.header("Carrier", "<carrier>")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"arrivedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"attributeFilter\": {\n \"arrivalTrainName\": \"<string>\",\n \"departureTrainName\": \"<string>\",\n \"stationGroupingIds\": [\n 123\n ]\n },\n \"bookingNumber\": \"<string>\",\n \"carNumbers\": [\n {\n \"equipmentInitial\": \"<string>\",\n \"equipmentNumber\": \"<string>\"\n }\n ],\n \"currentStation\": \"<string>\",\n \"currentTrack\": \"<string>\",\n \"departedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"destinationStation\": \"<string>\",\n \"equipmentUuids\": [\n \"<string>\"\n ],\n \"eventTitle\": \"<string>\",\n \"hasEquipment\": true,\n \"includeSummary\": true,\n \"page\": {\n \"nextToken\": \"<string>\",\n \"pageSize\": \"<string>\",\n \"prevToken\": \"<string>\"\n },\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ],\n \"stationFilter\": {\n \"name\": \"<string>\",\n \"railroad\": \"<string>\",\n \"splc\": \"<string>\",\n \"stateOrProvince\": \"<string>\"\n },\n \"statuses\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg-k-h1.arms.cedarai.com/t/v1/trip-plans/list-booking-expected-stops")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Carrier"] = '<carrier>'
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"arrivedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"attributeFilter\": {\n \"arrivalTrainName\": \"<string>\",\n \"departureTrainName\": \"<string>\",\n \"stationGroupingIds\": [\n 123\n ]\n },\n \"bookingNumber\": \"<string>\",\n \"carNumbers\": [\n {\n \"equipmentInitial\": \"<string>\",\n \"equipmentNumber\": \"<string>\"\n }\n ],\n \"currentStation\": \"<string>\",\n \"currentTrack\": \"<string>\",\n \"departedAt\": {\n \"end\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n },\n \"start\": {\n \"boundary\": \"UNSPECIFIED\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"destinationStation\": \"<string>\",\n \"equipmentUuids\": [\n \"<string>\"\n ],\n \"eventTitle\": \"<string>\",\n \"hasEquipment\": true,\n \"includeSummary\": true,\n \"page\": {\n \"nextToken\": \"<string>\",\n \"pageSize\": \"<string>\",\n \"prevToken\": \"<string>\"\n },\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ],\n \"stationFilter\": {\n \"name\": \"<string>\",\n \"railroad\": \"<string>\",\n \"splc\": \"<string>\",\n \"stateOrProvince\": \"<string>\"\n },\n \"statuses\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"bookingExpectedStops": [
{
"destinationStation": {
"distance": 123,
"endTime": "2023-11-07T05:31:56Z",
"eventTitle": "<string>",
"eventType": "UNSPECIFIED",
"location": {
"attributes": {},
"latLng": {
"latitude": 123,
"longitude": 123
},
"locationType": "UNKNOWN",
"station": {
"name": "<string>",
"railroad": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
}
},
"priority": 123,
"startTime": "2023-11-07T05:31:56Z",
"totalDistance": 123
},
"equipment": {
"arrivalState": "AS_INBOUND",
"equipmentId": 123,
"equipmentInitial": "<string>",
"equipmentNumber": "<string>",
"equipmentUuid": "<string>",
"groupings": [
{
"attributes": {},
"customerLocation": {
"abbreviatedName": "<string>",
"address": {
"addressId": "<string>",
"addressType": "AT_UNKNOWN",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"state": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"streetLine4": "<string>",
"zipCode": "<string>"
},
"addressName": "<string>",
"blockCode": "<string>",
"currencyCode": "<string>",
"customer": {
"customerId": "<string>",
"customerUuid": "<string>",
"locations": "<array>",
"name": "<string>"
},
"customerIdentificationNumbers": [
"<string>"
],
"customerLocationId": "<string>",
"customerLocationUuid": "<string>",
"email": "<string>",
"freightBillEdiReceiver": "<string>",
"generalLedgerNumber": "<string>",
"isDefault": true,
"isReportingLocation": true,
"name": "<string>",
"phoneNumber": "<string>",
"serviceTypeIds": [
"<string>"
],
"usedForBilling": true
},
"equipmentIndexEnabled": true,
"frozen": true,
"groupingId": "<string>",
"groupingType": "<string>",
"name": "<string>",
"sortOrder": 123,
"status": "ACTIVE"
}
],
"loadStatus": "<string>",
"location": {
"index": 123,
"track": {
"name": "<string>",
"trackId": "<string>"
}
},
"parentGroupings": [
{
"attributes": {},
"grouping": {
"attributes": {},
"customerLocation": {
"abbreviatedName": "<string>",
"address": {
"addressId": "<string>",
"addressType": "AT_UNKNOWN",
"city": "<string>",
"country": "<string>",
"name": "<string>",
"state": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"streetLine4": "<string>",
"zipCode": "<string>"
},
"addressName": "<string>",
"blockCode": "<string>",
"currencyCode": "<string>",
"customer": {
"customerId": "<string>",
"customerUuid": "<string>",
"locations": "<array>",
"name": "<string>"
},
"customerIdentificationNumbers": [
"<string>"
],
"customerLocationId": "<string>",
"customerLocationUuid": "<string>",
"email": "<string>",
"freightBillEdiReceiver": "<string>",
"generalLedgerNumber": "<string>",
"isDefault": true,
"isReportingLocation": true,
"name": "<string>",
"phoneNumber": "<string>",
"serviceTypeIds": [
"<string>"
],
"usedForBilling": true
},
"equipmentIndexEnabled": true,
"frozen": true,
"groupingId": "<string>",
"groupingType": "<string>",
"name": "<string>",
"sortOrder": 123,
"status": "ACTIVE"
},
"groupingIndex": 123
}
],
"umler": {
"abt57YrDueDate": "<string>",
"abtDueDate": "<string>",
"articulated": "<string>",
"attributes": {},
"axleCount": 123,
"bodyMaterial": "<string>",
"boxSideDoorOrientation": "<string>",
"brakeShoeType": "<string>",
"brakeWeightLb": 123,
"brakeWeightUnit": "UOM_UNSPECIFIED",
"carGrade": "<string>",
"couplerStyle": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"cubicFeetCapacity": 123,
"doorLubeDueDate": "<string>",
"elementEquipmentGroup": "<string>",
"endOfTrainOnly": "<string>",
"equipmentInitial": "<string>",
"equipmentNumber": "<string>",
"floorStrengthClassification": "<string>",
"gallonageCapacity": 123,
"grossRailWeight": 123,
"grossRailWeightLb": 123,
"grossRailWeightUnit": "UOM_UNSPECIFIED",
"insideHeight": 123,
"insideHeightFt": 123,
"insideHeightUnit": "UOM_UNSPECIFIED",
"insideLength": 123,
"insideLengthFt": 123,
"insideLengthUnit": "UOM_UNSPECIFIED",
"inspectionDueDate": "<string>",
"lengthFt": 123,
"lessee": "<string>",
"loadLimit": 123,
"loadLimitLb": 123,
"loadLimitUnit": "UOM_UNSPECIFIED",
"markOwnerCategory": "<string>",
"mechanicalDesignation": "<string>",
"netWeightLb": 123,
"netWeightUnit": "UOM_UNSPECIFIED",
"operatingBrakes": 123,
"outerExtremeHeight": 123,
"outerExtremeHeightFt": 123,
"outerExtremeHeightUnit": "UOM_UNSPECIFIED",
"outsideExtremeWidth": 123,
"outsideExtremeWidthFt": 123,
"outsideExtremeWidthUnit": "UOM_UNSPECIFIED",
"outsideHeightExtremeWidth": 123,
"outsideHeightExtremeWidthFt": 123,
"outsideHeightExtremeWidthUnit": "UOM_UNSPECIFIED",
"outsideLength": 123,
"outsideLengthFt": 123,
"outsideLengthUnit": "UOM_UNSPECIFIED",
"owner": "<string>",
"plateCode": "<string>",
"poolNumber": "<string>",
"residualSideBearings": "<string>",
"shoveAdjCarToRest": "<string>",
"shoveCarToRest": "<string>",
"sideDoorHeight": 123,
"sideDoorHeightFt": 123,
"sideDoorHeightUnit": "UOM_UNSPECIFIED",
"sideDoorType": "<string>",
"sideDoorWidth": 123,
"sideDoorWidthFt": 123,
"sideDoorWidthUnit": "UOM_UNSPECIFIED",
"tareWeight": 123,
"tareWeightLb": 123,
"tareWeightUnit": "UOM_UNSPECIFIED",
"trainPositionSensitive": "<string>",
"umet": "<string>",
"umlerUpdatedAt": "2023-11-07T05:31:56Z",
"unitEquipmentGroup": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"verificationKey": "<string>",
"verificationKeys": [
{
"compartment": 123,
"key": "<string>"
}
],
"waybill": {
"armsTrackingId": "<string>",
"billOfLadingNumber": "<string>",
"capacityLoadCode": "CAPACITY_LOAD_CODE_UNSPECIFIED",
"crossReferenceEquipment": [
{
"checkDigit": 123,
"crossReferenceTypeCode": "CROSS_REFERENCE_TYPE_CODE_UNSPECIFIED",
"equipmentInitial": "<string>",
"equipmentIsDamaged": true,
"equipmentLength": "<string>",
"equipmentNumber": "<string>",
"equipmentOperatorScac": "<string>",
"equipmentOwnerScac": "<string>",
"referenceId": "<string>",
"referenceIdQualifier": "<string>"
}
],
"defaultReceiver": "<string>",
"destinationJunction": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"destinationStation": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"equipmentDetails": [
{
"aarCarType": "<string>",
"canadianGrainInformation": [
{
"canadianWheatBoardMarketingClassCode": "<string>",
"canadianWheatBoardMarketingClassTypeCode": "<string>",
"commodityCode": "<string>",
"directHiToDepartureWharfForVesselLoading": true,
"fumigatedCleanedIndicator": "<string>",
"grainBlockNumber": "<string>",
"grainBlockQualifier": "<string>",
"inspectedWeighedIndicatorCode": "<string>",
"machineSeparableIndicatorCode": "<string>",
"numberOfCarsClaimedForIncentiveRate": 123,
"percentQualifier": "<string>",
"percentage": 123,
"stateOrProvinceCode": "<string>",
"terminalOrStagingAreaName": "<string>",
"unloadDate": "<string>",
"unloadTerminalElevatorCode": "<string>",
"week": 123
}
],
"carrierCode": "<string>",
"chassisInitial": "<string>",
"chassisNumber": "<string>",
"checkDigit": 123,
"descriptionCode": "<string>",
"dunnage": 123,
"dunnageMeasure": {
"unit": "<string>",
"value": 123
},
"equipmentInitial": "<string>",
"equipmentName": "<string>",
"equipmentNumber": "<string>",
"equipmentOrdered": {
"aarCarType": "<string>",
"cubicCapacity": 123,
"heightInches": 123,
"lengthInches": 123,
"weightCapacity": 123
},
"grossWeightLbs": 123,
"grossWeightMeasure": {
"unit": "<string>",
"value": 123
},
"heightIn": 123,
"heightMeasure": {
"unit": "<string>",
"value": 123
},
"interchangeMoveAuthorities": [
{
"carrierCode": "<string>",
"movementAuthorityCode": "<string>",
"rejectReasonCode": "<string>",
"stateTariffApplicationCode": "<string>",
"terminalTariffApplicationCode": "<string>"
}
],
"isoContainerCode": "<string>",
"lengthIn": 123,
"lengthMeasure": {
"unit": "<string>",
"value": 123
},
"netWeightLbs": 123,
"netWeightMeasure": {
"unit": "<string>",
"value": 123
},
"ownershipCode": "<string>",
"owningCarrierCode": "<string>",
"position": "<string>",
"sealNumbers": [
"<string>"
],
"shipmentInfo": [
{
"description": "<string>",
"extendedReferenceInfo": [
{
"description": "<string>",
"referenceId": "<string>",
"referenceIdQualifier": "<string>",
"referenceTimestamp": "2023-11-07T05:31:56Z"
}
],
"lineItems": [
{
"cbpBarcodeNumber": "<string>",
"commodityCode": "<string>",
"commodityCodeQualifier": "<string>",
"commodityDescription": "<string>",
"currencyCode": "<string>",
"customsShipmentValue": 123,
"destinationCountryCode": "<string>",
"marksAndNumbers": "<string>",
"originCountryCode": "<string>",
"quantity": 123,
"smallestExteriorPackageType": "<string>",
"weight": 123,
"weightUnitCode": "<string>"
}
],
"referenceId": "<string>",
"referenceIdQualifier": "<string>"
}
],
"tareQualifierCode": "<string>",
"tareWeightLbs": 123,
"tareWeightMeasure": {
"unit": "<string>",
"value": 123
},
"terminals": [
{
"locationIdentifier": "<string>",
"locationQualifier": "<string>",
"portName": "<string>",
"terminalFunctionCode": "<string>"
}
],
"weightAllowance": 123,
"weightAllowanceMeasure": {
"unit": "<string>",
"value": 123
},
"weightType": "WT_ESTIMATED",
"widthIn": 123,
"widthMeasure": {
"unit": "<string>",
"value": 123
}
}
],
"extendedReferenceInfo": [
{
"description": "<string>",
"referenceId": "<string>",
"referenceIdQualifier": "<string>",
"referenceTimestamp": "2023-11-07T05:31:56Z"
}
],
"lineItems": [
{
"descriptions": [
{
"commodityCode": "<string>",
"commodityCodeQualifier": "CCQ_UNKNOWN",
"compartmentIdCode": "<string>",
"hazmatRatingCommodityCode": "<string>",
"hazmatRatingCommodityCodeQualifier": "<string>",
"ladingDescription": "<string>",
"marksAndNumbers": "<string>",
"marksAndNumbersQualifier": "<string>",
"packagingCode": "<string>"
}
],
"measurements": [
{
"codeListQualifier": "<string>",
"industryCode": "<string>",
"measurementAttributeCode": "<string>",
"measurementMethodOrDevice": "<string>",
"measurementQualifier": "<string>",
"measurementSignificanceCode": "<string>",
"measurementValue": 123,
"rangeMaximum": 123,
"rangeMinimum": 123,
"referenceIdCode": "<string>",
"surfaceLayerPositionCode": "<string>",
"unitCode": "<string>"
}
],
"number": 123,
"priceAuthorities": [
{
"effectiveDate": "<string>",
"expirationDate": "<string>",
"issuingCarrierIdentifier": "<string>",
"itemNumber": "<string>",
"itemNumberSuffix": "<string>",
"primaryPublicationAuthority": "<string>",
"referenceId": "<string>",
"referenceIdQualifier": "<string>",
"regulatoryAgencyCode": "<string>",
"sectionNumber": "<string>",
"suffix": "<string>",
"supplementIdentifier": "<string>",
"tariffAgencyCode": "<string>"
}
],
"quantity": {
"billedAsQualifier": "<string>",
"billedAsQuantity": 123,
"dunnageDescription": "<string>",
"ladingQuantity": 123,
"packagingFormCode": "<string>",
"typeOfServiceCode": "<string>",
"volume": 123,
"volumeUnitQualifier": "<string>",
"weight": 123,
"weightQualifier": "WQ_UNKNOWN",
"weightUnitCode": "<string>"
}
}
],
"originCarrierCode": "<string>",
"originJunction": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"originStation": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"originSystem": "WAYBILL_ORIGIN_SYSTEM_UNSPECIFIED",
"parties": [
{
"additionalNames": [
"<string>"
],
"address": [
"<string>"
],
"administrativeContacts": [
{
"communicationNumbers": [
{
"number": "<string>",
"qualifier": "<string>"
}
],
"contactFunctionCode": "<string>",
"contactInquiryReference": "<string>",
"name": "<string>"
}
],
"billingInfo": [
{
"carrierCodes": [
"<string>"
],
"destination": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"origin": {
"cityName": "<string>",
"countryCode": "<string>",
"fsac": "<string>",
"postalCode": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
},
"rebillReasonCode": "REBILL_REASON_CODE_UNSPECIFIED"
}
],
"cityName": "<string>",
"countryCode": "<string>",
"countrySubdivisionCode": "<string>",
"entitySubIdentifierCode": "<string>",
"entitySubIdentifierRelationshipCode": "<string>",
"idCode": "<string>",
"idCodeQualifier": "PARTY_IDENTIFICATION_CODE_QUALIFIER_UNSPECIFIED",
"locationIdentifier": "<string>",
"locationQualifier": "<string>",
"locationUuid": "<string>",
"name": "<string>",
"partyType": "PARTY_ENTITY_IDENTIFIER_CODE_UNSPECIFIED",
"postalCode": "<string>",
"referenceInfo": [
{
"description": "<string>",
"referenceId": "<string>",
"referenceIdQualifier": "<string>"
}
],
"stateOrProvince": "<string>"
}
],
"revisionNumber": 123,
"revisionSourceType": "WAYBILL_REVISION_SOURCE_TYPE_UNSPECIFIED",
"revisionTime": "2023-11-07T05:31:56Z",
"route": [
{
"additionalSwitchCarrierCodes": [
"<string>"
],
"carrierCode": "<string>",
"intermodalServiceCode": "<string>",
"isBreakpoint": true,
"junctionCode": "<string>",
"rebillReasonCode": "<string>",
"routingSequenceCode": "ROUTING_SEQUENCE_CODE_UNSPECIFIED",
"rule11PartyId": "<string>",
"splc": "<string>"
}
],
"shipmentId": "<string>",
"shipmentPaymentMethod": "SHIPMENT_PAYMENT_METHOD_UNSPECIFIED",
"shipmentQualifier": "SHIPMENT_QUALIFIER_UNSPECIFIED",
"specialHandlingCodes": [
"<string>"
],
"transportationMethod": "TRANSPORTATION_METHOD_UNSPECIFIED",
"waybillDate": "2023-11-07T05:31:56Z",
"waybillId": 123,
"waybillNumber": 123,
"waybillStatus": "WAYBILL_STATUS_UNSPECIFIED",
"weightUnitCode": "WEIGHT_UNIT_CODE_UNSPECIFIED"
}
},
"expectedStop": {
"distance": 123,
"endTime": "2023-11-07T05:31:56Z",
"eventTitle": "<string>",
"eventType": "UNSPECIFIED",
"location": {
"attributes": {},
"latLng": {
"latitude": 123,
"longitude": 123
},
"locationType": "UNKNOWN",
"station": {
"name": "<string>",
"railroad": "<string>",
"splc": "<string>",
"stateOrProvince": "<string>"
}
},
"priority": 123,
"startTime": "2023-11-07T05:31:56Z",
"totalDistance": 123
},
"tripPlanHandle": {
"bookingNumber": "<string>",
"predictedLengthMm": 123,
"predictedWeightKg": 123,
"status": "<string>",
"suborderNumber": "<string>",
"tripPlanId": "<string>",
"wagonLetter": "<string>"
}
}
],
"page": {
"nextToken": "<string>",
"pageSize": "<string>",
"prevToken": "<string>"
},
"summary": {
"equipmentCarNames": [
"<string>"
],
"equipmentCount": "<string>",
"totalCount": "<string>"
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}