Skip to main content
POST
/
ims
/
waybills
/
bill-of-lading
Create bill of lading
curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/waybills/bill-of-lading \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '{
  "carrierId": 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": [
          {
            "contactFunctionCode": "<string>",
            "name": "<string>",
            "communicationNumbers": [
              "<any>"
            ],
            "contactInquiryReference": "<string>"
          }
        ],
        "billingInfo": [
          {
            "rebillReasonCode": "RC",
            "origin": {},
            "destination": {},
            "carrierCodes": [
              "<any>"
            ]
          }
        ],
        "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": "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": [
              "<any>"
            ],
            "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": [
                  "<any>"
                ],
                "contactInquiryReference": "<string>"
              }
            ],
            "billingInfo": [
              {
                "rebillReasonCode": "RC",
                "origin": {},
                "destination": {},
                "carrierCodes": [
                  "<any>"
                ]
              }
            ],
            "referenceInfo": [
              {
                "referenceIdQualifier": "<string>",
                "referenceId": "<string>",
                "description": "<string>"
              }
            ]
          }
        ]
      }
    ],
    "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>"
  }
}'
{
  "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": "<any>",
    "cityName": "<any>",
    "stateOrProvince": "<any>",
    "postalCode": "<any>",
    "countryCode": "<any>",
    "splc": "<any>"
  },
  "originJunction": {
    "fsac": "<any>",
    "cityName": "<any>",
    "stateOrProvince": "<any>",
    "postalCode": "<any>",
    "countryCode": "<any>",
    "splc": "<any>"
  },
  "destinationStation": {
    "fsac": "<any>",
    "cityName": "<any>",
    "stateOrProvince": "<any>",
    "postalCode": "<any>",
    "countryCode": "<any>",
    "splc": "<any>"
  },
  "destinationJunction": {
    "fsac": "<any>",
    "cityName": "<any>",
    "stateOrProvince": "<any>",
    "postalCode": "<any>",
    "countryCode": "<any>",
    "splc": "<any>"
  },
  "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": [
            "<any>"
          ],
          "contactInquiryReference": "<string>"
        }
      ],
      "billingInfo": [
        {
          "rebillReasonCode": "RC",
          "origin": {
            "fsac": "<any>",
            "cityName": "<any>",
            "stateOrProvince": "<any>",
            "postalCode": "<any>",
            "countryCode": "<any>",
            "splc": "<any>"
          },
          "destination": {
            "fsac": "<any>",
            "cityName": "<any>",
            "stateOrProvince": "<any>",
            "postalCode": "<any>",
            "countryCode": "<any>",
            "splc": "<any>"
          },
          "carrierCodes": [
            "<any>"
          ]
        }
      ],
      "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": "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": [
            "<any>"
          ],
          "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": [
                "<any>"
              ],
              "contactInquiryReference": "<string>"
            }
          ],
          "billingInfo": [
            {
              "rebillReasonCode": "RC",
              "origin": {
                "fsac": "<any>",
                "cityName": "<any>",
                "stateOrProvince": "<any>",
                "postalCode": "<any>",
                "countryCode": "<any>",
                "splc": "<any>"
              },
              "destination": {
                "fsac": "<any>",
                "cityName": "<any>",
                "stateOrProvince": "<any>",
                "postalCode": "<any>",
                "countryCode": "<any>",
                "splc": "<any>"
              },
              "carrierCodes": [
                "<any>"
              ]
            }
          ],
          "referenceInfo": [
            {
              "referenceIdQualifier": "<string>",
              "referenceId": "<string>",
              "description": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "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>"
}

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

Body

application/json
​
carrierId
integer
​
waybill
object

Response

200 - application/json

OK

​
loadStatus
string
​
commodityCode
string
​
netWeightTons
number
​
originCityName
string
​
originStateOrProvince
string
​
originFsac
string
​
destinationCityName
string
​
destinationStateOrProvince
string
​
destinationFsac
string
​
consignorCustomerName
string
​
consigneeCustomerName
string
​
originScac
string
​
trafficType
enum<string>
Available options:
LOCAL,
ORIGINATING,
TERMINATING,
STORAGE,
BRIDGE,
UNKNOWN
​
shipmentPaymentMethod
enum<string>
Available options:
11,
CC,
MX,
NC,
NR,
PP
​
transportationMethod
enum<string>
Available options:
R,
X
​
shipmentId
string
​
weightUnitCode
enum<string>
Available options:
E,
K,
L,
S,
T
​
shipmentQualifier
enum<string>
Available options:
1,
6,
7,
8,
B,
C,
E,
F,
G,
H,
I,
M,
N,
S,
W,
X
​
capacityLoadCode
enum<string>
Available options:
C,
F,
G,
M,
V
​
customsDocumentationHandlingCode
string
​
confidentialBillingRequestCode
enum<string>
Available options:
C,
M,
N,
R
​
taxReasonCode
string
​
shipmentWeightCode
enum<string>
Available options:
A3,
B,
C,
E,
G,
J,
K,
M,
N,
O,
S,
X
​
referencedPatternIdentifier
string
​
billingCode
enum<string>
Available options:
A,
D,
E,
G,
H,
M,
P,
S,
U,
V,
W,
X,
Y
​
repetitivePatternNumber
integer
​
extendedReferenceInfo
object[]
​
crossReferenceEquipment
object[]
​
equipmentDetails
object[]
​
intermodalStatusDetails
object
​
specialHandlingCodes
string[]
​
protectiveService
object[]
​
originStation
object
​
originJunction
object
​
destinationStation
object
​
destinationJunction
object
​
parties
object[]
​
route
object[]
​
emptyCarDispositions
object[]
​
lineItems
object[]
​
hazardousInfo
object[]
​
hazardousCertifications
object[]
​
release
object
​
defaultReceiver
string
​
waybillTemplateId
integer
​
waybillTemplateName
string
​
originCarrierCode
string
​
consigneeLocationId
integer
​
shipperLocationId
integer
​
inCareOfLocationId
integer
​
freightBillPartyLocationId
integer
​
waybillNumber
integer
​
waybillDate
string
​
billOfLadingNumber
string
​
originSystem
enum<string>
Available options:
ARMS,
EDI
​
preparationDate
string
​
preparationTime
string
​
revisionNumber
integer
​
revisionTime
string
​
revisionSourceType
enum<string>
Available options:
WAYBILL,
CONSIST,
BILL_OF_LADING,
ADVANCE_CAR_DISPOSITION,
LOAD,
EMPTY,
REBILL
​
armsTrackingId
string
​
resourceType
enum<string>
Available options:
Waybill
​
resourceId
integer
​
waybillStatus
enum<string>
Available options:
PENDING,
ACTIVE,
ARCHIVED
​
createdAt
string