Skip to main content
POST
/
ims
/
equipment
/
move
curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/equipment/move \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '{
  "items": [
    {
      "equipment": {
        "resourceId": 1,
        "resourceType": "Equipment"
      },
      "locationUpdate": {
        "from": {},
        "to": {}
      },
      "updateIntermodalUnits": true
    }
  ],
  "jobName": "MOVE TO FRONT"
}'
{
  "items": [
    {
      "resourceType": "Equipment",
      "resourceId": 123,
      "equipmentInitial": "<string>",
      "equipmentNumber": 123,
      "aarCarType": "<string>",
      "descriptionCode": "<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": [
              "<string>"
            ],
            "address": [
              "<string>"
            ],
            "cityName": "<string>",
            "stateOrProvince": "<string>",
            "postalCode": "<string>",
            "countryCode": "<string>",
            "locationQualifier": "<string>",
            "locationIdentifier": "<string>",
            "countrySubdivisionCode": "<string>",
            "administrativeContacts": [
              {}
            ],
            "billingInfo": [
              {}
            ],
            "referenceInfo": [
              {}
            ]
          }
        ],
        "route": [
          {
            "carrierCode": "<string>",
            "junctionCode": "<string>",
            "routingSequenceCode": "1",
            "splc": "<string>",
            "intermodalServiceCode": "<string>",
            "additionalSwitchCarrierCodes": [
              "<string>"
            ]
          }
        ],
        "emptyCarDispositions": [
          {
            "destinationConsigneeName": "<string>",
            "destinationConsigneeIdQualifier": "<string>",
            "destinationConsigneeId": "<string>",
            "destinationCityName": "<string>",
            "destinationStateOrProvince": "<string>",
            "destinationPostalCode": "<string>",
            "destinationCountryCode": "<string>",
            "destinationAddress": "<string>",
            "destinationRoute": [
              {
                "carrierCode": "<string>",
                "junctionCode": "<string>",
                "routingSequenceCode": "1",
                "splc": "<string>",
                "intermodalServiceCode": "<string>",
                "additionalSwitchCarrierCodes": [
                  "<string>"
                ]
              }
            ]
          }
        ],
        "lineItems": [
          {
            "number": 123,
            "descriptions": [
              {
                "ladingDescription": "<string>",
                "commodityCode": "<string>",
                "commodityCodeQualifier": "3",
                "packagingCode": "<string>",
                "marksAndNumbers": "<string>",
                "marksAndNumbersQualifier": "<string>",
                "hazmatRatingCommodityCodeQualifier": "<string>",
                "hazmatRatingCommodityCode": "<string>",
                "compartmentIdCode": "<string>"
              }
            ],
            "quantity": {
              "billedAsQuantity": 123,
              "billedAsQualifier": "DM",
              "weight": 123,
              "weightQualifier": "A3",
              "volume": 123,
              "volumeUnitQualifier": "B",
              "ladingQuantity": 123,
              "packagingFormCode": "<string>",
              "dunnageDescription": "<string>",
              "weightUnitCode": "<string>",
              "typeOfServiceCode": "<string>"
            },
            "measurements": [
              {
                "measurementReferenceIdCode": "<string>",
                "measurementQualifier": "<string>",
                "measurementValue": 123,
                "unitCode": "1E",
                "rangeMinimum": 123,
                "rangeMaximum": 123,
                "measurementSignificanceCode": "<string>",
                "measurementAttributeCode": "<string>",
                "surfaceLayerPositionCode": "<string>",
                "measurementMethodOrDevice": "<string>",
                "codeListQualifier": "<string>",
                "industryCode": "<string>"
              }
            ],
            "priceAuthorities": [
              {
                "referenceIdQualifier": "<string>",
                "referenceId": "<string>",
                "primaryPublicationAuthority": "<string>",
                "regulatoryAgencyCode": "<string>",
                "tariffAgencyCode": "<string>",
                "issuingCarrierIdentifier": "<string>",
                "suffix": "<string>",
                "itemNumber": "<string>",
                "supplementIdentifier": "<string>",
                "sectionNumber": "<string>",
                "itemNumberSuffix": "<string>",
                "effectiveDate": "<string>",
                "expirationDate": "<string>"
              }
            ]
          }
        ],
        "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": [
              {
                "hazardousClass": "<string>",
                "hazardousClassQualifier": "P",
                "hazardousPlacardNotation": "<string>",
                "hazardousEndorsement": "<string>",
                "reportableQuantityCode": "RQ",
                "flashpointUnitCode": "1E",
                "flashpointTemperature": 123,
                "controlUnitCode": "1E",
                "controlTemperature": 123,
                "emergencyUnitCode": "1E",
                "emergencyTemperature": 123,
                "netExplosiveWeightUnitCode": "<string>",
                "netExplosiveWeight": 123
              }
            ],
            "hazmatShippingNameInfo": [
              {
                "hazmatShippingName": "<string>",
                "hazmatShippingNameQualifier": "C",
                "nosIndicatorCode": "<string>",
                "railSafetySensitiveMaterial": true
              }
            ],
            "hazmatAdditionalInfo": [
              {
                "hazmatShippingInfoQualifier": "ADI",
                "hazmatShippingInfo": "<string>",
                "hazmatShippingInfoOverflow": "<string>",
                "hazardZoneCode": "<string>",
                "radioactiveActivityUnitCode": "1T",
                "radioactiveActivity": 123,
                "radioactiveTransportIndex": 123,
                "fumigationDate": "<string>"
              }
            ],
            "epaRequiredData": [
              {
                "epaWasteStreamNumberCode": "<string>",
                "wasteCharacteristicsCode": "<string>",
                "hazardousWasteNumberStateOrProvince": "<string>",
                "hazardousWasteNumber": "<string>"
              }
            ],
            "canadianDangerousRequirements": [
              {
                "emergencyResponsePlanNumber": "<string>",
                "communicationNumber": "<string>",
                "packagingGroupCode": "<string>",
                "firstSubsidiaryClassification": "<string>",
                "secondSubsidiaryClassification": "<string>",
                "thirdSubsidiaryClassification": "<string>",
                "subsidiaryRiskIndicator": "<string>",
                "netExplosiveQuantity": 123,
                "canadianHazardousNotation": "<string>",
                "specialCommodityIndicatorCode": "<string>",
                "additionalCommunicationNumber": "<string>",
                "netExplosiveQuantityUnitCode": "1E",
                "hazmatShipmentInfoQualifier": "<string>",
                "hazmatQuantity": 123,
                "hazmatQuantityUnitCode": "1E"
              }
            ],
            "transborderHazardousRequirements": [
              {
                "hazardousClassification": "<string>",
                "hazardousPlacardNotation": "<string>",
                "hazardousEndorsement": "<string>"
              }
            ],
            "hazmatReferenceNumbers": [
              {
                "referenceIdQualifier": "<string>",
                "referenceId": "<string>",
                "date": "<string>"
              }
            ],
            "administrativeContacts": [
              {
                "contactFunctionCode": "<string>",
                "name": "<string>",
                "communicationNumbers": [
                  {}
                ],
                "contactInquiryReference": "<string>"
              }
            ],
            "parties": [
              {
                "partyType": "11",
                "name": "<string>",
                "idCodeQualifier": "1",
                "idCode": "<string>",
                "entitySubIdentifierRelationshipCode": "<string>",
                "entitySubIdentifierCode": "<string>",
                "additionalNames": [
                  "<string>"
                ],
                "address": [
                  "<string>"
                ],
                "cityName": "<string>",
                "stateOrProvince": "<string>",
                "postalCode": "<string>",
                "countryCode": "<string>",
                "locationQualifier": "<string>",
                "locationIdentifier": "<string>",
                "countrySubdivisionCode": "<string>",
                "administrativeContacts": [
                  {}
                ],
                "billingInfo": [
                  {}
                ],
                "referenceInfo": [
                  {}
                ]
              }
            ]
          }
        ],
        "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
        }
      ],
      "loadStatus": "LOAD",
      "ichrTime": "2023-11-07T05:31:56Z"
    }
  ]
}

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
​
items
object[]

