{"items":[{"type":"link","fsPath":"docs/@v2025-07-01/Overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/docs/v2025-07-01/overview","routeSlug":"/docs/v2025-07-01/overview","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-07-01/Authorization.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/docs/v2025-07-01/authorization","routeSlug":"/docs/v2025-07-01/authorization","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-07-01/Versioning.md","metadata":{"type":"markdown"},"label":"Versioning","link":"/docs/v2025-07-01/versioning","routeSlug":"/docs/v2025-07-01/versioning","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","version":"v2025-07-01","versionFolderId":"a2557b8d","label":"Load Sync","items":[{"type":"link","fsPath":"docs/@v2025-07-01/LoadSync/GetStarted.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/docs/v2025-07-01/loadsync/getstarted","routeSlug":"/docs/v2025-07-01/loadsync/getstarted","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-07-01/LoadSync/Errors.md","metadata":{"type":"markdown"},"label":"Error Codes","link":"/docs/v2025-07-01/loadsync/errors","routeSlug":"/docs/v2025-07-01/loadsync/errors","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-07-01/LoadSync/IntegrationValidation.md","metadata":{"type":"markdown"},"label":"Integration Validation","link":"/docs/v2025-07-01/loadsync/integrationvalidation","routeSlug":"/docs/v2025-07-01/loadsync/integrationvalidation","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-07-01","versionFolderId":"a2557b8d","label":"Webhooks","items":[{"type":"link","fsPath":"docs/@v2025-07-01/Webhooks/GetStarted.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/docs/v2025-07-01/webhooks/getstarted","routeSlug":"/docs/v2025-07-01/webhooks/getstarted","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-07-01/Webhooks/EventTypes.md","metadata":{"type":"markdown"},"label":"Event Types","link":"/docs/v2025-07-01/webhooks/eventtypes","routeSlug":"/docs/v2025-07-01/webhooks/eventtypes","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-07-01","versionFolderId":"a2557b8d","label":"Tracking Visibility","items":[{"type":"link","fsPath":"docs/@v2025-07-01/TrackingVisibility/GetStarted.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/docs/v2025-07-01/trackingvisibility/getstarted","routeSlug":"/docs/v2025-07-01/trackingvisibility/getstarted","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-07-01","versionFolderId":"a2557b8d","label":"Changes","items":[{"type":"link","fsPath":"docs/@v2025-07-01/Changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/docs/v2025-07-01/changelog","routeSlug":"/docs/v2025-07-01/changelog","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-07-01","versionFolderId":"a2557b8d","label":"Brokers API","items":[{"type":"link","label":"Brokers","link":"/docs/v2025-07-01/2025-07-01.api","routeSlug":"/docs/v2025-07-01/2025-07-01.api","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","label":"carrierEligibility","link":"/docs/v2025-07-01/2025-07-01.api/carriereligibility","routeSlug":"/docs/v2025-07-01/2025-07-01.api/carriereligibility","items":[{"label":"Set or update carrier's eligibility to match a broker's loads on the Convoy Platform.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/carriereligibility/post-broker-carrier-eligibility","routeSlug":"/docs/v2025-07-01/2025-07-01.api/carriereligibility/post-broker-carrier-eligibility","metadata":{"seo":{"title":"Set or update carrier's eligibility to match a broker's loads on the Convoy Platform.","description":"The api takes an array of Carrier Matching Eligibilities each with a DOT number and Eligibility Status.Carriers with a status of DO_NOT_USE will no longer be able to match to your loads on the Convoy platform.Carriers with QUALIFIED will be allowed to match.Carriers with a QUALIFIED status do not need to be explicitly sent, only if they have transitioned from a DO_NOT_USE status."}},"httpPath":"/carrierEligibility","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"}],"version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","label":"accounting","link":"/docs/v2025-07-01/2025-07-01.api/accounting","routeSlug":"/docs/v2025-07-01/2025-07-01.api/accounting","items":[{"label":"Return all credit memos associated to the batch debit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/accounting/batchdebits_get-batch-debits-credit-memos","routeSlug":"/docs/v2025-07-01/2025-07-01.api/accounting/batchdebits_get-batch-debits-credit-memos","metadata":{"seo":{"title":"Return all credit memos associated to the batch debit","description":"Returns all credit memos associated to a batch debit specified by the id.The number of credit memos can be large (e.g. 10k credit memos), so you mustpaginate."}},"httpPath":"/batchDebits/{id}/creditMemos","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Return all invoices associated to the batch debit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/accounting/batchdebits_get-batch-debits-invoices","routeSlug":"/docs/v2025-07-01/2025-07-01.api/accounting/batchdebits_get-batch-debits-invoices","metadata":{"seo":{"title":"Return all invoices associated to the batch debit","description":"Returns all invoices associated to a batch debit specified by the id.The number of invoices can be large (e.g. 10k invoices), so you must paginate."}},"httpPath":"/batchDebits/{id}/invoices","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"}],"version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","label":"integration","link":"/docs/v2025-07-01/2025-07-01.api/integration","routeSlug":"/docs/v2025-07-01/2025-07-01.api/integration","items":[{"label":"Retrieve broker integration credentials","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/integration/integration_broker-integration-credentials","routeSlug":"/docs/v2025-07-01/2025-07-01.api/integration/integration_broker-integration-credentials","metadata":{"seo":{"title":"Retrieve broker integration credentials","description":"Retrieve the credentials for an active broker integration. The credentials will be available for a limited time after the broker integration is created. After this time period, the API will return a resonse with HTTP Status Code 404."}},"httpPath":"/integration/brokerIntegrationCredentials","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Retrieve the status of the broker integration client credentials. This API may be used to check that the provided broker integration credentials are valid.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/integration/integration_broker-integration-credentials-status","routeSlug":"/docs/v2025-07-01/2025-07-01.api/integration/integration_broker-integration-credentials-status","metadata":{"seo":{"title":"Retrieve the status of the broker integration client credentials. This API may be used to check that the provided broker integration credentials are valid.","description":"Retrieve the status of the credentials for a broker integration. The status indicates whether the credentials are valid."}},"httpPath":"/integration/brokerIntegrationCredentialsStatus","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Retrieve the current status of a broker integration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/integration/integration_broker-integration-status","routeSlug":"/docs/v2025-07-01/2025-07-01.api/integration/integration_broker-integration-status","metadata":{"seo":{"title":"Retrieve the current status of a broker integration","description":"Retrieve the current status of a broker integration."}},"httpPath":"/integration/brokerIntegrationStatus","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Create a new broker integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/integration/integration_create-broker-integration","routeSlug":"/docs/v2025-07-01/2025-07-01.api/integration/integration_create-broker-integration","metadata":{"seo":{"title":"Create a new broker integration","description":"Create a new broker integration. Integrations for existing, active Convoy brokers will be subject to approval by the broker's administrator. Integrations for new or existing inactive brokers will be subject to a broker onboarding and verification process."}},"httpPath":"/integration/createBrokerIntegration","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Deactivate a broker integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/integration/integration_deactivate-broker-integration","routeSlug":"/docs/v2025-07-01/2025-07-01.api/integration/integration_deactivate-broker-integration","metadata":{"seo":{"title":"Deactivate a broker integration","description":"Deactivate a broker integration. API client credentials associated with a deactivated broker integration will no longer be able to be used to access the Convoy API."}},"httpPath":"/integration/deactivateBrokerIntegration","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"}],"version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","label":"loads","link":"/docs/v2025-07-01/2025-07-01.api/loads","routeSlug":"/docs/v2025-07-01/2025-07-01.api/loads","items":[{"label":"Integration API: Create or Update Loads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/loads/post-broker-integration-loads","routeSlug":"/docs/v2025-07-01/2025-07-01.api/loads/post-broker-integration-loads","metadata":{"seo":{"title":"Integration API: Create or Update Loads","description":"This API is a transformation layer over the /broker/loads API request. It transforms your request and response to and from /broker/loads according to a pre-configured method."}},"httpPath":"/integration/loads","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Create or Update Loads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/loads/broker-post-loads","routeSlug":"/docs/v2025-07-01/2025-07-01.api/loads/broker-post-loads","metadata":{"seo":{"title":"Create or Update Loads","description":"Queues up the creation or updates of existing loads."}},"httpPath":"/loads","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"}],"version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","label":"webhooks","link":"/docs/v2025-07-01/2025-07-01.api/webhooks","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks","items":[{"label":"Batch Debit process is failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/batchdebit.failed","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/batchdebit.failed","metadata":{"seo":{"title":"Batch Debit process is failed","description":"A batch debit transaction failed after the associated money transfer was attempted. A batch debit aggregates overdue invoices and processes a single transaction to withdraw the total amount owed."}},"httpPath":"batchDebit.failed","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Batch Debit is paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/batchdebit.paid","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/batchdebit.paid","metadata":{"seo":{"title":"Batch Debit is paid","description":"A batch debit transaction was successfully completed after the associated money transfer occurred. A batch debit aggregates overdue invoices and processes a single transaction to withdraw the total amount owed."}},"httpPath":"batchDebit.paid","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Batch Debit is paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/batchdebit.scheduled","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/batchdebit.scheduled","metadata":{"seo":{"title":"Batch Debit is paid","description":"A batch debit transaction was scheduled at processingDate. A batch debit aggregates overdue invoices and processes a single transaction to withdraw the total amount owed."}},"httpPath":"batchDebit.scheduled","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Load Canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.booking.canceled","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.booking.canceled","metadata":{"seo":{"title":"Load Canceled","description":"The load booking was canceled, potentially by the carrier. This is valuable for broker partners to automate assigning the carrier in their TMS."}},"httpPath":"load.booking.canceled","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Load Booked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.booking.created","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.booking.created","metadata":{"seo":{"title":"Load Booked","description":"A load was booked with a carrier, either by choosing to book now, the carrier bid was auto-accepted or the carrier confirmed the broker-accepted bid. This is valuable for broker partners to mark the load as matched in their TMS and potentially onboard the carrier."}},"httpPath":"load.booking.created","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Load Documents Approval Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.documents.approval.updated","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.documents.approval.updated","metadata":{"seo":{"title":"Load Documents Approval Updated","description":"The load documents' approval has been updated. This is valuable for broker partners to automate downloading documents and changing the approval status in their TMS."}},"httpPath":"load.documents.approval.updated","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Load Delivered","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.delivered","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.delivered","metadata":{"seo":{"title":"Load Delivered","description":"The load has been delivered to the final destination. This is valuable for broker and/or visibility partners to track delivery of a load."}},"httpPath":"load.fulfillment.delivered","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Equipment Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.equipment.updated","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.equipment.updated","metadata":{"seo":{"title":"Equipment Updated","description":"The carrier has assigned equipment information for a load. This is valuable for brokers to track the equipment being used to fulfill a load."}},"httpPath":"load.fulfillment.equipment.updated","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Driver Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.driver.updated","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.driver.updated","metadata":{"seo":{"title":"Driver Updated","description":"The carrier has assigned or unassigned a driver for a load or driver contact information has changed. This is valuable for brokers to track the driver that is fulfilling a load."}},"httpPath":"load.fulfillment.driver.updated","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Exception Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.exception.created","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.exception.created","metadata":{"seo":{"title":"Exception Created","description":"A shipment exception has occurred. This is valuable for brokers to know so that they can understand and resolve issues that occur during load execution."}},"httpPath":"load.fulfillment.exception.created","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Location Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.location.updated","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.location.updated","metadata":{"seo":{"title":"Location Updated","description":"The location of the trailer on a load updated. This is valuable for broker and/or visibility partners to track loads when the trailer is on the move."}},"httpPath":"load.fulfillment.location.updated","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Stop Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.stop.updated","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.fulfillment.stop.updated","metadata":{"seo":{"title":"Stop Updated","description":"The carrier has arrived or departed a stop. This is valuable for broker and/or visibility partners to track progress on a load."}},"httpPath":"load.fulfillment.stop.updated","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Credit Memo Issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.creditmemo.issued","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.creditmemo.issued","metadata":{"seo":{"title":"Credit Memo Issued","description":"The credit memo has been issued, detailing how much the credit was issued."}},"httpPath":"load.creditMemo.issued","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Invoice Billed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.invoice.billed","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.invoice.billed","metadata":{"seo":{"title":"Invoice Billed","description":"The invoice has been issued, detailing the final fees the broker must pay to the Convoy Platform."}},"httpPath":"load.invoice.billed","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Load Sync Processed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.sync.processed","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/load.sync.processed","metadata":{"seo":{"title":"Load Sync Processed","description":"A load sync has been processed. This is valuable for broker partners to be informed about the results of the synchronization process. If there was an error during synchronization, see Errors for error descriptions."}},"httpPath":"load.sync.processed","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Broker Credentials Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/integration.broker.credentials.updated","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/integration.broker.credentials.updated","metadata":{"seo":{"title":"Broker Credentials Updated","description":"The broker credentials have been updated."}},"httpPath":"integration.broker.credentials.updated","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Broker Status Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-07-01/2025-07-01.api/webhooks/integration.broker.status.updated","routeSlug":"/docs/v2025-07-01/2025-07-01.api/webhooks/integration.broker.status.updated","metadata":{"seo":{"title":"Broker Status Updated","description":"The broker status has been updated."}},"httpPath":"integration.broker.status.updated","version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"}],"version":"v2025-07-01","isDefault":false,"versionFolderId":"a2557b8d"}]},{"type":"link","fsPath":"docs/@v2025-08-01/Overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/docs/v2025-08-01/overview","routeSlug":"/docs/v2025-08-01/overview","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-08-01/Authorization.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/docs/v2025-08-01/authorization","routeSlug":"/docs/v2025-08-01/authorization","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-08-01/Versioning.md","metadata":{"type":"markdown"},"label":"Versioning","link":"/docs/v2025-08-01/versioning","routeSlug":"/docs/v2025-08-01/versioning","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","version":"v2025-08-01","versionFolderId":"a2557b8d","label":"Load Sync","items":[{"type":"link","fsPath":"docs/@v2025-08-01/LoadSync/GetStarted.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/docs/v2025-08-01/loadsync/getstarted","routeSlug":"/docs/v2025-08-01/loadsync/getstarted","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-08-01/LoadSync/Errors.md","metadata":{"type":"markdown"},"label":"Error Codes","link":"/docs/v2025-08-01/loadsync/errors","routeSlug":"/docs/v2025-08-01/loadsync/errors","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-08-01/LoadSync/IntegrationValidation.md","metadata":{"type":"markdown"},"label":"Integration Validation","link":"/docs/v2025-08-01/loadsync/integrationvalidation","routeSlug":"/docs/v2025-08-01/loadsync/integrationvalidation","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-08-01","versionFolderId":"a2557b8d","label":"Webhooks","items":[{"type":"link","fsPath":"docs/@v2025-08-01/Webhooks/GetStarted.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/docs/v2025-08-01/webhooks/getstarted","routeSlug":"/docs/v2025-08-01/webhooks/getstarted","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-08-01/Webhooks/EventTypes.md","metadata":{"type":"markdown"},"label":"Event Types","link":"/docs/v2025-08-01/webhooks/eventtypes","routeSlug":"/docs/v2025-08-01/webhooks/eventtypes","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-08-01","versionFolderId":"a2557b8d","label":"Tracking Visibility","items":[{"type":"link","fsPath":"docs/@v2025-08-01/TrackingVisibility/GetStarted.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/docs/v2025-08-01/trackingvisibility/getstarted","routeSlug":"/docs/v2025-08-01/trackingvisibility/getstarted","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-08-01","versionFolderId":"a2557b8d","label":"Changes","items":[{"type":"link","fsPath":"docs/@v2025-08-01/Changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/docs/v2025-08-01/changelog","routeSlug":"/docs/v2025-08-01/changelog","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-08-01","versionFolderId":"a2557b8d","label":"Brokers API","items":[{"type":"link","label":"Brokers","link":"/docs/v2025-08-01/2025-08-01.api","routeSlug":"/docs/v2025-08-01/2025-08-01.api","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","label":"carrierEligibility","link":"/docs/v2025-08-01/2025-08-01.api/carriereligibility","routeSlug":"/docs/v2025-08-01/2025-08-01.api/carriereligibility","items":[{"label":"Set or update carrier's eligibility to match a broker's loads on the Convoy Platform.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/carriereligibility/post-broker-carrier-eligibility","routeSlug":"/docs/v2025-08-01/2025-08-01.api/carriereligibility/post-broker-carrier-eligibility","metadata":{"seo":{"title":"Set or update carrier's eligibility to match a broker's loads on the Convoy Platform.","description":"The api takes an array of Carrier Matching Eligibilities each with a DOT number and Eligibility Status.Carriers with a status of DO_NOT_USE will no longer be able to match to your loads on the Convoy platform.Carriers with QUALIFIED will be allowed to match.Carriers with a QUALIFIED status do not need to be explicitly sent, only if they have transitioned from a DO_NOT_USE status."}},"httpPath":"/carrierEligibility","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"}],"version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","label":"accounting","link":"/docs/v2025-08-01/2025-08-01.api/accounting","routeSlug":"/docs/v2025-08-01/2025-08-01.api/accounting","items":[{"label":"Return all credit memos associated to the batch debit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/accounting/batchdebits_get-batch-debits-credit-memos","routeSlug":"/docs/v2025-08-01/2025-08-01.api/accounting/batchdebits_get-batch-debits-credit-memos","metadata":{"seo":{"title":"Return all credit memos associated to the batch debit","description":"Returns all credit memos associated to a batch debit specified by the id.The number of credit memos can be large (e.g. 10k credit memos), so you mustpaginate."}},"httpPath":"/batchDebits/{id}/creditMemos","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Return all invoices associated to the batch debit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/accounting/batchdebits_get-batch-debits-invoices","routeSlug":"/docs/v2025-08-01/2025-08-01.api/accounting/batchdebits_get-batch-debits-invoices","metadata":{"seo":{"title":"Return all invoices associated to the batch debit","description":"Returns all invoices associated to a batch debit specified by the id.The number of invoices can be large (e.g. 10k invoices), so you must paginate."}},"httpPath":"/batchDebits/{id}/invoices","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"}],"version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","label":"integration","link":"/docs/v2025-08-01/2025-08-01.api/integration","routeSlug":"/docs/v2025-08-01/2025-08-01.api/integration","items":[{"label":"Retrieve broker integration credentials","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/integration/integration_broker-integration-credentials","routeSlug":"/docs/v2025-08-01/2025-08-01.api/integration/integration_broker-integration-credentials","metadata":{"seo":{"title":"Retrieve broker integration credentials","description":"Retrieve the credentials for an active broker integration. The credentials will be available for a limited time after the broker integration is created. After this time period, the API will return a resonse with HTTP Status Code 404."}},"httpPath":"/integration/brokerIntegrationCredentials","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Retrieve the status of the broker integration client credentials. This API may be used to check that the provided broker integration credentials are valid.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/integration/integration_broker-integration-credentials-status","routeSlug":"/docs/v2025-08-01/2025-08-01.api/integration/integration_broker-integration-credentials-status","metadata":{"seo":{"title":"Retrieve the status of the broker integration client credentials. This API may be used to check that the provided broker integration credentials are valid.","description":"Retrieve the status of the credentials for a broker integration. The status indicates whether the credentials are valid."}},"httpPath":"/integration/brokerIntegrationCredentialsStatus","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Retrieve the current status of a broker integration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/integration/integration_broker-integration-status","routeSlug":"/docs/v2025-08-01/2025-08-01.api/integration/integration_broker-integration-status","metadata":{"seo":{"title":"Retrieve the current status of a broker integration","description":"Retrieve the current status of a broker integration."}},"httpPath":"/integration/brokerIntegrationStatus","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Create a new broker integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/integration/integration_create-broker-integration","routeSlug":"/docs/v2025-08-01/2025-08-01.api/integration/integration_create-broker-integration","metadata":{"seo":{"title":"Create a new broker integration","description":"Create a new broker integration. Integrations for existing, active Convoy brokers will be subject to approval by the broker's administrator. Integrations for new or existing inactive brokers will be subject to a broker onboarding and verification process."}},"httpPath":"/integration/createBrokerIntegration","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Deactivate a broker integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/integration/integration_deactivate-broker-integration","routeSlug":"/docs/v2025-08-01/2025-08-01.api/integration/integration_deactivate-broker-integration","metadata":{"seo":{"title":"Deactivate a broker integration","description":"Deactivate a broker integration. API client credentials associated with a deactivated broker integration will no longer be able to be used to access the Convoy API."}},"httpPath":"/integration/deactivateBrokerIntegration","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"}],"version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","label":"loads","link":"/docs/v2025-08-01/2025-08-01.api/loads","routeSlug":"/docs/v2025-08-01/2025-08-01.api/loads","items":[{"label":"Integration API: Create or Update Loads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/loads/post-broker-integration-loads","routeSlug":"/docs/v2025-08-01/2025-08-01.api/loads/post-broker-integration-loads","metadata":{"seo":{"title":"Integration API: Create or Update Loads","description":"This API is a transformation layer over the /broker/loads API request. It transforms your request and response to and from /broker/loads according to a pre-configured method."}},"httpPath":"/integration/loads","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Create or Update Loads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/loads/broker-post-loads","routeSlug":"/docs/v2025-08-01/2025-08-01.api/loads/broker-post-loads","metadata":{"seo":{"title":"Create or Update Loads","description":"Queues up the creation or updates of existing loads."}},"httpPath":"/loads","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"}],"version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"type":"group","label":"webhooks","link":"/docs/v2025-08-01/2025-08-01.api/webhooks","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks","items":[{"label":"Batch Debit process is failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/batchdebit.failed","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/batchdebit.failed","metadata":{"seo":{"title":"Batch Debit process is failed","description":"A batch debit transaction failed after the associated money transfer was attempted. A batch debit aggregates overdue invoices and processes a single transaction to withdraw the total amount owed."}},"httpPath":"batchDebit.failed","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Batch Debit is paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/batchdebit.paid","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/batchdebit.paid","metadata":{"seo":{"title":"Batch Debit is paid","description":"A batch debit transaction was successfully completed after the associated money transfer occurred. A batch debit aggregates overdue invoices and processes a single transaction to withdraw the total amount owed."}},"httpPath":"batchDebit.paid","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Batch Debit is paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/batchdebit.scheduled","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/batchdebit.scheduled","metadata":{"seo":{"title":"Batch Debit is paid","description":"A batch debit transaction was scheduled at processingDate. A batch debit aggregates overdue invoices and processes a single transaction to withdraw the total amount owed."}},"httpPath":"batchDebit.scheduled","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Load Canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.booking.canceled","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.booking.canceled","metadata":{"seo":{"title":"Load Canceled","description":"The load booking was canceled, potentially by the carrier. This is valuable for broker partners to automate assigning the carrier in their TMS."}},"httpPath":"load.booking.canceled","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Load Booked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.booking.created","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.booking.created","metadata":{"seo":{"title":"Load Booked","description":"A load was booked with a carrier, either by choosing to book now, the carrier bid was auto-accepted or the carrier confirmed the broker-accepted bid. This is valuable for broker partners to mark the load as matched in their TMS and potentially onboard the carrier."}},"httpPath":"load.booking.created","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Load Documents Approval Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.documents.approval.updated","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.documents.approval.updated","metadata":{"seo":{"title":"Load Documents Approval Updated","description":"The load documents' approval has been updated. This is valuable for broker partners to automate downloading documents and changing the approval status in their TMS."}},"httpPath":"load.documents.approval.updated","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Load Delivered","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.delivered","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.delivered","metadata":{"seo":{"title":"Load Delivered","description":"The load has been delivered to the final destination. This is valuable for broker and/or visibility partners to track delivery of a load."}},"httpPath":"load.fulfillment.delivered","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Equipment Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.equipment.updated","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.equipment.updated","metadata":{"seo":{"title":"Equipment Updated","description":"The carrier has assigned equipment information for a load. This is valuable for brokers to track the equipment being used to fulfill a load."}},"httpPath":"load.fulfillment.equipment.updated","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Driver Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.driver.updated","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.driver.updated","metadata":{"seo":{"title":"Driver Updated","description":"The carrier has assigned or unassigned a driver for a load or driver contact information has changed. This is valuable for brokers to track the driver that is fulfilling a load."}},"httpPath":"load.fulfillment.driver.updated","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Exception Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.exception.created","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.exception.created","metadata":{"seo":{"title":"Exception Created","description":"A shipment exception has occurred. This is valuable for brokers to know so that they can understand and resolve issues that occur during load execution."}},"httpPath":"load.fulfillment.exception.created","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Location Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.location.updated","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.location.updated","metadata":{"seo":{"title":"Location Updated","description":"The location of the trailer on a load updated. This is valuable for broker and/or visibility partners to track loads when the trailer is on the move."}},"httpPath":"load.fulfillment.location.updated","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Stop Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.stop.updated","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.fulfillment.stop.updated","metadata":{"seo":{"title":"Stop Updated","description":"The carrier has arrived or departed a stop. This is valuable for broker and/or visibility partners to track progress on a load."}},"httpPath":"load.fulfillment.stop.updated","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Credit Memo Issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.creditmemo.issued","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.creditmemo.issued","metadata":{"seo":{"title":"Credit Memo Issued","description":"The credit memo has been issued, detailing how much the credit was issued."}},"httpPath":"load.creditMemo.issued","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Invoice Billed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.invoice.billed","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.invoice.billed","metadata":{"seo":{"title":"Invoice Billed","description":"The invoice has been issued, detailing the final fees the broker must pay to the Convoy Platform."}},"httpPath":"load.invoice.billed","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Load Sync Processed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.sync.processed","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/load.sync.processed","metadata":{"seo":{"title":"Load Sync Processed","description":"A load sync has been processed. This is valuable for broker partners to be informed about the results of the synchronization process. If there was an error during synchronization, see Errors for error descriptions."}},"httpPath":"load.sync.processed","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Broker Credentials Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/integration.broker.credentials.updated","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/integration.broker.credentials.updated","metadata":{"seo":{"title":"Broker Credentials Updated","description":"The broker credentials have been updated."}},"httpPath":"integration.broker.credentials.updated","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"},{"label":"Broker Status Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/v2025-08-01/2025-08-01.api/webhooks/integration.broker.status.updated","routeSlug":"/docs/v2025-08-01/2025-08-01.api/webhooks/integration.broker.status.updated","metadata":{"seo":{"title":"Broker Status Updated","description":"The broker status has been updated."}},"httpPath":"integration.broker.status.updated","version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"}],"version":"v2025-08-01","isDefault":false,"versionFolderId":"a2557b8d"}]},{"type":"link","fsPath":"docs/@v2025-09-01/Overview.md","metadata":{"type":"markdown"},"label":"Overview","link":"/docs/overview","routeSlug":"/docs/overview","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-09-01/Authorization.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/docs/authorization","routeSlug":"/docs/authorization","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-09-01/Versioning.md","metadata":{"type":"markdown"},"label":"Versioning","link":"/docs/versioning","routeSlug":"/docs/versioning","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"group","version":"v2025-09-01","versionFolderId":"a2557b8d","label":"Load Sync","items":[{"type":"link","fsPath":"docs/@v2025-09-01/LoadSync/GetStarted.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/docs/loadsync/getstarted","routeSlug":"/docs/loadsync/getstarted","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-09-01/LoadSync/Errors.md","metadata":{"type":"markdown"},"label":"Error Codes","link":"/docs/loadsync/errors","routeSlug":"/docs/loadsync/errors","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-09-01/LoadSync/IntegrationValidation.md","metadata":{"type":"markdown"},"label":"Integration Validation","link":"/docs/loadsync/integrationvalidation","routeSlug":"/docs/loadsync/integrationvalidation","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-09-01","versionFolderId":"a2557b8d","label":"Load Unassign","items":[{"type":"link","fsPath":"docs/@v2025-09-01/LoadUnassign/Errors.md","metadata":{"type":"markdown"},"label":"Error Codes","link":"/docs/loadunassign/errors","routeSlug":"/docs/loadunassign/errors","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-09-01","versionFolderId":"a2557b8d","label":"Webhooks","items":[{"type":"link","fsPath":"docs/@v2025-09-01/Webhooks/GetStarted.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/docs/webhooks/getstarted","routeSlug":"/docs/webhooks/getstarted","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"link","fsPath":"docs/@v2025-09-01/Webhooks/EventTypes.md","metadata":{"type":"markdown"},"label":"Event Types","link":"/docs/webhooks/eventtypes","routeSlug":"/docs/webhooks/eventtypes","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-09-01","versionFolderId":"a2557b8d","label":"Tracking Visibility","items":[{"type":"link","fsPath":"docs/@v2025-09-01/TrackingVisibility/GetStarted.md","metadata":{"type":"markdown"},"label":"Get Started","link":"/docs/trackingvisibility/getstarted","routeSlug":"/docs/trackingvisibility/getstarted","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-09-01","versionFolderId":"a2557b8d","label":"Changes","items":[{"type":"link","fsPath":"docs/@v2025-09-01/Changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/docs/changelog","routeSlug":"/docs/changelog","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}]},{"type":"group","version":"v2025-09-01","versionFolderId":"a2557b8d","label":"Brokers API","items":[{"type":"link","label":"Brokers","link":"/docs/2025-09-01.api","routeSlug":"/docs/2025-09-01.api","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"group","label":"carrierEligibility","link":"/docs/2025-09-01.api/carriereligibility","routeSlug":"/docs/2025-09-01.api/carriereligibility","items":[{"label":"Set or update carrier's eligibility to match a broker's loads on the Convoy Platform.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/carriereligibility/post-broker-carrier-eligibility","routeSlug":"/docs/2025-09-01.api/carriereligibility/post-broker-carrier-eligibility","metadata":{"seo":{"title":"Set or update carrier's eligibility to match a broker's loads on the Convoy Platform.","description":"The api takes an array of Carrier Matching Eligibilities each with a DOT number and Eligibility Status.Carriers with a status of DO_NOT_USE will no longer be able to match to your loads on the Convoy platform.Carriers with QUALIFIED will be allowed to match.Carriers with a QUALIFIED status do not need to be explicitly sent, only if they have transitioned from a DO_NOT_USE status."}},"httpPath":"/carrierEligibility","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}],"version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"group","label":"accounting","link":"/docs/2025-09-01.api/accounting","routeSlug":"/docs/2025-09-01.api/accounting","items":[{"label":"Return all credit memos associated to the batch debit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/accounting/batchdebits_get-batch-debits-credit-memos","routeSlug":"/docs/2025-09-01.api/accounting/batchdebits_get-batch-debits-credit-memos","metadata":{"seo":{"title":"Return all credit memos associated to the batch debit","description":"Returns all credit memos associated to a batch debit specified by the id.The number of credit memos can be large (e.g. 10k credit memos), so you mustpaginate."}},"httpPath":"/batchDebits/{id}/creditMemos","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Return all invoices associated to the batch debit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/accounting/batchdebits_get-batch-debits-invoices","routeSlug":"/docs/2025-09-01.api/accounting/batchdebits_get-batch-debits-invoices","metadata":{"seo":{"title":"Return all invoices associated to the batch debit","description":"Returns all invoices associated to a batch debit specified by the id.The number of invoices can be large (e.g. 10k invoices), so you must paginate."}},"httpPath":"/batchDebits/{id}/invoices","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}],"version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"group","label":"integration","link":"/docs/2025-09-01.api/integration","routeSlug":"/docs/2025-09-01.api/integration","items":[{"label":"Retrieve broker integration credentials","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/integration/integration_broker-integration-credentials","routeSlug":"/docs/2025-09-01.api/integration/integration_broker-integration-credentials","metadata":{"seo":{"title":"Retrieve broker integration credentials","description":"Retrieve the credentials for an active broker integration. The credentials will be available for a limited time after the broker integration is created. After this time period, the API will return a resonse with HTTP Status Code 404."}},"httpPath":"/integration/brokerIntegrationCredentials","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Retrieve the status of the broker integration client credentials. This API may be used to check that the provided broker integration credentials are valid.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/integration/integration_broker-integration-credentials-status","routeSlug":"/docs/2025-09-01.api/integration/integration_broker-integration-credentials-status","metadata":{"seo":{"title":"Retrieve the status of the broker integration client credentials. This API may be used to check that the provided broker integration credentials are valid.","description":"Retrieve the status of the credentials for a broker integration. The status indicates whether the credentials are valid."}},"httpPath":"/integration/brokerIntegrationCredentialsStatus","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Retrieve the current status of a broker integration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/integration/integration_broker-integration-status","routeSlug":"/docs/2025-09-01.api/integration/integration_broker-integration-status","metadata":{"seo":{"title":"Retrieve the current status of a broker integration","description":"Retrieve the current status of a broker integration."}},"httpPath":"/integration/brokerIntegrationStatus","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Create a new broker integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/integration/integration_create-broker-integration","routeSlug":"/docs/2025-09-01.api/integration/integration_create-broker-integration","metadata":{"seo":{"title":"Create a new broker integration","description":"Create a new broker integration. Integrations for existing, active Convoy brokers will be subject to approval by the broker's administrator. Integrations for new or existing inactive brokers will be subject to a broker onboarding and verification process."}},"httpPath":"/integration/createBrokerIntegration","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Deactivate a broker integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/integration/integration_deactivate-broker-integration","routeSlug":"/docs/2025-09-01.api/integration/integration_deactivate-broker-integration","metadata":{"seo":{"title":"Deactivate a broker integration","description":"Deactivate a broker integration. API client credentials associated with a deactivated broker integration will no longer be able to be used to access the Convoy API."}},"httpPath":"/integration/deactivateBrokerIntegration","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}],"version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"group","label":"loads","link":"/docs/2025-09-01.api/loads","routeSlug":"/docs/2025-09-01.api/loads","items":[{"label":"Unassign a load","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/loads/post-broker-unassign-loads","routeSlug":"/docs/2025-09-01.api/loads/post-broker-unassign-loads","metadata":{"seo":{"title":"Unassign a load","description":"The api unassigns a load from a carrier that was matched on Convoy Platform.To unassign a load successfully, the carrier DOT number or MC number is required and must match the assigned carrier.An unassign reason is defaulted to NO_REASON_PROVIDED if not provided.If the load is not currently assigned to a carrier, the api will return a 200 Accepted response."}},"httpPath":"/load/unassign","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Create or Update Loads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/loads/broker-post-loads","routeSlug":"/docs/2025-09-01.api/loads/broker-post-loads","metadata":{"seo":{"title":"Create or Update Loads","description":"Queues up the creation or updates of existing loads."}},"httpPath":"/loads","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Get Load","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/2025-09-01.api/loads/get-broker-load","routeSlug":"/docs/2025-09-01.api/loads/get-broker-load","metadata":{"seo":{"title":"Get Load","description":"Retrieve a load by its external identifier."}},"httpPath":"/loads/{externalId}","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}],"version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"type":"group","label":"webhooks","link":"/docs/2025-09-01.api/webhooks","routeSlug":"/docs/2025-09-01.api/webhooks","items":[{"label":"Batch Debit process is failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/batchdebit.failed","routeSlug":"/docs/2025-09-01.api/webhooks/batchdebit.failed","metadata":{"seo":{"title":"Batch Debit process is failed","description":"A batch debit transaction failed after the associated money transfer was attempted. A batch debit aggregates overdue invoices and processes a single transaction to withdraw the total amount owed."}},"httpPath":"batchDebit.failed","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Batch Debit is paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/batchdebit.paid","routeSlug":"/docs/2025-09-01.api/webhooks/batchdebit.paid","metadata":{"seo":{"title":"Batch Debit is paid","description":"A batch debit transaction was successfully completed after the associated money transfer occurred. A batch debit aggregates overdue invoices and processes a single transaction to withdraw the total amount owed."}},"httpPath":"batchDebit.paid","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Batch Debit is paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/batchdebit.scheduled","routeSlug":"/docs/2025-09-01.api/webhooks/batchdebit.scheduled","metadata":{"seo":{"title":"Batch Debit is paid","description":"A batch debit transaction was scheduled at processingDate. A batch debit aggregates overdue invoices and processes a single transaction to withdraw the total amount owed."}},"httpPath":"batchDebit.scheduled","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Load Canceled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.booking.canceled","routeSlug":"/docs/2025-09-01.api/webhooks/load.booking.canceled","metadata":{"seo":{"title":"Load Canceled","description":"The load booking was canceled, potentially by the carrier. This is valuable for broker partners to automate assigning the carrier in their TMS."}},"httpPath":"load.booking.canceled","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Load Booked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.booking.created","routeSlug":"/docs/2025-09-01.api/webhooks/load.booking.created","metadata":{"seo":{"title":"Load Booked","description":"A load was booked with a carrier, either by choosing to book now, the carrier bid was auto-accepted or the carrier confirmed the broker-accepted bid. This is valuable for broker partners to mark the load as matched in their TMS and potentially onboard the carrier."}},"httpPath":"load.booking.created","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Load Documents Approval Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.documents.approval.updated","routeSlug":"/docs/2025-09-01.api/webhooks/load.documents.approval.updated","metadata":{"seo":{"title":"Load Documents Approval Updated","description":"The load documents' approval has been updated. This is valuable for broker partners to automate downloading documents and changing the approval status in their TMS."}},"httpPath":"load.documents.approval.updated","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Load Delivered","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.fulfillment.delivered","routeSlug":"/docs/2025-09-01.api/webhooks/load.fulfillment.delivered","metadata":{"seo":{"title":"Load Delivered","description":"The load has been delivered to the final destination. This is valuable for broker and/or visibility partners to track delivery of a load."}},"httpPath":"load.fulfillment.delivered","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Equipment Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.fulfillment.equipment.updated","routeSlug":"/docs/2025-09-01.api/webhooks/load.fulfillment.equipment.updated","metadata":{"seo":{"title":"Equipment Updated","description":"The carrier has assigned equipment information for a load. This is valuable for brokers to track the equipment being used to fulfill a load."}},"httpPath":"load.fulfillment.equipment.updated","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Driver Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.fulfillment.driver.updated","routeSlug":"/docs/2025-09-01.api/webhooks/load.fulfillment.driver.updated","metadata":{"seo":{"title":"Driver Updated","description":"The carrier has assigned or unassigned a driver for a load or driver contact information has changed. This is valuable for brokers to track the driver that is fulfilling a load."}},"httpPath":"load.fulfillment.driver.updated","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Exception Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.fulfillment.exception.created","routeSlug":"/docs/2025-09-01.api/webhooks/load.fulfillment.exception.created","metadata":{"seo":{"title":"Exception Created","description":"A shipment exception has occurred. This is valuable for brokers to know so that they can understand and resolve issues that occur during load execution."}},"httpPath":"load.fulfillment.exception.created","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Location Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.fulfillment.location.updated","routeSlug":"/docs/2025-09-01.api/webhooks/load.fulfillment.location.updated","metadata":{"seo":{"title":"Location Updated","description":"The location of the trailer on a load updated. This is valuable for broker and/or visibility partners to track loads when the trailer is on the move."}},"httpPath":"load.fulfillment.location.updated","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Stop Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.fulfillment.stop.updated","routeSlug":"/docs/2025-09-01.api/webhooks/load.fulfillment.stop.updated","metadata":{"seo":{"title":"Stop Updated","description":"The carrier has arrived or departed a stop. This is valuable for broker and/or visibility partners to track progress on a load."}},"httpPath":"load.fulfillment.stop.updated","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Credit Memo Issued","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.creditmemo.issued","routeSlug":"/docs/2025-09-01.api/webhooks/load.creditmemo.issued","metadata":{"seo":{"title":"Credit Memo Issued","description":"The credit memo has been issued, detailing how much the credit was issued."}},"httpPath":"load.creditMemo.issued","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Charge Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.charge.updated","routeSlug":"/docs/2025-09-01.api/webhooks/load.charge.updated","metadata":{"seo":{"title":"Charge Updated","description":"The pre-billing charge line items for a load have been created or updated. Fires on first carrier-doc submission and on every subsequent line-item add/edit/remove. Each delivery contains the complete authoritative line-item set for the load."}},"httpPath":"load.charge.updated","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Invoice Billed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.invoice.billed","routeSlug":"/docs/2025-09-01.api/webhooks/load.invoice.billed","metadata":{"seo":{"title":"Invoice Billed","description":"The invoice has been issued, detailing the final fees the broker must pay to the Convoy Platform."}},"httpPath":"load.invoice.billed","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Load Sync Processed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/load.sync.processed","routeSlug":"/docs/2025-09-01.api/webhooks/load.sync.processed","metadata":{"seo":{"title":"Load Sync Processed","description":"A load sync has been processed. This is valuable for broker partners to be informed about the results of the synchronization process. If there was an error during synchronization, see Errors for error descriptions."}},"httpPath":"load.sync.processed","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Broker Credentials Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/integration.broker.credentials.updated","routeSlug":"/docs/2025-09-01.api/webhooks/integration.broker.credentials.updated","metadata":{"seo":{"title":"Broker Credentials Updated","description":"The broker credentials have been updated."}},"httpPath":"integration.broker.credentials.updated","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"},{"label":"Broker Status Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/2025-09-01.api/webhooks/integration.broker.status.updated","routeSlug":"/docs/2025-09-01.api/webhooks/integration.broker.status.updated","metadata":{"seo":{"title":"Broker Status Updated","description":"The broker status has been updated."}},"httpPath":"integration.broker.status.updated","version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}],"version":"v2025-09-01","isDefault":true,"versionFolderId":"a2557b8d"}]}]}