Waybill API
Empty equipment
Mark cars empty, the same way the Empty button in ARMS does. For each car, ARMS takes its current loaded waybill and creates the empty waybill from it: shipper and consignee swapped, route reversed, commodity kept as last contained, non-revenue (NR), origin at the car’s current station. If the carrier has turned off reverse routing for empties, the current waybill is emptied in place instead.
Usage notes:
- Name each car by
initialAndNumberor byequipmentId, not both. Cars are looked up in thecarrierIdcarrier’s inbound or online inventory only. - A car that is already empty is left as it is and returned with
changed: false. Resending is safe. - A car whose current waybill is not a loaded waybill (for example one with no shipment qualifier) is refused with 412, as is a car that is not at a station or whose station has no FSAC.
- Cars carrying containers are refused with 400; deramp them instead.
- The whole request is one transaction: any error writes nothing.
emptyTimewith an offset (for example-07:00orZ) is used as given. Without an offset it is read as the carrier’s local time, and when it is left out it is now. Its date, in that time zone, becomes the empty waybill’s date.- Do not empty cars with
POST /ims/waybills/bill-of-lading: it ignoresloadStatusand creates a new waybill with no parties or route. - A missing permission returns 401.
POST
/
ims
/
equipment
/
empty-equipment
curl --request POST \
--url https://api-lg.arms.cedarai.com/ims/equipment/empty-equipment \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"items": [
{
"initialAndNumber": "MGLX 5493"
},
{
"initialAndNumber": "MGLX 5511"
}
],
"emptyTime": "2026-10-30T08:05:00-06:00"
}
'{
"items": [
{
"equipmentId": 123,
"initialAndNumber": "<string>",
"changed": true,
"previousWaybillId": 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>",
"sealNumbers": [
"<string>"
],
"chassisInitial": "<string>",
"chassisNumber": 123,
"terminals": [
{
"terminalFunctionCode": "1",
"locationQualifier": "CS",
"locationIdentifier": "<string>",
"portName": "<string>"
}
],
"interchangeMoveAuthorities": [
{
"movementAuthorityCode": "A",
"carrierCode": "<string>",
"terminalTariffApplicationCode": "D",
"stateTariffApplicationCode": "N",
"rejectReasonCode": "AD"
}
],
"shipmentInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>",
"extendedReferenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>",
"date": "<string>",
"timestamp": "<string>"
}
],
"lineItems": [
{
"quantity": 123,
"commodityDescription": "<string>",
"marksAndNumbers": "<string>",
"commodityCodeQualifier": "3",
"commodityCode": "<string>",
"customsShipmentValue": 123,
"weightUnitCode": "E",
"weight": 123,
"cbpBarcodeNumber": "<string>",
"smallestExteriorPackageType": "<string>",
"originCountryCode": "<string>",
"destinationCountryCode": "<string>",
"currencyCode": "<string>"
}
]
}
]
}
],
"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": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"contactInquiryReference": "<string>"
}
],
"billingInfo": [
{
"rebillReasonCode": "RC",
"origin": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destination": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"carrierCodes": [
"<string>"
]
}
],
"referenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>"
}
]
}
],
"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": "<unknown>",
"ladingQuantity": 123,
"unIdCode": "<string>",
"unPageNumber": "<string>",
"commodityCode": "<string>",
"unitCode": "<unknown>",
"quantity": 123,
"compartmentIdCode": "<string>",
"residueIndicatorCode": "<string>",
"packagingGroupCode": "<string>",
"interimHazmatRegulatoryNumber": "<string>",
"industryCode": "<string>",
"classificationInfo": [
{
"hazardousClass": "<string>",
"hazardousClassQualifier": "P",
"hazardousPlacardNotation": "<string>",
"hazardousEndorsement": "<string>",
"reportableQuantityCode": "RQ",
"flashpointUnitCode": "<unknown>",
"flashpointTemperature": 123,
"controlUnitCode": "<unknown>",
"controlTemperature": 123,
"emergencyUnitCode": "<unknown>",
"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": "<unknown>",
"hazmatShipmentInfoQualifier": "<string>",
"hazmatQuantity": 123,
"hazmatQuantityUnitCode": "<unknown>"
}
],
"transborderHazardousRequirements": [
{
"hazardousClassification": "<string>",
"hazardousPlacardNotation": "<string>",
"hazardousEndorsement": "<string>"
}
],
"hazmatReferenceNumbers": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"date": "<string>"
}
],
"administrativeContacts": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"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": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"contactInquiryReference": "<string>"
}
],
"billingInfo": [
{
"rebillReasonCode": "RC",
"origin": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destination": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"carrierCodes": [
"<string>"
]
}
],
"referenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>"
}
]
}
]
}
],
"hazardousCertifications": [
{
"name": "<string>"
}
],
"release": {
"releaseCode": "B",
"releaseDate": "<string>",
"releaseTime": "<string>"
},
"defaultReceiver": "<string>",
"waybillTemplateId": 123,
"waybillTemplateName": "<string>",
"waybillNumberSuffix": "<string>",
"originCarrierCode": "<string>",
"consigneeLocationId": 123,
"shipperLocationId": 123,
"inCareOfLocationId": 123,
"freightBillPartyLocationId": 123,
"pickupPartyLocationId": 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,
"uuid": "<string>",
"waybillStatus": "PENDING",
"createdAt": "<string>",
"tags": {}
}
}
]
}{
"message": "<string>"
}Authorizations
Your ARMS API key
Email of a user assigned to the appropriate user group
Query Parameters
Carrier identifier; required for all endpoints
Optional user group context
Body
application/json
Request body for emptying cars. The whole request is applied or rejected as one unit.
The cars to empty, each at most once.
Required array length:
1 - 500 elementsShow child attributes
Show child attributes
Carrier identifier. Optional here; the carrierId query parameter is required and takes precedence.
When the cars were emptied. A time with an offset is used as given; a time without one is read as the carrier's local time. Defaults to now. Its date becomes the empty waybill's date.
Response
OK
One entry per requested car, in request order.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
curl --request POST \
--url https://api-lg.arms.cedarai.com/ims/equipment/empty-equipment \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"items": [
{
"initialAndNumber": "MGLX 5493"
},
{
"initialAndNumber": "MGLX 5511"
}
],
"emptyTime": "2026-10-30T08:05:00-06:00"
}
'{
"items": [
{
"equipmentId": 123,
"initialAndNumber": "<string>",
"changed": true,
"previousWaybillId": 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>",
"sealNumbers": [
"<string>"
],
"chassisInitial": "<string>",
"chassisNumber": 123,
"terminals": [
{
"terminalFunctionCode": "1",
"locationQualifier": "CS",
"locationIdentifier": "<string>",
"portName": "<string>"
}
],
"interchangeMoveAuthorities": [
{
"movementAuthorityCode": "A",
"carrierCode": "<string>",
"terminalTariffApplicationCode": "D",
"stateTariffApplicationCode": "N",
"rejectReasonCode": "AD"
}
],
"shipmentInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>",
"extendedReferenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>",
"date": "<string>",
"timestamp": "<string>"
}
],
"lineItems": [
{
"quantity": 123,
"commodityDescription": "<string>",
"marksAndNumbers": "<string>",
"commodityCodeQualifier": "3",
"commodityCode": "<string>",
"customsShipmentValue": 123,
"weightUnitCode": "E",
"weight": 123,
"cbpBarcodeNumber": "<string>",
"smallestExteriorPackageType": "<string>",
"originCountryCode": "<string>",
"destinationCountryCode": "<string>",
"currencyCode": "<string>"
}
]
}
]
}
],
"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": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"contactInquiryReference": "<string>"
}
],
"billingInfo": [
{
"rebillReasonCode": "RC",
"origin": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destination": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"carrierCodes": [
"<string>"
]
}
],
"referenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>"
}
]
}
],
"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": "<unknown>",
"ladingQuantity": 123,
"unIdCode": "<string>",
"unPageNumber": "<string>",
"commodityCode": "<string>",
"unitCode": "<unknown>",
"quantity": 123,
"compartmentIdCode": "<string>",
"residueIndicatorCode": "<string>",
"packagingGroupCode": "<string>",
"interimHazmatRegulatoryNumber": "<string>",
"industryCode": "<string>",
"classificationInfo": [
{
"hazardousClass": "<string>",
"hazardousClassQualifier": "P",
"hazardousPlacardNotation": "<string>",
"hazardousEndorsement": "<string>",
"reportableQuantityCode": "RQ",
"flashpointUnitCode": "<unknown>",
"flashpointTemperature": 123,
"controlUnitCode": "<unknown>",
"controlTemperature": 123,
"emergencyUnitCode": "<unknown>",
"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": "<unknown>",
"hazmatShipmentInfoQualifier": "<string>",
"hazmatQuantity": 123,
"hazmatQuantityUnitCode": "<unknown>"
}
],
"transborderHazardousRequirements": [
{
"hazardousClassification": "<string>",
"hazardousPlacardNotation": "<string>",
"hazardousEndorsement": "<string>"
}
],
"hazmatReferenceNumbers": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"date": "<string>"
}
],
"administrativeContacts": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"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": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"contactInquiryReference": "<string>"
}
],
"billingInfo": [
{
"rebillReasonCode": "RC",
"origin": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destination": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"carrierCodes": [
"<string>"
]
}
],
"referenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>"
}
]
}
]
}
],
"hazardousCertifications": [
{
"name": "<string>"
}
],
"release": {
"releaseCode": "B",
"releaseDate": "<string>",
"releaseTime": "<string>"
},
"defaultReceiver": "<string>",
"waybillTemplateId": 123,
"waybillTemplateName": "<string>",
"waybillNumberSuffix": "<string>",
"originCarrierCode": "<string>",
"consigneeLocationId": 123,
"shipperLocationId": 123,
"inCareOfLocationId": 123,
"freightBillPartyLocationId": 123,
"pickupPartyLocationId": 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,
"uuid": "<string>",
"waybillStatus": "PENDING",
"createdAt": "<string>",
"tags": {}
}
}
]
}{
"message": "<string>"
}