List of move instructions to perform in a single batch.

​
updateTime
string

Timestamp associated with the move (e.g., job time).

​
updateType
enum<string>
Available options:
ABNO,
AETA,
AETI,
AINV,
ARIL,
ARRI,
BADO,
BFRM,
BHVY,
BLGT,
BOHR,
BXNG,
CGIP,
CGRD,
CH80,
CH81,
CH82,
CH83,
CH84,
CH85,
CH86,
CH89,
DFLC,
DRMP,
EQOR,
FFBO,
FTBO,
HADR,
HAND,
HANR,
HEMB,
HHAR,
HIGT,
HMIS,
HOGT,
ICHD,
ICHR,
IGTI,
IGTR,
LDCH,
LTFR,
LTTO,
MAWY,
MOTR,
NOBL,
NOTP,
OGTI,
OGTR,
OSTH,
PACT,
PASL,
PCON,
PFLT,
PFPS,
PKGD,
PKGR,
PLJI,
PLLF,
PLLT,
PUJI,
RAMP,
REBL,
REJS,
REMB,
RFLT,
RLOD,
RMTY,
RRFS,
RTAA,
RTOI,
RTPO,
STEA,
STEX,
STPL,
STSE,
STSU,
STUN,
SWAP,
ULCH,
UNSC,
UNKN
​
jobName
string

Friendly name for the job shown in history (e.g., 'MOVE TO FRONT').

Response

OK

​
items
object[]