{"items":[{"type":"group","fsPath":"pregate/overview.md","metadata":{"type":"markdown"},"label":"Pre-Gate","link":"/pregate/overview","routeSlug":"/pregate/overview","items":[{"type":"link","label":"eModal.TermOps.PregateGatewayAPI","link":"/pregate/openapi","routeSlug":"/pregate/openapi"},{"type":"group","label":"Appointments","link":"/pregate/openapi/appointments","routeSlug":"/pregate/openapi/appointments","items":[{"label":"About - Information about message about this API","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pregate/openapi/appointments/paths/~1api~1appointment~1about/get","routeSlug":"/pregate/openapi/appointments/paths/~1api~1appointment~1about/get","metadata":{"seo":{"title":"About - Information about message about this API","description":"About - Information about message about this API"}},"httpPath":"/api/appointment/about"},{"label":"GetAppointments - Get list of appointments based on the provided search criteria","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pregate/openapi/appointments/paths/~1api~1appointment~1getappointments/post","routeSlug":"/pregate/openapi/appointments/paths/~1api~1appointment~1getappointments/post","metadata":{"seo":{"title":"GetAppointments - Get list of appointments based on the provided search criteria","description":"This API queries the appointment database to return appointments matching the specified filters.Results are paginated and sorted by appointment start date (descending), then by truck visit ID (descending)."}},"httpPath":"/api/appointment/getappointments"},{"label":"TruckVisitDetails - Get detailed appointment information for a specific truck visit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pregate/openapi/appointments/paths/~1api~1appointment~1truckvisitdetails/get","routeSlug":"/pregate/openapi/appointments/paths/~1api~1appointment~1truckvisitdetails/get","metadata":{"seo":{"title":"TruckVisitDetails - Get detailed appointment information for a specific truck visit","description":"This API queries the appointment database to return comprehensive visit-level and move-level detailsfor the specified truck visit ID, including associated validation messages for each move."}},"httpPath":"/api/appointment/truckvisitdetails"},{"label":"GetCompanyInfo - Get all company information for the authenticated user based on their affiliations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pregate/openapi/appointments/paths/~1api~1appointment~1getcompanyinfo/get","routeSlug":"/pregate/openapi/appointments/paths/~1api~1appointment~1getcompanyinfo/get","metadata":{"seo":{"title":"GetCompanyInfo - Get all company information for the authenticated user based on their affiliations","description":"This API returns a list of all trucking companies the authenticated user has access to,derived from their UserAffiliations for the current application context. Only companieswith a CompanyType_Cd of \"T\" (Trucking) are included.The primary company is listed first, followed by remaining companies sorted alphabetically by name."}},"httpPath":"/api/appointment/getcompanyinfo"},{"label":"GetAvailableTimeSlots - Get available appointment time slots based on the provided visit and move details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pregate/openapi/appointments/paths/~1api~1appointment~1getavailabletimeslots/post","routeSlug":"/pregate/openapi/appointments/paths/~1api~1appointment~1getavailabletimeslots/post","metadata":{"seo":{"title":"GetAvailableTimeSlots - Get available appointment time slots based on the provided visit and move details","description":"This API performs a two-step process:"}},"httpPath":"/api/appointment/getavailabletimeslots"},{"label":"GetBookingDetails - Get booking details for the specified booking numbers and optional terminal operator","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pregate/openapi/appointments/paths/~1api~1appointment~1getbookingdetails/post","routeSlug":"/pregate/openapi/appointments/paths/~1api~1appointment~1getbookingdetails/post","metadata":{"seo":{"title":"GetBookingDetails - Get booking details for the specified booking numbers and optional terminal operator","description":"This API retrieves booking/EDO details from the BRE API for a given list of booking numbers."}},"httpPath":"/api/appointment/getbookingdetails"},{"label":"CreateUpdateAppointment - Creates or updates appointments with a lighter payload designed for external APIM consumers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pregate/openapi/appointments/paths/~1api~1appointment~1createupdateappointment/post","routeSlug":"/pregate/openapi/appointments/paths/~1api~1appointment~1createupdateappointment/post","metadata":{"seo":{"title":"CreateUpdateAppointment - Creates or updates appointments with a lighter payload designed for external APIM consumers","description":"This API is called by external customers through APIM. APIM authenticates the client and derivesthe Bearer Token and Request Source Identifier, which are passed to this API via request headers."}},"httpPath":"/api/appointment/createupdateappointment"},{"label":"CancelAppointment - Cancels appointment moves or an entire visit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pregate/openapi/appointments/paths/~1api~1appointment~1cancelappointment/post","routeSlug":"/pregate/openapi/appointments/paths/~1api~1appointment~1cancelappointment/post","metadata":{"seo":{"title":"CancelAppointment - Cancels appointment moves or an entire visit","description":"Cancels either individual moves or the entire appointment (visit) depending on the provided input.Supports two ways of identifying what should be canceled:"}},"httpPath":"/api/appointment/cancelappointment"}]},{"type":"link","fsPath":"pregate/reference.md","metadata":{"type":"markdown"},"label":"Pre-Gate Reference Tables","link":"/pregate/reference","routeSlug":"/pregate/reference"}]},{"type":"group","fsPath":"sprintpay/overview.md","metadata":{"type":"markdown"},"label":"SprintPay","link":"/sprintpay/overview","routeSlug":"/sprintpay/overview","items":[{"type":"link","label":"API Reference","link":"/sprintpay/openapi","routeSlug":"/sprintpay/openapi"},{"type":"link","label":"Authentication","link":"/sprintpay/openapi/section/authentication","routeSlug":"/sprintpay/openapi/section/authentication"},{"type":"link","label":"Environments","link":"/sprintpay/openapi/section/environments","routeSlug":"/sprintpay/openapi/section/environments"},{"type":"link","label":"Requests and responses","link":"/sprintpay/openapi/section/requests-and-responses","routeSlug":"/sprintpay/openapi/section/requests-and-responses"},{"type":"link","label":"Errors","link":"/sprintpay/openapi/section/errors","routeSlug":"/sprintpay/openapi/section/errors"},{"type":"link","label":"Not currently supported","link":"/sprintpay/openapi/section/not-currently-supported","routeSlug":"/sprintpay/openapi/section/not-currently-supported"},{"type":"group","label":"Oauth","link":"/sprintpay/openapi/oauth","routeSlug":"/sprintpay/openapi/oauth","items":[{"label":"Get Authorization Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpay/openapi/oauth/getauthorizationtoken","routeSlug":"/sprintpay/openapi/oauth/getauthorizationtoken","metadata":{"seo":{"title":"Get Authorization Token","description":"Exchange client credentials for an access token. Send the credentials using HTTP Basic authentication."}},"httpPath":"/oauth2/token"}]},{"type":"group","label":"Facilities","link":"/sprintpay/openapi/facilities","routeSlug":"/sprintpay/openapi/facilities","items":[{"label":"Get All Facilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpay/openapi/facilities/getfacilities","routeSlug":"/sprintpay/openapi/facilities/getfacilities","metadata":{"seo":{"title":"Get All Facilities","description":"Search the facility catalog. Supply at least one filter. Results are paginated."}},"httpPath":"/facilities"},{"label":"Get Facility Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpay/openapi/facilities/getfacility","routeSlug":"/sprintpay/openapi/facilities/getfacility","metadata":{"seo":{"title":"Get Facility Details","description":"Retrieve a single facility. When the facility is served by an integration, the response includes an integration block giving the supported operations, the query fields required to fetch charges, and any constraints on which shipments the integration handles. A facility without that block is paid directly, with no charge lookup."}},"httpPath":"/getFacility/{id}"},{"label":"Get Shipment Charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpay/openapi/facilities/getfacilitycharges","routeSlug":"/sprintpay/openapi/facilities/getfacilitycharges","metadata":{"seo":{"title":"Get Shipment Charges","description":"Retrieve the charges an integration holds for a shipment. Call this before paying a facility that has an integration block, then submit the returned charges in the payment request. Build the request from the operations and queryFields advertised on that block."}},"httpPath":"/facility/{facilityId}/lookup"}]},{"type":"group","label":"Cart","link":"/sprintpay/openapi/cart","routeSlug":"/sprintpay/openapi/cart","items":[{"label":"Make Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpay/openapi/cart/makepayment","routeSlug":"/sprintpay/openapi/cart/makepayment","metadata":{"seo":{"title":"Make Payment","description":"Submit one or more payments. Each item is processed independently: the HTTP status remains 200 and unsuccessful items are returned with saleStatus of ERROR, so every element of the response should be inspected."}},"httpPath":"/payment"}]},{"type":"group","label":"Invoices","link":"/sprintpay/openapi/invoices","routeSlug":"/sprintpay/openapi/invoices","items":[{"label":"Get Invoice Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpay/openapi/invoices/getinvoicedetails","routeSlug":"/sprintpay/openapi/invoices/getinvoicedetails","metadata":{"seo":{"title":"Get Invoice Details","description":"Retrieve invoice details for a transaction. Invoices are produced on the nightly billing cycle, so an invoice may not be available immediately after a payment."}},"httpPath":"/external/invoices/details"},{"label":"Get Invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpay/openapi/invoices/getinvoices","routeSlug":"/sprintpay/openapi/invoices/getinvoices","metadata":{"seo":{"title":"Get Invoices","description":"Download the invoice for a transaction as a PDF or XLSX document."}},"httpPath":"/external/downloadInvoices"}]},{"type":"group","label":"Payments","link":"/sprintpay/openapi/payments","routeSlug":"/sprintpay/openapi/payments","items":[{"label":"Get Payment Confirmation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpay/openapi/payments/getpaymentconfirmation","routeSlug":"/sprintpay/openapi/payments/getpaymentconfirmation","metadata":{"seo":{"title":"Get Payment Confirmation","description":"Download the payment confirmation document for a completed transaction."}},"httpPath":"/external/paymentConfirmation"}]}]},{"type":"group","fsPath":"sprintpasspro/overview.md","metadata":{"type":"markdown"},"label":"SprintPass Pro","link":"/sprintpasspro/overview","routeSlug":"/sprintpasspro/overview","items":[{"type":"group","fsPath":"sprintpasspro/ApiSpec.md","metadata":{"type":"markdown"},"label":"API Specification","link":"/sprintpasspro/apispec","routeSlug":"/sprintpasspro/apispec","items":[{"type":"group","label":"Orchestration Specification","items":[{"type":"link","label":"Orchestration API","link":"/sprintpasspro/sprintpassproapi","routeSlug":"/sprintpasspro/sprintpassproapi"},{"type":"group","label":"SprintPassPro","link":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration","routeSlug":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration","items":[{"label":"Submit One or More Orchestration Requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations/post","routeSlug":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations/post","metadata":{"seo":{"title":"Submit One or More Orchestration Requests","description":"Types of orchestrations:"}},"httpPath":"/v1/orchestrations"},{"label":"Cancel Orchestration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1{tradetype}~1unit-nbr~1{unitnbr}/delete","routeSlug":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1{tradetype}~1unit-nbr~1{unitnbr}/delete","metadata":{"seo":{"title":"Cancel Orchestration","description":"Canceling an orchestration."}},"httpPath":"/v1/orchestrations/trade-type/{tradeType}/unit-nbr/{unitNbr}"},{"label":"Update Orchestration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/updateorchestration","routeSlug":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/updateorchestration","metadata":{"seo":{"title":"Update Orchestration","description":"Updating an orchestration."}},"httpPath":"/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/locations/{location_type}"},{"label":"Cancel Appointment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1{trade_type}~1unit-nbr~1{unit_nbr}~1locations~1{location_type}/delete","routeSlug":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1{trade_type}~1unit-nbr~1{unit_nbr}~1locations~1{location_type}/delete","metadata":{"seo":{"title":"Cancel Appointment","description":"An appointment can be canceled."}},"httpPath":"/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/locations/{location_type}"},{"label":"Orchestration Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1{trade_type}~1unit-nbr~1{unit_nbr}~1orchestration-status/get","routeSlug":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1{trade_type}~1unit-nbr~1{unit_nbr}~1orchestration-status/get","metadata":{"seo":{"title":"Orchestration Status","description":"Trade Type. I=Import, E=Export."}},"httpPath":"/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/orchestration-status"},{"label":"Unit Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1{trade_type}~1unit-nbr~1{unit_nbr}~1unit-status/get","routeSlug":"/sprintpasspro/sprintpassproapi/sprintpasspro_sprintpassproorchestration/paths/~1v1~1orchestrations~1trade-type~1{trade_type}~1unit-nbr~1{unit_nbr}~1unit-status/get","metadata":{"seo":{"title":"Unit Status","description":"Unit status endpoint."}},"httpPath":"/v1/orchestrations/trade-type/{trade_type}/unit-nbr/{unit_nbr}/unit-status"}]},{"type":"link","fsPath":"sprintpasspro/basic_examples.md","metadata":{"type":"markdown"},"label":"Basic Examples","link":"/sprintpasspro/basic_examples","routeSlug":"/sprintpasspro/basic_examples"},{"type":"link","fsPath":"sprintpasspro/reservation_preferences_examples.md","metadata":{"type":"markdown"},"label":"Reservation Preferences Examples","link":"/sprintpasspro/reservation_preferences_examples","routeSlug":"/sprintpasspro/reservation_preferences_examples"},{"type":"link","fsPath":"sprintpasspro/update_orchestration_examples.md","metadata":{"type":"markdown"},"label":"Update Orchestration Examples","link":"/sprintpasspro/update_orchestration_examples","routeSlug":"/sprintpasspro/update_orchestration_examples"}],"expanded":"true"},{"type":"group","label":"Receiving Status Updates from the Orchestration","items":[{"type":"link","fsPath":"sprintpasspro/orchestration_updates.md","metadata":{"type":"markdown"},"label":"Orchestration Status Notifications","link":"/sprintpasspro/orchestration_updates","routeSlug":"/sprintpasspro/orchestration_updates"},{"type":"link","fsPath":"sprintpasspro/container_status.md","metadata":{"type":"markdown"},"label":"Container Status","link":"/sprintpasspro/container_status","routeSlug":"/sprintpasspro/container_status"},{"type":"link","fsPath":"sprintpasspro/orchestration_status_empty_returns.md","metadata":{"type":"markdown"},"label":"Orchestration Status for Empty Returns","link":"/sprintpasspro/orchestration_status_empty_returns","routeSlug":"/sprintpasspro/orchestration_status_empty_returns"},{"type":"link","fsPath":"sprintpasspro/orchestration_status_off_dock.md","metadata":{"type":"markdown"},"label":"Orchestration Status for Off-dock Locations","link":"/sprintpasspro/orchestration_status_off_dock","routeSlug":"/sprintpasspro/orchestration_status_off_dock"},{"type":"link","fsPath":"sprintpasspro/orchestration_status_dual.md","metadata":{"type":"markdown"},"label":"Orchestration Status for Dual Transactions","link":"/sprintpasspro/orchestration_status_dual","routeSlug":"/sprintpasspro/orchestration_status_dual"}],"expanded":"true"},{"type":"group","label":"Use Cases","items":[{"type":"link","fsPath":"sprintpasspro/use_cases.md","metadata":{"type":"markdown"},"label":"Use Cases","link":"/sprintpasspro/use_cases","routeSlug":"/sprintpasspro/use_cases"},{"type":"link","fsPath":"sprintpasspro/trace_and_book.md","metadata":{"type":"markdown"},"label":"Start Tracing Book Later","link":"/sprintpasspro/trace_and_book","routeSlug":"/sprintpasspro/trace_and_book"}],"expanded":"true"},{"type":"group","label":"Status Codes, Errors and Warnings","items":[{"type":"link","fsPath":"sprintpasspro/errors_and_warnings.md","metadata":{"type":"markdown"},"label":"Error and Warnings","link":"/sprintpasspro/errors_and_warnings","routeSlug":"/sprintpasspro/errors_and_warnings"},{"type":"link","fsPath":"sprintpasspro/status_codes.md","metadata":{"type":"markdown"},"label":"Status Codes","link":"/sprintpasspro/status_codes","routeSlug":"/sprintpasspro/status_codes"}]},{"type":"group","label":"Useful information","items":[{"type":"link","fsPath":"sprintpasspro/ports_and_terminals.md","metadata":{"type":"markdown"},"label":"Ports and Terminals Supported by Orchestration API","link":"/sprintpasspro/ports_and_terminals","routeSlug":"/sprintpasspro/ports_and_terminals"}]}]}]},{"type":"group","fsPath":"data-services/overview.md","metadata":{"type":"markdown"},"label":"Data Services","link":"/data-services/overview","routeSlug":"/data-services/overview","items":[{"type":"link","label":"Data Services API","link":"/data-services/swagger","routeSlug":"/data-services/swagger"},{"type":"group","label":"TerminalMetrics","link":"/data-services/swagger/terminalmetrics","routeSlug":"/data-services/swagger/terminalmetrics","items":[{"label":"Retrieve Information About Terminals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/data-services/swagger/terminalmetrics/terminals","routeSlug":"/data-services/swagger/terminalmetrics/terminals","metadata":{"seo":{"title":"Retrieve Information About Terminals","description":"This endpoint returns information about individual terminals including terminal name/code/ID, supported move types (pickup, drop off, etc.), and appointment type (slot vs pre-advice). This information is required to query specific terminal appointment availability or dwell statistics."}},"httpPath":"/terminalmetrics/v{version}/terminals"},{"label":"Retrieve Metrics About Appointment Availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/data-services/swagger/terminalmetrics/terminals/{terminal_id}/apptavailability","routeSlug":"/data-services/swagger/terminalmetrics/terminals/{terminal_id}/apptavailability","metadata":{"seo":{"title":"Retrieve Metrics About Appointment Availability","description":"This API endpoint returns appointment availability statistics for time slotted appointments. This API returns data only for the time slotted appointment move types and does not include pre-advice information as it is not applicable as an appointment availability statistic. The response will contain appointment availability data starting with the current date and 7 days into the future and contain a listing of available and booked appointments by move type and time slot for a specific terminal."}},"httpPath":"/terminalmetrics/v{version}/terminals/{terminal_id}/apptavailability"},{"label":"Retrieve Information About Terminal Dwell Statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/data-services/swagger/terminalmetrics/containerdwelltime","routeSlug":"/data-services/swagger/terminalmetrics/containerdwelltime","metadata":{"seo":{"title":"Retrieve Information About Terminal Dwell Statistics","description":"This API endpoint provides information about container dwell time in a specific terminal. The dwelling time is calculated as an average dwell within the specified date range. Dwell time is average time spent in hours on the terminal between containers discharge date and gate out date or from discharge to current dwell time on terminal."}},"httpPath":"/terminalmetrics/v{version}/terminals/{terminal_id}/containerdwelltime"},{"label":"Retrieves Appointment Performance Metrics for a Specific Terminal within a Given Date Range.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/data-services/swagger/terminalmetrics/apptperformance","routeSlug":"/data-services/swagger/terminalmetrics/apptperformance","metadata":{"seo":{"title":"Retrieves Appointment Performance Metrics for a Specific Terminal within a Given Date Range.","description":"This endpoint returns aggregated appointment performance data for the specified terminal and date range. The response includes appointment counts and related statistics."}},"httpPath":"/terminalmetrics/v{version}/terminals/{terminal_id}/apptperformance"}]}]}]}