openapi: 3.2.0 info: title: Bnsf Requests API version: '1.0' contact: name: BNSF Customer API email: CustomerAPI@bnsf.com termsOfService: http://www.bnsf.com/site-terms-of-use.html description: 'Operations tagged Requests across 7 of this provider''s published API definitions: bnsf-automotive-hub-operations-openapi.json, bnsf-diagnostics-openapi.json, bnsf-intermodal-hub-operations-openapi.json, bnsf-prices-openapi.json, bnsf-reference-files-openapi.json, bnsf-schedules-openapi.json, bnsf-waybill-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: https://api.bnsf.com:6443 tags: - name: Requests paths: /v1/pregate/automotive/haulaway-entry: post: tags: - Requests summary: Haul Away Gate Entry Request - Allow truckers and/or dispatchers to submit load… requestBody: content: application/json: schema: $ref: '#/components/schemas/haulawayGateEntryRequest' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/haulawayGateEntryResponse' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: postV1PregateAutomotiveHaulawayEntry x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/vehicles/addHold: post: tags: - Requests summary: ​​AddHold Request - Haulway or OEM will have the capability to add hold on VIN… requestBody: content: application/json: schema: $ref: '#/components/schemas/automotiveVehicleHoldAdd' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: type: object properties: vinHoldResponseMessageText: type: string title: VIN Hold Response Message Text example: ACCEPTED HOLD REQUEST '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: postV1VehiclesAddHold x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/vehicles/releaseHold: post: tags: - Requests summary: ​​Release Hold Request - This enables Haulway and OEM to release existing Hold… requestBody: content: application/json: schema: $ref: '#/components/schemas/automotiveVehicleHoldRelease' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: type: object properties: vinHoldResponseMessageText: type: string title: VIN Hold Response Message Text example: ACCEPTED HOLD REQUEST '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: postV1VehiclesReleaseHold x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/gate-pass/ramp/{aarRampCode}/vehicle/{vin}: get: tags: - Requests summary: Haulway Carries - Retrieves information of a entry request that is already… parameters: - $ref: '#/components/parameters/AAR_Ramp_Code' - $ref: '#/components/parameters/Vin' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/gateEntryRequestList' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: getV1GatePassRampByAarRampCodeVehicleByVin x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/gate-pass/ramp/{aarRampCode}/gate-pass/{gatePassCode}: get: tags: - Requests summary: Haulway Carries - Retrieves information of a entry request that is already… parameters: - $ref: '#/components/parameters/AAR_Ramp_Code' - $ref: '#/components/parameters/Gate_Pass_Code' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/gateEntryRequestList' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: getV1GatePassRampByAarRampCodeGatePassByGatePassCode x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/exit-request: post: tags: - Requests summary: Haul Away Gate Exit Request – Allow truckers and/or dispatchers to submit load… requestBody: content: application/json: schema: $ref: '#/components/schemas/gateExitRequestFromHaulaway' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/GateExitRequestResponseFromBNSF' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: postV1ExitRequest x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/pre-outgate: post: tags: - Requests summary: Haul‑Away Gate Pre-Exit Request – Allow dispatchers to submit load details… requestBody: content: application/json: schema: $ref: '#/components/schemas/preOutageRequestFromHaulway' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/PreOutageResponseFromBNSF' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: postV1PreOutgate x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /healthcheck: get: tags: - Requests summary: Check the status of the BNSF Customer API responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: type: string example: ok '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: getHealthcheck x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/analytic-event: post: tags: - Requests summary: Submit event data for analytical purposes requestBody: content: application/json: schema: $ref: '#/components/schemas/Generic_User_Provided_Details' responses: '200': description: '**OK** The request has succeeded.' content: application/json: {} '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1AnalyticEvent x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/dray-booking/open: get: tags: - Requests summary: Dray open booking details parameters: - name: drayageBookingNumber in: query description: drayageBookingNumber required: true schema: type: string title: Schema example: 'SH0987654 ' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/DrayBookingResponse' '400': description: '**Bad Request**' content: application/json: schema: type: object properties: httpErrors: type: array items: type: string example: Invalid Booking Number httpResponseCode: type: string example: '400' '403': $ref: '#/components/responses/403' '404': description: '**Not Found**' content: application/json: schema: type: object properties: httpErrors: type: array items: type: string example: Not Found httpResponseCode: type: string example: '404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: getV1DrayBookingOpen x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 '/v1/dray-plan/list-units ': post: tags: - Requests summary: Dray Plan List Units- Returns a list of dray plans for a given supplier633 and… parameters: - name: supplier633 in: query required: true schema: type: string example: APARTNERS633 requestBody: $ref: '#/components/requestBodies/drayPlanListUnits' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/DrayPlan' '400': description: '**Bad Request**' content: application/json: schema: type: object properties: httpErrors: type: array items: type: string example: Invalid Booking Number httpResponseCode: type: string example: '400' '403': $ref: '#/components/responses/403' '404': description: '**Not Found**' content: application/json: schema: type: object properties: httpErrors: type: array items: type: string example: Not Found httpResponseCode: type: string example: '404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: 'postV1DrayPlanListUnits ' x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/dray-plan/initial/{equipmentInitial}/number/{equipmentNumber}: delete: tags: - Requests summary: Dray Plan- Remove dray plans parameters: - name: equipmentInitial in: path required: true schema: type: string example: BNSF - name: equipmentNumber in: path required: true schema: type: string example: '12345' responses: '200': description: '**OK** The request has succeeded.' '400': description: '**Bad Request** The request could not be understood by the server due to incorrect syntax. Do not repeat the request without modifications. ' '403': $ref: '#/components/responses/403' '404': description: '**Not Found** The server cannot find the requested resource (URI). That is, the address of the endpoint in your request does not exist. Please consult the documentation. ' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: deleteV1DrayPlanInitialByEquipmentInitialNumberByEquipmentNumber x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/dray-plan/units: get: tags: - Requests summary: Dray Plan- Capture an intermodal container's dwell profile from dray carriers… parameters: - name: supplier633 in: query description: Supplier 633 required: true schema: type: string title: Schema example: APARTNERS633 responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/DrayPlan' '400': description: '**Bad Request**' content: application/json: schema: type: object properties: httpErrors: type: array items: type: string example: Invalid Booking Number httpResponseCode: type: string example: '400' '403': $ref: '#/components/responses/403' '404': description: '**Not Found**' content: application/json: schema: type: object properties: httpErrors: type: array items: type: string example: Not Found httpResponseCode: type: string example: '404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: getV1DrayPlanUnits x-operation-id-source: derived post: tags: - Requests summary: Dray Plan- Create dray plans parameters: - name: supplier633 in: query required: true schema: type: string example: APARTNERS633 requestBody: content: application/json: schema: $ref: '#/components/schemas/DrayPlan' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/DrayPlan' '400': description: '**Bad Request**' content: application/json: schema: type: object properties: httpErrors: type: array items: type: string example: Invalid Booking Number httpResponseCode: type: string example: '400' '403': $ref: '#/components/responses/403' '404': description: '**Not Found**' content: application/json: schema: type: object properties: httpErrors: type: array items: type: string example: Not Found httpResponseCode: type: string example: '404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1DrayPlanUnits x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v2/dvir: post: tags: - Requests summary: Driver Vehicle Inspection Report - Submit chassis defects (Y/N) within BNSF… requestBody: content: application/json: schema: $ref: '#/components/schemas/DvirInputBean' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: type: object title: Schema properties: httpErrors: type: array title: httpErrors description: Response error of the API items: type: string example: Error httpResponseCode: type: number format: float title: httpResponseCode description: Response status of the API example: 0 '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV2Dvir x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/flips: post: tags: - Requests summary: Flips - Returns details on authorized flips for given units requestBody: $ref: '#/components/requestBodies/flipInputList' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/equipmentFlip' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1Flips x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/hub: get: tags: - Requests summary: Hub - Returns a list of valid lot locations at a given hub facility parameters: - name: station333 in: query description: The location of the most recently reported event required: true schema: type: string example: LOSANGELE example: DALLAS - name: stationStateCode in: query description: The location state of the most recently reported event required: true schema: type: string example: CA example: TX responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/Intermodal_Station' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: getV1Hub x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v2/ingate: post: tags: - Requests summary: Ingate - Returns way-billed units that can be registered prior to arrival at a… requestBody: content: application/json: schema: $ref: '#/components/schemas/Gate_Move_Request' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/IngateResponse' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV2Ingate x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/ingate-management/current: get: tags: - Requests summary: Current Gate Target - Returns all ingate targets related to the authorized list… responses: '200': description: '**OK** The request has succeeded.' content: application/json1: schema: type: object properties: ContainerIngateTargets: type: array items: type: object properties: containerTargetCountEffectiveDate: type: string description: Date on which the given allocation of containers is being considered effective for the given shipper. example: 2024/08/05 containerTargetCountExpirationDate: type: string description: Date on which the given allocation of containers is being considered no more effective for the given shipper. example: 2024/08/05 containerIngateStation333: type: string description: Station at which containers are ingated. example: CICERO containerIngateStationStateCode: type: string description: State code in which the station at which containers are ingated is located. example: IL ingateOutgateMaxCode: type: string description: Code indicating the side of the gate, Ingate or Outgate, at which given Ingate Outgate Maximum Allowed Container Count limit applies. example: IG ingateOutgateMaxDate: type: string description: Date on which the given Ingate Outgate Code is set. example: '2024-08-05' containerIngateOutgateCountCode: type: string description: 'Code defining whether the given container allocation count is applicable to a customer or pool of chassis.\nValid Values Include: P (Pool of Chassis), C (Customer).' example: P customer633Shipper: type: string description: Name of a Customer, acting as the Shipper, which has been abbreviated from the Customer's full Legal Name through the use of a standardized programmatic process. example: JBHUNTRANSPO ingateOutgateTargetAllowedContainerCount: type: integer description: Count of maximum container allowed to either ingate or outgate at the given station for the given effective period and shipper. example: 270 ingateOutgateCount: type: integer description: Count of actual containers either ingated or outgated at the given station for a day. example: 181 lastMaintenanceTimestamp: type: string description: The Date, Time** with fractional seconds, and Time Zone**** when a user, system, or DBMS process initially persists (saves) any data or persists any modification to data (including a logical delete). example: 2024-07-27T22:03:16.705+0000 lastMaintenanceId: type: string description: The ID of the user, system, or DBMS process that triggered the initial persistence (saving) of any data or the persistence of any modification to data (including a logical delete). example: IMDPSCO2 containerDestinationStation333: type: string description: Destination Station of outgating containers. example: ANYWHERE containerDestinationStationStateCode: type: string description: State code in which the destination Station of outgating containers is located. example: US controlFreightQuoteNumber: type: string description: Applicable freight rate quote number. TSS waybill supports only up to 12 characters for storing quote. example: $1000.00 internationalDomesticCode: type: string description: 'Code defining the originating location of the containers.\nValid Values Include: I (International), D (Domestic), B (Both).' example: D truckerSCAC: type: string description: Company abbreviation of the trucker company. example: FXFW reportFilterCode: type: string description: Repeat filter code. Currently when a filter is added it is good for one day only. This indicator will be used to determine if the user wants to continue to repeat the filter. Valid values are Y or N. example: Y containerCalculatedLengthFeet: type: string description: The calculated length, in feet of Container. example: '28' ingateHazardousMaterialProfileCode: type: string description: 'Indicates whether given container has been identified as prohibiting the ingate of hazardous material or not.\nValid Values Are: Y (Yes), N (No).' example: Y ingateErrorMessageText: type: string description: Manually entered message describing the errors encountered while ingating the containers. example: Error message intermodalPlanCode: type: string description: Code indicating the intermodal plan service supplied. (20=rail owned door to door service, 40=steamship stack operator owned, door to door domestic shipment, etc.) Also known as the intermodal service code. example: '20' equipmentLoadEmptyCode: type: string description: 'Code that is used to convey whether a piece of rail conveyance equipment (i.e., a railcar) is being shipped while laden with cargo or while empty, as is the case if it does not pick up another load at its destination.\nValid values are: L (Loaded), E (Empty), RE (Revenue Empty). For intermodal equipment a ''C'' is for chassis and will not be counted as loaded or empty.' example: E countCumulativeTypeCode: type: string description: 'Code which identifies the type of accumulation associated with the count. Valid values include: D (this applies to a daily count), C (this applies to a cumulative count).' example: D createUserId: type: string description: The BNSF ID of the user or program that created the row. (Also known as Create User ID.) example: USERID createDatetime: type: string description: The create timestamp. (Also known as Create Date/Time.) example: 2022-05-14T10:47:32.667+0000 serviceLevelCode: type: string description: 'One-character code used to distinguish differently priced services BNSF provides for customers relative to volumes and other considerations. Also gives Marketing the ability to prioritize shippers within a service level based on seasonal requirements.\nValid Values Include: R (REGULAR), S (STACK), G (GUARANTEED), W (WEEKLY), Y (EMPTY), V (STANDBY), etc..' example: P tofcCofcCode: type: string description: 'A code indicating TOFC(trailer on flat car) or COFC(container on flat car) movement. Also used to determine stacked/non-stacked flat cars. Values are: T (TOFC), C (COFC).' example: TOFC businessSubUnitCode: type: string description: Code defining the specific group within each profit center targeted at a specific customer group. example: Group businessForecastCode: type: string description: Code that indicates within which Business Forecast a shipment exists. example: Business Forecast intermodalHoldingCode3: type: string description: Code indicating intermodal handling. It is also used as the unit loading priority. H=Hot, D=Double stack. Loading priority values go from 1 (highest priority) to 9 (lowest priority). example: H ingateCustomerExceptionCommentText: type: string description: A comment, entered by a user on why an ingate rule had a customer exception. example: Comment ingateLocationExceptionCommentText: type: string description: A comment, entered by a user on why an ingate rule had a location exception. example: Comment beneficialOwnerFullName: type: string description: Full name of the legal entity considered to be the owner of the goods in a shipment, the Beneficial Owner is the party on whose behalf the shipment is being handled by a third party. example: John Doe basisStation: type: string description: The difference between a cash grain price and a futures price. Cash price at a specific 333 location minus specific futures price = BASIS example: '0' dayOfTheWeekCode: type: string description: Number identifying the day of the week and used in a calculation. (1=Sunday, 2=Monday, 3=Tuesday, 4=Wednesday, 5=Thursday, 6=Friday, 7=Saturday) example: '7' timezone: type: string description: Code which identifies the US (United States) Time Zone a Station is located within. example: American/Chicago '400': description: '**Bad Request** The request could not be understood by the server due to incorrect syntax. Do not repeat the request without modifications.' '403': description: "Unauthorized request. Here are the most common causes:\n \n* You are getting 403 Access Denied.\n\n * It takes a few days for us to get you set up after you register. When set up is complete, you will receive an email letting you know. If you have not received the email, please wait up to five business days. Let us know via API Support if you still have not received the email after five business days.\n * You can also get this error if your certificate is not configured properly on your side. Please review the Mutual Authentication in the Getting Started section of our documentation.\n\n\n* You are getting 403 \"message\": \"Insufficient privileges\" when accessing a restricted service for which you do not have permission. You can use our Registration form to request access. Be sure to explain the situation in the \"Please explain how you intend to use the API\" field.\n" '404': description: '**Not Found** The server cannot find the requested resource (URI). That is, the address of the endpoint in your request does not exist. Please consult the documentation.' '405': description: '**Method Not Allowed** The request HTTP method is known by the server but has been disabled and cannot be used for that resource. For example, you may be using GET when POST is required. Please consult the documentation.' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return a **429 Too Many Requests** error response. Upon receiving such exceptions, you can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits. " '500': description: '**Internal Server Error** The server encountered an unexpected condition which prevented it from fulfilling the request. This is always a problem on the server side. Our internal support systems will be made aware.' '504': description: '**Gateway Timeout** The server is acting as a gateway and cannot get a response in time for a request. Wait about one minute then try again.' deprecated: false operationId: getV1IngateManagementCurrent x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v2/ingate/validate: post: tags: - Requests summary: Validate Ingate - Returns required/missing information needed for ingate requestBody: content: application/json: schema: $ref: '#/components/schemas/Gate_Move_Request' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: type: object properties: httpErrors: type: array items: type: string httpResponseCode: type: number format: float description: Response Status of the API '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV2IngateValidate x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/j1-receipts: post: tags: - Requests summary: J1 Receipts - Returns a list of J1 Gate Receipts description: The j1-receipts request accepts up to 100 units. requestBody: content: application/json: schema: type: object title: Schema required: - unitList - endDate - startDate properties: unitList: $ref: '#/components/schemas/unit_list' endDate: type: string example: '2020-07-18' startDate: type: string example: '2020-07-18' j1ReceiptData: type: boolean example: false j1ReceiptPdf: type: boolean example: false responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: type: object title: Schema properties: elements: type: array title: Elements items: $ref: '#/components/schemas/j1_receipt_response' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1J1Receipts x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v2/outgate: post: tags: - Requests summary: Outgate - Returns way-billed units that can be registered prior to exiting at a… requestBody: content: application/json: schema: $ref: '#/components/schemas/Gate_Move_Request' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/OutgateResponse' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV2Outgate x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v2/outgate/validate: post: tags: - Requests summary: Validate Outgate - Returns required/missing information needed for outgate requestBody: content: application/json: schema: $ref: '#/components/schemas/Gate_Move_Request' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/OutgateResponse' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV2OutgateValidate x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/pickup-number: post: tags: - Requests summary: Pickup Number - Validate and/or retrieve pickup numbers requestBody: content: application/json: schema: $ref: '#/components/schemas/Pickup_Number_Request' responses: '200': description: '** No Content ** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/Pickup_Number' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 5 API Request Per Second, Per Partner, Per Service\n* 100 API Requests Per Minute, Per Partner, Per Service\n* 500 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1PickupNumber x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/pregate/in: post: tags: - Requests summary: Pre-Ingate - Advanced creation of an ingate ahead of arriving at a hub facility requestBody: content: application/json: schema: $ref: '#/components/schemas/Intermodal_Pregate' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: type: object properties: railpassId: type: string description: RailPASS ID example: '12345' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1PregateIn x-operation-id-source: derived delete: tags: - Requests summary: Cancel a pre-ingate parameters: - name: equipmentInitial in: query required: true schema: type: string example: BNSF - name: equipmentNumber in: query required: true schema: type: string example: '12345' - name: truckerDriverLicenseNumber in: query required: true schema: type: string example: '123456789' - name: truckerDriverLicenseStateCode in: query required: true schema: type: string example: TX responses: '204': description: '** No Content ** The request has succeeded.' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: deleteV1PregateIn x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/pregate/out: post: tags: - Requests summary: Pre-Outgate - Advanced creation of an outgate ahead of exiting a hub facility requestBody: content: application/json: schema: $ref: '#/components/schemas/Intermodal_Pregate' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: type: object properties: railpassId: type: string description: RailPASS ID example: '12345' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1PregateOut x-operation-id-source: derived delete: tags: - Requests summary: Cancel a pre-outgate parameters: - name: equipmentInitial in: query required: true schema: type: string example: BNSF - name: equipmentNumber in: query required: true schema: type: string example: '12345' - name: truckerDriverLicenseNumber in: query required: true schema: type: string example: '123456789' - name: truckerDriverLicenseStateCode in: query required: true schema: type: string example: TX responses: '204': description: '** No Content ** The request has succeeded.' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: deleteV1PregateOut x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v2/street-en-route: post: tags: - Requests summary: Street En-route - Report pre-arrival to hub and returns rail waybill ingate… requestBody: content: application/json: schema: $ref: '#/components/schemas/Gate_Move_Request' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/StreetEnRouteResponse' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV2StreetEnRoute x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v3/unit-details: post: tags: - Requests summary: Unit Details - Returns hub information (e.g., Lot Location) for units at a BNSF… description: 'The unit-details request accepts up to 500 units. Changelog June 1, 2021: Added response attributes equipmentLotRowSpotTierLocationName and equipmentLotRowSpotTierStatusName. April 26, 2021: Removed pickup number. See new Pickup Number service; updated attribute names to conform to BNSF naming standards.' requestBody: content: application/json: schema: $ref: '#/components/schemas/intermodalUnits' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/IntermodalUnits' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV3UnitDetails x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v3/unit-details/domestic-empties: get: tags: - Requests summary: Domestic Empties - Returns a list of empty units ready for pickup at a BNSF… parameters: - name: station333 in: query description: The location of the most recently reported event required: true schema: type: string example: LOSANGELE example: DALLAS - name: stationStateCode in: query description: The location state of the most recently reported event required: true schema: type: string example: CA example: TX - name: equipmentInitial in: query description: The initials used in the equipment identification for the shipment required: true schema: type: string example: BNSF example: BNSF responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/IntermodalUnits' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: getV3UnitDetailsDomesticEmpties x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/update-parking: post: tags: - Requests summary: Update Parking - Update a unit's parking information at a Hub facility (i.e. requestBody: $ref: '#/components/requestBodies/updateParkingInput' responses: '200': description: '**OK** The request has succeeded.' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1UpdateParking x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/carload-rates: post: tags: - Requests summary: Carload Rates - Returns a list of prices within a BNSF Carload Price Authority requestBody: $ref: '#/components/requestBodies/Post_Rates' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/prices_response' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1CarloadRates x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/intermodal-rates: post: tags: - Requests summary: Intermodal Rates - Returns a list of prices within a BNSF Intermodal Price… requestBody: $ref: '#/components/requestBodies/Post_Rates' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/prices_response' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1IntermodalRates x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/invoices: post: tags: - Requests summary: ​Retrieve Open Invoices - Returns details of customer's open invoices for given… requestBody: $ref: '#/components/requestBodies/Post_Invoice' responses: '200': description: '**OK** The request has succeeded. **Note:** The response data is paginated, with 20 invoices displayed per page. You can find pagination details at the bottom of the response.' content: application/json: schema: $ref: '#/components/schemas/customerInvoice' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: postV1Invoices x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/rail-miles: post: tags: - Requests summary: Rail Mile Inquiry API – Mileage – Returns mileage for BNSF local and/or rule 11… requestBody: $ref: '#/components/requestBodies/Post_oD_Pairs' responses: '200': description: '**OK** The request has succeeded. ' content: application/json: schema: $ref: '#/components/schemas/OD_Pairs_Response' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: postV1RailMiles x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/event-codes: get: tags: - Requests summary: Event Codes - returns a list of event codes and their descriptions, which… responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/tripPlan' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: getV1EventCodes x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/stations: get: tags: - Requests summary: Stations - Returns details of each station matching input criteria description: One of these parameters is required. parameters: - name: scac in: query schema: type: string example: BNSF example: BNSF - name: stationName in: query schema: type: string example: HOUSTON example: Parkwater - name: station333 in: query schema: type: string example: HOUSTON example: PARKWTR - name: stationState in: query schema: type: string example: TX example: WA responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/station' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: getV1Stations x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/stcc: get: tags: - Requests summary: STCC - Returns STCC numbers and descriptions matching input criteria parameters: - name: stcc in: query schema: type: string example: BNSF example: '01' - name: commodityDescription in: query schema: type: string example: HOUSTON example: wheat responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/stcc' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: getV1Stcc x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/stcc/hazardous: get: tags: - Requests summary: STCC - Hazardous - Returns detailed information on hazardous materials matching… parameters: - name: stcc in: query schema: type: string example: BNSF example: '48' - name: hazardousCommodityProperShippingName in: query schema: type: string example: HOUSTON example: WASTE ETHYLENE responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/hazardousCommodities' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: getV1StccHazardous x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/umler: post: tags: - Requests summary: Umler - The Umler service returns internal and external dimensions, capacities… requestBody: $ref: '#/components/requestBodies/requestBody' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/umler' '400': description: '**Bad Request** The request could not be understood by the server due to incorrect syntax. Do not repeat the request without modifications.' '403': description: "Unauthorized request. Here are the most common causes:\n \n* You are getting 403 Access Denied.\n\n * It takes a few days for us to get you set up after you register. When set up is complete, you will receive an email letting you know. If you have not received the email, please wait up to five business days. Let us know via API Support if you still have not received the email after five business days.\n * You can also get this error if your certificate is not configured properly on your side. Please review the Mutual Authentication in the Getting Started section of our documentation.\n\n\n* You are getting 403 \"message\": \"Insufficient privileges\" when accessing a restricted service for which you do not have permission. You can use our Registration form to request access. Be sure to explain the situation in the \"Please explain how you intend to use the API\" field.\n" '404': description: '**Not Found** The server cannot find the requested resource (URI). That is, the address of the endpoint in your request does not exist. Please consult the documentation.' '405': description: '**Method Not Allowed** The request HTTP method is known by the server but has been disabled and cannot be used for that resource. For example, you may be using GET when POST is required. Please consult the documentation.' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return **429 Too Many Requests** error response to the Client. Upon receiving such exceptions, the client can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.\n" '500': description: '**Internal Server Error** The server encountered an unexpected condition which prevented it from fulfilling the request. This is always a problem on the server side. Our internal support systems will be made aware.' '504': description: '**Gateway Timeout** The server is acting as a gateway and cannot get a response in time for a request. Wait about one minute then try again.' operationId: postV1Umler x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/intermodal-schedules: get: tags: - Requests summary: Intermodal Schedules - Returns all Intermodal Schedules parameters: - name: shipmentServiceLevelCode in: query description: E=Expedited; P = Premium; Y = Empty schema: type: string title: Schema example: E - name: businessTypeCode in: query description: D=Domestic; I=International; B=International and Domestic schema: type: string title: Schema example: D - name: equipmentTypeCode in: query description: K=Container; V=Trailer schema: type: string title: Schema example: K responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: type: object title: Schema properties: elements: type: array title: Elements items: $ref: '#/components/schemas/intermodal_schedules' additionalProperties: true '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' security: - Restricted: [] operationId: getV1IntermodalSchedules x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/bol: post: tags: - Requests summary: Submit Bill of Lading - Submit required transit information in order to create… requestBody: content: application/json: schema: $ref: '#/components/schemas/billOfLading' responses: '200': description: '**OK** The request has succeeded.' '201': description: '**Created** The request successfully created a new resource. ' '400': description: '**Bad Request** The request could not be understood by the server due to incorrect syntax. Do not repeat the request without modifications.' content: application/json: schema: type: array items: type: object properties: timestamp: type: string example: 2020-08-13T21:26:36.977+0000 internalErrorId: type: string example: '20003' httpStatusCode: type: string example: '400' message: type: string example: BOL submission invalid messageLabel: type: string example: Invalid STCC code '403': description: "**Forbidden**\n\nUnauthorized request. Here are the most common causes:\n \n* You are getting 403 Access Denied.\n\n * It takes a few days for us to get you set up after you register. When set up is complete, you will receive an email letting you know. If you have not received the email, please wait up to five business days. Let us know via API Support if you still have not received the email after five business days.\n * You can also get this error if your certificate is not configured properly on your side. Please review the Mutual Authentication in the Getting Started section of our documentation.\n\n\n* You are getting 403 \"message\": \"Insufficient privileges\" when accessing a restricted service for which you do not have permission. You can use our Registration form to request access. Be sure to explain the situation in the \"Please explain how you intend to use the API\" field." '404': description: '**Not Found** The server cannot find the requested resource (URI). That is, the address of the endpoint in your request does not exist. Please consult the documentation.' '405': description: '**Method Not Allowed** The request HTTP method is known by the server but has been disabled and cannot be used for that resource. For example, you may be using GET when POST is required. Please consult the documentation.' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return a **429 Too Many Requests** error response. Upon receiving such exceptions, you can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits. " '500': description: '**Internal Server Error** The server encountered an unexpected condition which prevented it from fulfilling the request. This is always a problem on the server side. Our internal support systems will be made aware.' '504': description: '**Gateway Timeout** The server is acting as a gateway and cannot get a response in time for a request. Wait about one minute then try again.' security: - Restricted: [] operationId: postV1Bol x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 /v1/waybill: get: tags: - Requests summary: Retrieve Waybill - Retrieve current active waybill/bill of lading information… description: 'Changelog November 17, 2021: Added customerWaybillReferenceNumbers array.' parameters: - name: equipmentInitial in: query description: Equipment initial. required: true schema: type: string example: BNSF - name: equipmentNumber in: query description: Equipment number. required: true schema: type: string example: '12345' responses: '200': description: '**OK** The request has succeeded.' content: application/json: schema: $ref: '#/components/schemas/Waybill_Details' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '504': $ref: '#/components/responses/504' operationId: getV1Waybill x-operation-id-source: derived servers: - url: https://api.bnsf.com:6443 components: schemas: preOutageRequestFromHaulway: type: object properties: preGateRequestData: type: object required: - carrierScac - driverLicense - gatePassCode - loadNumber - outGateLocation - trailerNumber - truckNumber - vin properties: carrierScac: type: string description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: DEAA driverLicense: type: string description: A value assigned to identify a haulaway truck driver. Value may be a Driver License Number or a value assigned by a haulaway carrier itself. example: WDL55BTJ263B gatePassCode: type: string description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: '703241' loadNumber: type: string description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: '703241' outGateLocation: type: string description: Code assigned by the AAR (Association Of American Railroads) that uniquely identifies automotive ramps used in loading and unloading trains throughout North America. example: OR002 trailerNumber: type: string description: Identification number assigned to a Trailer (part of a tractor trailer) as supplied by the haulaway carrier. example: '1111' truckNumber: type: string description: Identification number assigned to a Truck (part of a tractor trailer) as supplied by the haulaway carrier. example: '2222' vin: type: array description: List of VINs - Vehicle Identification Number (VIN) is a unique, standardized, alphanumeric ID used by the automotive industry to identify individual motor vehicles. items: type: string example: 3FTTW8SA6TRA22427 additionalProperties: false automotiveVehicleHoldRelease: type: object title: Automotive Vehicle Hold Release required: - automotiveVehicleHoldChangeRequestedById - vinList properties: automotiveVehicleHoldChangeRequestedById: type: string title: Automotive Vehicle Hold Change Requested By ID description: Identifier of the entity that has requested a hold status change for automotive vehicles (by VIN). Values originate from other sources and may include SCAC, Manufacturer ID, etc. example: ABCD vinList: type: array title: VIN List description: Comma separated list of VIN (Vehicle Identification Numbers). items: type: string example: '12345678901234567' haulawayGateEntryResponse: type: object title: 'Haulaway Gate Entry Response ' required: - scac - haulawayDriverId - aarRampCode - haulawayGatePassId properties: scac: type: string title: SCAC description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: ABCD haulawayDriverId: type: string title: Haulaway Driver ID description: A value assigned to identify a haulaway truck driver. Value may be a Driver License Number or a value assigned by a haulaway carrier itself. example: K18 aarRampCode: type: string title: AAR Ramp Code description: Code assigned by the AAR (Association Of American Railroads) that uniquely identifies automotive ramps used in loading and unloading trains throughout North America. example: TX027 haulawayGatePassId: type: string title: Haulaway Gate Pass ID description: The gate pass ID is assigned by a haulaway carrier. As there are multiple haulaway carriers, this value is not guaranteed to be unique across all haulers, therefore duplicate values are possible. example: ABCD1234 bnsfHaulawayGatePassId: type: string title: Haulaway Pass Id description: The unique identifier of a gate pass, as generated by BNSF, for every load received from a Haulaway Carrier through the EPOD (Electronic Proof of Delivery) process. example: EQAEM6 haulawayLoadId: type: string title: Haulaway Load ID description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: ABCD1234 haulawayTrailerNumber: type: string title: Haulaway Trailer Number description: Identification number assigned to a Trailer (part of a tractor trailer) as supplied by the haulaway carrier. example: 5688T haulawayTruckNumber: type: string title: Haulaway Truck Number description: Identification number assigned to a Truck (part of a tractor trailer) as supplied by the haulaway carrier. example: Q1025 automotiveVehicles: type: array title: Automotive Vehicles items: type: object required: - vin - commodityStorageZoneName - commodityStorageZoneBayName properties: vin: type: string title: VIN description: Vehicle Identification Number (VIN) is a unique, standardized, alphanumeric ID used by the automotive industry to identify individual motor vehicles. example: 1X6XXXXX2XX566133 commodityStorageZoneName: type: string title: commodityStorageZoneName description: The name of a zone, within a facility or station's storage area, where a commodity (e.g. automobile) is stored or parked. example: PIZN commodityStorageZoneBayName: type: string title: commodityStorageZoneBayName description: The name of a bay, within a facility or station's storage area, where a commodity (e.g. automobile) is stored or parked. example: A1 automotiveVehicleHoldAdd: type: object title: Automotive Vehicle Hold Add required: - automotiveVehicleHoldChangeRequestedById - automotiveHoldOriginDestinationCode - vinList properties: automotiveVehicleHoldChangeRequestedById: type: string title: Automotive Vehicle Hold Change Requested By ID description: Identifier of the entity that has requested a hold status change for automotive vehicles (by VIN). Values originate from other sources and may include SCAC, Manufacturer ID, etc. example: ABCD automotiveHoldOriginDestinationCode: type: string title: Automotive Hold Origin Destination Code description: Code that defines if the associated Automotive hold information relates to an origin or destination location. example: O (Origin) vinList: type: array title: VIN List description: Comma separated list of VIN (Vehicle Identification Numbers). items: type: string example: '12345678901234567' GateExitRequestResponseFromBNSF: type: object properties: errors: type: array description: 'List of errors: 0000 - Vin is valid and present in table / E002 - Vin is not present in table / E0003 - Multiple Vins Found / E9999 - Error Querying for Vin' items: type: object properties: code: type: string example: '0000' message: type: string example: Vin is valid and present in table vin: type: string example: 4JGFB4FB0TB515072 additionalProperties: false gateExitRequestFromHaulaway: type: object properties: carrierScac: type: string description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: SPMA driverLicense: type: string description: A value assigned to identify a haulaway truck driver. Value may be a Driver License Number or a value assigned by a haulaway carrier itself. example: '16435' gatePassCode: type: string description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: 552IRB loadNumber: type: string description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: '389772' loadedVehicles: type: array description: List of VINs items: type: object properties: damages: type: array description: List of damages items: type: object properties: location: type: string description: Code that defines the area of an automobile where damage has been reported. example: '25' severity: type: string description: Code that defines the severity of damage to an automobile that has been reported. example: '2' type: type: string description: Code that defines the type of damage to an automobile that has been reported. example: '2' vin: type: string description: Vehicle Identification Number (VIN) is a unique, standardized, alphanumeric ID used by the automotive industry to identify individual motor vehicles. example: 4JGFB4FB0TB515072 outGateLocation: type: string description: Code assigned by the AAR (Association Of American Railroads) that uniquely identifies automotive ramps used in loading and unloading trains throughout North America. example: CA052 trailerNumber: type: string description: Identification number assigned to a Trailer (part of a tractor trailer) as supplied by the haulaway carrier. example: PLANOBM truckNumber: type: string description: Identification number assigned to a Truck (part of a tractor trailer) as supplied by the haulaway carrier. example: '1102' additionalProperties: false haulPass: type: string description: The gate pass ID is assigned by a haulaway carrier. As there are multiple haulaway carriers, this value is not guaranteed to be unique across all haulers, therefore duplicate values are possible. example: AIL6YJ additionalProperties: false haulawayGateEntryRequest: type: object title: Haulaway Gate Entry Request required: - scac - aarRampCode - haulawayGatePassId - haulawayDriverId properties: scac: type: string title: SCAC description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: ABCD aarRampCode: type: string title: AAR Ramp Code description: Code assigned by the AAR (Association Of American Railroads) that uniquely identifies automotive ramps used in loading and unloading trains throughout North America. example: TX027 haulawayGatePassId: type: string title: Haulaway Gate Pass ID description: The gate pass ID is assigned by a haulaway carrier. As there are multiple haulaway carriers, this value is not guaranteed to be unique across all haulers, therefore duplicate values are possible. example: ABCD1234 haulawayLoadId: type: string title: Haulaway Load ID description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: ABCD1234 haulawayTrailerNumber: type: string title: Haulaway Trailer Number description: Identification number assigned to a Trailer (part of a tractor trailer) as supplied by the haulaway carrier. example: 5688T haulawayTruckNumber: type: string title: Haulaway Truck Number description: Identification number assigned to a Truck (part of a tractor trailer) as supplied by the haulaway carrier. example: Q1025 haulawayDriverId: type: string title: Haulaway Driver ID description: A value assigned to identify a haulaway truck driver. Value may be a Driver License Number or a value assigned by a haulaway carrier itself. example: K18 automotiveVehicles: type: array title: Automotive Vehicles items: type: object required: - vin properties: vin: type: string title: VIN description: Vehicle Identification Number (VIN) is a unique, standardized, alphanumeric ID used by the automotive industry to identify individual motor vehicles. example: 1X6XXXXX2XX566133 automotiveVehicleDamages: type: array title: Automotive Vehicle Damages items: type: object properties: automotiveVehicleDamagedAreaCode: type: string title: Automotive Vehicle Damaged Area Code description: Code that defines the area of an automobile where damage has been reported. example: '03' automotiveVehicleDamageTypeCode: type: string title: Automotive Vehicle Damage Type Code description: Code that defines the type of damage to an automobile that has been reported. example: '04' automotiveVehicleDamageSeverityCode: type: string title: Automotive Vehicle Damage Severity Code description: Code that defines the severity of damage to an automobile that has been reported. example: '2' gateExitRequestFromHaulaway: type: object required: - carrierScac - driverLicense - gatePassCode - loadNumber - loadedVehicles - outGateLocation - trailerNumber - truckNumber properties: carrierScac: type: string description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: SPMA driverLicense: type: string description: A value assigned to identify a haulaway truck driver. Value may be a Driver License Number or a value assigned by a haulaway carrier itself. example: '16435' gatePassCode: type: string description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: 552IRB loadNumber: type: string description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: '389772' loadedVehicles: type: array description: List of VINs items: type: object required: - vin properties: damages: type: array description: List of damages items: type: object properties: location: type: string description: Code that defines the area of an automobile where damage has been reported. example: '25' severity: type: string description: Code that defines the severity of damage to an automobile that has been reported. example: '2' type: type: string description: Code that defines the type of damage to an automobile that has been reported. example: '2' vin: type: string description: Vehicle Identification Number (VIN) is a unique, standardized, alphanumeric ID used by the automotive industry to identify individual motor vehicles. example: 4JGFB4FB0TB515072 outGateLocation: type: string description: Code assigned by the AAR (Association Of American Railroads) that uniquely identifies automotive ramps used in loading and unloading trains throughout North America. example: CA052 trailerNumber: type: string description: Identification number assigned to a Trailer (part of a tractor trailer) as supplied by the haulaway carrier. example: PLANOBM truckNumber: type: string description: Identification number assigned to a Truck (part of a tractor trailer) as supplied by the haulaway carrier. example: '1102' additionalProperties: false PreOutageResponseFromBNSF: type: object properties: errors: type: array description: 'List of errors: 0000 - Vin is valid and present in table / E002 - Vin is not present in table / E0003 - Multiple Vins Found / E9999 - Error Querying for Vin' items: type: object properties: code: type: string message: type: string vin: type: string additionalProperties: false example: [] preGateResponseData: type: array items: type: object properties: carrierScac: type: string description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: DEAA driverLicense: type: string description: A value assigned to identify a haulaway truck driver. Value may be a Driver License Number or a value assigned by a haulaway carrier itself. example: WDL55BTJ263B gatePassCode: type: string description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: '703241' haulPassCode: type: string description: BNSF generated unique code for entry/exit requests example: CPHWBK loadNumber: type: string description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: '703241' loadedVehicles: type: array description: List of VINs items: type: object properties: bay: type: string description: A designated spot within a zone where shipments are staged for loading or unloading. example: R12 damages: type: array description: List of damages items: type: object properties: location: type: string description: Code that defines the area of an automobile where damage has been reported. example: '00' severity: type: string description: Code that defines the severity of damage to an automobile that has been reported. example: '0' type: type: string description: Code that defines the type of damage to an automobile that has been reported. example: '00' additionalProperties: false vin: type: string description: Vehicle Identification Number (VIN) is a unique, standardized, alphanumeric ID used by the automotive industry to identify individual motor vehicles. example: 3FTTW8SA6TRA22427 zone: type: string description: A section of the parking lot that contains multiple bays for organizing shipments. example: R additionalProperties: false outGateLocation: type: string description: Code assigned by the AAR (Association Of American Railroads) that uniquely identifies automotive ramps used in loading and unloading trains throughout North America. example: OR002 trailerNumber: type: string description: Identification number assigned to a Trailer (part of a tractor trailer) as supplied by the haulaway carrier. example: '1111' truckNumber: type: string description: Identification number assigned to a Truck (part of a tractor trailer) as supplied by the haulaway carrier. example: '2222' additionalProperties: false additionalProperties: false gateEntryRequestList: type: object title: Gate Entry Request List properties: gateEntryRequestList: type: array description: 'Collection of entry requests ' items: type: object properties: carrierScac: type: string description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: CASF driverId: type: string description: A value assigned to identify a haulaway truck driver. Value may be a Driver License Number or a value assigned by a haulaway carrier itself. example: S53045369122 aarRampCode: type: string description: Code assigned by the AAR (Association Of American Railroads) that uniquely identifies automotive ramps used in loading and unloading trains throughout North America. example: IL022 gatePassCode: type: string description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: '20349891' haulPassCode: type: string description: The gate pass ID is assigned by a haulaway carrier. As there are multiple haulaway carriers, this value is not guaranteed to be unique across all haulers, therefore duplicate values are possible. example: IEY6UY loadNumber: type: string description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: '20349891' trailerNumber: type: string description: Identification number assigned to a Trailer (part of a tractor trailer) as supplied by the haulaway carrier. example: '22410' truckNumber: type: string description: Identification number assigned to a Truck (part of a tractor trailer) as supplied by the haulaway carrier. example: '22409' requestTimestamp: type: string description: Timestamp at which the request is posted. example: '2023-12-07T12:21:02.605-06:00' ingateTimestamp: type: string description: Timestamp at which the request is ingated. example: '2023-12-07T12:21:02.605-06:00' ingateUserId: type: string description: User id used to ingate the request. example: USER status: type: string description: Current status of the load. example: A loadedVehicles: type: array description: List of Vins items: type: object properties: vin: type: string description: Vehicle Identification Number (VIN) is a unique, standardized, alphanumeric ID used by the automotive industry to identify individual motor vehicles. example: 1FMSK7DH6PGC01166 zone: type: string description: Zone information of the VIN. example: 2 digit alpha numberic value. Ex. A1 bay: type: string description: Bay information of the vin example: 'alpha numeric value ' damages: type: array description: List of damages items: type: object properties: location: type: string description: Code that defines the area of an automobile where damage has been reported. example: 'numeric values Ex : 1,2,3' type: type: string description: Code that defines the type of damage to an automobile that has been reported. example: 'numeric values Ex : 1,2,3' severity: type: string description: Code that defines the severity of damage to an automobile that has been reported. example: 'numeric values Ex : 1,2,3' Generic_User_Provided_Details: type: object required: - userProvidedEventTypeName - userProvidedStation333 - userProvidedStationStateCode properties: userProvidedEventTypeName: type: string description: The name of an Event Type as provided by an internal or external user. example: Gate userProvidedStation333: type: string description: Name of a City, which is abbreviated from the City's Full Name as recognized across the Rail Industry, as provided by an internal or external user. example: GREFALLS userProvidedStationStateCode: type: string description: The State code for a given station defined by a standardized State code, as assigned by a national body such as the US Postal Service as provided by an internal or external user. example: MT userProvidedValues: type: array items: type: object required: - userProvidedDataItemName - userProvidedDataItemValueText properties: userProvidedDataItemName: type: string description: 'The symbolic name used to represent a unit of data that is provided by a user and is equivalent to the key in a key-value pair. ' example: Lane userProvidedDataItemValueText: type: string description: The actual data content that is provided by a user and is equivalent to the value in a key-value pair. This may be alpha or numeric in content. example: A12 unit_information: type: object title: unit_information properties: badOrderIndicator: type: boolean title: Bad Order Indicator description: Indicates if the unit is bad ordered example: true carKindCarTypeCode: type: string title: Car Kind Car Type Code description: First character of car kind example: K carKindCode: type: string title: Car Kind Code description: Car kind example: KC destinationStateCode: type: string title: Destination State Code description: The destination hub state of the shipment example: CA destinationStation333: type: string title: Destination Station333 description: The destination hub station of the shipment example: LOSANGELE errorMessage: type: string title: Error Message description: Error message example: Unit details not available estimatedDerampDate: type: string title: Estimated Deramp Date description: The estimated deramp date example: 10/31/2019 estimatedDerampTime: type: string title: Estimated Deramp Time description: The estimated deramp time example: 01:00 eventCode: type: string title: Event Code description: Code indicating the event/activity abbreviation example: TA eventDate: type: string title: Event Date description: Event date example: 7/7/2020 eventTime: type: string title: Event Time description: Event time example: 12:00:00 PM fullBilledIndicator: type: boolean title: Full Billed Indicator description: Full billed indicator example: true gateEditCode: type: string title: Gate Edit Code description: Code indicating if there are gate instructions example: A gateEditMessage: type: string title: Gate Edit Message description: Gate instructions example: 'INGATE AT CHICAGO CORWITH ' grossWeightPounds: type: string title: Gross Weight Pounds description: Gross weigth of the unit, in pounds example: '10000' hazmatIndicator: type: boolean title: Hazmat Indicator description: Hazardous material indicator example: true heightFeet: type: string title: Height Feet description: Height of the unit, in feet example: '9' heightInches: type: string title: Height Inches description: Height of the unit, in inches example: '10' ingateSealNumber: type: string title: Ingate Seal Number description: Seal Number example: ABC123 lastFreeDayDate: type: string title: Last Free Day Date description: Last free day for storage clock example: '2020-07-07' lastPassingStation333: type: string title: Last Passing Station333 description: Last pass station example: ALLIANCE lastPassingStationStateCode: type: string title: Last Passing Station State Code description: Last pass state example: TX lengthFeet: type: string title: Length Feet description: Length of the unit, in feet example: '53' loadEmptyChassisCode: type: string title: Load Empty Chassis Code description: Code indicating if the unit is loaded, empty or a chassis (L, E, C) example: L lockedEstimatedNotificationDate: type: string title: Locked Estimated Notification Date description: The confirmed estimated date that the customer will be notified of delivery example: 10/31/2019 lockedEstimatedNotificationTime: type: string title: Locked Estimated Notification Time description: The confirmed estimated time that the customer will be notified of delivery example: 01:00 netWeightPounds: type: string title: Net Weight Pounds description: Net weight of the unit, in pounds example: '1000' originStation333: type: string title: Origin Station333 description: The origin hub station of the shipment example: CHICAGO originStationStateCode: type: string title: Origin Station State Code description: The origin hub state of the shipment example: IL parkingAssignment: $ref: '#/components/schemas/unit_location' poolMarketingCode: type: string title: Pool Marketing Code description: Code indicating marketed or pool intermodal equipment (M=Marketed, P=Pooled) example: P railpassId: type: string title: Railpass Id description: RailPASS ID example: '12345' releaseNumber: type: string title: Release Number description: Release number example: L12345 shipper633: type: string title: Shipper633 description: Company or customer sending rail shipment at origin example: JBHUNTRANSPO station333: type: string title: Station333 description: The location of the most recently reported event example: ALLIANCE stationStateCode: type: string title: Station State Code description: The location state of the most recently reported event example: TX tareWeightPounds: type: string title: Tare Weight Pounds description: Tare weight is the weight of the empty unit example: '10000' truckCarrierScac: type: string title: Truck Carrier Scac description: Standard Carrier Alpha Code (SCAC) assigned to the truck carrying the shipment example: JBHU unitGradeCode: type: string title: Unit Grade Code description: Code indicating the grade of the unit example: H unitInitial: type: string title: Unit Initial description: The initials used in the equipment identification for the shipment example: JBHU 'unitLocation ': $ref: '#/components/schemas/unit_location' unitLocationCode: type: string title: Unit Location Code description: Code indicating the location of the unit e.g. G = Ground example: G unitNumber: type: string title: Unit Number description: The numbers used in the equipment identification for the shipment example: '12345' unitStatusCode: type: string title: Unit Status Code description: Current status of the unit example: In Inv on Ground Pickup_Number: type: object title: Pickup Number properties: pickupNumber: type: string title: pickupNumber description: A security number provided to the notify party which allows the vehicle to outgate from (leave) a BNSF facility. The truck driver must provide the pickup number at the time of outgate. example: '772454' pickupNumberValidIndicator: type: string title: pickupNumberValidIndicator description: Indicates if the pickup number is valid. enum: - 'Yes' - 'No' example: 'Yes' intermodalUnits: type: object title: intermodalUnitsRequest properties: intermodalUnits: type: array items: type: object properties: equipmentInitial: type: string example: BNSF equipmentNumber: type: string example: '123456' unit_location: type: object title: unit_location properties: lotLocation: type: string title: Lot Location description: This is the is the lot where the intermodal unit is placed for pickup by the trucker example: A rowLocation: type: string title: Row Location description: This is the is the row where the intermodal unit is placed for pickup by the trucker example: '12' spotLocation: type: string title: Spot Location description: This is the is the spot where the intermodal unit is placed for pickup by the trucker example: '2' DvirInputBean: type: object title: DvirInputBean required: - chassisInitial - chassisNumber - dvirRequiredIndicator - station333 - stationStateCode properties: chassisInitial: type: string title: chassisInitial description: The chassis identification initial used for the shipment example: ABCD chassisNumber: type: string title: chassisNumber description: The chassis identification number used for the shipment example: '1234' dvirRequiredIndicator: type: string title: dvirRequiredIndicator description: Driver Vehicle Inspection Report required indicator example: Y station333: type: string title: station333 description: The location of the most recently reported event example: ALLIANCE stationStateCode: type: string title: stationStateCode description: The location state of the most recently reported event example: TX IngateResponse: type: object title: IngateResponse properties: equipmentLotLocationInstructions: type: string title: equipmentLotLocationInstructions description: Parking instructions for driver example: 1234Proceed to lot A5 httpResponseCode: type: number format: float title: httpResponseCode description: Response status of the API example: 0 railpassId: type: string title: railpassId description: RailPASS ID example: '12345' OutgateResponse: type: object title: OutgateResponse properties: railpassId: type: string title: railpassId description: RailPASS ID example: '12345' httpResponseCode: type: number format: float title: httpResponseCode description: Response status of the API example: 0 DrayPlan: type: object title: Dray Plan properties: intermodalUnits: type: array title: Intermodal Units items: type: object required: - equipmentInitial - equipmentNumber - supplier633 properties: authorizedSuppliers: type: array title: Authorized Suppliers description: List of authorized suppliers. items: type: string description: Standardized code which uniquely represents a authorized Supplier. Value is assigned by putting the Legal Name of a supplier through a computer algorithm example: APARTNERS633 beneficialCargoOwner633: type: string title: Beneficial Cargo Owner 633 description: Name of the person or legal entity who owns or has title to the cargo being transported. Value abbreviated from the Customer's full Legal Name through the use of a standardized programmatic process. maxLength: 12 example: APARTNERS633 beneficialCargoOwnerFullName: type: string title: Beneficial Cargo Owner Full Name description: Full name of the legal entity considered to be the owner of the shipment cargo, the Beneficial Owner is the party on whose behalf the shipment cargo is being handled by a third party. maxLength: 35 example: BCO Full Company Name containerDestinationZipcode: type: string title: ContainerDestination Zip Code description: Container Destination Zip Code maxLength: 5 example: '76107' containerIntermodalLotLocationName: type: string title: Container Intermodal Lot Location Name description: Intermodal lot location of the given container. example: 7 / 2 / 0000 containerOutgatePrivateChassisIndicator: type: string title: Container Outgate Private Chassis Indicator description: Indicates whether the givenunit will be outgated with a private chassis. maxLength: 1 example: Y containerPeelPileIndicataor: type: string title: Container Peel Pile Indicataor description: "Indicates if the given container is a candidate for a peel pile at the destination lot. \nA stack of containers in Intermodal facilities organized in such way that drayage carrier drivers can lift (aka peel) the top one off as opposed to waiting for or moving a specific one that could be located anywhere in the pile, cutting the dwell time on a container and mitigating demurrage expenses." maxLength: 1 example: Y createDatetime: type: string format: date-time title: Create Datetime description: Created Timestamp example: '2024-03-11 12:17:19.12' createUserId: type: string title: Create User Id description: Created by User maxLength: 128 example: ABCD destETADate: type: string format: date title: Container Destination ETA Date description: Approximate date that the container will arrive at a destination location. maxLength: 10 example: '2023-09-20' destETATime: type: string title: Container Destination ETA Time description: ETA (Estimated Time of Arrival) is the time when a container is expected to arrive at a certain place or destination. maxLength: 10 example: '20:07:00' destinationLocationDwellIndicatorDateTime: type: string format: date-time title: Destination Location Dwell Indicator DateTime description: Date and time the given supplier 633 sets the Destination Location Dwell Indicator. example: '2023-11-03 13:52:04.856' destinationLocationDwellIndicatorModificationIndicator: type: string title: Destination Location Dwell Indicator Modification Indicator description: Indicates whether the given Destination Location Dwell Indicator can be modified or not. maxLength: 1 example: Y destinationLocationDwellIndicatorUserFullName: type: string title: Destination Location Dwell Indicator User Full Name description: Full name of the user that sets the Destination Location Dwell Indicator. maxLength: 128 example: Full Name destinationLocationDwellIndicatorUserId: type: string title: Destination Location Dwell Indicator User Id description: User id that sets the Destination Location Dwell Indicator. maxLength: 128 example: ABCS drayageCarrier633: type: string title: Drayage Carrier 633 description: Is the abbreviated 12-character transportation drayage carrier as defined by the BNSF operating department using the first 6 letters of the first name, the first 3 letters of the second name, and the first 3 letters of the last name. maxLength: 12 example: APARTNERS633 drayageCarrierFullName: type: string title: Drayage Carrier Full Name description: Full name of the legal entity considered to be the drayage carrier. maxLength: 35 example: APARTNERS633 full name dwellAtDestinationIndicator: type: string title: Dwell at Destination Indicator description: 'Indicates whether or not there will be a dwell at the destination location. Valid Values Are: Y(Yes), N(no).' maxLength: 1 example: Y equipmentInitial: type: string title: Equipment Initial description: Equipment Initial is the prefix or alphabetic part of an equipment units identifying number. maxLength: 6 example: ABCD equipmentNumber: type: string title: Equipment Number description: Equipment Number is the sequencing or serial part of an equipment units identifying number. maxLength: 6 example: '12345' intermodalDrayageCarrierFirstNotificationCode: type: string title: IntermodalDrayageCarrierFirstNotificationCode description: Code defining the notification being sent to given intermodal drayage carrier. maxLength: 3 example: NFI intermodalDrayageCarrierSecondNotificationCode: type: string title: IntermodalDrayageCarrierSecondNotificationCode description: Code defining the notification being sent to given intermodal drayage carrier. maxLength: 3 example: NFI intermodalDrayageCarrierThirdNotificationCode: type: string title: IntermodalDrayageCarrierThirdNotificationCode description: Code defining the notification being sent to given intermodal drayage carrier. maxLength: 3 example: NFI supplier633: type: string title: Supplier 633 description: Standardized code which uniquely represents a Supplier. Value is assigned by putting the Legal Name of a supplier through a computer algorithm maxLength: 12 example: APARTNERS633 truckerScac: type: string title: Trucker SCAC description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation trucking company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: HJBU updateUserId: type: string title: Update User Id description: Last Update User maxLength: 128 example: ABCD updateDatetime: type: string format: date-time title: Update Datetime description: Last Update Timestamp example: '2023-12-26 17:41:38.969' drayBooking: type: object title: DrayBooking properties: drayageBookingNumber: type: string description: An agreement between BNSF and a trucking company who will complete the dray move. Which is just the movement of equipment to another location such as a different lot. example: SH0987654 destinationStateCode: type: string description: The State code for a given destination defined by a standardized State code, as assigned by a national body such as the US Postal Service. example: CA destinationStation333: type: string description: Name of a City, defined as a destination for a movement, which has been abbreviated from the City's Full Name through the use of a standardized programmatic algorithm. example: CITCOMMER destinationStationLotLocationName: type: string description: The name given to a location within a specific lot as assigned by the destination station. This is where equipment, material, or shipments are to be placed for a given period of time. example: SAG originStateCode: type: string description: The State code for a given origin defined by a standardized State code, as assigned by a national body such as the US Postal Service. example: CA originStation333: type: string description: Name of a City, defined as the origin of a shipment, which has been abbreviated from the City's Full Name through the use of a standardized programmatic process. example: LOSANGELE originStationLotLocationName: type: string description: The name given to a location within a specific lot as assigned by the origin station. This is where equipment, material, or shipments are to be placed for a given period of time. example: MAIN drayageMovementMethodName: type: string description: The method to be used to move equipment, material, or shipments in drayage from one location to another. example: Shuttle drayageShuttleTypeName: type: string description: Value which defines the shuttle type applied to drayage (UnitSpecific, Generic, etc.). example: UnitSpecific drayageShuttleMovementTypeName: type: string description: Value which defines if the movement of drayaged equipment is from one lot to another lot or from one yard to another yard. example: Yard truckerScac: type: string description: The SCAC (Standard Carrier Alpha Code) assigned to a Trucking Company. example: BNSF units: type: array items: type: object title: Equipment properties: equipmentInitial: type: string description: Equipment Initial is the prefix or alphabetic part of an equipment unit's identifying number. equipmentNumber: type: string description: Equipment Number is the sequencing or serial part of an equipment unit's identifying number. equipmentFlip: type: object title: Equipment Flip properties: equipmentFlips: type: array description: A flip is a type of lift movement at an intermodal facility which can include the lifting of a container from the ground to a chassis or from a chassis to a different chassis. items: type: object required: - equipmentInitial - equipmentNumber properties: equipmentInitial: type: string description: Equipment Initial is the prefix or alphabetic part of an equipment units identifying number. example: BNSF equipmentNumber: type: string description: Equipment Number is the sequencing or serial part of an equipment units identifying number. example: '123456' equipmentFlipAuthorizedDatetime: type: string description: The Date and Time when the flip is authorized and the equipment can be picked up. This value is formatted using the ISO 8601 Standard. example: '2021-03-29T12:00:00Z' equipmentFlipAuthorizationStatusCode: type: string description: 'A code that represents the current status of a flip authorization. ' example: A equipmentLengthFeet: type: string description: The length, in feet, of a piece of rail equipment. example: '40' shipper633: type: string description: Name of a Customer, acting as the Shipper, which has been abbreviated from the Customer's full Legal Name through the use of a standardized programmatic process. example: ACMESHIPPR station333: type: string description: Name of a City which has been abbreviated from the City's Full Name through the use of a standardized programmatic algorithm. example: TRAINTWN stationStateCode: type: string description: The State code for a given station defined by a standardized State code, as assigned by a national body such as the US Postal Service. example: TX billableCostIndicator: type: string description: Flag indicating if the associated cost is billable? example: Y equipmentFlipRequestReasonNote: type: string description: Freeform note that describes the reason for the Equipment Flip Request. example: BAD ORDER CHASSIS patron633: type: string description: Name of a Patron, a Customer who ships or wants to ship with BNSF, that has been abbreviated from the Customer's full Legal Name through the use of a standardized programmatic process. example: ACMEPATRON chassisInitial: type: string description: Chassis Initial is the prefix or alphabetic part of a chassis unit's identifying number. example: ACME chassisNumber: type: string description: Chassis Number is the sequencing or serial part of an Chassis unit's identifying number. example: '999999' chassisAttachedDatetime: type: string description: The Date and Time when the equipment was attached. This value is formatted using the ISO 8601 Standard. example: '2021-03-29T12:00:00Z' derivedEquipmentStatusName: type: string description: BNSF derived value which defines the status for a piece of equipment. example: No details found for unit StreetEnRouteResponse: type: object title: StreetEnRouteResponse required: - chassisInitial - chassisNumber - dvirRequiredIndicator properties: chassisInitial: type: string title: chassisInitial description: The chassis identification initial used for the shipment example: ABCD chassisNumber: type: string title: chassisNumber description: The chassis identification number used for the shipment example: '1234' dvirRequiredIndicator: type: string title: dvirRequiredIndicator description: Driver Vehicle Inspection Report required indicator example: Y httpErrors: type: array title: httpErrors items: type: string example: Invalid unit httpResponseCode: type: number format: float title: httpResponseCode description: Response status of the API example: 0 railpassId: type: string title: railpassId description: RailPASS ID example: '12345' j1_receipt_response: type: object title: j1_receipt_response properties: errors: type: array title: errors description: J1 Receipt PDF base64 encoded data items: type: string j1Details: $ref: '#/components/schemas/j1_response' status: type: number format: float title: status description: Response status of the API example: 0 j1_response: type: object title: j1_response properties: j1PdfData: type: string title: j1PdfData description: J1 Receipt PDF base64 encoded data example: JVBERi0... J1 Receipt: $ref: '#/components/schemas/j1_receipt' unitInitial: type: string title: unitInitial description: The initials used in the equipment identification for the shipment example: JBHU unitNumber: type: string title: unitNumber description: The numbers used in the equipment identification for the shipment example: '12345' Intermodal_Station: type: object description: Contains information related to Intermodal Stations and any details related to them. required: - station333 - stationStateCode properties: equipmentLotLocations: type: array description: List of all Equipment Lot Locations found within the boundaries of a given Intermodal Station. items: type: object required: - equipmentLotLocationName properties: equipmentLotLocationName: type: string description: The name of the lot where equipment is located. example: A station333: type: string description: Name of a City which has been abbreviated from the City's Full Name through the use of a standardized programmatic algorithm. example: TRAINTWN stationStateCode: type: string description: The State code for a given station defined by a standardized State code, as assigned by a national body such as the US Postal Service. example: TX Intermodal_Pregate: type: object required: - dvirRequiredIndicator - equipmentLengthFeet - gateEquipmentMovementTypeCode - shipper633 - station333 - stationStateCode - truckerDriverLicenseNumber - truckerDriverLicenseStateCode - truckerGateActionCode - truckingScac properties: carKindCode: type: string description: Code that identifies the physical characteristics for equipment as defined by BNSF Railway itself. Value is used when car characteristics are required for business decision making. example: K18 chassisInitial: type: string description: Chassis Initial is the prefix or alphabetic part of a chassis unit's identifying number. example: DEF chassisNumber: type: string description: Chassis Number is the sequencing or serial part of an Chassis unit's identifying number. example: '5678' dvirRequiredIndicator: type: string description: Indicates if a DVIR (Driver Vehicle Inspection Report) is required to be performed. example: Y equipmentDoorSealNumber: type: string description: Identification number for a seal. A seal is typically applied to a door on Intermodal Equipment (Containers or Trailers) prior to transit. example: '12345' equipmentInitial: type: string description: Equipment Initial is the prefix or alphabetic part of an equipment units identifying number. example: ABC equipmentLengthFeet: type: string title: equipmentLengthFeet description: The length, in feet, of a piece of rail equipment. example: '10' equipmentNumber: type: string description: Equipment Number is the sequencing or serial part of an equipment units identifying number. example: '1234' estimatedGateMoveDatetime: type: string description: Date and Time when the gate move is estimated to occur. example: '2021-05-03T21:15:44.900Z' gateEquipmentMovementTypeCode: type: string description: 'A code that defines the type of movement a piece of equipment is to make at the time it enters an intermodal gate. ' example: U pickupNumber: type: string description: A security number provided to the notify party which allows the vehicle to outgate from (leave) a BNSF facility. The truck driver must provide the pickup number at the time of outgate. example: '12345' railpassId: type: string example: 1ABCD shipper633: type: string description: Name of a Customer, acting as the Shipper, which has been abbreviated from the Customer's full Legal Name through the use of a standardized programmatic process. example: JBHUNTRANSPO station333: type: string description: Name of a City which has been abbreviated from the City's Full Name through the use of a standardized programmatic algorithm. example: ALLIANCE stationStateCode: type: string description: The State code for a given station defined by a standardized State code, as assigned by a national body such as the US Postal Service. example: TX tractorLicensePlateNumber: type: string description: The license plate number attached to the tractor portion of a tractor trailer (AKA Semi). example: AB123 tractorLicenseStateCode: type: string description: Code indicating the state the tractor license plate was issued from. A tractor is a portion of a tractor trailer (AKA Semi). example: TX tractorStencilId: type: string description: A unique alphanumeric value stenciled on the tractor of a tractor-trailer (semi truck) by the owner of the trailer. example: ABC123 truckerDriverLicenseNumber: type: string description: The Drivers License Number of an intermodal truck driver. example: AA12345 truckerDriverLicenseStateCode: type: string description: State where drivers license was issued from. example: TX truckerGateActionCode: type: string description: Derived code indicating the action it is believed a trucker is trying to make at the associated gate. example: L truckingScac: type: string description: The SCAC (Standard Carrier Alpha Code) assigned to a Trucking Company. example: BNSF Pickup_Number_Request: type: object title: Pickup Number Request required: - equipmentInitial - equipmentNumber properties: equipmentInitial: type: string title: equipmentInitial description: The initials used in the equipment identification for the shipment. example: BNSF equipmentNumber: type: string title: equipmentNumber description: The numbers used in the equipment identification for the shipment. example: '12345' pickupNumber: type: string title: pickupNumber description: A security number provided to the notify party which allows the vehicle to outgate from (leave) a BNSF facility. The truck driver must provide the pickup number at the time of outgate. example: '772454' DrayBookingResponse: type: object title: DrayBookingResponse properties: httpErrors: type: array items: type: string httpResponseCode: type: integer format: int32 example: 200 drayBooking: $ref: '#/components/schemas/drayBooking' IntermodalUnits: type: object properties: intermodalUnits: type: array items: type: object properties: attachedIntermodalUnits: type: array items: type: object carInitial: type: string title: Car Initial description: Car Initial is the prefix or alphabetic part of a railcar's identifying number. example: INIT carKindCode: type: string description: Code that identifies the physical characteristics for equipment as defined by BNSF Railway itself. example: 'K18 ' carKindTypeCode: type: string description: First character of a Car Kind Code which is used to define the type of car. example: K carNumber: type: string description: Car Number is the sequencing or serial part of a railcar's identifying number. example: A1B2 derivedBadOrderIndicator: type: string description: BNSF derived value which indicates if a Bad Order exists for the associated equipment. example: Y derivedEquipmentStatusName: type: string description: 'BNSF derived value which defines the status for a piece of equipment. ' example: On the Ground destinationStateCode: type: string description: The State code for a given destination defined by a standardized State code, as assigned by a national body such as the US Postal Service. example: TX destinationStation333: type: string description: Name of a City, defined as a destination for a movement, which has been abbreviated from the City's Full Name through the use of a standardized programmatic algorithm. example: ALLIANCE equipmentDoorSealNumber: type: string description: Identification number for a seal. A seal is typically applied to a door on Intermodal Equipment (Containers or Trailers) prior to transit. example: '123456' equipmentGradeCode: type: string description: Code that defines the grade, quality, applied to a piece of equipment. example: H equipmentGrossScaleWeightPounds: type: string description: The gross scale weight of a piece of equipment as measured in pounds. example: '1000' equipmentInitial: type: string description: Equipment Initial is the prefix or alphabetic part of an equipment units identifying number. example: ABCD equipmentLengthFeet: type: string description: The length, in feet, of a piece of rail equipment. example: '40' equipmentLocationCode: type: string description: Code which defines the location of a piece of equipment. example: G equipmentLotLocationName: type: string description: The name of the lot where equipment is located. example: A equipmentLotRowLocationName: type: string description: The name of the row, within a lot, where equipment is located. example: '1' equipmentLotRowSpotLocationName: type: string description: The name of the spot, within a row that is within a lot, where equipment is located. example: '1' equipmentLotRowSpotTierLocationName: type: string description: Name of the tier (within a spot, that is within a row, that is within a lot) where the equipment is located. 1 is the bottom of the stack with the number increasing throughout the stack. example: '2' equipmentLotRowSpotTierStatusName: type: string description: 'Value that defines the placement status of a piece of equipment that is stacked within a tier in a Lot, Row, Spot location. Valid Values Include: (blank), Not Stacked, In Stack, Top Of Stack.' example: Top Of Stack equipmentNumber: type: string description: Equipment Number is the sequencing or serial part of an equipment units identifying number. example: '123456' equipmentOutsideHeightFeet: type: string description: The height, in feet, of the outside of a piece of equipment. example: '10' equipmentOutsideHeightInches: type: string description: The height, in inches, of the outside of a piece of equipment which is in addition to the height in feet. example: '6' equipmentTareWeightPounds: type: string description: The weight of an empty vehicle or container, as measured in pounds, without cargo. Sometimes referred to as Unladen Weight. example: '1000' estimatedEquipmentUnloadDatetime: type: string description: Date and Time when a shipment is estimated to deramped, unloaded, from the train. This represents the complete Date (YYYY/MM/DD), on the Gregorian calendar, along with a valid complete Time (HHMMSSx) example: '2021-04-19T14:47:37.068Z' eventCode: type: string description: Code used to define an event or activity occurring on the rail network. example: DR eventDatetime: type: string description: Date and Time when a given event was created. This represents the complete Date (YYYY/MM/DD), on the Gregorian calendar, along with a valid complete Time (HHMMSSx) example: '2021-04-19T14:47:37.068Z' fullWaybillIndicator: type: string description: Indicates if the associated Waybill is a Full Waybill. example: Y lastPassedStateCode: type: string description: The State code for a station through which a something (a shipment, a piece of equipment, a train, etc.) has passed, as defined by a standardized State code, as assigned by a national body such as the US Postal Service. example: TX lastPassedStation333: type: string description: Name of a City through which something (a shipment, a piece of equipment, a train, etc.) has passed. This name has been abbreviated from the City's Full Name through the use of a standardized programmatic algorithm. example: ALLIANCE loadEmptyChassisCode: type: string description: Code that defines if a piece of equipment is loaded, empty, or is a chassis. example: L lockedEstimatedPickupNotificationDatetime: type: string description: The locked Date and Time when a shipment is estimated to be ready for pickup. This represents the complete Date (YYYY/MM/DD), on the Gregorian calendar, along with a valid complete Time (HHMMSSx). example: '2021-04-19T14:47:37.068Z' originStation333: type: string description: Name of a City, defined as the origin of a shipment, which has been abbreviated from the City's Full Name through the use of a standardized programmatic process. example: ALLIANCE originStationStateCode: type: string description: The State code for a given origin defined by a standardized State code, as assigned by a national body such as the US Postal Service. example: TX shipmentLastFreeStorageDate: type: string description: The last date a shipment is considered to be eligible for free storage (YYYY/MM/DD). After this date Storage Fees will begin to accrue. example: '2021-01-01' shipmentNetScaleWeightPounds: type: string description: The net scale weight of a shipment, as measured in pounds. example: '1000' shipper633: type: string description: Name of a Customer, acting as the Shipper, which has been abbreviated from the Customer's full Legal Name through the use of a standardized programmatic process. example: BNSFRAILWAY station333: type: string description: Name of a City which has been abbreviated from the City's Full Name through the use of a standardized programmatic algorithm. example: ALLIANCE stationStateCode: type: string description: The State code for a given station defined by a standardized State code, as assigned by a national body such as the US Postal Service. example: TX trackNumber: type: string description: Number used to uniquely identify a track at a station. example: '1234' truckingScac: type: string description: Standard Carrier Alpha Code (SCAC) assigned to the truck carrying the shipment example: BNSF waybillHazardousMaterialIndicator: type: string description: Indicates if the associated shipment has a Hazardous Material Profile on the Waybill. example: N unit_list: type: array title: unit_list items: type: string example: JBHU722223 minItems: 1 maxItems: 100 example: - JBHU722223 - JBHU722254 j1_receipt: type: object title: j1_receipt properties: agsDefectFoundIndicator: type: string title: agsDefectFoundIndicator description: Indicates if a defect was found via the automated gate system (AGS) example: N attachedDispositionCode: type: string title: attachedDispositionCode description: Code indicating disposition of chassis attachment to equipment. (D=Dual, F=Flip, A=same as chassis, Blank = nodecision of disposition at gate time) example: D attachedUnit: $ref: '#/components/schemas/unit_information' badOrderIndicator: type: boolean title: badOrderIndicator description: Indicates if the unit is bad ordered example: true booth: type: string title: booth description: Intermodal checkpoint boot where inspection document printer is housed (1, 2, 10, 99, etc.) example: '1' carInitial: type: string title: carInitial description: Car initial example: ABCD carKindCarTypeCode: type: string title: carKindCarTypeCode description: First character of car kind example: K carKindCode: type: string title: carKindCode description: Car Kind example: KC carNumber: type: string title: carNumber description: Car number example: '123456' commodityDescription: type: string title: commodityDescription description: Commodity description example: MEDICAL SUPP destinationReleasedCustomer633: type: string title: destinationReleasedCustomer633 description: Customer that shipment was actually released to example: CUSTOMER destinationStateCode: type: string title: destinationStateCode description: The destination hub state of the shipment example: CA destinationStation333: type: string title: destinationStation333 description: The destination hub station of the shipment example: LOSANGELE driverLicenseNumber: type: string title: driverLicenseNumber description: Driver license number example: '123456' equipmentControlCode: type: string title: equipmentControlCode description: Code indicating system/foreign or private control of equipment example: L errorMessage: type: string title: errorMessage description: Error message example: Unit details not available estimatedDerampDate: type: string title: estimatedDerampDate description: The estimated deramp date example: '2020-07-07' estimatedDerampTime: type: string title: estimatedDerampTime description: The estimated deramp time example: '9:00' eventCode: type: string title: eventCode description: Code indicating the event/activity abbreviation example: TA eventDate: type: string title: eventDate description: Event date example: '2020-07-07' eventTime: type: string title: eventTime description: Event time example: '12:00:00' flightVoyageNumber: type: string title: flightVoyageNumber description: Number of the flight or voyage on which the cargo traveled example: '123456' fullBilledIndicator: type: boolean title: fullBilledIndicator description: Last pass state example: true gateEditCode: type: string title: gateEditCode example: A gateEditMessage: type: string title: gateEditMessage grossWeightPounds: type: string title: grossWeightPounds description: Gross weigth of the unit, in pounds example: '10000' hazmatDescription: type: string title: hazmatDescription description: Description of the hazmat example: DANGEROUS hazmatIndicator: type: boolean title: hazmatIndicator description: Net weight of the unit, in pounds example: true heightFeet: type: string title: heightFeet description: Height of the unit, in feet example: '9' heightInches: type: string title: heightInches description: Height of the unit, in inches example: '12' historicalVoyageBookingNumber: type: string title: historicalVoyageBookingNumber description: Historical voyage booking number example: '123456' ingateGrossWeightPounds: type: string title: ingateGrossWeightPounds description: Ingate gross weight in pounds example: '40000' ingateHazardousPlacardCode: type: string title: ingateHazardousPlacardCode description: Driver's declaration of hazardous shipment placecard code example: CM ingateHazmatDeclarationIndicator: type: string title: ingateHazmatDeclarationIndicator description: Drivers declaration to identify the need for hazardous papers example: N ingateSealNumber: type: string title: ingateSealNumber description: Seal Number example: ABC123 intermodalDriverFirstName: type: string title: intermodalDriverFirstName description: 'Intermodal driver''s first name ' example: First intermodalDriverLastName: type: string title: intermodalDriverLastName description: 'intermodal driver''s last name ' example: Last intermodalEquipmentProviderDOTNumber: type: string title: intermodalEquipmentProviderDOTNumber description: 'A department of transportation (DOT) identification number for an intermodal equipment provider (IEP) compan ' example: '123456' intermodalUnitCertificationDate: type: string title: intermodalUnitCertificationDate description: 'Intermodal unit certification date ' example: '2020-07-08' lastFreeDayDate: type: string title: lastFreeDayDate description: Last free day for storage clock example: '2020-07-07' lastPassingStation333: type: string title: lastPassingStation333 description: 'Last pass station ' example: ALLIANCE lastPassingStationStateCode: type: string title: lastPassingStationStateCode description: 'Last pass state ' example: TX lengthFeet: type: string title: lengthFeet description: 'Length of the unit, in feet ' example: '70' loadEmptyChassisCode: type: string title: loadEmptyChassisCode description: 'Code indicating if the unit is loaded, empty or a chassis (L, E, C) ' example: L loadSheetCofcWeightPounds: type: string title: loadSheetCofcWeightPounds description: 'Load sheet COFC weight in pounds ' example: '5000' loadSheetTofcWeightPounds: type: string title: loadSheetTofcWeightPounds description: 'Load sheet TOFC weight in pounds ' example: '5000' lockedEstimatedNotificationDate(1): type: string title: Locked Estimated Notification Date description: The confirmed estimated date that the customer will be notified of delivery example: 10/31/2019 lockedEstimatedNotificationTime: type: string title: Locked Estimated Notification Time description: The confirmed estimated time that the customer will be notified of delivery example: 01:00 netWeightPounds: type: string title: Net Weight Pounds description: Net weight of the unit, in pounds example: '1000' originStation333: type: string title: Origin Station333 description: The origin hub station of the shipment example: CHICAGO originStationStateCode: type: string title: originStationStateCode description: The origin hub state of the shipment example: IL parkingAssignment: $ref: '#/components/schemas/unit_location' patron633: type: string title: patron633 description: 'Shipping patron (customer) name in 633 format ' example: BNSF patronName: type: string title: patronName description: 'Full spelling of a Patron Name ' example: BNSF Railway platformCode: type: string title: platformCode description: 'Code indicating which platform. (B=platform at brake end of car, C=first platform from brake end of car platform, etc.) ' example: B platformPositionCode: type: string title: platformPositionCode description: 'Code indicating which platform position on car(1= first position from bench on lower platform, T= Top position, etc.) ' example: T poolMarketingCode: type: string title: poolMarketingCode description: 'Code indicating marketed or pool intermodal equipment (M=Marketed, P=Pooled) ' example: P railCarrierScac: type: string title: railCarrierScac description: 'Railroad carrier Standard Carrier Alpha Code (SCAC) ' example: ABCD railControlledCode: type: string title: railControlledCode description: 'Code which identifies if the associated equipment is considered to be controlled by Rail or Non-Rail ' example: N railpassId: type: string title: railpassId description: 'RailPASS ID ' example: '12345' refrigerationMountPositionCode: type: string title: refrigerationMountPositionCode description: 'Code indicating the refrigeration unit position mounting. (N=Nosemount, U=Undermount) ' example: N releaseNumber: type: string title: releaseNumber description: 'Release number ' example: L12345 roadabilityConditionDefectCode: type: string title: roadabilityConditionDefectCode description: 'Code representing the type of defect in roadability condition ' example: '01' shipmentLadingWeightPounds: type: string title: shipmentLadingWeightPounds description: 'Net weight of shipment landing in pounds ' example: '40000' shipper633: type: string title: Shipper633 example: JBHUNTRANSPO station333: type: string title: Station333 description: The location of the most recently reported event example: ALLIANCE stationStateCode: type: string title: stationStateCode description: The location state of the most recently reported event example: TX stopOrderDescription: type: string title: stopOrderDescription description: 'Freeform description of the stoporder ' example: Do not stop at gate tareWeightPounds: type: string title: tareWeightPounds description: 'Tare weight is the weight of the empty unit ' example: '1000' tofcCofcCode: type: string title: tofcCofcCode description: 'Code indicating TOFC(Trailer on flat car) or COFC (container on flat car). T = TOFC, C = COFC ' example: T tractorLicensePlateNumber: type: string title: tractorLicensePlateNumber description: 'Tractor license plate number ' example: '123456' tractorWeightPounds: type: string title: tractorWeightPounds description: 'Tractor weight in pounds ' example: '1000' truckCarrierScac: type: string title: truckCarrierScac example: JBHU truckNumber: type: string title: truckNumber description: 'Truck number ' example: '123456' trueKingPinIndicator: type: integer format: int32 title: trueKingPinIndicator description: 'Adjusted kingpin setting in inches ' example: 36 unitGradeCode: type: string title: unitGradeCode description: 'Code indicating the grade of the unit ' example: H unitInitial: type: string title: Unit Initial description: The initials used in the equipment identification for the shipment example: JBHU unitLocation (1): $ref: '#/components/schemas/unit_location' unitLocationCode: type: string title: Unit Location Code description: Code indicating the location of the unit e.g. G = Ground example: G unitNumber: type: string title: Unit Number description: The numbers used in the equipment identification for the shipment example: '12345' unitStatusCode: type: string title: unitStatusCode description: Current status of the unit example: In Inv on Ground unitWhatDamageDescriptions: type: array title: unitWhatDamageDescriptions description: 'Descriptions of what damages the unit has (Automatic Airing System - Left Front, etc.) ' items: type: string example: Automatic Airing System unitWhyDamageDescriptions: type: array title: unitWhyDamageDescriptions description: 'Descriptions of the cause of the damages (Bent, Broken etc.) ' items: type: string example: Broken vesselName: type: string title: vesselName description: 'Name of sailing vessel ' example: OOCL TOKYO voyageBookingNumber: type: string title: voyageBookingNumber description: 'Booking number assigned by the carrier for space reservation on a voyage ' example: '123456' waybillId: type: string title: waybillId description: 'BNSF assigned identifier of a waybill ' example: '0248-05-21 02:45:48' waybillVersion: type: string title: waybillVersion description: 'Waybill version ' example: '1' Gate_Move_Request: type: object description: JSON document used to send and receive information related to a Customer's Drayage Booking requests. required: - carKindCode - equipmentInitial - equipmentLengthFeet - equipmentNumber - railpassId - shipper633 - station333 - stationStateCode - tractorLicensePlateNumber - tractorLicenseStateCode - tractorStencilId - truckerDriverLicenseNumber - truckerDriverLicenseStateCode - truckingScac properties: carKindCode: type: string description: Code that identifies the physical characteristics for equipment as defined by BNSF Railway itself. Value is used when car characteristics are required for business decision making. example: K chassisInitial: type: string description: Chassis Initial is the prefix or alphabetic part of a chassis unit's identifying number. example: ABCD chassisNumber: type: string description: Chassis Number is the sequencing or serial part of an Chassis unit's identifying number. example: '123456' equipmentDoorSealNumber: type: string description: Identification number for a seal. A seal is typically applied to a door on Intermodal Equipment (Containers or Trailers) prior to transit. example: '12345' equipmentInitial: type: string description: Equipment Initial is the prefix or alphabetic part of an equipment units identifying number. example: ABCD equipmentLengthFeet: type: string description: The length, in feet, of a piece of rail equipment. example: '40' equipmentNumber: type: string description: Equipment Number is the sequencing or serial part of an equipment units identifying number. example: '1' pickupNumber: type: string description: A security number provided to the notify party which allows the vehicle to outgate from (leave) a BNSF facility. The truck driver must provide the pickup number at the time of outgate. example: '1234' railpassId: type: string description: RailPASS ID example: ABC12 shipper633: type: string description: Name of a Customer, acting as the Shipper, which has been abbreviated from the Customer's full Legal Name through the use of a standardized programmatic process. example: BNSFRAILWAY station333: type: string description: Name of a City which has been abbreviated from the City's Full Name through the use of a standardized programmatic algorithm. example: ALLIANCE stationStateCode: type: string description: The State code for a given station defined by a standardized State code, as assigned by a national body such as the US Postal Service. example: TX tractorLicensePlateNumber: type: string description: The license plate number attached to the tractor portion of a tractor trailer (AKA Semi). example: '1234567' tractorLicenseStateCode: type: string description: Code indicating the state the tractor license plate was issued from. A tractor is a portion of a tractor trailer (AKA Semi). example: TX tractorStencilId: type: string description: A unique alphanumeric value stenciled on the tractor of a tractor-trailer (semi truck) by the owner of the trailer. example: STENCIL truckerDriverLicenseNumber: type: string description: The Drivers License Number of an intermodal truck driver. example: '13456' truckerDriverLicenseStateCode: type: string description: State where drivers license was issued from. example: TX truckerGateActionCode: type: string description: Derived code indicating the action it is believed a trucker is trying to make at the associated gate. example: L truckingScac: type: string description: The SCAC (Standard Carrier Alpha Code) assigned to a Trucking Company. example: BNSF OD_Pairs_Response: type: object properties: data: type: object properties: odPairsList: type: array items: type: object properties: originState: type: string description: Origin state identifier example: IL originCity: type: string description: Origin station identifier example: CHICAGO destinationState: type: string description: Destination state identifier example: TX destinationCity: type: string description: Destination station identifier example: HOUSTON originSPLC: type: string example: '380000' originFSAC: type: string example: '66000' originR260JCT: type: string example: CHGO destSPLC: type: string example: '684800' destFSAC: type: string example: '35100' destR260JCT: type: string example: HUSTN miles: type: string example: '1257' status: type: string example: '200' errorMessage: type: - string - 'null' example: null additionalProperties: false status: type: string example: SUCCESS httpStatus: type: string example: '200' additionalProperties: false Price_Authority: type: object properties: priceAuthority: type: object required: - priceAuthorityGroups properties: priceAuthorityOwnerIssuedName: type: string description: 'A name must be assigned by the Owner of a Price Authority which is combined with the Owner''s ID, an Owner Issued Number, and an optional Owner Issued Item Number to help uniquely identify an official document (Authority) containing price(s) for shipment(s). It may consist of any alpha numeric character string excluding special characters, which may be a minimum of one character and a maximum of ten characters in length; examples include: BNSF, BNSFQ, QTYELLOW, C, CIRC, NSPQ, MA42MW, etc. ' example: BNSFQ (Carload) --OR-- QTTSSLC (Intermodal) priceAuthorityNumber: type: number format: float description: 'A number can be assigned by the Owner of a Price Authority such that it can be combined with the Owner''s ID, an Owner Issued Name, and an optional Owner Issued Item Number to help uniquely identify an official document (Authority) containing price(s) for shipment(s). If the Owner does not wish to create a specific number, then the Owner must identify this number as 9999999999 (ten 9''s) to indicate there is no specific Price Authority Owner Issued Number. The only characters allowed in the number are zero (0) through nine (9) and one decimal point (if needed). The number must not exceed ten (10) characters in length; a decimal point counts as a character. The number of positions to the right of the decimal point must not exceed four (4) characters. ' example: 105355 priceAuthorityItemNumber: type: number format: float description: 'A number that Identifies an Owner Issued Item (or Implementing Agreement) which is used to identify a more granular reference to a given price when combined with the Owner ID, Owner Issued Name, and Owner Issued Number. Marketing sometimes divides a given Price Authority into what might be referred to as sub-authorities which are identified by a given Owner Issued Item Number. The only characters allowed in the number are zero (0) through nine (9) and one decimal point (if needed). The number must not exceed ten (10) characters in length; a decimal point counts as a character. The number of positions to the right of the decimal point must not exceed four (4) characters: eg, ''00123.4567'' would be valid. If a Price Authority does not actually have a item number, then the item number will be set to '' '' (Blank). ' example: 100 priceAuthorityRevisionNumber: type: string description: 'Identifies the Revision of a given Price Authority as it changes over time. When a Pricing Authority is created, Marketing starts the revision numbering for it at 0 (zero), which indicates that the Pricing Authority is brand new (the first initial creation of it). After the initial creation of the authority, the revision number is incremented by one each time Marketing decides and makes a revision to the Pricing Authority which is for external publication. This differs from a Pricing Authority internal only change where the Version Number is incremented alone and the Revision Number remains the same. For example a PA currently set at Version Number #10 and the Revision Number still set as #5 indicates there have been more internal changes than external changes. Revision Numbers begin the series at #0 (zero). ' example: '29' priceAuthorityOwnerId: type: string description: 'A two to four character alpha abbreviation which identifies the Owner of a Price Authority. An Owner ID is usually a SCAC (Standard Carrier Alpha Code) used to designate a transportation company. SCACs are assigned by the National Motor Freight Traffic Association (NMFTA). Examples of a railroad SCAC include: BNSF, NS, UP. Sometimes, however, the Owner ID might be an abbreviation for a Tarrif Bureau. Examples of a Tariff Bureau include: WRTA = "Western Railroad Traffic Association", RPS = "Railroad Publishing Services". ' example: BNSF priceAuthorityVersionNumber: type: number format: float description: 'Every time a Price Authority is to be changed by Marketing for Pricing, the Pricing Authority Version Number is incremented by one, no matter whether it is an internal or external (reported to a customer) change. This differs from a Pricing Authority external change where the Version Number is incremented as well as the Revision Number. For example a PA can be set at Version Number 10 and the Revision Number may not have changed from 5, because there have been more internal changes than external changes. Version Numbers begin the series with a value of 1 (one). ' example: 37 priceAuthorityVersionId: type: number format: float description: "The identifier of the Price Authority Version table. \n" example: 1411524 priceAuthorityFileId: type: string description: 'An identification of the internal identifier (alpha numeric) assigned to a Price Authority generated from either the Legacy Rate Price Management System (RPMS) or from RAPID /Price Translator. This internal identifier is a business term (Price Authority File ID) that is used and referenced by the Marketing Department as well as other business areas. ' example: 0212242279 priceAuthorityGeneralRuleSet: type: string description: 'Identifies the General Rules that apply to the Prices within the given Price Authority. ' example: Freight charges must be prepaid. Price applies in U.S. Funds. Price does not apply on shipments accorded transit, inspection, sampling, reconsignment, diversion, or stopping in transit for loading or unloading. prices: type: array description: Identifies an array of one or more rates within a given Price Authority. items: type: object description: Identifies the price data elements that are common (are core) to most Price Authorities. properties: priceAuthorityPriceEffectiveDate: type: string format: date description: 'Effective Date. (yyyy-mm-dd format) ' example: '2019-09-01' priceAuthorityPriceExpirationDate: type: string format: date description: 'Expiration Date. (yyyy-mm-dd format) ' example: '2020-08-31' priceAuthorityPriceAmount: type: string description: 'Identifies the rate amount of a given Price Package qualified by the Rate Unit Calculation Code (RT_UNT_CALCTN_CD) and Currency Type Code (CURR_TYP_CD) within that Price Package. ' example: '913.0000' unitOfMeasure: type: string description: 'indicate the unit of measure that the price can be applied. For example: PC - per car, PT - Per net ton, etc...' example: PC priceAuthorityPriceUnitCalculationCode: type: string description: 'Identifies the rate unit calculation code for a Rate Amount (RT_AMT) within a given Price Package qualified by the Currency Type Code (CURR_TYP_CD) within that Price Package. ' example: IM priceAuthorityPriceCurrencyTypeCode: type: string description: 'Identifies the currency type that is to be used. Valid values are: ''U'' United States; ''C'' = Canada, ''M'' = Mexico. ' example: USD minimumWeightQuantity: type: string description: "The Quantity of Weight (if present and not zero) that will be used as the Minimum Weight to rate a weight-based shipment if the actual lading weight is less than this minimum weight.\n\nFor example, if the Minimum Weight Quantity is 50,000 (pounds) and the actual lading weight of the shipment is 20,000 (pounds), the shipment will be rated at the minimum 50,000.\n\nThis is used to protect that a customer does not load up a car with only 100 pounds of lading for a shipment from California to Illinois where the rate is $10.00 per hundred pounds.\n\nA minimum weight quantity of 50,000 pounds means that the customer must pay at least $5,000 for such a shipment. \n" example: '5000' minimumWeightQuantityUomCode: type: string description: 'Identifies what unit of measure that the Minimum Weight is expressed in, e.g., pounds ("LB"), net tons ("PT"), etc. Example: if the Minimum Weight Quantity is 500, then this can be 500 pounds, 500 net tons, etc.' example: LB originGeographicTypeCode: type: string description: 'Identifies the type of geography (eg. city, state, zip code, etc.). Examples include: ''AC'' = OPSL Station Name (City), ''CO''= County, ''SP'' = States/Provinces, ''PQ'' = ZIP 3, ''PS'' = ZIP 5, ''FS'' = FREIGHT STATIONS, ''S2'' = two digit SPLC, ''S4'' = four digit SPLC, ''S6'' = six digit SPLC. Canadian Postal Region Codes may be added in the future as ''PU''. ''OL'' = OPSL number ranges may be added in the future. ' example: AC originStationName: type: string description: 'OPEN AND PREPAID STATION LIST NAME. OPEN AND PREPAID STATION LIST (OPSL) IS AN OFFICIAL LIST OF ALL STATIONS IN THE UNITED STATES THAT ARE LEGAL AND OFFICIAL RAILROAD STATIONS THAT A SHIPMENT MAY BE BILLED TO OR FROM. THIS LIST ALSO HAS SPECIAL INSTRUCTIONS THAT APPLY TO EACH STATION ' example: CHICAGO originStateCode: type: string description: 'The identifier of the State / Province. ' example: IL originSwitchingLimitsUsedIndicator: type: string description: "Indicates \"T\" (True) or \"F\" (False) whether the price is valid also for all revenue stations within the Switching Limits of the Origin. This is based on the origin rail carrier in the revenue route and how that carrier defines what other stations (if any) are included within the switching limits of that origin station.\n\nFor example, BNSF says CICERO, IL (and some other Illinois stations) are within the Switching Limits of CHICAGO, IL, but CSXT says that CICERO, IL and HAMMOND, IN (different state) are within SWL of CHICAGO. \n" minLength: 1 maxLength: 1 example: T originGeographicGroupName: type: string description: 'Identifies a given short name for a specific geographic group within a given business group. The members of geographic groups may be different between different business groups even though the group name may be the same. ' example: CHICAGO & LPC originGeographicGroupNumber: type: string description: "A unique key that identifies a given geographic group that being used as origin in a service price package. \n \nThe members of geographic groups may be different between different business groups even though the group name may be the same\n" example: '375200646' destinationGeographicTypeCode: type: string description: 'Identifies the type of geography (eg. city, state, zip code, etc.). Examples include: ''AC'' = OPSL Station Name (City), ''CO''= County, ''SP'' = States/Provinces, ''PQ'' = ZIP 3, ''PS'' = ZIP 5, ''FS'' = FREIGHT STATIONS, ''S2'' = two digit SPLC, ''S4'' = four digit SPLC, ''S6'' = six digit SPLC. Canadian Postal Region Codes may be added in the future as ''PU''. ''OL'' = OPSL number ranges may be added in the future. ' example: AC destinationStationName: type: string description: 'OPEN AND PREPAID STATION LIST NAME. OPEN AND PREPAID STATION LIST (OPSL) IS AN OFFICIAL LIST OF ALL STATIONS IN THE UNITED STATES THAT ARE LEGAL AND OFFICIAL RAILROAD STATIONS THAT A SHIPMENT MAY BE BILLED TO OR FROM. THIS LIST ALSO HAS SPECIAL INSTRUCTIONS THAT APPLY TO EACH STATION ' example: SEATTLE destinationStateCode: type: string description: "The identifier of the State / Province. \n" example: WA destinationSwitchingLimitsUsedIndicator: type: string description: "Indicates \"T\" (True) or \"F\" (False) whether the price is valid also for all revenue stations within the Switching Limits of the Destination. This is based on the destination rail carrier in the revenue route and how that carrier defines what other stations (if any) are included within the switching limits of that destination station.\n\nFor example, BNSF says CICERO, IL (and some other Illinois stations) are within the Switching Limits of CHICAGO, IL, but CSXT says that CICERO, IL and HAMMOND, IN (different state) are within SWL of CHICAGO. \n" minLength: 1 maxLength: 1 example: F destinationGeographicGroupName: type: string description: 'Identifies a given short name for a specific geographic group within a given business group. The members of geographic groups may be different between different business groups even though the group name may be the same. ' example: SEATTLE PORTS destinationGeographicGroupNumber: type: string description: 'A unique key that identifies a given specific geographic group being used as destination in a service price package. ' example: '216601236' serviceCode: type: string description: The first column of the Shipment Condition Code is the 'V' field (Value field). This identifies the Intermodal Service Code when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to ISCO. example: '25' bnsfServiceLevelCode: type: string description: The first column of the Shipment Condition Code is the 'V' field (Value field). This identifies the BNSF Intermodal Service Level Code when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to BN06. example: P priorOriginGeographicTypeCode: type: string description: 'The first column of the Shipment Condition Code is the ''V'' field (Value field). This identifies the Prior Origin Geographic Type Code when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to ACPO. ' example: SL priorOriginFirstQualifierName: type: string description: 'This is the second column of the Shipment Condition and is referred to as the ''F'' field (Range From field). The ''F'' field might not be a range. This identifies the Prior Origin First Qualifier Name when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to ACPO. ' example: 093900 priorOriginSecondQualifierName: type: string description: 'This is the third column of the Shipment Condition and is referred to as the ''T'' field (Range To field). The ''T'' field might not be a range. This identifies the Prior Origin Second Qualifier Name when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to ACPO. ' example: 093989 finalDestinationGeographicTypeCode: type: string description: 'The first column of the Shipment Condition Code is the ''V'' field (Value field). This identifies the Final Destination Geographic Type Code when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to ACFD. ' example: PS finalDestinationFirstQualifierName: type: string description: 'This is the second column of the Shipment Condition and is referred to as the ''F'' field (Range From field). The ''F'' field might not be a range. This identifies the Final Destination First Qualifier Name when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to ACFD. ' example: '66210' finalDestinationSecondQualifierName: type: string description: 'This is the third column of the Shipment Condition and is referred to as the ''T'' field (Range To field). The ''T'' field might not be a range. This identifies the Final Destination Second Qualifier Name when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to ACFD. ' example: '66219' servicePricePackageId: type: number format: float description: 'The identifier of the Service Price Package table. This is a surrogate key identity column of table TSVC_PRC_PKG. ' example: 31608704 servicePackageCommodityLowStcc: type: string description: 'Identifies the low end STCC (Standard Transportation Commodity Code) code number within a range, otherwise it identifies a non-range single STCC to be used. ' example: '4611110' servicePackageCommodityHighStcc: type: string description: 'Identifies the high end STCC (Standard Transportation Commodity Code) code number within a range of STCC. ' example: '4611127' servicePackageLoadEmptyCode: type: string description: Code indicate whether the price can applied to Load or Empty intermodal move example: E commodityGroupShortName: type: string description: 'Identifies a given short name for a specific commodity group within a given business group. The members of commodity groups may be different between different business groups even though the group name may be the same. ' example: EMPTY CONTAINER commodityGroupLongName: type: string description: 'Identifies a given long name for a specific commodity group within a given business group. The members of commodity groups may be different between different business groups even though the group name may be the same. ' example: EMPTY CONTAINER commodityGroupNumber: type: string description: A unique key that identifies a specific commodity group used in a service price package of a price authority. example: '104093082' revenueRouteDescription: type: string description: 'A description of the Route with the carrier abbreviations and the off-going junction abbreviations. ' example: BNSF Direct equipmentTypeDescription: type: string description: 'A description of the Equipment Type which may be a railcar or other intermodal type of transport carried on rail. ' example: BOXCAR (Carload) --OR-- CONTAINER (Intermodal) equipmentOwnerTypeLabel: type: string description: 'A name or label given to describe whether the equipment owner is a Shipper or a Rail Carrier or is unknown. ' example: SHIPPER OWNED equipmentUsageStatusCode: type: string description: 'Identifies if the equipment is empty or loaded and this applies mainly to Intermodal, so Carload can be blank. ' example: EMPTY equipmentGroupShortDescription: type: string description: 'A short description of a given Shipment Contition Group as of a specified Version. This identifies the Equipment when the Shipment Condition Group Version has a Group Type Code (SHPMT_COND_GRP_TYP_CD) is set to "E". ' example: 20CM equipmentGroupShortName: type: string description: 'Identifies a given short name for a specific Shipment Condition group within a given business group. The members of Shipment Condition groups may be different between different business groups even though the group name may be the same. This identifies the Equipment when the Shipment Condition Group Version has a Group Type Code (SHPMT_COND_GRP_TYP_CD) is set to "E". ' example: 20CM-MAX. CONT. W/O CHASSIS equipmentGroupLongName: type: string description: 'Identifies a given long name for a specific Shipment Condition group within a given business group. The members of Shipment Condition groups may be different between different business groups even though the group name may be the same. This identifies the Equipment when the Shipment Condition Group Version has a Group Type Code (SHPMT_COND_GRP_TYP_CD) is set to "E". ' example: 20 FOOT MAXIMUM LENGTH CONTAINER WITHOUT A CHASSIS equipmentMinimumInsideLengthFeetInches: type: string description: This is the second column of the Shipment Condition and is referred to as the 'F' field (Range From field). The 'F' field might not be a range. This identifies the Equipment Minimum Inside Length in Feet and Inches when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to EQIL. example: 000-00 equipmentMaximumInsideLengthFeetInches: type: string description: This is the third column of the Shipment Condition and is referred to as the 'T' field (Range To field). The 'T' field might not be a range. This identifies the Equipment Maximum Inside Length in Feet and Inches when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to EQIL. example: 015-11 equipmentMinimumOutsideLengthFeetInches: type: string description: 'This is the second column of the Shipment Condition and is referred to as the ''F'' field (Range From field). The ''F'' field might not be a range. This identifies the Equipment Minimum Outside Length in Feet and Inches when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to EQOL. ' example: 000-00 equipmentMaximumOutsideLengthFeetInches: type: string description: 'This is the third column of the Shipment Condition and is referred to as the ''T'' field (Range To field). The ''T'' field might not be a range. This identifies the Equipment Maximum Outside Length in Feet and Inches when the Shipment Condition code (SHPMT_COND_ELE_CD) is set to EQOL. ' example: 020-00 servicePackageConditionGroupShortName: type: string description: Identifies a given short name for a specific Shipment Condition group within a given business group. The members of Shipment Condition groups may be different between different business groups even though the group name may be the same. This identifies the Service Package Condition when the Shipment Condition Group Version has a Group Type Code (SHPMT_COND_GRP_TYP_CD) is set to "M" (M=Matrix). This Group is contains additional shipment conditions that further qualifies or restricts a given service which are not generally considered equipment related conditions. example: R11 DEST MUST WT LIMIT NEW additionalProperties: false priceAuthorityGroups: type: object description: Identifies all of the Groups that may defined for a give Price Authority and may consist of Geographic Groups, Commodity Groups, and Shipment Condition Groups. required: - geographicGroup - commodityGroup - shipmentConditionGroup properties: geographicGroup: type: array description: Identifies a Geographic Group which contains one or more Geographic Elements that qualify a Price Authority. items: type: object required: - geoGroupMembers properties: geoGroupShortName: type: string example: BNSF 5 CHICAGO geoGroupMembers: type: array items: type: string example: County of DUPAGE,IL additionalProperties: false commodityGroup: type: array description: Identifies a Commodity Group which contains one or more Commodity Elements that qualify a Price Authority. items: type: object required: - commodityGroupMembers properties: commodityGroupShortName: type: string commodityGroupMembers: type: array items: type: string example: 2499700-2499799 additionalProperties: false shipmentConditionGroup: type: array description: Identifies a Shipment Condition Group which contains one or more Shipment Condition Elements that qualify a Price Authority. items: type: object required: - shipmentConditionGroupDescription - shipmentConditionGroupPublishedText properties: shipmentConditionGroupShortName: type: string example: EQ-FLAT,CB <74' SYS <205K shipmentConditionGroupDescription: type: string example: System Flats <=74ft, <=205,000lbs shipmentConditionGroupPublishedText: type: string example: 'Price applies in System Centerbeam Flat Cars (Mechanical Designation: FBC - Centerbeam Flat Car), with inside length less than or equal to 74 feet with a minimum weight exceeding 1 pounds but not exceeding 205,000 pounds and System cars are owned or leased by the following class 1 carriers: BNSF, CN, UP, CP, CSXT, NS or KCS.' additionalProperties: false additionalProperties: false additionalProperties: false customerInvoice: type: object title: Customer Invoice required: - customerInvoiceDetails properties: customerInvoiceDetails: type: object title: Customer Invoice Details properties: billDueAmount: type: string title: Bill Due Amount description: The amount due in US dollars after adjustments and payments have been applied to total bill amount. example: $1999.99 invoiceNumber: type: string title: Invoice Number description: Number that uniquely identifies a bill, regardless of the type of bill. example: 12345ABD invoiceTypeName: type: string title: Invoice Type Name description: 'The designation of the invoice type. Valid values include: Freight.' example: Freight billDueDate: type: string title: Bill Due Date description: Date a bill is due for payment. example: '2023-01-10' billOfLadingId: type: string title: Bill Of Lading Id description: Unique identifier for an instance of an internal or external customer request for the shipment of lading via rail. example: 100200AB waybillDate: type: string title: Waybill Date description: Waybill Date is the day, month, and year specified on a waybill, expressed as CCYYMMDD where CC represents the first two digits of the calendar year. Can not be in the future. example: '2023-01-10' invoiceDate: type: string title: Invoice Date description: Date an invoice was created. example: '2023-01-10' waybillNumber: type: string title: Waybill Number description: Waybill Number is the carrier accounting number of a waybill. example: '989999' freightRateAuthoritySourceName: type: string title: Freight Rate Authority Source Name description: The source from which the rate authority for freight charges to customers is defined. example: TARIFF_ITEM billAdjustedAmount: type: string title: Bill Adjusted Amount description: The amount to be added or subtracted from the bill amount. example: $323.99 billPreviouslyDisputedIndicator: type: string title: Bill Previously Disputed Indicator description: 'Indicates whether the bill has been previously disputed or not. Valid values: Y (The bill has been previously disputed), N (The bill has not been previously disputed)' example: Y invoiceRecipientCompanyCode: type: string title: Invoice Recipient Company Code description: 'Code indicating the subsidiary company or other outside company that is the recipient of the invoice amount. Valid values include: 01 (The Atchison, Topeka and Santa Fe Railway Company), 02 (The Clinton and Oklahoma Western Railroad Company), 18 (The Star Lake Railroad Company).' example: '01' businessUnitCode: type: string title: Business Unit Code description: 'Code that identifies the high level business unit a shipment is associated with. Valid values include: 01 (Intermodal), 03 (Automotive and Steel), 04 (Bulk Commodities), 05 (Consumer Products), 06 (Forest Products), 07 (Grain Products), etc.' example: '01' patronCode: type: string title: Patron Code description: An approved patron code represents a customer who ships (or wants to ship) with BNSF and has established a credit arrangement with the BNSF treasury department. example: ABCD12 cashBookCode: type: string title: Cash Book Code description: 'Code assigned by accounting indicating the type of charges for bookkeeping purposes. Valid values include: 201=Rental Bills, 202=Miscellaneous Railroad Bills, 211=Car Repair Bills, 215 =Rolling Stock, 220=Crossing Maintenance Bills, etc.' example: '201' cashBookGroupCode: type: string title: Cash Book Group Code description: 'Code assigned by accounting indicating the grouping of charges for bookkeeping purposes. Valid values include: DEM (Demurrage), FIN (Finance).' example: DEM payerOfFreight633: type: string title: Payer of Freight 633 description: Name of the person or entity with responsibility for paying charges associated with the shipment. Value has been abbreviated from the Customer's full Legal Name through the use of a standardized programmatic process. example: ACMECUST payerOfFreightFullName: type: string title: Payer of Freight Full Name description: Full name of the person or entity with responsibility for paying charges associated with the shipment. example: ACME Customer payerOfFreightAddressText: type: string title: Payer of Freight Address Text description: The full address of the person or entity with responsibility for paying charges associated with the shipment. example: 345 Dream St. Fort Worth 76137 US careOfPartyFullName: type: string title: Care of Party Full Name description: The full name of a receiver of rail cars on behalf of the actual consignee (the physical delivery point). example: Care of Party Customer attentionPartyFullName: type: string title: Attention Party Full Name description: The name of the person or entity to whose attention information of a waybill will be sent. example: Attention Customer cifId: type: string title: CIF Id description: CIF ID (Customer Identification File) is a unique identifier used in exchanges of shipment information to accurately identify a transportation company customers and their locations. example: '656999' shipper633: type: string title: Shipper 633 description: Name of a Customer, acting as the Shipper, which has been abbreviated from the Customer's full Legal Name through the use of a standardized programmatic process. example: ACMECUST shipperFullName: type: string title: Shipper Full Name description: Full name of a Customer, acting as the Shipper. example: ACME Customer origin333: type: string title: Origin 333 description: Name of a City, defined as the origin of a shipment, which has been abbreviated from the City's Full Name through the use of a standardized programmatic process. example: TRNTOWN originStateCode: type: string title: Origin State Code description: The code, as assigned by a national body such as the US Postal Service, for a state, province, or territory for a given origin. example: TX consignee633: type: string title: Consignee 633 description: Name of a Customer, acting as the Consignee (AKA Receiver), which has been abbreviated from the Customer's full Legal Name through the use of a standardized programmatic process. example: CNSGNEE consigneeFullName: type: string title: Consignee Full Name description: The full name of a customer that is filling the role of Consignee. A Consignee, also referred to as the "Receiver", is the company or individual receiving a shipment at a destination. example: Consignee destination333: type: string title: Destination 333 description: Name of a City, defined as the destination of a shipment, which has been abbreviated from the City's Full Name through the use of a standardized programmatic process. example: TRNVILL destinationStateCode: type: string title: Destination State Code description: The code, as assigned by a national body such as the US Postal Service, for a state, province, or territory for a given destination. example: MT currencyCode: type: string title: Currency Code description: 'Code to designate a currency based on the ISO 4217 standard. Valid values include: USD, MXN, CAD, etc.' example: CAD intermodalServicePlanCode: type: string title: Intermodal Service Plan Code description: 'Code that defines the service plan associated with intermodal shipments. Valid values include: 25 (Ramp to Ramp service, Domestic, Rail owned equipment), 80 (Door to Door service, International, Steamship Owned equipment), etc.' example: '25' intermodalServiceLevelCode: type: string title: Intermodal Service Level Code description: 'A code representation of the level of service BNSF provides/offers, which indicates intermodal transportation service (transit time) on BNSF''s network. Service levels are reflected in the intermodal price authorities and service schedules. Valid values are: E (Expedited), P (Premium), V (Value), Y (Empty).' example: E freightUnitRateList: type: array title: Freight Unit Rate List items: type: object properties: freightPerUnitRate: type: string title: Freight Per Unit Rate description: The amount in dollars per unit of freight. example: $999.50 freightUnitCount: type: string title: Freight Unit Count description: The number of freight units. example: '5' additionalProperties: false miscellaneousChargeList: type: array title: Miscellaneous Charge List items: type: object properties: miscellaneousChargeAmount: type: string title: Miscellaneous Charge Amount description: Amount in dollars for miscellaneous charges. example: $1999.99 miscellaneousChargeTypeCode: type: string title: Miscellaneous Charge Type Code description: 'Code to indicate the type of miscellaneous charges. Valid values include: CCA (Carrier Credit Allowance), TRN (Transit), SWC (Switching Charges), etc.' example: CCA additionalProperties: false customerWaybillReferenceNumberList: type: array title: Customer Waybill Reference Number List items: type: object properties: waybillReferenceNumberTypeCode: type: string title: Waybill Reference Number Type Code description: A code defining the type of reference number or identifier associated with a Waybill. example: WBREFNBR waybillReferenceNumberTypeName: type: string title: Waybill Reference Number Type Name description: A short, free-form description of a code defining the type of reference number or identifier associated with a Waybill. example: Waybill Customer Reference waybillReferenceNumber: type: string title: Waybill Reference Number description: A reference number or identifier associated with a Waybill. example: '123456' additionalProperties: false paymentList: type: array title: Payment List items: type: object properties: customerInvoicePaymentNumber: type: string title: Customer Invoice Payment Number description: Number identifying a payment made by a customer against an invoice. The payment can be made with a check, previous credits or other means. example: '1002501' customerInvoicePaymentDate: type: string title: Customer Invoice Payment Date description: Date payment was made by a customer against an invoice. example: '2023-01-18' customerInvoicePaymentAmount: type: string title: Customer Invoice Payment Amount description: Amount of payment issued by a customer against an invoice. example: $1999.99 additionalProperties: false equipmentList: type: array title: Equipment List items: type: object properties: accountingWaybillEquipmentGroupId: type: string title: Accounting Waybill Equipment Group Id description: Identifier used to group one or more freight rating result entries together for association to the accounting waybill equipment for which they apply. example: '0' equipmentInitial: type: string title: Equipment Initial description: Equipment Initial is the prefix or alphabetic part of an equipment units identifying number. example: ABCD equipmentNumber: type: string title: Equipment Number description: Equipment Number is the sequencing or serial part of an equipment units identifying number. example: '123456' commodityDescription: type: string title: Commodity Description description: Description of the commodity. example: PLASTC stcc: type: string title: STCC description: STCC (Standard Transportation Commodity Code) number identifying a Commodity. example: '2821142' carKindCode: type: string title: Car Kind Code description: Code that identifies the physical characteristics for equipment as defined by BNSF Railway itself. example: A7E aarCarKindCode: type: string title: AAR Car Kind Code description: Code that identifies the physical characteristics for equipment as defined by AAR (Association of American Railroads) example: Z130 shipmentNetScaleWeightPounds: type: string title: Shipment Net Scale Weight Pounds description: The net scale weight of a shipment, as measured in pounds. example: '100' freightRateMinimumWeightPounds: type: string title: Freight Rate Minimum Weight Pounds description: The minimum weight in pounds of a piece of equipment and cargo that make possible a freight rate to take effect. example: '2000' equipmentLengthFeet: type: string title: Equipment Length Feet description: The length, in feet, of a piece of rail equipment. example: '23' equipmentOutsideHeightFeet: type: string title: Equipment Outside Height Feet description: The height, in feet, of the outside of a piece of equipment. example: '20' equipmentVolumeCubicFeet: type: string title: Equipment Volume Cubic Feet description: Volume capacity of a piece of equipment in cubic feet. example: '7300' billOfLadingId: type: string title: Bill Of Lading Id description: Unique identifier for an instance of an internal or external customer request for the shipment of lading via rail. example: 100200AB aarRule260CarrierAbbreviation: type: string title: AAR Rule 260 Carrier Abbreviation description: Abbreviation of the carrier that is to assume responsibility for the movement of a shipment at the junction location per the AAR Rule 260. example: AERC cotId: type: string title: COT Id description: Identifier assigned by the marketing department that guarantees future placement of equipment for a specific period and locks in a rate for the customer that is awarded the Certificate of Transportation (COT). example: COT123456 cotCreditAmount: type: string title: COT Credit Amount description: Certificate of Transportation (COT) credit amount in dollars applied to a movement waybill. example: $1999.99 cotPremiumAmount: type: string title: COT Premium Amount description: Certificate of Transportation (COT) premium amount in dollars applied to a movement waybill. example: $1999.99 cotDiscountAmount: type: string title: COT Discount Amount description: Certificate of Transportation (COT) discount in dollars applied to a movement waybill. example: $1999.99 cotEffectiveRateDate: type: string title: COT Effective Rate Date description: Date the Certificate of Transportation (COT) rate becomes effective. example: '2023-01-10' additionalProperties: false vinList: type: array title: VIN List description: Comma separated list of VIN (Vehicle Identification Numbers). items: type: string example: 4Y1SL65848Z411439, 1HGBH41JXMN109186, 1FTFX1E57JKE37092 totalGrossEquipmentCommodityWeightPounds: type: string title: Equipment Gross Scale Weight Pounds description: Total weight of equipment and commodity in pounds. example: '200' totalCommodityWeightPounds: type: string title: Shipment Net Scale Weight Pounds description: The total weight in pounds of the commodity. example: '100' totalEquipmentTarePounds: type: string title: Equipment Tare Pounds description: The total weight in pounds of all empty equipment. example: '500' totalCotCreditAmount: type: string title: Total COT Credit Amount description: Certificate of Transportation (COT) total credit amount in dollars applied to a movement waybill. example: $1999.99 totalInvoiceAmount: type: string title: Total Invoice Amount description: Total amount of the invoice in dollars. example: $1999.99 totalBillDueAmount: type: string title: Total Bill Due Amount description: The total amount due in US dollars after adjustments and payments have been applied to total bill amount. example: $1999.99 totalInvoicePaymentAmount: type: string title: Total Invoice Payment Amount description: The total payment amount issued by a customer against an invoice. example: $1999.99 additionalProperties: false apiResponseElementCount: type: string title: API Response Element Count description: Number of individual elements within the API response. example: '5' apiResponsePageNumber: type: string title: API Response Page Number description: Current page number within the API response. example: '2' apiResponseElementPerPageCount: type: string title: API Response Element Per Page Count description: Number of individual elements per page within the API response. example: '8' apiResponseTotalCurrentInvoiceAmount: type: string title: API Response Total Current Invoice Amount description: Total amount of the current invoices within the API response which bill due date is later or equal to the current date. example: $1000.18 apiResponseTotalPastInvoiceAmount: type: string title: API Response Total Past Invoice Amount description: Total amount of the past invoices within the API response which bill due date is before the current date. example: $18999.00 apiResponseTotalInvoiceAmount: type: string title: API Response Total Invoice Amount description: Total amount of the invoices included in the API response. example: $19999.18 additionalProperties: false prices_response: type: object title: Prices Response properties: status: type: string title: Status description: Response status of the API example: SUCCESS message: type: object title: Message properties: errors: type: array title: Errors items: type: string results: $ref: '#/components/schemas/Price_Authority' additionalProperties: false httpStatus: type: string title: Http Status description: Response status code of the API example: '200' additionalProperties: false tripPlan: type: object title: Event Code properties: jobStatus: type: integer format: int32 title: jobStatus minimum: 1 maximum: 4 example: '4' jobStatusDescription: type: string title: jobStatusDescription description: '* 1: Job in queue * 2: Job is running * 3: The job has data available * 4: The job is complete' example: Job is complete resultSet: type: array title: resultSet items: type: object required: - equipmentLoadEmptyStatusCode - eventCode - eventDescription - eventStatusCode properties: equipmentLoadEmptyStatusCode: type: string title: Equipment Status Code description: L or E, this code describes whether the equipment is loaded or empty. example: L eventCode: type: string title: Event Code description: ' Event Code indicates the event/activity abbreviation.' example: AD eventDescription: type: string title: Event Description description: Description for an Event Code used to define an event or activity occurring on the rail network. example: Add Car eventStatusCode: type: string title: Event Location Name description: 'Event Status Code used with event code representing equipment activity. ' example: AD rowCount: type: integer format: int32 title: rowCount example: '1' stcc: type: array title: stcc items: type: object required: - stcc - commodityDescription - commodityDescriptionAbbreviation properties: stcc: type: string title: stcc description: STCC (Standard Transportation Commodity Code) number identifying a Commodity. example: '0113710' commodityDescription: type: string title: commodityDescription description: The description of the commodity. example: WHEAT commodityDescriptionAbbreviation: type: string title: commodityDescriptionAbbreviation description: A short description of the commodity. example: WHEAT station: type: array title: Station items: type: object required: - scac - fsac - splc - railincRegisteredStationIndicator - stationName - station333 - stationStateCode - railincStation333 - r260JunctionCode - stationSixCharacterAbbreviation - stationThreeCharacterAbbreviation - stationTwoCharacterAbbreviation - stationTimeZoneCode - crewTimeReportingTimeZoneCode - stationTssTimeZoneCode - stationObservesDaylightSavingTimeIndicator - opslStationNumber - opslStationSubNumber - opslStationName - stationLatitude - stationLongitude - systemBlockNumber - stationCarhireReloadAbbreviation - stationCustomsInspectionRequiredIndicator - grainInspectionRequiredIndicator - stationAutomotiveRampTypeCode - stationTssRampTypeCode - stationMaximumGrossWeightPounds - stationOperatingPlateCode - stationLocomotiveFuelingTypeCode - stationImportExportTypeCode - stationTrainClassificationServiceLevelCode - fipsCountyCode - usbeaRegionCode - usbeaCountyName - stationReportingScac - payrollTripTicketPrefixCode - updateDatetime - componentEconomicAreaCode - stationScacInternationalCarrierIndicator - stationOnsiteScaleIndicator - stationOnsiteCleaningFacilitiesIndicator - stationTrafficTypeCode - stationMechanicalRegionCode - stationMechanicalZoneName - stationEmbargoIndicator properties: scac: type: string title: SCAC description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: BNSF fsac: type: string title: FSAC description: FSAC (Freight Station Accounting Code) is a number assigned to a station that uniquely identifies the station within the context of each reporting railroad (i.e., Different railroads might share identical FSAC numbers). example: '1234' splc: type: string title: SPLC description: SPLC (Standard Point Location Code) is a six-to-nine digit geographic code used by North American transportation industries, which serves as the official code assigned to a city or point (for rate making purposes) within a city. example: '1234' railincRegisteredStationIndicator: type: string title: Railinc Registered Station Indicator description: Indicates is the associated Station is registered with Railinc. example: Y stationName: type: string title: Station Name description: Name of a station. This may or may not be the fully spelled name of the station but it is NOT the standard 333 abbreviated name. example: PARKWATER station333: type: string title: Station 333 description: Name of a City, where a Station is located, which has been abbreviated from the City's Full Name through the use of a standardized programmatic algorithm. example: PRKWTR stationStateCode: type: string title: Station State Code description: Station State Code is a code value, as defined by the appropriate government agency of the United States, Canada, or Mexico, specifying the state or province of a station. example: WA railincStation333: type: string title: Railinc Station 333 description: 333 Abbreviated name for the city where a station is located as defined by Railinc and not by BNSF. See also Station 333. example: PARKWTR r260JunctionCode: type: string title: R260 Junction Code description: R260 Junction Code is a code value (as specified by AAR Accounting Rule 260) which specifies a junction where two rail carriers interchange shipments. example: PRKWT stationSixCharacterAbbreviation: type: string title: Station Six Character Abbreviation description: Six character abbreviation for a BNSF, MRL (Montana Rail Line), or LAJ (Los Angeles Junction Railway) Station. Internal value assigned at BNSF. example: PRKWAT stationThreeCharacterAbbreviation: type: string title: Station Three Character Abbreviation description: Three character abbreviation for a BNSF, MRL (Montana Rail Line), or LAJ (Los Angeles Junction Railway) Station. Internal value assigned at BNSF. example: PAT stationTwoCharacterAbbreviation: type: string title: Station Two Character Abbreviation description: Two character abbreviation for a BNSF, MRL (Montana Rail Line), or LAJ (Los Angeles Junction Railway) Station. Internal value assigned at BNSF. example: PA stationTimeZoneCode: type: string title: Station Time Zone Code description: Code that defines the time zone where a station is physically located. example: C crewTimeReportingTimeZoneCode: type: string title: Crew Time Reporting Time Zone Code description: Code that defines the time zone where the crew reports time when working at a given station. This value may or may not be the same as the time zone of the station itself. example: C stationTssTimeZoneCode: type: string title: Station TSS Time Zone Code description: Code that defines the time zone for a station as recorded within BNSF's TSS (Transportation Support System) application. example: C stationObservesDaylightSavingTimeIndicator: type: string title: Station Observes Daylight Saving Time Indicator description: Indicates whether or not the station observed Daylight Savings Time. example: Y opslStationNumber: type: string title: OPSL Station Number description: The OPSL (Open and Prepay Station List) number assigned to a Railroad Station. Value is generated and maintained by the Business Services Division of Railinc. example: '3165' opslStationSubNumber: type: string title: OPSL Station Sub Number description: Sub-number assigned to further define the Station as recorded within the OPSL (Open and Prepay Station List). This list is maintained at the Industry level for all Registered Stations. example: '00' opslStationName: type: string title: OPSL Station Name description: Name of the Station as recorded on the OPSL (Open and Prepay Station List) from which the Station information was recorded. example: PARKWATER stationLatitude: type: number format: float title: Station Latitude description: The latitude, distance north or south of the equator as measured in degrees, where the Station is physically located. example: '39.762026' stationLongitude: type: number format: float title: Station Longitude description: The latitude, distance east or west of the prime meridian as measured in degrees, where the Station is physically located. example: '-104.995627' systemBlockNumber: type: string title: System Block Number description: System block identifying the general geographic area of the railroad assigned by the systems operations center. System block is defined as a group of stations. example: '14210' stationCarhireReloadAbbreviation: type: string title: Station Carhire Reload Abbreviation description: Abbreviation referring to 'Carhire Reload Station' as defined by Railinc. This abbreviation is a 5 positions alpha value. example: IRVIN stationCustomsInspectionRequiredIndicator: type: string title: Station Customs Inspection Required Indicator description: 'Indicates whether or not U.S. Customs is required to perform an inspection of cars and intermodal equipment for customs clearance at the associated station. ' example: N grainInspectionRequiredIndicator: type: string title: Grain Inspection Required Indicator description: Indicates whether or not a recognized grain inspection authority is required to perform an inspection of grain. example: N stationAutomotiveRampTypeCode: type: string title: Station Automotive Ramp Type Code description: Code that defines the type of Automotive Ramp located at the associated Station. example: F stationTssRampTypeCode: type: string title: Station TSS Ramp Type Code description: Code that defines the type of Ramp, as recorded within TSS (Transportation Support System), located at the associated Station. example: C stationMaximumGrossWeightPounds: type: number format: float title: Station Maximum Gross Weight Pounds description: The maximum gross weight, measured in pounds, that can be handled on rail at this station location. example: '263000' stationOperatingPlateCode: type: string title: Station Operating Plate Code description: 'The maximum Plate Size (car dimensions) that can be handled at this location. ' example: C stationLocomotiveFuelingTypeCode: type: string title: Station Locomotive Fueling Type Code description: Code that defines the types of fueling available at this station for a locomotive. example: F stationImportExportTypeCode: type: string title: Station Import Export Type Code description: Code that defines the type of imports and/or exports that are handled at the associated station. example: E stationTrainClassificationServiceLevelCode: type: string title: Station Train Classification Service Level Code description: Code indicating the station's class/service level for train service. example: '3' fipsCountyCode: type: string title: FIPS County Code description: Federal Information Processing Standard (FIPS) code for the County of the location as determined by the Bureau of Economic Analysis of the U.S. Department of Commerce. example: '53063' usbeaRegionCode: type: string title: USBEA Region Code description: Bureau of Economic Analysis assigned code defining geographic regional economic areas. example: B usbeaCountyName: type: string title: USBEA County Name description: Bureau of Economic Analysis Name value which corresponds to the FIPS County code. example: SPOKANE, WA legacyStationId: type: string title: Legacy Station ID description: Internal Station Randomly Generated Key field used in the Legacy Mainframe. Not needed in the new Station Hub. example: '302227791' stationReportingScac: type: string title: Station Reporting SCAC description: The SCAC (Standard Carrier Alpha Code) of the carrier that reported/registered this Station at Railinc. example: BNSF payrollTripTicketPrefixCode: type: string title: Payroll Trip Ticket Prefix Code description: Code indicating the prefix for a payroll trip ticket. A payroll trip ticket is when the trip ticket has been approved for payment. example: KS updateDatetime: type: string title: Update DateTime description: The UTC* Date and Time** when a business process persists (saves) modification of business data. example: 2/1/2020 11:56:45 AM componentEconomicAreaCode: type: string title: Component Economic Area Code description: Component Economic Area Code in which the county specified in the FIPS County Code belongs. example: '7840' stationScacInternationalCarrierIndicator: type: string title: Station SCAC International Carrier Indicator description: Indicates whether or not the Station's SCAC is an international carrier. example: N stationOnsiteScaleIndicator: type: string title: Station Onsite Scale Indicator description: Indicates whether or not this station has a scale onsite. example: Y stationOnsiteCleaningFacilitiesIndicator: type: string title: Station Onsite Cleaning Facilities Indicator description: Indicates whether or not this station has cleaning facilities onsite. example: N stationTrafficTypeCode: type: string title: Station Traffic Type Code description: Code that defines the type of traffic that can be handled at this Station. example: P stationMechanicalRegionCode: type: string title: Station Mechanical Region Code description: 'The mechanical region, within the BNSF network, where the associated station is located. Note: These may differ than the Business/Marketing Regions.' example: '2' stationMechanicalZoneName: type: string title: Station Mechanical Region Code description: The mechanical zone, with a mechanical region, where the associated station is located. example: '2' stationComment: type: string title: Station Comment description: Any comment found related to a Station. example: Sending to Railinc as a new Add stationEmbargoIndicator: type: string title: Station Embargo Indicator description: Indicates whether or not this station has any Embargos applied to it. example: N umler: type: array title: UMLER items: type: object required: - equipmentInitial - equipmentNumber properties: equipmentInitial: type: string title: Equipment Initial description: Equipment Initial is the prefix or alphabetic part of an equipment units identifying number. example: BNSF equipmentNumber: type: string title: Equipment Number description: Equipment Number is the sequencing or serial part of an equipment units identifying number. example: '12345' equipmentGroupCode: type: string title: Equipment Group Code description: Code that defines the logical grouping of equipment into major car types. example: CHSS (Chassis) equipmentDraftGearTypeCode: type: string title: Equipment Draft Gear Type Code description: 'A code that defines the type of equipment that connects the couplings to the rolling stock, known as the draft gear or draw gear. Railinc Element ID B073. Umler Element EQMVCPDS' example: C grossRailWeightPounds: type: number format: float title: Gross Rail Weight Pounds description: The maximum permissible weight on rail of the equipment and the load, reported in pounds. example: 287400 shipmentLoadLimitPounds: type: number format: float title: Shipment Load Limit Pounds description: The number of pounds a shipment is allowed to weigh, the load limit, in order to allow it to be safely moved over rail. example: '144900' equipmentTareWeightPounds: type: number format: float title: Equipment Tare Weight Pounds description: Equipment Tare Weight is the weight of an empty rail shipping container or vehicle measured in pounds. Sometimes called the unladen weight. example: 142500 equipmentExternalLengthInches: type: number format: float title: Equipment External Length Inches description: The external length, measured in inches, of a piece of equipment. example: 1020 equipmentTruckSideBearingTypeCode: type: string title: Equipment Truck Side Bearing Type Code description: "Code that defines the type of constant contact bearing located on the equipment's truck side. These bearings are used to stabilize equipment on curves and in high-speed service. \nRailinc Element ID A146" example: LC (Long Travel Constant Contact) equipmentSpeedRestrictionLoadEmptyStatusCode: type: string title: Equipment Speed Restriction Load Empty Status Code description: Code that defines that a speed restriction related to the loaded or empty status applies to a piece of BNSF equipment. example: L (Loaded) equipmentSpeedRestrictionCode: type: string title: Equipment Speed Restriction Code description: Code that defines a speed restriction, in MPH (miles per hour), that applies to rail or rail equipment. example: 15 (15 MPH) specialConditionHandlingInstructionsCodeOne: type: string title: Special Condition Handling Instructions Code One example: RE specialConditionHandlingInstructionsCodeTwo: type: string title: Special Condition Handling Instructions Code Two description: The second set of instructions, conditions, or handling requirements for a shipment that help ensure that trains are built properly, safe movement occurs, shipments are held (e.g., clearance, customs, etc.), and awareness can be brought to any special handling needs. example: DK specialConditionHandlingInstructionsCodeThree: type: string title: Special Condition Handling Instructions Code Three description: The third set of instructions, conditions, or handling requirements for a shipment that help ensure that trains are built properly, safe movement occurs, shipments are held (e.g., clearance, customs, etc.), and awareness can be brought to any special handling needs. example: HV specialConditionHandlingInstructionsCodeFour: type: string title: Special Condition Handling Instructions Code Four description: The fourth set of instructions, conditions, or handling requirements for a shipment that help ensure that trains are built properly, safe movement occurs, shipments are held (e.g., clearance, customs, etc.), and awareness can be brought to any special handling needs. example: DH bnsfCarKindName: type: string title: BNSF Car Kind Name description: Name given to physical characteristics for equipment as defined by BNSF Railway itself. Value is used when car characteristics are required for business decision making. example: UU2 bnsfPoolId: type: string title: BNSF Pool ID description: A four-digit code used by BNSF for a pool of cars assigned to a specific loading location. example: '0000' bnsfPoolAlphabeticCode: type: string title: BNSF Pool Alphabetic Code description: An alphabetic code assigned to categorize a Pool of cars as assigned by BNSF. example: PSGR equipmentAxleCount: type: number format: float title: Equipment Axle Count description: The total number of axles attached to a piece of equipment. example: 4 articulatedUnitAirBrakeControlValveCount: type: number format: float title: Articulated Unit Air Brake Control Valve Count description: 'The total number of operating air brake valves, excluding hand breaks, found on an articulated unit. Railinc Element ID A182.' example: 1 hazardousCommodities: type: array title: Hazardous Commodities items: type: object title: Hazardous Commodity required: - stcc - commodityRegulatoryAuthorityCode - hazardousCommodityProperShippingNameSequenceNumber properties: stcc: type: string title: STCC description: STCC (Standard Transportation Commodity Code) number identifying a Commodity. example: '4809195' commodityRegulatoryAuthorityCode: type: string title: Commodity Regulatory Authority Code description: Code that defines the authority body(s) defining the regulatory requirements for a commodity. example: N hazardousCommodityProperShippingNameSequenceNumber: type: string title: Hazardous Commodity Proper Shipping Name Sequence Number description: The order to be applied to the Proper Shipping Name(s) for a hazardous commodity. example: '1' unnaNumber: type: string title: UNNA Number description: A number assigned to identify or classify a hazardous commodity/material as assigned by the UN (United Nations) or NA (North American/US DOT), required in commerce and transportation. example: UN1952 hazardousCommodityClassificationCode: type: string title: Hazardous Commodity Classification Code description: Code indicating the classification applied to a hazardous commodity. May include Canadian, United States, and international codes depending on the data storage file and the type of shipments. example: '2.2' hazardousCommoditySecondaryClassificationCode: type: string title: Hazardous Commodity Secondary Classification Code description: Code indicating the secondary classification applied to a hazardous commodity. May include Canadian, United States, and international codes depending on the data storage file and the type of shipments. example: '7' canadianHazardousCommoditySubsidiaryClassification1: type: string title: Canadian Hazardous Commodity Subsidiary Classification 1 description: The first, primary, Canadian Hazardous Commodity Subsidiary Classification associated with a given material being shipped. example: '5.1' canadianHazardousCommoditySubsidiaryClassification2: type: string title: Canadian Hazardous Commodity Subsidiary Classification 2 description: The second, secondary, Canadian Hazardous Commodity Subsidiary Classification associated with a given material being shipped. example: '8' canadianHazardousCommoditySubsidiaryClassification3: type: string title: Canadian Hazardous Commodity Subsidiary Classification 3 description: The third possible Canadian Hazardous Commodity Subsidiary Classification associated with a given material being shipped. example: '8' commodityPackagingGroupCode1: type: string title: Commodity Packaging Group Code 1 description: Code which designates the first of up to three, Canadian or International, Packaging Groups assigned to a commodity. example: A commodityPackagingGroupCode2: type: string title: Commodity Packaging Group Code 2 description: Code which designates the second of up to three, Canadian or International, Packaging Groups assigned to a commodity. example: '1' commodityPackagingGroupCode3: type: string title: Commodity Packaging Group Code 3 description: Code which designates the third of up to three, Canadian or International, Packaging Groups assigned to a commodity. example: '2' hazardousCommodityProperShippingName: type: string title: Hazardous Commodity Proper Shipping Name description: The full Proper Shipping Name assigned to a Hazardous Commodities as required by US, Canadian, and International Regulations. example: WASTE ETHYLENE OXIDE AND CARBON DIOXIDE MIXTURES hazardousCommodityProperShippingAugmentationRequiredIndicator: type: string title: Hazardous Commodity Proper Shipping Augmentation Required Indicator description: Indicates if Hazardous Commodity Proper Shipping Name(s) should be augmented with a Technical Name. example: Y hazardousSubstanceComponentDescription: type: string title: Hazardous Substance Component Description description: Description of an element, or compound, associated with a hazardous substance. example: NICKLE POWDER hazardousCommodityToxicityTypeCode: type: string title: Hazardous Commodity Toxicity Type Code description: Code that defines the specific toxicity related statement required to be attached to the shipping papers when transporting a hazardous commodity. example: P primaryHazardousPlacardCode: type: string title: Primary Hazardous Placard Code description: The primary code, as defined by the US DOT or Canada, to be assigned to the hazardous placard when transporting/shipping hazardous materials. example: FL secondaryHazardousPlacardCode: type: string title: Secondary Hazardous Placard Code description: The secondary code, as defined by the US DOT or Canada, to be assigned to the hazardous placard when transporting/shipping hazardous materials. example: CP canadianSpecialCommodityStatementCode: type: string title: Canadian Special Commodity Statement Code description: Code that defines, per Canadian Regulations, what statement related to a special commodity are required to be included on the shipping papers. example: A canadianEmergencyResponsePlanRequiredCode: type: string title: Canadian Emergency Response Plan Required Code description: Code that defines what, if any, Emergency Response Assistance Plan (ERAP) reference number and telephone number are required to appear on the shipping paper. example: E hazardousCommodityUsdotInhalationHazardZoneCode: type: string title: Hazardous Commodity USDOT Inhalation Hazard Zone Code description: Code, assigned by the US DOT, that specifies any hazardous zone information that is required to be part of the shipping papers when transporting hazardous commodities that are considered to be poisonous by inhalation. example: B combustibleHazardousCommodityIndicator: type: string title: Combustible Hazardous Commodity Indicator description: Code that defines if the associated commodity is considered to be combustible (Class 3 Commodities include items that are made of natural fibers including paper products or products made of wood). example: C marinePollutantComponentDescription: type: string title: Marine Pollutant Component Description description: Description of the component in a hazardous material shipment that makes it a marine pollutant. example: TETRAETHYL LEAD CARBON TETRACHLORIDE intermodal_schedules: type: object title: Intermodal Schedules properties: additionalDescription: type: string title: additionalDescription description: Customer specific information. example: None additionalDetails: type: string title: additionalDetails description: Customer specific information. example: None businessTypeName: type: string title: Business Type description: Service schedules for business types. I=International; D=Domestic; or B= International and Domestic example: Domestic destinationAvailabilityDayOfWeekName: type: string title: Destination Availability Day Of Week description: Destination availability day of week example: Friday destinationAvailabilityTime: type: string title: Destination Availability Time description: Desitnation availability time example: 04:00 destinationStationName: type: string title: Destination Facility description: Destination station/facility example: CHICAGO destinationStateCode: type: string title: Destination State description: Destination state example: IL equipmentTypeName: type: string title: Equipment Type description: Equipment type. K=Container; V=Trailer example: Container bnsfTransitGoalHourCount: type: string title: Goal Hours description: Goal hours, number of hours from cutoff to availability example: '24' interchangeDeliveredSCAC: type: string title: Interchange Delivered Carrier description: Interchange delivered carrier (to) example: UPRR interchangeReceivedSCAC: type: string title: Interchange Received Carrier description: Interchange received carrier (from) example: NS originCutoffDayOfWeekName: type: string title: Origin Cutoff Day Of Week description: Origin cutoff day of week example: Monday originCutoffTime: type: string title: Origin Cutoff Time description: Origin cutoff time example: 600 originStationName: type: string title: Origin Facility description: Origin station/facility example: ALBUQUERQUE originStateCode: type: string title: Origin State description: Origin State example: NM shipmentServiceLevelName: type: string title: Service Level description: Service level billed for shipment. E=Expedited; P = Premium; Y = Empty example: Expedited updateTimestamp: type: string title: updateTimestamp description: Timestamp when the schedule was updated. example: 09/03/2019 09:34 additionalProperties: true Waybill_Details: type: object properties: customerWaybillDetails: type: object required: - equipmentInitial - equipmentNumber properties: equipmentInitial: type: string description: Equipment Initial is the prefix or alphabetic part of an equipment units identifying number. example: AOKX equipmentNumber: type: string description: Equipment Number is the sequencing or serial part of an equipment units identifying number. example: '79005' loadEmptyCode: type: string description: 'Code which indicates the load status of a piece of equipment. Valid values are: L = Loaded, E = Empty, B = Both' example: E equipmentGrossScaleWeightPounds: type: string description: The gross scale weight of a piece of equipment as measured in pounds. example: '270648' equipmentTareWeightPounds: type: string description: The weight of an empty vehicle or container, as measured in pounds, without cargo. Sometimes referred to as Unladen Weight. example: '10000' shipmentNetScaleWeightPounds: type: string description: The net scale weight of a shipment, as measured in pounds. example: '202348' carKindCode: type: string description: Code that identifies the physical characteristics for equipment as defined by BNSF Railway itself. Value is used when car characteristics are required for business decision making. example: C5G billOfLadingId: type: string description: Is a unique identifier for an instance of an internal or external customer request for the Bill of Lading via rail. example: 017415FD waybillNumber: type: string description: Waybill Number is the carrier accounting number of a waybill. example: '836486' waybillVersionNumber: type: string description: Number added to a specific Waybill to allow for versioning of the Waybill over time. example: '4' shippingManifestId: type: string description: Identifier of a Shipping Manifest which is a list of all goods loaded onto a transport vessel. A manifest usually documents the items, quantity, weight, and the destination information for where the cargo is to go. example: '205481286' waybillDate: type: string description: Waybill Date is the day, month, and year specified on a waybill, expressed as CCYYMMDD where CC represents the first two digits of the calendar year. Can not be in the future. example: 11-12-2000 waybillEdiCode: type: string description: Code which defines if the Waybill has an EDI code. example: TBL waybillStatusCode: type: string description: 'BNSF defined code values to track the operational lifecycle state of a Waybill''s execution from initialization to close. Valid Values Include: A=ACTIVATED, C=CLOSED CYCLE, O=OFFLINE, S=SUSPENDED, V=VOIDED' example: C waybillParties: type: array description: Information on interested or responsible parties associated with a Waybill. items: type: object properties: waybillPartyRoleName: type: string description: Description of the Waybill Party Role Code value which provides the full name associated with the role. example: Consignee waybillPartyFullName: type: string description: Full name of a Party (business or individual) that plays a part within a Waybill. example: Company ABC waybillDetails: type: object description: Details relating to a Waybill. properties: originStationName: type: string description: The fully spelled out name of an origin station. example: VANCOUVER originStateCode: type: string description: The code, as assigned by a national body such as the US Postal Service, for a state, province, or territory for a given origin. example: WA destinationStationName: type: string description: The fully spelled out name of an destination station. example: CHICAGO destinationStateCode: type: string description: The code, as assigned by a national body such as the US Postal Service, for a state, province, or territory for a given destination. example: IL stcc: type: string description: STCC (Standard Transportation Commodity Code) number identifying a Commodity. example: '9999' commodityDescription: type: string description: Text value which describes a Commodity. example: CORN contractFreightRateQuoteNumber: type: string description: Number assigned to identify a quote generated for a Contract Freight Rate. example: '9999' aarRule11Indicator: type: string description: Indicates if AAR (Association of American Railroads) Rule 11 applies to the shipment. This rule identifies the proper billing procedure that must be followed by each party in scenarios in which through waybilling of shipments require more than one carrier to collect. example: Y shipmentUnitCount: type: string description: Number of pieces of equipment that are being moved in a shipment. example: '11' waybillRoutes: type: array items: type: object properties: waybillRouteScac: type: string aarRule260JunctionAbbreviation: type: string description: The AAR Rule 260 junction abbreviation associated with a segment of the route for a Waybill where two rail carriers will exchange shipments. waybillRouteSequenceNumber: type: string description: A value that defines the sequence within a full Waybill route the associated portion of a route pertains. example: '5' waybillDiversions: type: array description: 'Diversions allow a customer to update a waybill to divert a shipment to a different destination or to update the consignee. ' items: type: object properties: consigneeFullName: type: string description: The full name of a customer that is filling the role of Consignee. A Consignee, also referred to as the "Receiver", is the company or individual receiving a shipment at a destination. example: Consignee ABC waybillDiversionAuthorizedByName: type: string description: The full name of the person who authorized the Waybill Diversion. example: John Doe waybillDiversionRequesterPhoneNumber: type: string description: Phone number of the person who requested the Waybill Diversion. example: 999-999-9999 waybillDiversionDate: type: string description: Full calendar date when the Waybill Diversion occurred. example: 11-30-2020 waybillDiversionTime: type: string description: Time when the Waybill Diversion occurred. Formatted as HHMMSS. example: 08:33:52 waybillDiversionComments: type: array description: Any comments related to the diversion(s) made to the original Waybill. items: type: object properties: waybillDiversionComment: type: string description: 'Comments entered related to any diversions made to a Waybill. Diversions allow a customer to update a waybill to divert a shipment to a different destination or to update the consignee. ' example: ABC waybillHazardousCommodities: type: array description: Details about any hazardous commodities/materials being hauled under the associated Waybill. items: type: object properties: unNorthAmericanHazardousCommodityNumber: type: string description: UN (United Nations) or North American Hazardous Commodity Number (BOE 6000). example: UN3257 hazardousCommodityTechnicalName: type: string description: The technical name for a Hazardous Commodity. example: ASPHALT hazardousCommodityProperShippingName: type: string description: The full name of a Proper Shipping name assigned to a Hazardous Commodities as required by US, Canadian, and International Regulations. example: ELEVATED TEMPERATURE LIQUID hazardousSubstanceChemicalComponent: type: string description: The chemical component(s) identified for a given Hazardous Commodity. example: ACETIC ACID hazardousCommodityClassificationCode: type: string description: Code indicating the classification applied to a hazardous commodity. May include Canadian, United States, and international codes depending on the data storage file and the type of shipments. example: '9' canadianHazardousCommoditySubsidiaryClassification1: type: string description: The first, primary, Canadian Hazardous Commodity Subsidiary Classification associated with a given material being shipped. example: '6.1' canadianHazardousCommoditySubsidiaryClassification2: type: string description: The second, secondary, Canadian Hazardous Commodity Subsidiary Classification associated with a given material being shipped. example: '6.4' packagingGroupCode: type: string description: Code which designates the Canadian or International Packaging Group assigned to a shipment. example: ABC stcc: type: string description: STCC (Standard Transportation Commodity Code) number identifying a Commodity. example: '9999' commodityAdditionalDescriptiveInformation: type: string description: Additional descriptive information recorded for a Commodity, tariff, or other relevant data. example: CONTAINS NOT LESS THAN 48% WATER BY WEIGHT hazardousMaterialShipmentWeightPounds: type: string description: The weight, as measured in pounds, of a Hazardous Material shipment. example: '172954' reportableHazardousMaterialQuantityIndicator: type: string description: Indicates if the quantity of a hazardous commodity must be reported to the US or State DOT (Department of Transportation) agency. example: N customerNotificationPhoneNumber: type: string description: Telephone number to be used to notify a Customer of any important information. example: 999-999-9999 waybillHazardousMaterialComment: type: string description: A comment entered about hazardous materials found on a Waybill. example: ABC waybillVessels: type: array description: Information on any sailing vessel(s) associated with freight movement under the associated Waybill. items: type: object properties: sailingDate: type: string description: The date a sailing vessel is to depart (formatted as YYYY-MM-DD). example: '2021-01-31' sailingTime: type: string description: The time a sailing vessel is to depart (formatted as HH:MM). example: '20:00' vesselInboundOutboundCode: type: string description: Code which defines the high level movement of a vessel, inbound or outbound. example: O vesselName: type: string description: 'Name of a sailing vessel as documented in "Lloyd''s Register of Ships". ' example: ABC XYZ vesselVoyageNumber: type: string description: Number associated with a vessel's voyage that identifies the voyage cargo is shipped under. example: 038W vesselTerminalName: type: string description: Name of a terminal, within a given port, a sailing vessel may begin or end a voyage from. example: ABC123 vesselPortName: type: string description: Name of a port, a maritime facility, from which a sailing vessel may begin or end a voyage from. example: LONG BEACH pierName: type: string description: Name of a pier a sailing vessel may begin or end a voyage from example: ABC123 vesselBookingNumber: type: string description: The number, assigned by a carrier, for the reservation of space aboard a shipping vessel. example: '6286500640' vesselBookingDate: type: string description: The date a sailing vessel has been booked, space has been reserved, by a Carrier (formatted as YYYY-MM-DD). example: '2021-01-25' scheduledUnitAvailabilityDate: type: string description: Date a given unit is scheduled to be available (formatted as YYYY-MM-DD). example: '2021-01-25' scheduledUnitAvailabilityTime: type: string description: Time a given unit is scheduled to be available (formatted as HH:SS). example: 08:30 integratedServiceDetails: type: object properties: requestedUnitAvailabilityDate: type: string description: Date a given unit is requested to be made available to the Customer (formatted as YYYY-MM-DD). example: '2021-01-25' requestedUnitAvailabilityTime: type: string description: Time a given unit is requested to be made available to the Customer (formatted as HH:MM). example: '18:15' plannedUnitAvailabilityDate: type: string description: Date a given unit is planned to be made available to the Customer (formatted as YYYY-MM-DD). example: '2021-01-25' plannedUnitAvailabilityTime: type: string description: Time a given unit is planned to be made available to the Customer (formatted as HH:MM). example: '20:20' waybillErrors: type: array items: type: object properties: waybillErrorDescription: type: string description: Full description of an error generated when Waybill information was entered. example: ORIGIN ROAD (BNSF) DOES NOT SERVE ORIGIN (TOLUCA EM). waybillSpecialInstructions: type: array items: type: object properties: waybillSpecialInstructions: type: string description: Any special instructions to be communicated or followed during the execution of a Waybill. example: 'RULE 705: OPTIM TEMP 0 OR LESS DO NOT HEAT IN CANADA' waybillSpecialConditions: type: array items: type: object properties: waybillSpecialConditionCode: type: string description: Code that defines a special condition to be considered during the execution of a Waybill. example: ZZ waybillSpecialConditionName: type: string description: Descriptive name, assigned to a special condition code, that defines a special condition to be considered during the execution of a Waybill. example: Abcde waybillAdditionalUnits: type: array items: type: object properties: equipmentInitial: type: string description: Equipment Initial is the prefix or alphabetic part of an equipment units identifying number. equipmentNumber: type: string description: Equipment Number is the sequencing or serial part of an equipment units identifying number. totalLadingWeightPounds: type: string description: Total chargeable weight (lading weight) for a specific Railcar as measured in pounds. example: '197404' customerWaybillReferenceNumbers: type: array items: type: object properties: waybillReferenceNumberTypeCode: type: string description: A code defining the type of reference number or identifier associated with a Waybill. example: BM waybillReferenceNumberTypeName: type: string description: A short, free-form description of a code defining the type of reference number or identifier associated with a Waybill. example: Bill of Lading waybillReferenceNumber: type: string description: A reference number or identifier associated with a Waybill. example: A1B2C3 billOfLading: type: object properties: billOfLading: type: object properties: billOfLadingEdiQualifierCode: type: string description: 'EDI Shipment Qualifier Code is an EDI-defined qualifier code value specifying the relationship a shipment with respect to other shipments given to the carrier at the same time. Sample Values Include: 1 (Master Bill for Empty Non-Revenue Equipment), 2 (Sea Waybill), E (Empty Equipment Billing (Non-Revenue)), I (Intermodal) **EDI Mapping:** DE147/BX07' example: E billOfLadingEdiWeightMethodTypeCode: type: string description: 'EDI Weight Method Type Code is an EDI-defined code value indicating the method by which freight conveyance equipment weights are obtained for a shipment. Sample Values Include: C (Consignee Scale Weight), E (Estimated Weight), H (Public Scale Weight on Behalf of Shipper), O (Official Weight) **EDI Mapping:** DE460/BNX01 ' example: C billOfLadingEdiWeightUomCode: type: string description: 'EDI Weight Unit of Measure Code is an EDI-defined code value specifying the weight unit of an associated measurement. Sample Values Are: E (Metric Ton), G (Grams), K (Kilograms), L (Pounds), M (Measurement Ton), O (Ounces), S (Short Ton), T (Long Ton) **EDI Mapping:** DE188/BX06 ' example: L billOfLadingEdiMethodOfPaymentCode: type: string description: 'EDI Method of Payment Code is an EDI-defined code value specifying payment terms for transportation charges. Sample Values Include: 11 (Association of American Railroads Accounting Rule 11 Shipment), CC (Collect), MX (Mixed), NC (Service Freight, No Charge), NR (Non Revenue), PP (Prepaid (by Seller)) **EDI Mapping:** DE146/BX03 ' example: PP billOfLadingEdiTransactionSetPurposeCode: type: string description: 'EDI Transaction Set Purpose Code is an EDI-defined code value specifying the purpose of an associated transaction set. Sample Values Include: 00 (Original), 04 (Change) **EDI Mapping:** DE353/BX01 ' example: '00' billOfLadingEdiTransportationTypeCode: type: string description: 'Is an EDI-defined code value specifying the method or type of transportation for a shipment. **EDI Mapping:** DE91/ZC108/BX02 ' example: X billOfLadingEdiSectionSevenCode: type: string description: 'Is an EDI-defined code value indicating the applicability of the section seven option on a shipment. ' example: F billOfLadingEdiBillingTypeCode: type: string description: Is an EDI-defined code value which indicates a type of bill. example: S equipmentEdiReleaseCode: type: string description: 'EDI Equipment Release Code is an EDI-defined code value signifying whether or not the shipment information transaction set includes instructions for pickup and movement of the shipment. ' example: R equipmentReleaseDateTime: type: string description: 'Equipment Release DateTime records the date and time which a shipper''s equipment is released to BNSF. ' example: '2021-03-06T21:17:07.187Z' equipmentReleaseDateTimeOffsetNumber: type: string description: 'Equipment Release DateTime Offset Number is the amount of time subtracted from or added to the Coordinated Universal Time to get the time supplied for the equipment release date-time. ' example: CT billOfLadingCargoManifests: type: array items: type: object properties: billOfLadingCargoManifestSequenceNumber: type: number format: float description: 'BOL Cargo Manifest Sequence Number allows for more than one Cargo Manifest per BOL. The EDI standard allows for a maximum of two. ' example: 1 voyageNumber: type: string description: Identifying designator number for the particular ocean movement on which the cargo travels. example: 537S oceanPortFunctionalCode: type: string description: Code defining function performed at the port with respect to a shipment. example: L oceanPortName: type: string description: Free-form name for the place at which an offshore carrier/vessel originates or terminates its actual ocean carriage of property. example: LONGBEACH vesselSailDockEdiDate: type: string format: date description: The date the ship will sailed or docked at the port. Present if Ocean Port Functional Code contains a 'L", 'D' or '1'. example: '2022-09-01' vesselBookingNumber: type: string description: Number assigned by the carrier for space reservation on a voyage. example: LGB700188300 currentScac: type: string description: Current SCAC (Standard Carrier Alpha Code) provided by EDI example: BNSF previousScac: type: string description: Previous SCAC (Standard Carrier Alpha Code) provided by EDI example: BNSF billOfLadingManifestDate: type: string format: date description: The date the manifest was established by the shipper. example: '2022-09-01' vesselName: type: string description: Name of the vessel as documented in "Lloyd's Register of Ships". example: ANL BAREGA oceanPierNumber: type: string description: Identifying number for the pier located within the Ocean Port Name. example: '1234' oceanPierName: type: string description: Identifying name for the pier located within the Ocean Port Name. example: SANTIAGO oceanTerminalName: type: string description: Identifying name for the terminal located within the Ocean Port Name. example: ANL BAREGA oceanTerminalStateCode: type: string description: Identifying state code for the terminal located within the Ocean Port Name. example: CA oceanTerminalCountryCode: type: string description: Identifying country code for the terminal located within the Ocean Port Name. example: US cargoManifestReferenceId: type: string description: Cargo Manifest Reference ID is a reference identifier for Vessel Agent Number. example: CM123456 billOfLadingCommodities: type: array description: 'Specifies a shipment''s lading information for each commodity in terms of description, marks, and numbers. **EDI Mapping:** LX,L5 ' items: type: object properties: billOfLadingCommoditySequenceNumber: type: number format: float description: 'Is a sequence number that in combination with BOL ID and BOL Commodity Sequence Number, uniquely identifies a row on the BOL Commodity Detail element. ' example: 1 billOfLadingTransactionSetAssignedNumber: type: number format: float description: 'Is a number assigned for differentiation within a BOL transaction set. **EDI Mapping:** DE554/LX01 ' example: 1 ladingLineItemNumber: type: number format: float description: 'Lading Line Item Number is the sequential line number for a lading item within a shipment. **EDI Mapping:** DE213/L501 ' example: 1 stcc: type: string description: 'STCC (Standard Transportation Commodity Code) assigned to a lading commodity or group of lading commodities. **EDI Mapping:** DE22/L503 ' example: '4611110' stccEdiQualifierCode: type: string description: 'Is an EDI-defined code value that identifies the commodity coding system used for an associated Commodity Code. Sample Values Include: 0 (National Association of Convenience Stores), 1 (Global Product Classification Code (GPC)), 2 (Dun s SIC 2+2, Dun and Bradstreet), 3 (Empty Non-hazardous Last Contained (HMRC) Code) **EDI Mapping:** DE23/L504/L508 ' example: '3' ladingDescription: type: string description: 'Lading Description describes a lading item as required for rating and billing purposes. **EDI Mapping:** DE79/L502 ' example: STANDARD NON-HAZARDOUS FREIGHT ALL KINDS billOfLadingCommodityDetails: type: array description: 'Specifies a shipment''s detailed lading information for each line item, including packaging, quantity, weight, and volume. **EDI Mapping:** L0 ' items: type: object properties: billOfLadingCommodityDetailSequenceNumber: type: number format: float description: 'Is a sequence number that in combination with BOL ID and BOL Commodity Sequence Number, uniquely identifies a row on the BOL Commodity Detail element. ' example: 1 ladingQuantityCount: type: number format: float description: 'Number of units (pieces) of the lading commodity. **EDI Mapping:** DE80/X110 ' example: 1 ladingEdiPackagingFormCode: type: string description: 'Is an EDI-defined code value specifying the packaging form of a lading quantity. Sample Values Include: BLK (Bulk), CAR (Carrier), CNT (Container), CRT (Crate), PLT (Pallet) **EDI Mapping:** DE211/L009/L014 ' example: BLK ladingWeight: type: number format: float description: 'Lading Weight is a measure of the weight of a lading item. This must be qualified with a code defining the unit of measure to be meaningful. **EDI Mapping:** DE81/L004 ' example: 29118 ladingEdiWeightQualifierCode: type: string description: 'Is an EDI-defined code value that identifies the manner in which the weight of a piece of freight conveyance equipment was calculated. Sample Values Include: A (Consolidated Weight), B (Billed Weight), L (Legal Weight), N (Actual Net Weight) **EDI Mapping:** DE187/L005 ' example: A ladingVolume: type: number format: float description: 'Lading Volume is a volumetric measure of a lading item. This must be qualified with a code defining the unit of measure used to be meaningful. **EDI Mapping:** DE183/L006 ' example: 0 ladingEdiVolumeUnitCode: type: string description: 'Is an EDI-defined qualifier code value that provides context to a volume measurement. Sample Values Include: C (Cubic Centimeters), E (Cubic Feet), G (Gallons), M (Cubic Decimeters) **EDI Mapping:** DE184/L007 ' example: C billOfLadingPrices: type: array description: 'Relates a line item in a shipment to the authority document, contract number, quote number, and tariff number which are used to determine the basis of pricing. **EDI Mapping:** LX Loop/LX,L0,PI ' items: type: object properties: billOfLadingPriceSequenceNumber: type: number format: float description: 'Is a sequence number that is needed to uniquely identify a price associated with a commodity on the BOL. ' example: 1 billOfLadingLineItemPriceReferenceEdiQualifierCode: type: string description: 'Is an EDI-defined qualifier code value that provides context to the value present in the EDI Reference ID column. **EDI Mapping:** DE128/PI01 ' example: CT billOfLadingLineItemPriceReferenceId: type: string description: 'Is a reference identification number for the BOL Price element. **EDI Mapping:** DE127/PI02 ' example: QTTFDXFXF publicationAuthorityEdiTypeCode: type: string title: publicationAuthorityEdiTypeCode description: 'Is an EDI-defined code value that specifies the type of external price publication provided for a line item in a shipment. Sample Values Are: BR (Backward Reference), DR (Division Reference), GR (Group Reference), OP (Other Publication), RR (Rate Reference), TP (Tariff Publication) **EDI Mapping:** DE436/PI03 ' example: BR priceAuthorityAgencyCode: type: string description: "Price Authority Agency Code is a code value, as defined by the National Motor Freight Traffic Association, specifying the tariff bureau or tariff publishing agent that governs the pricing/rates applied to a shipment.\n\nCodes sourced from the Directory of Standard Carrier Alpha Codes (SCAC), NMF 101 Series, available from the National Motor Freight Traffic Association, Inc.\n\n**EDI Mapping:** DE168/PI05 \n" example: BNSF priceAuthorityIssuingCarrierId: type: string description: 'Price Authority Issuing Carrier ID is an identification label used to identify the issuing carrier of a price authority specified on a shipment. **EDI Mapping:** DE965/PI06 ' example: BNSF billOfLadingExportLicenses: type: array items: type: object properties: billOfLadingExportLicenseSequenceNumber: type: number format: float description: In combination with a BOL ID, uniquely identifies a row in the BOL Export License element. example: 1 licensingAgencyEdiCode: type: string description: Is an EDI-defined code value used to identify a licensing, certification, registration, or accreditation agency associated with a commodity being shipped. example: '1' exportLicenseId: type: string description: Export License ID is a government assigned identification number for exporter. example: License1 exportLicenseEdiStatusCode: type: string description: Is an EDI-defined code value specifying whether the shipment completes the terms of the export license, or the shipment is only a partial delivery relative to the license terms. example: '1' exportLicenseExpirationDate: type: string format: date description: Is the day, month, and year when an export license expires (expressed as CCYYMMDD where CC represents the first two digits of the calendar year). example: '2022-01-01' exportLicenseEdiSymbolCode: type: string description: Is an EDI-defined code value which specifies the export license symbol marked on a shipment. example: A1 exportLicenseEdiControlCode: type: string description: Is an EDI-defined code value specifying the type of control applicable to an export license. exportLicenseCountryCode: type: string description: Export License Country Code is an ISO 3166 code value specifying a country, dependency, or geopolitical area in which an exporter operates. example: US commodityScheduleBNumber: type: string description: "Schedule B Number is a classification and identification code for commodities for use by exporters in preparing Shippers Export Declarations.\n\nThe code is a ten digit numeric of the form dddd.dd.dddd. \n\nCodes sourced from the Schedule B Statistical Classification of Domestic and Foreign Commodities Exported from the United States, 1990 Edition. Maintained by the U.S. Bureau of the Census." example: A12 billOfLadingEdiInternationalDomesticCode: type: string description: Is an EDI-defined code value specifying whether a shipment is international or domestic. example: A ladingQuantityCount: type: number format: float description: Lading Quantity Count is a count of the number of units (pieces) of the lading commodity. example: 2900 ladingValueAmount: type: number format: float description: Lading Value Amount specifies the monetary value of a shipment for export, expressed in the standard monetary denomination for the currency specified. example: 29.1 exportLicenseEdiFilingKeyCode: type: string description: Is an EDI-defined code value specifying whether the information contained on an export license has been filed with Customs via an automatic or manual process. example: '1' ediUomCode: type: string description: Is an EDI-defined code value specifying the units in which a value is being expressed, or manner in which a measurement has been taken. example: AB ladingUnitPrice: type: number format: float description: Lading Unit Price is the price per unit of a commodity. example: 2.1 usGovernmentLicenseTypeCode: type: string description: The type of U.S. government license being used on the export license associated with a shipment. example: A eccn: type: string description: Export Control Classification Number is a designation used on the Commerce Control List (CCL) to identify dual-use items for export control purposes. example: AN993993 exportDeclarationLocationScheduledCode: type: string example: TX90345 billOfLadingEquipment: type: array description: 'Provides detail information about the rail conveyance equipment on the BOL. **EDI Mapping:** N7 Loop/L0,N7,T2 ' items: type: object required: - equipmentId - equipmentLoadEmptyStatusCode - equipmentExteriorLengthFeetInches properties: billOfLadingEquipmentSequenceNumber: type: number format: float description: 'Is a sequence number that in combination with BOL Identifer, uniquely identifies a piece of freight conveyance equipment on a BOL. The purpose of the sequence number is to preserve the order of equipment as supplied on the EDI 404 or other channel. Sequence values should start from one (1) and increment by one for each piece of equipment on the request.' example: 1 equipmentId: type: string description: 'Equipment ID serves as an identifier for a piece of freight conveyance equipment. It consists of a 4-character equipment initial followed by an up to 15-character equipment unit identifying number. **EDI Mapping:** DE206-207/N804/N805 ' example: FDXU532684 equipmentLoadEmptyStatusCode: type: string description: 'Load Empty Status Code is used to convey whether a piece of rail conveyance equipment (i.e., a railcar) is being shipped while laden with cargo or while empty, as is the case if it does not pick up another load at its destination. ' example: L equipmentEdiWeightQualifierCode: type: string description: 'EDI Weight Qualifier Code is an EDI-defined code value that identifies the manner in which the weight of a piece of freight conveyance equipment was calculated. Sample Values Include: A (Consolidated Weight), B (Billed Weight), L (Legal Weight), N (Actual Net Weight) **EDI Mapping:** DE187/N704/L005/T204 ' example: A equipmentWeight: type: number format: float description: 'BOL Equipment Weight is the numeric value of the weight of a shipment as it appears on a BOL. This must be qualified with a code defining the type of weight (i.e., Estimated Net Weight, Gross Weight, Actual Net Weight) used to be meaningful. EDI specifies that dunnage weight must be included and is limited to 8 digits for rail transactions. The numeric value of the residue weight is required for trans-border residue empty moves into the U.S. The Equipment Weight Qualifier indicate the type of weight measured. **EDI Mapping:** DE81/N703 ' example: 29118 equipmentEdiTypeCode: type: string description: 'EDI Equipment Type Code is an EDI-defined code value specifying the method or type of transportation used for the shipment. Sample Values Include: 20 (20 ft. IL Container (Open Top)), AA (Air Ride Van), AC (Closed Container), BX (Boxcar) **EDI Mapping:** DE40/N711 ' example: AA equipmentTareWeight: type: number format: float description: 'Equipment Tare Weight is the weight of an empty rail shipping container or vehicle. Sometimes called the unladen weight. **EDI Mapping:** DE167/N705 ' example: 0 equipmentExteriorLengthFeetInches: type: number format: float description: 'Is the length (in feet and inches) of equipment ordered or used to transport shipment. The format is FFFII where FFF is feet and II is inches. The range for II is 00 through 11. Outside length required for intermodal equipment. **EDI Mapping:** DE567/N715 ' example: 5300 equipmentCheckDigitNumber: type: string description: Equipment Check Digit Number designates the check digit applied to a piece of equipment, which serves as a form of redundancy check used for error detection. equipmentAllowanceWeight: type: number format: float description: Equipment Allowance Weight is the permitted increase in the weight of a piece of shipping equipment due to such factors as snow. example: 10 equipmentDunnageWeight: type: number format: float description: Equipment Dunnage Weight is the combined weight of the materials used to protect the lading being transported on the freight conveyance equipment (even bracings, false floors, etc.). example: 120 equipmentOwnerScac: type: string description: Equipment Owner SCAC is the standard carrier alpha code for the owner of the associated freight conveyance equipment. example: BNSF equipmentEdiOwnershipCode: type: string description: Is an EDI-defined code value specifying the relationship of a piece of equipment to the carrier it belongs to. example: T equipmentPositionNumber: type: string description: Equipment Position Number specifies the relative position of a shipment within the associated freight conveyance equipment (car, trailer, or container). example: A1 equipmentExteriorHeightInches: type: number format: float description: Is the exterior vertical dimension of a piece of freight conveyance equipment, measured in inches when the object is in the upright position. example: 50 equipmentExteriorWidthInches: type: number format: float description: Is the exterior width of a piece of freight conveyance equipment, measured in inches when the object is in the upright position. example: 100 equipmentAarCarTypeCode: type: string description: Equipment AAR Car Type Code is an AAR-maintained code value used to identify a type of rail car or intermodal equipment type and its general characteristics. example: SHR equipmentIsoContainerTypeCode: type: string description: Equipment ISO Container Type Code is an ISO 6346-defined code value used to specify the type of a shipping container. example: U223 billOfLadingEquipmentSeals: type: array description: 'Records seal numbers used to close openings on a piece of rail conveyance equipment. **EDI Mapping:** M7 ' items: type: object properties: billOfLadingEquipmentSealSequenceNumber: type: number format: float description: "Is a sequence number that in combination with BOL ID and BOL Equipment Sequence Number uniquely identifies a seal associated with the freight conveyance equipment on a BOL. \n" example: 1 equipmentSealNumber: type: string description: 'Is a unique number on seal used to close a shipment. **EDI Mapping:** DE225/M701 ' example: '1234' billOfLadingEquipmentReferences: type: array items: type: object properties: billOfLadingEquipmentReferenceSequenceNumber: type: number format: float description: Is a sequence number that in combination with BOL ID and BOL Equipment Sequence Number, uniquely identifies a piece equipment reference information on a Shipment. example: 1 equipmentReferenceEdiQualifierCode: type: string description: Is an EDI-defined qualifier code value that provides context to the value present in the 'EDI Reference ID' column. example: COB equipmentReferenceId: type: string description: Equipment Reference ID is a reference identification number for the 'BOL Equipment Reference' table. example: FREE FORM TEXT equipmentReferenceDescription: type: string description: Equipment Reference Description is a free-form description explaining the significance of the reference information attached to the freight conveyance equipment. example: FREE FORM TEXT billOfLadingCustomsInBondDetails: type: array items: type: object properties: billOfLadingCustomsInBondSequenceNumber: type: number format: float description: Is a sequence number that in combination with BOL ID and BOL Equipment Sequence Number, uniquely identifies a row in the BOL Customs In Bond element. example: 1 customsEntryTypeCode: type: string description: Customs Entry Type Code is an EDI-defined code value specifying the type of entry assigned by U.S. Customs and Border Protection (CBP). example: '6' customsEntryNumber: type: string description: Customs Entry Number is the Automated Commercial System Code furnished by U.S. Customs Service. example: AN123456 oceanPortLocationCode: type: string description: Is a location identifier for a port where shipments are exported or received. example: AN3901 foreignOceanPortLocationCode: type: string description: Contains a five-digit numeric census Schedule K code which identifies a foreign port of destination. example: AN7878 inBondShipmentValueAmount: type: string description: In-bond Shipment Value Amount is the value of the in bond shipment in whole dollars, as required by US Customs. example: AN5656 inBondShipmentControlNumber: type: string description: Is assigned to an import or export shipment that hasn't been cleared by US Customs and serves as a means of telling shipments apart while simultaneously identifying the carrier transporting the shipment. example: V7210163606 inBondShipmentReferenceEdiQualifierCode: type: string description: Is an EDI-defined qualifier code value that provides context to the value present in the 'In-bond Shipment Reference Identification Number' column. example: XC inBondShipmentReferenceIdentificationNumber: type: string description: For any value held in this column is contextualized and given meaning by the code value of the associated "In-bond Shipment Reference EDI Qualifier Code". example: BI inBondShipmentEdiTransportationTypeCode: type: string description: Is an EDI-defined code value specifying the method or type of transportation for a shipment. example: S vesselName: type: string description: Name of the vessel as documented in "Lloyd's Register of Ships". example: VESSEL NAME billOfLadingEquipmentQuantityAndDescription: type: array description: 'Count of the number of packages, of a specific commodity, Description of the commodity to be shipped on a railcar as defined on the BOL (Bill of Lading). **EDI Mapping:** N10 Loop/N7,REF,N10 ' items: type: object required: - billOfLadingEquipmentQuantity - billOfLadingEquipmentQuantityDescription - billOfLadingEquipmentDestinationCountryCode properties: billOfLadingEquipmentQuantityAndDescriptionSequenceNumber: type: number format: float description: 'Is a sequence number that in combination with BOL Identifer, uniquely identifies a piece of freight conveyance equipment on a BOL. The purpose of the sequence number is to preserve the order of equipment as supplied on the EDI 404 or other channel. Sequence values should start from one (1) and increment by one for each piece of equipment on the request.' example: 1 billOfLadingEquipmentQuantity: type: string description: 'Count of the number of packages, of a specific commodity, to be shipped on a railcar as defined on the BOL (Bill of Lading). **EDI Mapping:** N10/01 ' example: '1' billOfLadingEquipmentQuantityDescription: type: string description: 'Description of the commodity to be shipped on a railcar as defined on the BOL (Bill of Lading). **EDI Mapping:** N10/02' example: SCRAP PAPER billOfLadingEquipmentWeightUnitCode: type: string description: 'Code that defines the standard UOM (Unit of Measure) to be applied to the BOL (Bill of Lading) Commodity Item Weight value. **EDI Mapping:** N10/07 ' example: L billOfLadingEquipmentWeight: type: number format: float description: 'The weight of the specific commodity within a given railcar as defined on the BOL (Bill of Lading). See also "BOL Commodity Item Weight UOM Code." **EDI Mapping:** N10/08 ' example: 100 billOfLadingEquipmentManifestCode: type: string description: 'Code specifying the smallest type of package a commodity can be bundled into for shipping on a railcar as defined on the BOL (Bill of Lading.) **EDI Mapping:** N10/10 ' example: CAR billOfLadingEquipmentOriginCountryCode: type: string description: 'Code that defines the origin country of a commodity as defined on the BOL (Bill of Lading.). **EDI Mapping:** N10/11 ' example: MEX billOfLadingEquipmentDestinationCountryCode: type: string description: 'Code that defines the destination country of a commodity as defined on the BOL (Bill of Lading.). **EDI Mapping:** N10/12 ' example: US billOfLadingSpecialHandlingInstructions: type: array description: 'Records the codes provided by the shipper that specify how a commodity or piece of equipment is processed/handled on the BOL. **EDI Mapping:** H3 ' items: type: object properties: specialHandlingInstructionsSequenceNumber: type: number format: float description: 'Special Handling Instruction Sequence Number is a sequence number that in combination with BOL ID, uniquely identifies an occurrence in the BOL Special Handling Instruction group. ' example: 1 specialCarHandlingCode: type: string description: 'Is an EDI-defined code value specifying special transportation handling instructions that must be applied to a shipment. Sample Values Include: AJ (Do Not Stack), AH (Humidity Sensitive Shipment), FR (Fragile - Handle with Care), DNF (Do Not Freeze) **EDI Mapping:** DE152/H301 ' example: AJ billOfLadingRouteSequences: type: array description: "Describes the carrier and routing (interchange) sequence for rail transportation of a shipment from origin to destination. \n\n**EDI Mapping:** R2\n\n" items: type: object properties: billOfLadingRouteSequenceNumber: type: number format: float description: 'Is a sequence number that in combination with BOL ID, uniquely identifies a row in the BOL Route Sequence element. ' example: 1 billOfLadingRoute: type: object description: "Describes the carrier and routing (interchange) sequence for rail transportation of a shipment from origin to destination. \n" required: - carrierEdiShipmentRoutingSequenceCode - scac properties: carrierEdiShipmentRoutingSequenceCode: type: string description: 'Carrier EDI Shipment Routing Sequence Code describes the relationship of a carrier to a specific shipment movement. Sample Values Include: 1 (1st Carrier after Origin Carrier), 9 (9th Carrier after Origin Carrier), D (Delivery Switch Carrier), I (Origin Switch Carrier), R (Origin Carrier, Rule 11 Shipment) **EDI Mapping:** DE133/R202/E502 ' example: S scac: type: string description: 'SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). **EDI Mapping:** DE140/CM06 ' example: BNSF r260JunctionName: type: string description: 'Route Junction Name is the junction name (as specified by AAR Accounting Rule 260) of the interchange for a segment of the route. This information represents the beginning of service for intermediate and interline received rail shipments. The city name of the rail location/interchange for this segment of the route on the BOL. **EDI Mapping:** DE19/E503/R203 ' example: LAREDO intermodalServiceCode: type: string description: 'Intermodal Service Code identifies the Intermodal Service Plan. Required on intermodal shipments. Required on intermodal shipments (BX02 = ''X'') when N711 contains ''CC'', ''CH'', ''CM'', ''CN'', ''CX'', ''CZ'', ''GS'', ''LS'', ''OT'', ''PL'', ''PT'', ''RT'' or ''TL'' **EDI Mapping:** DE177/R205 ' example: '65' billOfLadingDestinationLocation: type: object description: 'Specifies the rail locations related to the BOL such as origin (station) and destination (station). **EDI Mapping:** F9,D9 ' required: - stationCityName - stationStateCode properties: fsac: type: string description: 'FSAC (Freight Station Accounting Code) is a number assigned to a station that uniquely identifies the station within the context of each reporting railroad (i.e., Different railroads might share identical FSAC numbers). **EDI Mapping:** DE573/PS06 ' example: '9090' stationCityName: type: string description: 'Is a fully qualified name of a city for a given station. **EDI Mapping:** DE19/G401 ' example: CHICAGO stationStateCode: type: string description: 'Is a code value, as defined by the appropriate government agency of the United States, Canada, or Mexico, specifying a state or province. Codes sourced from the U.S. Postal Service, Canada Post, or Bureau of Transportation Statistics. **EDI Mapping:** DE156/PS08 ' example: IL billOfLadingOriginLocation: type: object description: 'Specifies the rail locations related to the BOL such as origin (station) and destination (station). **EDI Mapping:** F9,D9 ' required: - stationCityName - stationStateCode properties: fsac: type: string description: 'FSAC (Freight Station Accounting Code) is a number assigned to a station that uniquely identifies the station within the context of each reporting railroad (i.e., Different railroads might share identical FSAC numbers). **EDI Mapping:** DE573/PS06 ' example: '9090' stationCityName: type: string description: 'Is a fully qualified name of a city for a given station. **EDI Mapping:** DE19/G401 ' example: SAN BERNARDINO stationStateCode: type: string description: 'Is a code value, as defined by the appropriate government agency of the United States, Canada, or Mexico, specifying a state or province. Codes sourced from the U.S. Postal Service, Canada Post, or Bureau of Transportation Statistics. **EDI Mapping:** DE156/PS08 ' example: CA billOfLadingParties: type: array description: 'Specifies role and location (address) information for parties associated with a BOL. **EDI Mapping:** N1 Loop/N1, N2, N3, PER ' items: type: object properties: billOfLadingPartySequenceNumber: type: number format: float description: 'Is a sequence number that in combination with BOL ID, uniquely identifies a party role and location on a BOL. ' example: 1 billOfLadingParty: type: object description: 'BOL Party specifies role and location (address) information for parties associated with a BOL. ' properties: partyRoleCode: type: string description: 'Shipping Party Role Code is an EDI-defined code value specifying the role of an organizational entity, a physical location, or an individual participating with a BOL. Sample Values Include: PU (Party at Pickup Location), SH (Shipper), CN (Consignee), PF (Party to Receive Freight Bill) **EDI Mapping:** DE98/N101 ' example: SH partyName: type: string description: 'Party Name is the fully qualified name of of a party. This must be qualified with a code defining the role that the party plays in the freight movement process to be meaningful. **EDI Mapping:** DE93/N102 ' example: ABC FREIGHT INC partyId: type: string description: 'Party ID serves as a unique identifier of the person, organization, or organizational component that is of interest to BNSF that can act in a legal capacity. This must be qualified with a code defining the type of party identifier used to be meaningful. **EDI Mapping:** DE67/N104 ' example: FREE FORM TEXT partyFirstLineAddress: type: string description: 'Is free-form text specifying the line 1 address information for a location in which a party operates. **EDI Mapping:** DE166/N301/N302 ' example: 1234 W 4TH STREET partySecondLineAddress: type: string description: 'Is free-form text specifying the line 2 address information for a location in which a party operates. **EDI Mapping:** DE166/N301/N302 ' example: APT 1234 partyAddressCityName: type: string description: 'Party Address City Name is the fully qualified name of a city in which a party operates. **EDI Mapping:** DE19/N401 ' example: SAN BERNARDINO partyAddressStateCode: type: string description: 'Party Address State Code is a code value, as defined by the appropriate government agency of the United States, Canada, or Mexico, specifying the state or province in which a party operates. Codes sourced from the U.S. Postal Service, Canada Post, or Bureau of Transportation Statistics. **EDI Mapping:** DE156/N402 ' example: CA partyAddressPostalCode: type: string description: 'Party Address Postal Code is the international postal zone code (excluding punctuation and blanks) identifying the geographical area in which a party operates. **EDI Mapping:** DE116/N403 ' example: '92411' partyAddressCountryCode: type: string description: 'Party Address Country Code is an ISO 3166 code value specifying a country, dependency, or geopolitical area in which a party operates. **EDI Mapping:** DE26/N404 ' example: US partyEdiIdentificationQualifierCode: type: string description: 'EDI Party Identification Qualifier Code is an EDI-defined code value designating the system/method of code structure of an associated ID used to uniquely identify a party. For example, it may be used to convey that the associated ID is a telephone number, a Customer Identification File ID, or a Federal Taxpayer''s ID. Sample Values Include: C5 (Customer Identification File), 12 (Telephone Number), FI (Federal Taxpayer''s Identification Number) **EDI Mapping:** DE66/N103 ' example: C5 billOfLadingPartyContacts: type: array description: 'Records the information of a specific contact acting as a representative of a larger party taking part in the BOL process. **EDI Mapping:** N1 Loop/PER ' items: type: object properties: billOfLadingPartyContactSequenceNumber: type: number format: float description: 'Is a sequence number that in combination with BOL ID and BOL Party Sequence Number, uniquely identifies a row in the BOL Party Contact element. ' example: 1 partyContactEdiFunctionCode: type: string description: 'EDI Contact Function Code is an EDI-defined code value that identifies the major duty or responsibility of an associated person or group. Sample Values Include: 1A (Review/Repricing Contact), 1B (Preferred Provider Organization (PPO) Contact), 1C (Health Maintenance Organization (HMO) Contact) **EDI Mapping:** DE366/PER01 ' example: NT partyContactName: type: string description: 'Party Contact Name is the fully qualified name of a person or office who represents a party to whom communications should be directed. **EDI Mapping:** DE93/PER02 ' example: ABC FREIGHT INC communicationNumberEdiQualifierCode: type: string description: 'Is an EDI qualifier code that provides context to a communication number. Typically contains the contact method such as telephone, e-mail or fax. **EDI Mapping:** DE365/PER03/PER05/PER07 ' example: AB partyCommunicationNumber: type: string description: 'Party Communication Number is the complete communications number for a party including country and/or area code when applicable. This must be qualified with a code defining the type of communication number used to be meaningful. **EDI Mapping:** DE364/PER04/PER06/PER08 ' example: '1234567890' billOfLadingBillings: type: array items: type: object properties: billOfLadingBillingSequenceNumber: type: number format: float description: Is a sequence number that in combination with BOL ID and BOL Party Sequence Number, uniquely identifies a row on the BOL Billing element. example: 1 carrierEdiRebillReasonCode: type: string description: EDI Rebill Reason Code is an EDI-defined code value specifying the reason for rebill. example: RC originFsac: type: string description: Origin FSAC is the FSAC (Freight Station Accounting Code) for the origin point of the rate for a portion of a movement. example: '30857' originSplc: type: string description: Origin SPLC is the SPLC (Standard Point Location Code) for the origin point of the rate for a portion of a movement. example: A1234 billingRateOriginCityName: type: string description: Begin Rate City Name is the fully qualified name of a city used for the billing rate for the beginning portion of a movement. example: CHICAGO billingRateOriginStateCode: type: string description: Begin Rate State Code is a code value, as defined by the appropriate government agency of the United States, Canada, or Mexico, specifying the state or province used for the billing rate for the beginning portion of a movement. example: IL billingRateOriginCountryCode: type: string description: Begin Rate Country Code is an ISO 3166 code value specifying a country, dependency, or geopolitical area used for the billing rate for the beginning portion of a movement. example: US destinationFsac: type: string description: Destination FSAC is th FSAC (Freight Station Accounting Code) for the destination point of the rate for a portion of a movement. example: '30888' destinationSplc: type: string description: Destination SPLC is the SPLC (Standard Point Location Code) for the destination point of the rate for a portion of a movement. example: A1234 billingRateDestinationCityName: type: string description: End Rate City Name is the fully qualified city name of a city used for the billing rate for the ending portion of a movement. example: DENVER billingRateDestinationStateCode: type: string description: End Rate State Code is a code value, as defined by the appropriate government agency of the United States, Canada, or Mexico, specifying the state or province used for the billing rate for the ending portion of a movement. example: CO billingRateDestinationCountryCode: type: string description: End Rate Country Code is an ISO 3166 code value specifying a country, dependency, or geopolitical area used for the billing rate for the ending portion of a movement. example: US billOfLadingBillingCarriers: type: array items: type: object properties: billOfLadingBillingCarrierSequenceNumber: type: number format: float description: Conveys the order of a carrier participating in the rate for a rail transportation movement. example: 1 scac: type: string description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: BNSF billOfLadingReferences: type: array description: 'Provides additional reference information for the shipment such as Bill of Lading number, Bill of Lading Date, Purchase Order number etc. **EDI Mapping:** N9 ' items: type: object properties: billOfLadingReferenceSequenceNumber: type: number format: float description: 'Is a sequence number that in combination with BOL Identifier, uniquely identifies a piece of reference information on a Bill of Lading. ' example: 1 billOfLadingReferenceEdiQualifierCode: type: string description: 'Is an EDI-defined qualifier code value that provides context to the value present in the ''EDI Reference ID'' column. **EDI Mapping:** DE128/N901 ' example: BM billOfLadingReferenceId: type: string description: 'BOL Reference ID is a reference identification number for the ''BOL Reference'' table. Any value held in this column is contextualized and given meaning by the code value of the associated ''EDI Reference Identification Qualifier Code'' column. **EDI Mapping:** DE127/N902 ' example: '4307664' billOfLadingReferenceDescription: type: string description: 'Is a free-form description meant to clarify the related BOL extended reference information. **EDI Mapping:** DE369/N903 ' example: FREE FORM TEXT billOfLadingReferenceDateTime: type: string format: date-time description: 'Reference DateTime is the party supplied date and/or time value for a specific BOL reference document. Date-Time values received may be in context from customer/party locale. The date-time value is stored in UTC time with the offset number added or subtracted to get the actual time supplied by the customer/party. **EDI Mapping:** DE373-DE337/N904/N905 ' example: '2021-03-28T21:17:07' billOfLadingReferenceDateTimeUtcOffset: type: string description: 'Reference DateTime Offset Number specifies the amount of time subtracted from or added to the Coordinated Universal Time to get the time supplied for the BOL reference information. Date-Time values received may be in context from customer/party locale. In the EDI standard, the Time Code (N906) reflects a two character US time zone. The supplied date, time and timezone values are converted to UTC time with the offset number added or subtracted to get the actual time supplied by the party. **EDI Mapping:** DE623/N906 ' example: CT billOfLadingActivityDateTimes: type: array description: 'Records pertinent dates and times for activities on a BOL. **EDI Mapping:** DTM ' items: type: object properties: billOfLadingActivityDateSequenceNumber: type: number format: float description: 'Is a sequence number that in combination with BOL ID, uniquely identifies a row in the BOL Activity date element. ' example: 1 billOfLadingActivityEdiDateTimeQualifierCode: type: string description: 'Is an EDI-defined code value which qualifies the type of action that occurred at an associated date and/or time. **EDI Mapping:** DE374/DTM01 ' billOfLadingActivityDateTime: type: string format: date-time description: 'Specifies the day, month, and year of an activity associated with a BOL. This must be qualified with a code defining the type of BOL activity performed to be meaningful. **EDI Mapping:** DE373/DTM02/DE337/DTM03 ' example: '2021-03-10T21:17:07' billOfLadingActivityEdiTimeZoneCode: type: string description: 'Is an EDI-defined code value used to identify the time zone for an associated activity. **EDI Mapping:** DE623/DTM04 ' example: CT billOfLadingHazmatIdentifications: type: array description: 'Records commodity identification reference numbers and codes, as well as quantity and location (within a compartmentalized car) information, for the hazardous material being shipped. ' items: type: object properties: billOfLadingHazmatIdentificationSequenceNumber: type: number format: float description: 'Is a sequence number that in combination with the BOL ID, uniquely identifies a row on the BOL Hazmat Identification Element. ' example: 1 hazmatEdiPackageTypeCode: type: string description: 'Is an EDI-defined code value specifying the type of package being shipped for an associated hazardous commodity movement. **EDI Mapping:** DE355/LH101' example: PC hazmatLadingPackageQuantityCount: type: integer format: int32 description: 'Hazmat Lading Package Quantity Count denotes the number of packages of the hazardous material lading commodity being moved for the associated shipment. **EDI Mapping:** DE80/LH102 ' example: 7 hazmatUnNaIdentificationCode: type: string description: 'Is used to identify hazardous materials and articles in the framework of international transport, as required by Title 49 of the code of Federal Regulations. **EDI Mapping:** DE277/LH103 ' example: UN0336 hazmatCommodityCode: type: string description: 'Hazmat Commodity Code describes a hazmat commodity or group of hazmat commodities. Codes sourced from the Standard Transportation Commodity Code (STCC) corporate reference file. **EDI Mapping:** DE22/LH105 ' example: '4903520' hazmatLadingEdiUomCode: type: string description: 'Is an EDI-defined code value specifying the units in which, or manner in which, the measurement of the associated hazardous material lading commodity has been taken. **EDI Mapping:** DE355/LH106' example: LB hazmatLadingMeasure: type: integer format: int32 description: 'Hazmat Lading Measure is a number specifying the measurement of a hazardous material lading commodity. **EDI Mapping:** DE380/LH107 ' example: 145 hazmatPackingGroupCode: type: string description: Hazmat Packing Group Code is a code value defined by the Canadian government which indicates degree of danger of the hazardous material, expressed as Roman numeral I, II, or III. example: AAA hazmatUnHazmatPageNumber: type: string description: Defines the page number of the publication where a specific hazardous commodity is described, as required for the international transport of hazardous materials. example: '123' hazmatEdiTankCarCompartmentCode: type: string description: Is an EDI-defined code value used to identify the a specific compartment of a compartmentalized tank car. example: A hazmatPackagingEdiContainerResidueCode: type: string description: Is an EDI-defined code value used to convey that residue from the associated material remains in the packaging (including a tank car) after it has been unloaded. example: Y billOfLadingHazmatClassifications: type: array description: 'Records the classification, notation, and endorsement information for the hazardous material being shipped. **EDI Mapping:** LH1 Loop/LH2' items: type: object properties: billOfLadingHazmatClassificationSequenceNumber: type: number format: float description: Is a sequence number that is needed to uniquely identify a row on the "BOL Hazmat Classification" table. example: 1 hazmatClassificationCode: type: string description: Hazmat Classification Code is a code value defined by the Department of Transportation specifying the hazardous classification corresponding to the shipping name of a hazardous commodity. example: '2.1' hazmatEdiClassQualifierCode: type: string description: Is an EDI-defined code value qualifying an associated hazardous material class as either primary or secondary. example: P hazmatPlacardNotationCode: type: string description: Hazmat Placard Notation Code is a code value defined by the Department of Transportation which specifies the placard notation corresponding to the hazard class of a hazardous commodity. example: P hazmatEndorsementCode: type: string description: Hazmat Endorsement Code is a code value defined by the Department of Transportation which specifies the placard endorsement that is to be shown on the shipping papers for a hazardous commodity. example: NONE hazmatEdiReportableQuantityIndicator: type: string description: Is an EDI code value identifying presence of hazardous substance. example: '2.1' hazmatFlashPointTemperatureEdiUomCode: type: string description: Is an EDI-defined code value specifying the units in which a flash point temperature is being expressed. example: P hazmatFlashPointTemperature: type: number format: float description: Hazmat Flash Point Temperature is the lowest temperature at which the vapor given off by a hazardous material will ignite on application of a flame. example: 10 hazmatExplosiveContentEdiWeightUomCode: type: string description: Is an EDI-defined code value specifying the weight unit of an associated measurement. example: P hazmatExplosiveContentNetWeight: type: number format: float description: Is the net weight of the explosive quantity of a hazardous commodity. example: 0 billOfLadingHazmatShippingNames: type: array description: 'Hazardous Material Shipping Name Information ' items: type: object properties: billOfLadingHazmatShippingNameSequenceNumber: type: number format: float example: 1 hazmatShippingNameList: type: string description: 'Hazmat Shipping Name List records all the proper shipping names of a hazardous commodity. ' example: ABC hazmatEdiShippingNameQualifierCode: type: string description: 'Is an EDI-defined code value indicating the regulatory source of a hazardous commodity proper shipping name. ' example: N billOfLadingHazmatCommodityEmergencyContacts: type: array description: 'Administrative Communications Contact ' items: type: object properties: billOfLadingHazmatCommodityEmergencyContactSequenceNumber: type: number format: float description: Is needed to uniquely identify a row on the "BOL Hazmat Commodity Emergency Contact" element. example: 1 partyContactEdiFunctionCode: type: string description: 'Is an EDI-defined code value that identifies the major duty or responsibility of an associated person or group. ' example: HM partyContactName: type: string description: 'Party Contact Name is the fully qualified name of a person or office who represents a party to whom communications should be directed. ' example: ABC communicationNumberEdiQualifierCode: type: string description: 'Is an EDI qualifier code that provides context to a communication number. ' example: TE partyContactCommunicationNumber: type: string description: 'Is the complete communications number for a party including country and/or area code when applicable. ' example: '1234567890' billOfLadingHazmatGovernmentRegulations: type: array items: type: object properties: billOfLadingHazmatGovernmentRegulationSequenceNumber: type: number format: float description: Is a sequence number that is needed to uniquely identify a row on the "BOL Hazmat Government Regulation" element. example: 1 hazmatEdiShipmentInformationQualifierCode: type: string description: Is an EDI-defined code value indicating the type of hazmat shipment information being passed so that a receiver may format a description of hazardous commodity movements that meets regulatory requirements. example: MPI hazmatShipmentInformationText: type: string description: Hazmat Line 1 Shipment Information Text is the line 1 information required by law for hazardous material shipments. example: MARINE POLLUTANT hazmatEdiInhalationToxicityHazardZoneCode: type: string description: Is an EDI-defined code value specifying the Department of Transportation assigned Inhalation Toxicity Hazard Zone for an associated hazardous commodity. example: A hazmatEdiRadioactivityUomCode: type: string description: Is an EDI-defined code value specifying the units in which a measurement of radioactivity is being expressed. example: AA hazmatRadioactivityMeasure: type: number format: float description: Hazmat Radioactivity Measure is a numerical measurement of the radioactivity (radioactive decay) of a hazardous commodity. example: 12.11 hazmatTransportIndexNumber: type: number format: float description: Hazmat Transport Index Number is the transport index number for a hazardous commodity. This is a dimensionless number placed on the package label to designate the degree of control to be exercised by the carrier during transportation. example: 12345 billOfLadingHazmatUsepaWasteRegulations: type: array items: type: object properties: billOfLadingHazmatUsepaWasteRegulationSequenceNumber: type: number format: float description: Is a sequence number that is needed to uniquely identify a row on the BOL Hazmat USEPA Waste Regulation table. example: 1 usepaHazardousWasteStreamCode: type: string description: Specifies the waste stream number applicable to the movement of hazardous waste as determined by government regulations and required by the the EPA. example: AAAA billOfLadingHazmatReferences: type: array items: type: object properties: billOfLadingHazmatReferenceSequenceNumber: type: number format: float description: Is a sequence number that in combination with the BOL ID and BOL Hazmat Identification Sequence Number, uniquely identifies a row on the "BOL Hazmat Reference" element. example: 1 hazmatReferenceEdiQualifierCode: type: string description: Is an EDI-defined qualifier code value that provides context to the value present in the 'EDI Reference ID' column. example: AAA hazmatReferenceIdentificationNumber: type: string description: Is a reference identification number for the 'BOL Hazmat Reference' table. example: 12AAAA hazmatCanadianTransportationPermitExpirationDate: type: string format: date description: Is the expiration date of a Transport Canada Equivalence Certificate. example: '2021-12-31' billOfLadingHazmatParties: type: array items: type: object properties: billOfLadingHazmatPartySequenceNumber: type: number format: float description: Is a sequence number that in combination with BOL ID and BOL Hazmat Identification Sequence Number, uniquely identifies a row in the BOL Hazmat Party table. example: 1 hazmatParty: type: object properties: partyRoleCode: type: string description: Party Role Code is an EDI-defined code value specifying the role of an organizational entity, a physical location, or an individual participating with a BOL. example: SH partyName: type: string description: Party Name is the fully qualified name of a party. example: ABC FREIGHT INC partyId: type: string description: Party ID serves as a unique identifier of the person, organization, or organizational component that is of interest to BNSF that can act in a legal capacity. example: 'FREE FORM TEXT ' partyFirstLineAddress: type: string description: Is free-form text specifying the line 1 address information for a location in which a party operates. example: 1234 W 4TH STREET partySecondLineAddress: type: string description: Is free-form text specifying the line 2 address information for a location in which a party operates. example: APT 1234 partyAddressCityName: type: string description: Party Address City Name is the fully qualified name of a city in which a party operates. example: SAN BERNARDINO partyAddressStateCode: type: string description: Is a code value, as defined by the appropriate government agency of the United States, Canada, or Mexico, specifying the state or province in which a party operates. example: CA partyAddressPostalCode: type: string description: Party Address Postal Code is the international postal zone code (excluding punctuation and blanks) identifying the geographical area in which a party operates. example: '92411' partyAddressCountryCode: type: string description: Party Address Country Code is an ISO 3166 code value specifying a country, dependency, or geopolitical area in which a party operates. example: US partyEdiIdentificationQualifierCode: type: string description: Is an EDI-defined code value designating the system/method of code structure of an associated ID used to uniquely identify a party. example: C5 billOfLadingHazmatWastePartyContacts: type: array items: type: object properties: billOfLadingHazmatWastePartyContactSequenceNumber: type: number format: float description: Is a sequence number that is needed to uniquely identify an element in the BOL Hazmat Waste Party Contact complex element. example: 1 partyContactEdiFunctionCode: type: string description: Is an EDI-defined code value that identifies the major duty or responsibility of an associated person or group. example: NT partyContactName: type: string description: Party Contact Name is the fully qualified name of a person or office who represents a party to whom communications should be directed. example: ABC FREIGHT INC communicationNumberEdiQualifierCode: type: string description: Is an EDI qualifier code that provides context to a communication number. example: AB partyCommunicationNumber: type: string description: Party Communication Number is the complete communications number for a party including country and/or area code when applicable. example: '1234567890' billOfLadingHazmatCanadianGovernmentRegulations: type: array items: type: object properties: billOfLadingHazmatCanadianGovernmentRegulationSequenceNumber: type: number format: float description: Is a sequence number that is needed to uniquely identify a row on the "BOL Hazmat Canadian Government Regulation" element. example: 1 hazmatEmergencyResponsePlanId: type: string description: Is the identity number of a specific hazardous emergency response plan that is assigned by the Director General of Canada. example: ER3434 hazmatEmergencyResponsePlanPhoneNumber: type: string description: Is the complete phone number including country or area code that has been provided as part of the associated Canadian emergency response plan. example: 817-999-9999 billOfLadingHazmatCertifications: type: array description: 'Hazardous Certification ' items: type: object properties: billOfLadingHazmatCertificationSequenceNumber: type: number format: float description: Is a sequence number that in combination with the BOL ID, uniquely identifies a row on the BOL Hazmat Certification element. example: 1 hazmatShipmentCertifierName: type: string description: Is name of the person certifying that a hazardous material shipment complies with regulations. example: CHEMTREAT billOfLadingHazmatShipmentEmergencyContacts: type: array items: type: object properties: billOfLadingHazmatShipmentEmergencyContactSequenceNumber: type: number format: float description: Is a sequence number that in combination with the BOL ID, uniquely identifies a row on the BOL Hazmat Shipment Emergency Contact element. example: 1 partyContactEdiFunctionCode: type: string description: Is an EDI-defined code value that identifies the major duty or responsibility of an associated person or group. example: N partyContactName: type: string description: Party Contact Name is the fully qualified name of a person or office who represents a party to whom communications should be directed. example: ABC FREIGHT INC communicationNumberEdiQualifierCode: type: string description: Is an EDI qualifier code that provides context to a communication number. example: AB partyContactCommunicationNumber: type: string description: Is the complete communications number for a party including country and/or area code when applicable. example: '1234567890' billOfLadingProtectiveServiceInstructions: type: array items: type: object properties: billOfLadingProtectiveServiceInstructionSequenceNumber: type: number format: float description: Is a sequence number that plays a part in uniquely identifying an instance of mechanical protective service and ventilation instructions that applies to a shipment. example: 1 protectiveServiceRuleCode: type: string description: Protective Service Rule Code is an AAR-defined code value which specifies a protective service (heating or cooling) that applies to a shipment. example: '705' protectiveServiceEdiCode: type: string description: Is an EDI-defined code value specifying a perishable protective service that applies to a shipment. example: M optimumShipmentTemperatureEdiUomCode: type: string description: Is an EDI-defined code value specifying the units in which a value is being expressed, or manner in which a measurement has been taken. example: CE optimumShipmentTemperature: type: number format: float description: Optimum Shipment Temperature is the optimum allowable temperature condition for a shipment. example: 10 scac: type: string description: SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association). example: BNSF fsac: type: string description: FSAC (Freight Station Accounting Code) is a number assigned to a station that uniquely identifies the station within the context of each reporting railroad (i.e., Different railroads might share identical FSAC numbers). example: BNSF stationCityName: type: string description: Is the fully qualified name of a city where a station that contains a scale is located. example: DENVER stationStateCode: type: string description: Station State Code is a code value, as defined by the appropriate government agency of the United States, Canada, or Mexico, specifying the state or province of a station. example: CO shipmentPrecoolIndicator: type: string description: Indicates whether or not the shipment was precooled per Association of American Railroads (AAR) Protective Service Rule 710. example: A equipmentEdiHeaterLocationCode: type: string description: Is an EDI-defined code value to specify the heater location for freight conveyance equipment requiring protective service. example: Y foodCommodityShipmentEdiIndicatorCode: type: string description: Is an EDI-defined code value to identify whether or not an associated commodity is a food product. example: Y equipmentEdiDoorwaySpaceWidthCode: type: string description: Is an 'EDI' defined code value which specifies the amount of doorway space for the full width of a car. example: N protectiveServiceShipmentOriginTemperature: type: number format: float description: Specifies the temperature of a shipment requiring a protective service at the origin location. example: 10 billOfLadingIntermodalChassisEquipment: type: object properties: chassisId: type: string description: Serves as an identifier for a piece of freight conveyance equipment. It consists of a 4-character equipment initial followed by an up to 15-character equipment unit identifying number. example: BNSF123456 chassisOwnerScac: type: string description: Chassis Owner SCAC is the standard carrier alpha code for the owner of the associated freight conveyance equipment. example: BNSF chassisLesseeScac: type: string description: Chassis Lessee SCAC is the standard carrier alpha code for the lessee of the associated freight conveyance equipment. example: BNSF chassisTareWeight: type: number format: float description: Chassis Tare Weight is the weight of an empty rail shipping container or vehicle. Sometimes called the unladen weight. example: 2300 chassisTareQualifierCode: type: string description: Is the code identifying the type of tare weight of an empty rail shipping container or vehicle. Sometimes called the unladen weight. example: A chassisExteriorLengthFeetInches: type: string description: Chassis Exterior Length Feet Inches is the length (in feet and inches) of equipment ordered or used to transport shipment. example: '5300' billOfLadingChassisTypeCode: type: string description: BOL Chassis Type Code is a BNSF-defined code value which specifies the type of rail conveyance equipment (Intermodal or Railcar) applicable to a particular operating partner agreement. example: 8P chassisCheckDigitNumber: type: string description: Chassis Check Digit Number designates the check digit applied to a piece of equipment, which serves as a form of redundancy check used for error detection. example: '1' billOfLadingCanadaCustomsExport: type: object properties: shipmentSpecialChargeEdiCurrencyCode: type: string description: Shipment Special Charge EDI Currency Code is an EDI-defined code value specifying the Standard ISO code for country in whose currency the charges are specified. example: USD transactionEdiRelatedCompanyIndicator: type: string description: Transaction EDI Related Company Indicator specifies whether the two parties in a transaction are related. shipmentSpecialChargeEdiQualifierCode: type: string description: Shipment Special Charge EDI Qualifier Code is an EDI-defined code value specifying the type of special charge or allowance associated with a shipment. ('595' = Proforma Invoice, 'FCB' = Freight Changes to Border, 'FCD' = Freight Changes to Destination) example: '595' shipmentSpecialChargeAmount: type: number format: float description: Shipment Special Charge Amount is the total monetary amount of a special charge included on the total invoice for a shipment, in the standard monetary denomination for the currency specified. example: 123 portEdiBlockTwentyQualifierCode: type: string description: Port EDI Block Twenty Qualifier Code is an EDI-defined code value used to define Block 20 characteristics. example: '1' commodityChemicalAnalysisPercentage: type: number format: float description: Chemical Analysis Percentage is a percentage of a specific chemical component that makes up a complete product, which is required to be reported by U.S. and Canada Customs. example: 2.1 ladingUnitPrice: type: number format: float description: Lading Unit Price is the price per unit of a commodity. example: 22.2 billOfLadingCustomsInformation: type: array items: type: object properties: billOfLadingCustomsInformationSequenceNumber: type: number format: float description: Is a sequence number that in combination with BOL ID, uniquely identifies a row in the BOL Customs Information element. example: 1 billOfLadingCustomsInformationFirstLineText: type: string example: FREE FORM TEXT billOfLadingCustomsInformationSecondLineText: type: string example: FREE FORM TEXT responses: '504': description: '**Gateway Timeout** The server is acting as a gateway and cannot get a response in time for a request. Wait about one minute then try again.' '429': description: "**Too Many Requests**\n\nThe BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows:\n* 1 API Request Per Second, Per Partner, Per Service\n* 15 API Requests Per Minute, Per Partner, Per Service\n* 100 API Request Per Minute, Per Service\n \nWhen requests exceed these limits the API Gateway will return a **429 Too Many Requests** error response. Upon receiving such exceptions, you can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits. " '405': description: '**Method Not Allowed** The request HTTP method is known by the server but has been disabled and cannot be used for that resource. For example, you may be using GET when POST is required. Please consult the documentation.' '404': description: '**Not Found** The server cannot find the requested resource (URI). That is, the address of the endpoint in your request does not exist. Please consult the documentation.' '400': description: '**Bad Request** The request could not be understood by the server due to incorrect syntax. Do not repeat the request without modifications.' '500': description: '**Internal Server Error** The server encountered an unexpected condition which prevented it from fulfilling the request. This is always a problem on the server side. Our internal support systems will be made aware.' '403': description: "Unauthorized request. Here are the most common causes:\n \n* You are getting 403 Access Denied.\n\n * It takes a few days for us to get you set up after you register. When set up is complete, you will receive an email letting you know. If you have not received the email, please wait up to five business days. Let us know via API Support if you still have not received the email after five business days.\n * You can also get this error if your certificate is not configured properly on your side. Please review the Mutual Authentication in the Getting Started section of our documentation.\n\n\n* You are getting 403 \"message\": \"Insufficient privileges\" when accessing a restricted service for which you do not have permission. You can use our Registration form to request access. Be sure to explain the situation in the \"Please explain how you intend to use the API\" field.\n" parameters: Vin: name: vin in: path description: Vehicle Identification Number (VIN) is a unique, standardized, alphanumeric ID used by the automotive industry to identify individual motor vehicles. required: true schema: type: string title: vin description: A Vehicle Identification Number (VIN) is a unique, standardized alphanumeric ID used by the automotive industry to identify individual motor vehicles. example: 1FMSK7DH6PGC01166 example: 1FMSK7DH6PGC01166 Gate_Pass_Code: name: gatePassCode in: path description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. required: true schema: type: string title: gatePassCode description: Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique. example: '20349891' example: '20349891' AAR_Ramp_Code: name: aarRampCode in: path description: Code assigned by the AAR (Association Of American Railroads) that uniquely identifies automotive ramps used in loading and unloading trains throughout North America. required: true schema: type: string title: aarRampCode description: A code assigned by the AAR (Association of American Railroads) that uniquely identifies automotive ramps used for loading and unloading trains throughout North America. example: AZ007 example: IL022 requestBodies: flipInputList: content: application/json: schema: type: object title: Schema properties: flipInputList: type: array title: flipInputList items: type: object properties: equipmentInitial: type: string example: BNSF equipmentNumber: type: string example: '12345' station333: type: string example: DALLAS stationStateCode: type: string example: TX minItems: 1 maxItems: 300 drayPlanListUnits: content: application/json: schema: type: object properties: intermodalUnits: type: array title: intermodalUnits items: type: object properties: equipmentInitial: type: string title: Equipment Initial description: Equipment Initial is the prefix or alphabetic part of an equipment units identifying number. example: ABCD equipmentNumber: type: string title: Equipment Number description: Equipment Number is the sequencing or serial part of an equipment units identifying number. example: '12345' updateParkingInput: content: application/json: schema: type: object title: Schema properties: equipmentInitial: type: string example: BNSF equipmentLotLocationName: type: string example: A equipmentLotRowLocationName: type: string example: A equipmentLotRowSpotLocationName: type: string example: A equipmentNumber: type: string example: '12345' station333: type: string example: DALLAS stationStateCode: type: string example: TX truckerDriverLicenseNumber: type: string example: '12345' truckerDriverLicenseStateCode: type: string example: TX Post_Invoice: content: application/json: schema: type: object required: - patronCodeList properties: billOfLadingList: type: array items: type: string description: Filter based on list of values provided on shipper's bill of lading Identifier. example: '999999' destinationList: type: array items: type: string description: Filter based on list of destination names provided. It is the name of destination city that was used to rate a shipment. example: ARCO, WA equipmentIdList: type: array items: type: string description: 'Filter based on Equipment Id in Invoice. Equipment Id is the combination of Equipment Initial and Equipment Number. Equipment List is the prefix or alphabetic part of an equipment units identifying number. This is used when there is no requirement for a specific type of equipment. i.e. locomotives, box cars, gondolas, flats, vans, etc. Equipment Number used with equipment initials to uniquely identify equipment. This is used when there is no specific requirement for a specific type of equipment. ' example: MBLX34238 fromDueDate: type: string description: Filter based on Due Date of bill - begin range example: '2023-01-29' fromInvoiceDate: type: string description: Filter based on Invoice Date of bill - begin range example: '2023-01-29' fromWayBillDate: type: string description: Filter based on Waybill Date of bill - begin range example: '2023-01-29' invoiceNumberList: type: array items: type: string description: Filter based on list of Invoice Number provided .Invoice Number that uniquely identifies a bill regardless of the type of bill. example: '999999999' invoiceTypeList: type: array items: type: string description: Filter based on type of invoices, Right now only "Freight" type is supported. example: Freight originList: type: array items: type: string description: Filter based on list of origin names provided, origin name is the name of the origin city that was used to rate a shipment. example: AMELIA, TX patronCodeList: type: array description: 'Filter based on patron code in bill, Accepts list of patron codes. An approved patron code represents a customer who ships (or wants to ship) with BNSF and has established a credit arrangement with the BNSF treasury department. ' items: type: string description: 'Filter based on patron code in bill, Accepts list of patron codes. An approved patron code represents a customer who ships (or wants to ship) with BNSF and has established a credit arrangement with the BNSF treasury department. ' example: 0108990041 rateAuthorityList: type: array items: type: string description: Filter based on rate authority in the bill. example: BNSFC999999999999999999999 stccList: type: array items: type: string description: 'Filter based on List of STCC .STCC (Standard Transportation Commodity Code) number identifying a Commodity. Note: STCC_NUMBER is the combination of Product Classification (PROD_CLS) and Product Classification Number (PROD_CLS_NBR).Note: The STCC (Standard Transportation Commodity Code) is a publication containing specific product information used on waybills and other shipping documents. A STCC code is a seven digit numeric code representing 38 commodity groupings. Assignment of a STCC Code is associated by a commodity description developed to conform with exact descriptions in freight transportation classifications of rail and motor carriers.' example: '4905752' toDueDate: type: string description: Filter based on Due Date of bill - end range example: '2023-01-29' toInvoiceDate: type: string description: Filter based on Invoice Dates of bill - end range example: '2023-01-31' toWayBillDate: type: string description: Filter based on Waybill Date of bill - end range example: '2023-01-29' tracerList: type: array items: type: string description: Filter based on tracer number if anything assigned to the invoices. example: '99999999999' wayBillNumberList: type: array items: type: string description: Filter based on waybill numbers provided in list. The number the shipper (issuing company) has placed on a Waybill. example: '999999' additionalProperties: false Post_Rates: content: application/json: schema: type: object required: - priceAuthorityNumber - priceAuthorityOwnerIssuedName properties: priceAuthorityItemNumber: type: number format: float description: 'A number that Identifies an Owner Issued Item (or Implementing Agreement) which is used to identify a more granular reference to a given price when combined with the Owner ID, Owner Issued Name, and Owner Issued Number. Marketing sometimes divides a given Price Authority into what might be referred to as sub-authorities which are identified by a given Owner Issued Item Number. The only characters allowed in the number are zero (0) through nine (9) and one decimal point (if needed). The number must not exceed ten (10) characters in length; a decimal point counts as a character. The number of positions to the right of the decimal point must not exceed four (4) characters: eg, ''00123.4567'' would be valid. If a Price Authority does not actually have a item number, then the item number will be set to '' '' (Blank). ' example: 100 priceAuthorityNumber: type: number format: float example: 105355 priceAuthorityOwnerIssuedName: type: string description: 'A name must be assigned by the Owner of a Price Authority which is combined with the Owner''s ID, an Owner Issued Number, and an optional Owner Issued Item Number to help uniquely identify an official document (Authority) containing price(s) for shipment(s). It may consist of any alpha numeric character string excluding special characters, which may be a minimum of one character and a maximum of ten characters in length; examples include: BNSF, BNSFQ, QTYELLOW, C, CIRC, NSPQ, MA42MW, etc. ' example: BNSFQ searchDate: type: string description: If not entered, then current date is used or else Search Date should be today or future date only. example: '2021-09-01' additionalProperties: false Post_oD_Pairs: content: application/json: schema: type: object required: - effectiveDate - oDPairsList - stcc properties: effectiveDate: type: string format: date description: ' Shipment date to be considered for pulling the miles' example: '2025-10-12' oDPairsList: type: array items: type: object required: - destinationCity - destinationState - originCity - originState properties: destinationCity: type: string description: Destination station identifier example: HOUSTON destinationState: type: string description: Destination state identifier example: TX originCity: type: string description: Origin station identifier example: CHICAGO originState: type: string description: Origin state identifier example: IL additionalProperties: false stcc: type: string description: '7 digit STCC (Standard Transportation Commodity Code) number identifying a Commodity. ' example: '1111110' additionalProperties: false requestBody: content: application/json: schema: type: object properties: equipmentList: type: array items: type: object properties: equipmentId: type: string example: AEAX2011 equipmentSpeedRestrictionLoadEmptyStatusCode: type: string example: L equipmentSpeedRestrictionCode: type: string example: E x-refined-from: - bnsf-automotive-hub-operations-openapi.json - bnsf-diagnostics-openapi.json - bnsf-intermodal-hub-operations-openapi.json - bnsf-prices-openapi.json - bnsf-reference-files-openapi.json - bnsf-schedules-openapi.json - bnsf-waybill-openapi.json