Skip to main content
POST
/
ims
/
equipment
/
inventory
curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/equipment/inventory \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '{
  "pageSize": 20,
  "loadStatus": "LOAD",
  "station": 1001
}'
{
  "items": [
    {
      "resourceType": "Equipment",
      "resourceId": 123,
      "equipmentInitial": "<string>",
      "equipmentNumber": 123,
      "aarCarType": "<string>",
      "arrivalState": "INBOUND",
      "parentGroupings": [
        {
          "resourceType": "Grouping",
          "resourceId": 123,
          "name": "<string>",
          "groupingType": "<string>",
          "sortOrder": 123
        }
      ],
      "waybill": {
        "loadStatus": "<string>",
        "commodityCode": "<string>",
        "netWeightTons": 123,
        "originCityName": "<string>",
        "originStateOrProvince": "<string>",
        "originFsac": "<string>",
        "destinationCityName": "<string>",
        "destinationStateOrProvince": "<string>",
        "destinationFsac": "<string>",
        "consignorCustomerName": "<string>",
        "consigneeCustomerName": "<string>",
        "originScac": "<string>",
        "trafficType": "LOCAL",
        "shipmentPaymentMethod": "11",
        "transportationMethod": "R",
        "shipmentId": "<string>",
        "weightUnitCode": "E",
        "shipmentQualifier": "1",
        "capacityLoadCode": "C",
        "customsDocumentationHandlingCode": "<string>",
        "confidentialBillingRequestCode": "C",
        "taxReasonCode": "<string>",
        "shipmentWeightCode": "A3",
        "referencedPatternIdentifier": "<string>",
        "billingCode": "A",
        "repetitivePatternNumber": 123,
        "extendedReferenceInfo": [
          {
            "referenceIdQualifier": "<string>",
            "referenceId": "<string>",
            "description": "<string>",
            "date": "<string>",
            "timestamp": "<string>"
          }
        ],
        "crossReferenceEquipment": [
          {
            "referenceIdQualifier": "<string>",
            "referenceId": "<string>",
            "equipmentInitial": "<string>",
            "equipmentNumber": 123,
            "crossReferenceTypeCode": "A",
            "equipmentOwnerScac": "<string>",
            "equipmentLength": "<string>",
            "equipmentOperatorScac": "<string>",
            "equipmentIsDamaged": true,
            "checkDigit": 123
          }
        ],
        "equipmentDetails": [
          {
            "equipmentInitial": "<string>",
            "equipmentNumber": 123,
            "netWeightLbs": 123,
            "grossWeightLbs": 123,
            "weightType": "ESTIMATED",
            "tareWeightLbs": 123,
            "weightAllowance": 123,
            "dunnage": 123,
            "ownershipCode": "L",
            "descriptionCode": "<string>",
            "owningCarrierCode": "<string>",
            "position": "<string>",
            "lengthIn": 123,
            "tareQualifierCode": "A",
            "checkDigit": 123,
            "heightIn": 123,
            "widthIn": 123,
            "isoContainerCode": "<string>",
            "carrierCode": "<string>",
            "aarCarType": "<string>",
            "chassisInitial": "<string>",
            "chassisNumber": 123
          }
        ],
        "intermodalStatusDetails": {
          "shipmentStatusCode": "A",
          "shipmentStatusTime": "<string>"
        },
        "specialHandlingCodes": [
          "<string>"
        ],
        "protectiveService": [
          {
            "ruleCode": "<string>",
            "serviceCode": "D",
            "temperatureUnit": "CE",
            "optimalTemperature": 123,
            "scac": "<string>",
            "fsac": "<string>",
            "cityName": "<string>",
            "stateOrProvince": "<string>",
            "precooled": true,
            "heaterLocation": "Y",
            "commodityType": "Y",
            "doorwaySpace": "Y",
            "originTemperature": 123
          }
        ],
        "originStation": {
          "fsac": "<string>",
          "cityName": "<string>",
          "stateOrProvince": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>",
          "splc": "<string>"
        },
        "originJunction": {
          "fsac": "<string>",
          "cityName": "<string>",
          "stateOrProvince": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>",
          "splc": "<string>"
        },
        "destinationStation": {
          "fsac": "<string>",
          "cityName": "<string>",
          "stateOrProvince": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>",
          "splc": "<string>"
        },
        "destinationJunction": {
          "fsac": "<string>",
          "cityName": "<string>",
          "stateOrProvince": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>",
          "splc": "<string>"
        },
        "parties": [
          {
            "partyType": "11",
            "name": "<string>",
            "idCodeQualifier": "1",
            "idCode": "<string>",
            "entitySubIdentifierRelationshipCode": "<string>",
            "entitySubIdentifierCode": "<string>",
            "additionalNames": [
              "<any>"
            ],
            "address": [
              "<any>"
            ],
            "cityName": "<string>",
            "stateOrProvince": "<string>",
            "postalCode": "<string>",
            "countryCode": "<string>",
            "locationQualifier": "<string>",
            "locationIdentifier": "<string>",
            "countrySubdivisionCode": "<string>",
            "administrativeContacts": [
              "<any>"
            ],
            "billingInfo": [
              "<any>"
            ],
            "referenceInfo": [
              "<any>"
            ]
          }
        ],
        "route": [
          {
            "carrierCode": "<string>",
            "junctionCode": "<string>",
            "routingSequenceCode": "1",
            "splc": "<string>",
            "intermodalServiceCode": "<string>",
            "additionalSwitchCarrierCodes": [
              "<any>"
            ]
          }
        ],
        "emptyCarDispositions": [
          {
            "destinationConsigneeName": "<string>",
            "destinationConsigneeIdQualifier": "<string>",
            "destinationConsigneeId": "<string>",
            "destinationCityName": "<string>",
            "destinationStateOrProvince": "<string>",
            "destinationPostalCode": "<string>",
            "destinationCountryCode": "<string>",
            "destinationAddress": "<string>",
            "destinationRoute": [
              "<any>"
            ]
          }
        ],
        "lineItems": [
          {
            "number": 123,
            "descriptions": [
              "<any>"
            ],
            "quantity": {},
            "measurements": [
              "<any>"
            ],
            "priceAuthorities": [
              "<any>"
            ]
          }
        ],
        "hazardousInfo": [
          {
            "ladingUnitCode": "1E",
            "ladingQuantity": 123,
            "unIdCode": "<string>",
            "unPageNumber": "<string>",
            "commodityCode": "<string>",
            "unitCode": "1E",
            "quantity": 123,
            "compartmentIdCode": "<string>",
            "residueIndicatorCode": "<string>",
            "packagingGroupCode": "<string>",
            "interimHazmatRegulatoryNumber": "<string>",
            "industryCode": "<string>",
            "classificationInfo": [
              "<any>"
            ],
            "hazmatShippingNameInfo": [
              "<any>"
            ],
            "hazmatAdditionalInfo": [
              "<any>"
            ],
            "epaRequiredData": [
              "<any>"
            ],
            "canadianDangerousRequirements": [
              "<any>"
            ],
            "transborderHazardousRequirements": [
              "<any>"
            ],
            "hazmatReferenceNumbers": [
              "<any>"
            ],
            "administrativeContacts": [
              "<any>"
            ],
            "parties": [
              "<any>"
            ]
          }
        ],
        "hazardousCertifications": [
          {
            "name": "<string>"
          }
        ],
        "release": {
          "releaseCode": "B",
          "releaseDate": "<string>",
          "releaseTime": "<string>"
        },
        "defaultReceiver": "<string>",
        "waybillTemplateId": 123,
        "waybillTemplateName": "<string>",
        "originCarrierCode": "<string>",
        "consigneeLocationId": 123,
        "shipperLocationId": 123,
        "inCareOfLocationId": 123,
        "freightBillPartyLocationId": 123,
        "waybillNumber": 123,
        "waybillDate": "<string>",
        "billOfLadingNumber": "<string>",
        "originSystem": "ARMS",
        "preparationDate": "<string>",
        "preparationTime": "<string>",
        "revisionNumber": 123,
        "revisionTime": "<string>",
        "revisionSourceType": "WAYBILL",
        "armsTrackingId": "<string>",
        "resourceType": "Waybill",
        "resourceId": 123,
        "waybillStatus": "PENDING",
        "createdAt": "<string>"
      },
      "umler": {},
      "notes": "<string>",
      "intermodalUnits": [
        {
          "resourceType": "IntermodalUnit",
          "resourceId": 123,
          "unitInitial": "<string>",
          "unitNumber": 123,
          "waybill": {
            "loadStatus": "<string>",
            "commodityCode": "<string>",
            "netWeightTons": 123,
            "originCityName": "<string>",
            "originStateOrProvince": "<string>",
            "originFsac": "<string>",
            "destinationCityName": "<string>",
            "destinationStateOrProvince": "<string>",
            "destinationFsac": "<string>",
            "consignorCustomerName": "<string>",
            "consigneeCustomerName": "<string>",
            "originScac": "<string>",
            "trafficType": "LOCAL",
            "shipmentPaymentMethod": "11",
            "transportationMethod": "R",
            "shipmentId": "<string>",
            "weightUnitCode": "E",
            "shipmentQualifier": "1",
            "capacityLoadCode": "C",
            "customsDocumentationHandlingCode": "<string>",
            "confidentialBillingRequestCode": "C",
            "taxReasonCode": "<string>",
            "shipmentWeightCode": "A3",
            "referencedPatternIdentifier": "<string>",
            "billingCode": "A",
            "repetitivePatternNumber": 123,
            "extendedReferenceInfo": [
              {
                "referenceIdQualifier": "<string>",
                "referenceId": "<string>",
                "description": "<string>",
                "date": "<string>",
                "timestamp": "<string>"
              }
            ],
            "crossReferenceEquipment": [
              {
                "referenceIdQualifier": "<string>",
                "referenceId": "<string>",
                "equipmentInitial": "<string>",
                "equipmentNumber": 123,
                "crossReferenceTypeCode": "A",
                "equipmentOwnerScac": "<string>",
                "equipmentLength": "<string>",
                "equipmentOperatorScac": "<string>",
                "equipmentIsDamaged": true,
                "checkDigit": 123
              }
            ],
            "equipmentDetails": [
              {
                "equipmentInitial": "<string>",
                "equipmentNumber": 123,
                "netWeightLbs": 123,
                "grossWeightLbs": 123,
                "weightType": "ESTIMATED",
                "tareWeightLbs": 123,
                "weightAllowance": 123,
                "dunnage": 123,
                "ownershipCode": "L",
                "descriptionCode": "<string>",
                "owningCarrierCode": "<string>",
                "position": "<string>",
                "lengthIn": 123,
                "tareQualifierCode": "A",
                "checkDigit": 123,
                "heightIn": 123,
                "widthIn": 123,
                "isoContainerCode": "<string>",
                "carrierCode": "<string>",
                "aarCarType": "<string>",
                "chassisInitial": "<string>",
                "chassisNumber": 123
              }
            ],
            "intermodalStatusDetails": {
              "shipmentStatusCode": "A",
              "shipmentStatusTime": "<string>"
            },
            "specialHandlingCodes": [
              "<string>"
            ],
            "protectiveService": [
              {
                "ruleCode": "<string>",
                "serviceCode": "D",
                "temperatureUnit": "CE",
                "optimalTemperature": 123,
                "scac": "<string>",
                "fsac": "<string>",
                "cityName": "<string>",
                "stateOrProvince": "<string>",
                "precooled": true,
                "heaterLocation": "Y",
                "commodityType": "Y",
                "doorwaySpace": "Y",
                "originTemperature": 123
              }
            ],
            "originStation": {
              "fsac": "<string>",
              "cityName": "<string>",
              "stateOrProvince": "<string>",
              "postalCode": "<string>",
              "countryCode": "<string>",
              "splc": "<string>"
            },
            "originJunction": {
              "fsac": "<string>",
              "cityName": "<string>",
              "stateOrProvince": "<string>",
              "postalCode": "<string>",
              "countryCode": "<string>",
              "splc": "<string>"
            },
            "destinationStation": {
              "fsac": "<string>",
              "cityName": "<string>",
              "stateOrProvince": "<string>",
              "postalCode": "<string>",
              "countryCode": "<string>",
              "splc": "<string>"
            },
            "destinationJunction": {
              "fsac": "<string>",
              "cityName": "<string>",
              "stateOrProvince": "<string>",
              "postalCode": "<string>",
              "countryCode": "<string>",
              "splc": "<string>"
            },
            "parties": [
              {
                "partyType": "11",
                "name": "<string>",
                "idCodeQualifier": "1",
                "idCode": "<string>",
                "entitySubIdentifierRelationshipCode": "<string>",
                "entitySubIdentifierCode": "<string>",
                "additionalNames": [
                  "<any>"
                ],
                "address": [
                  "<any>"
                ],
                "cityName": "<string>",
                "stateOrProvince": "<string>",
                "postalCode": "<string>",
                "countryCode": "<string>",
                "locationQualifier": "<string>",
                "locationIdentifier": "<string>",
                "countrySubdivisionCode": "<string>",
                "administrativeContacts": [
                  "<any>"
                ],
                "billingInfo": [
                  "<any>"
                ],
                "referenceInfo": [
                  "<any>"
                ]
              }
            ],
            "route": [
              {
                "carrierCode": "<string>",
                "junctionCode": "<string>",
                "routingSequenceCode": "1",
                "splc": "<string>",
                "intermodalServiceCode": "<string>",
                "additionalSwitchCarrierCodes": [
                  "<any>"
                ]
              }
            ],
            "emptyCarDispositions": [
              {
                "destinationConsigneeName": "<string>",
                "destinationConsigneeIdQualifier": "<string>",
                "destinationConsigneeId": "<string>",
                "destinationCityName": "<string>",
                "destinationStateOrProvince": "<string>",
                "destinationPostalCode": "<string>",
                "destinationCountryCode": "<string>",
                "destinationAddress": "<string>",
                "destinationRoute": [
                  "<any>"
                ]
              }
            ],
            "lineItems": [
              {
                "number": 123,
                "descriptions": [
                  "<any>"
                ],
                "quantity": {},
                "measurements": [
                  "<any>"
                ],
                "priceAuthorities": [
                  "<any>"
                ]
              }
            ],
            "hazardousInfo": [
              {
                "ladingUnitCode": "1E",
                "ladingQuantity": 123,
                "unIdCode": "<string>",
                "unPageNumber": "<string>",
                "commodityCode": "<string>",
                "unitCode": "1E",
                "quantity": 123,
                "compartmentIdCode": "<string>",
                "residueIndicatorCode": "<string>",
                "packagingGroupCode": "<string>",
                "interimHazmatRegulatoryNumber": "<string>",
                "industryCode": "<string>",
                "classificationInfo": [
                  "<any>"
                ],
                "hazmatShippingNameInfo": [
                  "<any>"
                ],
                "hazmatAdditionalInfo": [
                  "<any>"
                ],
                "epaRequiredData": [
                  "<any>"
                ],
                "canadianDangerousRequirements": [
                  "<any>"
                ],
                "transborderHazardousRequirements": [
                  "<any>"
                ],
                "hazmatReferenceNumbers": [
                  "<any>"
                ],
                "administrativeContacts": [
                  "<any>"
                ],
                "parties": [
                  "<any>"
                ]
              }
            ],
            "hazardousCertifications": [
              {
                "name": "<string>"
              }
            ],
            "release": {
              "releaseCode": "B",
              "releaseDate": "<string>",
              "releaseTime": "<string>"
            },
            "defaultReceiver": "<string>",
            "waybillTemplateId": 123,
            "waybillTemplateName": "<string>",
            "originCarrierCode": "<string>",
            "consigneeLocationId": 123,
            "shipperLocationId": 123,
            "inCareOfLocationId": 123,
            "freightBillPartyLocationId": 123,
            "waybillNumber": 123,
            "waybillDate": "<string>",
            "billOfLadingNumber": "<string>",
            "originSystem": "ARMS",
            "preparationDate": "<string>",
            "preparationTime": "<string>",
            "revisionNumber": 123,
            "revisionTime": "<string>",
            "revisionSourceType": "WAYBILL",
            "armsTrackingId": "<string>",
            "resourceType": "Waybill",
            "resourceId": 123,
            "waybillStatus": "PENDING",
            "createdAt": "<string>"
          },
          "descriptionCode": "<string>"
        }
      ],
      "loadStatus": "LOAD",
      "ichrTime": "2023-11-07T05:31:56Z"
    }
  ],
  "statusCode": 123,
  "nextToken": "<string>",
  "prevToken": "<string>"
}

