TransVirtual

Actions:

Incoming

No incoming actions are implemented in this release. The incoming transport is scaffolded but no real pull actions exist yet.

Outgoing

CREATECONSIGNMENT — Creates a new consignment in TransVirtual by POSTing to the consignment endpoint. The Crossfire message XML is mapped to the TransVirtual CreateConsignment request payload. No response is sent back to

Crossfire.

Message Standard

<UniqueId>{Consignment unique id}</UniqueId>

<Number>{Consignment number}</Number>

<CustomerName>{Customer name}</CustomerName>

<CustomerIdentifier>{Customer identifier}</CustomerIdentifier>

<CustomerCode>{Customer code}</CustomerCode>

<SenderAutoCompleteAddress>{Optional auto-complete address}</SenderAutoCompleteAddress>

<ReceiverAutoCompleteAddress>{Optional auto-complete address}</ReceiverAutoCompleteAddress>

<SenderName>{Sender name}</SenderName>

<SenderName2>{Sender name line 2, optional}</SenderName2>

<SenderAddress>{Sender address line 1}</SenderAddress>

<SenderAddress2>{Sender address line 2, optional}</SenderAddress2>

<SenderSuburb>{Sender suburb}</SenderSuburb>

<SenderPostcode>{Sender postcode}</SenderPostcode>

<SenderState>{Sender state}</SenderState>

<ReceiverName>{Receiver name}</ReceiverName>

<ReceiverName2>{Receiver name line 2, optional}</ReceiverName2>

<ReceiverAddress>{Receiver address line 1}</ReceiverAddress>

<ReceiverAddress2>{Receiver address line 2, optional}</ReceiverAddress2>

<ReceiverSuburb>{Receiver suburb}</ReceiverSuburb>

<ReceiverPostcode>{Receiver postcode}</ReceiverPostcode>

<ReceiverState>{Receiver state}</ReceiverState>

<SenderReference>{Sender reference, optional}</SenderReference>

<ReceiverReference>{Receiver reference, optional}</ReceiverReference>

<SenderEmail>{Sender email, optional}</SenderEmail>

<ReceiverEmail>{Receiver email, optional}</ReceiverEmail>

<SpecialInstructions>{Special instructions, optional}</SpecialInstructions>

<ConsignmentSenderContact>{Sender contact, optional}</ConsignmentSenderContact>

<ConsignmentSenderPhone>{Sender phone, optional}</ConsignmentSenderPhone>

<ConsignmentReceiverContact>{Receiver contact, optional}</ConsignmentReceiverContact>

<ConsignmentReceiverPhone>{Receiver phone, optional}</ConsignmentReceiverPhone>

<ConsignmentPickupSpecialInstructions>{Pickup instructions, optional}</ConsignmentPickupSpecialInstructions>

<PickupRequest>{true|false, optional}</PickupRequest>

<ConsignmentSenderIsResidential>{true|false, optional}</ConsignmentSenderIsResidential>

<ConsignmentReceiverIsResidential>{true|false, optional}</ConsignmentReceiverIsResidential>

<ConsignmentOtherReferences>{Other reference 1, optional}</ConsignmentOtherReferences>

<ConsignmentOtherReferences2>{Other reference 2, optional}</ConsignmentOtherReferences2>

<ConsignmentBookingDateTime>{YYYY-MM-DD HH:mm, optional}</ConsignmentBookingDateTime>

<ConsignmentServiceType>{Service type, optional}</ConsignmentServiceType>

<ReturnPdfLabels>{true|false, optional}</ReturnPdfLabels>

<ReturnPdfConsignment>{true|false, optional}</ReturnPdfConsignment>

<Rows>

<Row>

<RemoteRowUniqueId>{Row unique id}</RemoteRowUniqueId>

<Qty>{Integer qty}</Qty>

<QtyDecimal>{Decimal qty, optional}</QtyDecimal>

<Description>{Row description}</Description>

<ItemContentsDescription>{Item contents description, optional}</ItemContentsDescription>

<Weight>{Decimal, optional}</Weight>

<Length>{Decimal, optional}</Length>

<Width>{Decimal, optional}</Width>

<Height>{Decimal, optional}</Height>

<CubicQty>{Decimal, optional}</CubicQty>

<Reference>{Row reference, optional}</Reference>

<StockCode>{Stock code, optional}</StockCode>

<Uom>{Unit of measure, optional}</Uom>

<DangerousGoodsUNNumber>{UN number, optional}</DangerousGoodsUNNumber>

<DangerousGoodsClass>{Class, optional}</DangerousGoodsClass>

<DangerousGoodsSubRisk>{Sub risk, optional}</DangerousGoodsSubRisk>

<DangerousGoodsPackagingGroup>{Packaging group, optional}</DangerousGoodsPackagingGroup>

<Items>

<Item>

<Barcode>{Barcode, optional}</Barcode>

<AlternateBarcode>{Alternate barcode, optional}</AlternateBarcode>

</Item>

</Items>

</Row>

</Rows>

</OutgoingCreateConsignmentMessage>

UPDATECONSIGNMENT — Updates an existing consignment in TransVirtual by PUTting to the consignment endpoint. Identifies the consignment by UniqueId and optionally re-keys it via NewUniqueId. The Crossfire message XML is

mapped to the TransVirtual UpdateConsignment request payload. No response is sent back to Crossfire.