Set up TransVirtual

Account requirements

Request API access and the correct customer code from your TransVirtual administrator. Authentication uses the API key in the Authorization header. Customer code identifies the export customer within the provider account; a successful read test does not verify this customer code or write permission.

Obtain an existing test consignment number and confirm account automation rules. No pickup request is sent by HaulMatch, but provider rules can still act on a newly created consignment.

• TransVirtual public OpenAPI contract

Configure and test

1. Choose TransVirtual in company TMS connections and enter a name, customer code and API key. Confirm the provider environment.
2. Enter an existing test consignment number and run Test access. The check reads that record without creating a consignment.
3. For shipper import, enter a consignment number and explicitly confirm it is unallocated and authorized for publication. Review the draft before publishing.

• Open company TMS connections
• Review, security and recovery guide

Consignment creation and tracking

Confirmed exports call Consignment with a stable Number and UniqueId, selected CustomerCode and PickupRequest set to n. No PDFs, rates or financial actions are requested. Rows use total weight in kilograms, quantity and per-item dimensions in metres.

ConsignmentQuery reads freight details and ConsignmentStatus reads tracking. Logical errors in the provider envelope are failures even if HTTP status is 200. Tracking observations do not bypass HaulMatch job permissions or release payments.

Before live use

• Verify the customer code, write access and no-pickup behavior in a vendor test account.
• Check round-trip row quantities, weight, dimensions, addresses and special instructions.
• Validate a known consignment status and unknown status handling.
• Check invalid keys, provider business errors, throttling and uncertain creation reconciliation.