Agent Manifest
list, retrieve, and close agent (onforwarder) manifests via the API/Api/AgentManifests
List open agent manifests for an onforwarder agent (HTTP Post). Returns manifests where type is agent and status is open. Response Data is an object with Items (rows), Page, PageSize, and HasMore. Optional Page and PageSize in the request (page size clamped to a server maximum). Each row returns ManifestStatus as Open.
HTTP Post — AgentManifests
Request properties
| Property Name | Required | Description |
|---|---|---|
| AgentName | Yes | The agent (onforwarder) name for this TransVirtual account (if not known, agent code must be supplied). Max length: 200 |
| AgentCode | Yes | The agent TransVirtual account code (if not known, agent name must be supplied). Max length: 20 |
| Page | Optional. 1-based page number. Default 1. | |
| PageSize | Optional. Rows per page (default 100, maximum 1000). |
Response Data (object)
| Property Name | Description |
|---|---|
| Page | 1-based page number applied to this response. |
| PageSize | Page size applied after clamping to the server maximum. |
| HasMore | True if more rows exist after this page. |
| Property Name | Description |
|---|---|
| ManifestDate | Manifest date (client time culture). |
| ManifestId | TransVirtual manifest id. |
| ManifestNumber | Manifest number. |
| ManifestStatus | Manifest status: "Open" (list includes open manifests only). |
| ManifestTitle | Manifest title. |
Items[] (each element)
| Property Name | Description |
|---|---|
| ManifestDate | Manifest date (client time culture). |
| ManifestId | TransVirtual manifest id. |
| ManifestNumber | Manifest number. |
| ManifestStatus | Manifest status: "Open" (list includes open manifests only). |
| ManifestTitle | Manifest title. |
Example
/Api/AgentManifest/{id}
Get one agent manifest and its consignments (HTTP Get). Pass the manifest id only in the URL. ManifestStatus is Open or Closed.
HTTP Get — AgentManifest
Response Data (array of one manifest)
| Property Name | Description |
|---|---|
| ManifestDate | Manifest date (client time culture). |
| ManifestId | TransVirtual manifest id. |
| ManifestNumber | Manifest number. |
| ManifestStatus | Manifest status: "Open" or "Closed". |
| ManifestTitle | Manifest title. |
| Property Name | Description |
|---|---|
| ConsignmentId | TransVirtual consignment id. |
| ConsignmentNumber | Consignment number. |
| ConsignmentOtherReferences | Other references (1). |
| ConsignmentOtherReferences2 | Other references (2). |
| ConsignmentRemoteUniqueId | Remote unique id for the consignment. |
| ReceiverReference | Receiver reference. |
| SenderReference | Sender reference. |
Consignments[]
| Property Name | Description |
|---|---|
| ConsignmentId | TransVirtual consignment id. |
| ConsignmentNumber | Consignment number. |
| ConsignmentOtherReferences | Other references (1). |
| ConsignmentOtherReferences2 | Other references (2). |
| ConsignmentRemoteUniqueId | Remote unique id for the consignment. |
| ReceiverReference | Receiver reference. |
| SenderReference | Sender reference. |
Example
/Api/AgentManifestClose
Close a single open agent manifest (HTTP Put). Sets the manifest to pending export (same workflow as closing in the UI).
HTTP Put — AgentManifestClose
Request properties
| Property Name | Required | Description |
|---|---|---|
| AgentName | Yes | The agent (onforwarder) name for this TransVirtual account (if not known, agent code must be supplied). Max length: 200 |
| AgentCode | Yes | The agent TransVirtual account code (if not known, agent name must be supplied). Max length: 20 |
| ManifestId | Yes | The TransVirtual manifest id to close. |
Example
Error codes
| Error Code | Description |
|---|---|
| 1901 | Unknown error - report if this persists |
| 1902 | Invalid Customer Account details (Name or Code) |
| 1903 | Invalid Agent Account details (Name or Code) |
| 1905 | Manifest not found or access denied |
| 1908 | Provide at least one of agent name or agent code |