Authorizations

​
x-arms-api-key
string
header
required

Your ARMS API key

​
x-arms-assume-user
string
header
required

Email of a user assigned to the appropriate user group

Query Parameters

​
carrierId
integer
required

Carrier identifier; required for all endpoints

​
viewAsUserGroup
string

Optional user group context

Body

application/json
​
pageSize
integer

Number of items per page. Use with pageNextToken/pagePrevToken for pagination.

Required range: x >= 1
​
pageNextToken
string

Token to fetch the next page of results returned from a previous call.

​
pagePrevToken
string

Token to fetch the previous page of results returned from a previous call.

​
initialAndNumber
string

Filter by equipment initial and number (e.g., 'XYZ 123456').

​
loadStatus
enum<string>

Filter by derived load status.

Available options:
LOAD,
EMPTY,
UNKNOWN
​
aarCarType
string

Filter by AAR car type (e.g., GONDOLA).

​
station
integer

Filter by station ID. Obtain IDs from the listStationTracks endpoint.

​
track
integer

Filter by track ID. Obtain IDs from the listStationTracks endpoint.

​
tag
integer

Filter by tag ID. Obtain IDs from the listStationTracks endpoint.

​
shipper
string

Filter by shipper name.

​
consignee
string

Filter by consignee name.

​
arrivalState
enum<string>[]

Filter by arrival state of equipment.

​
carrierId
integer

Carrier identifier. May also be supplied via query parameter.

​
equipmentId
integer

Filter by a single equipment resourceId.

​
equipmentIds
integer[]

Filter by multiple equipment resourceIds.

​
equipmentInitial
string

Filter by equipment initial prefix (e.g., 'ABC').

​
equipmentInitialsAndNumbers
any[][]

Filter by explicit tuples of equipment initial and number (e.g., [["ABC", 123], ["DEF", 456]]).

​
equipmentNumber
integer

Filter by equipment number.

​
trainId
string

Filter by train ID.

​
includeTrain
boolean

Whether to include train information in the response.

​
intersectedGroupFilters
object[]

Intersect all grouping filters to get grouping IDs. For example, can specify multiple filters at once, such as zone, station, track. In this case, it expands zone and station to track level and intersects them with each other.

This field is mutually exclusive with the legacy grouping fields (station, track, tag).

  • Option 1
  • Option 2
​
consistUuid
string

Filter by consist UUID. This is used with includeSwitchRequest to get all of the equipment on a consist.

​
includeSwitchRequest
boolean

Whether to include switch request information.

Response

OK

​
items
object[]
​
statusCode
integer
​
nextToken
string
​
prevToken
string
⌘I