AccuFRATE provides an API for LTL quoting, tendering, tracking, and document retrieval for Loads.
Setup
Enter Credentials
Enable the AccuFRATE integration by completing the following steps.
Navigate to TMS Admin.
Select Credentials.
Select the Global Services tab
Find AccuFRATE in the list and open the card.
Check the Enabled boxes as needed.
Enter the User ID and Password 1 into the text fields.
Click the Save button when finished.
User ID | Password 1 | Password 2 | Customer Number |
---|---|---|---|
Required | Required |
Remote Site Settings
If upgrading from a previous release of the TMS, check that the Remote Site Settings for the AccuFRATE integration URL are current.
Click the Setup gear icon in the top Right corner.
From the drop-down, click Setup.
In the Quick Find Toolbar type Remote Site Settings and click the link.
From the list of remote sites find AccuFRATE and click the Edit link.
Update the Remote Site URL to match the Service URL below:
Service URL: http://webservice.accufrate.com
Test Service URL: http://testwebservice.accufrate.com
Load Status Batch Job
The Load Status Batch Job must be running to automatically track updates from AccuFRATE.
The LoadStatusUpdateJob runs continuously. The job brings any Load status data changes into the TMS from the AccuFRATE API.
Name | Purpose | ‘Run Now’ Action | ‘Schedule’ Action |
---|---|---|---|
LoadStatusUpdateJob | Requests load status updates from API and email carriers. | Active – runs job immediately | Inactive - invoked by itself upon completion |
Run the LoadStatusUpdateJob from the list of Batch Processes on the Performance IQ Lightning Web Component (LWC).
The AccuFRATE integration only supports 2 Stop Loads. If more than 2 Stop locations are included on a Load, no information returns.
AccuFRATE does not support the same location for Pickup and Delivery Stops. If the same location is used as a Pickup and Delivery, users receive an error.
Accessorial Codes
Code | Description |
---|---|
50 | Airport Delivery |
49 | Airport Pickup |
93 | Amazon FBA Delivery (ExFreight Only Only) |
1 | Appointment Fee Delivery |
99 | CFS Delivery |
98 | CFS Pickup |
48 | Construction Site Delivery |
47 | Construction Site Pickup |
88 | Delivery Notification Fee (XPO Only) |
4 | Farm / Country Club / Estate Delivery |
97 | Farm / Country Club / Estate Pickup |
61 | Gov / Airport / Mine / Oil / Gas Delivery (XPO Only) |
62 | Gov / Airport / Mine / Oil / Gas Pickup (XPO Only) |
43 | Grocery Warehouse (Central Transport Only) |
5 | Hazmat |
100 | Hotel Delivery |
6 | Inside Delivery |
7 | Inside Pickup |
8 | Liftgate Delivery |
9 | Liftgate Pickup |
59 | Limited Access Delivery |
58 | Limited Access Pickup |
10 | Military / Prison / Camp Delivery |
65 | Mini Storage Unit Delivery (Estes Only) |
64 | Mini Storage Unit Pickup (Estes Only) |
90 | Notification Prior To Delivery |
104 | Over 12 ft but less than 16 |
105 | Over 16 ft but less than 20 |
106 | Over 20 ft |
103 | Over 8 ft but less than 12 |
11 | Place of Worship Delivery |
18 | Protect From Freezing |
12 | Residential Delivery / Non Commercial Delivery |
13 | Residential Pickup / Non Commercial Pickup |
14 | Saturday Delivery |
15 | Saturday Pickup |
16 | School Delivery |
96 | School Pickup |
101 | Shopping Mall Delivery |
102 | Storage Facility Delivery |
54 | Time Date Critical or Appointment (XPO Logistics Only) |
46 | Trade Show / Expo Delivery |
45 | Trade Show / Expo Pickup |
Integration Calls
TMS fields included in each call are provided below.
Troubleshoot mismatched Carrier Quotes and Rate Entries with the following components:
Get LTL Carrier Quotes
Origin City (From City)
Origin State (From State)
Origin Zip (From Zip)
Origin Country (From Country)
Destination City (To City)
Destination State (To State)
Destination Zip (To Zip)
Destination Country (To Country)
At least one Line Item is required.
NMFC Class (Class Code)
Weight (Weight)
Note: The AccuFRATE integration does not support filtering Carrier quotes through the Customer Portal with the Portal Quote Direct/Interline Filter field on the Transportation Profile. Selecting Unspecified as a picklist value when using the AccuFRATE integration filters all Carrier quotes.
Tender/Dispatch Loads
The Tender/Dispatch Request sends the Load tender and any Pickup/Delivery information to the Carrier.
TMS Operation | AccuFRATE Endpoint | Request Type | Response |
---|---|---|---|
Tender Loads through AccuFRATE | CreateShipment | POST | 200: Success |
Each Carrier Quote returned from the Rate Request Response contains a unique ID that is stored in the Carrier Quote Reference field.
The following logic determines the information sent to AccuFRATE for Pickup or Delivery Instructions in the Special Instructions element.
When both First and Last Stop location Instructions fields contains value, both Stop Instructions are included in the Special Instructions element.
In cases when only First Stop or Last Stop Instructions fields contain values, the single Stop instructions are included in the Special Instructions element.
If both First and Last Stop location Instructions fields contain no value, no value is included in the Special Instructions element.
TMS Fields Included in CreateShipment call
Object | Field | Type | AccuFRATE Field |
---|---|---|---|
Account | Account Name | Consignee (Ship To) Name | ConsigneeCompany |
Account | Account Name | Shipper (Ship From) Name | ShipperCompany |
Account | Shipping Address | Consignee (Ship To) Address | ConsigneeAddress1 |
Account | Shipping Address | Shipper (Ship From) Address | ShipperAddress1 |
Carrier Quote | Carrier Quote Reference | Text(100) | QuoteDetailId |
Contact | Consignee (Ship To) Email | ConsigneeEmail | |
Contact | Phone | Consignee (Ship To) Phone | ConsigneePhone |
Contact | Name | Consignee (Ship To) Name | ConsigneeContact |
Contact | Name | Shipper (Ship From) Name | *ShipperContact |
Contact | Shipper (Ship From) Email | ShipperEmail | |
Contact | Phone | Shipper (Ship From) Phone | ShipperPhone |
Line Item | Handling Units | Picklist | ItemTypeCode |
Line Item | Item Description | Text(255) | Description |
Line Item | Item Number | Text(80) | Reference |
Line Item | HU Count | Number(18, 0) | Quantity |
Line Item | NMFC Class | Picklist | ClassCode |
Line Item | NMFC Number | Text(20) | NMFCCode |
Line Item | Weight | Number(18, 0) | Weight |
Load | Expected Ship Date | Formula (Date) | PickUpDate |
Load | PO Number | Text(100) | PONumber |
Stop (Pickup) | Appointment Time | Text(11) | PickUpReadyTime, PickUpCloseTime |
Stop (Delivery) | Instructions | Long Text Area(2000) | SpecialInstructions |
Stop (Pickup) | Instructions | Long Text Area(2000) | SpecialInstructions |
Stop (Pickup) | Shipping/Receiving Hours | Text(11) | PickUpReadyTime, PickUpCloseTime |
TMS sends ‘true’ | IsPickUpRequired |
*The Shipper Contact is required if Auto Dispatch is selected.
Note: The Line Item Weight field is sent in pounds. Line Item weights in kilograms are converted to pounds.
Sample CreateShipment Request Payload
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:acc="http://schemas.datacontract.org/2004/07/accufRATE.accufRATE">
<soapenv:Header />
<soapenv:Body>
<tem:CreateShipment>
<tem:request>
<acc:Authentication>
<acc:Mode>C</acc:Mode>
<acc:Password>*********</acc:Password>
<acc:UserName>test@test.com</acc:UserName>
</acc:Authentication>
<acc:ConsigneeAddress1>999 Test St</acc:ConsigneeAddress1>
<acc:ConsigneeCompany>ABC Company</acc:ConsigneeCompany>
<acc:ConsigneeContact>John</acc:ConsigneeContact>
<acc:ConsigneeEmail>test@test.com</acc:ConsigneeEmail>
<acc:ConsigneePhone>(999) 999-9999</acc:ConsigneePhone>
<acc:FreightItems>
<acc:FreightItem>
<acc:ClassCode>100</acc:ClassCode>
<acc:Description>This is a test</acc:Description>
<acc:Height>48</acc:Height>
<acc:ItemTypeCode>11</acc:ItemTypeCode>
<acc:Length>40</acc:Length>
<acc:NMFCCode />
<acc:Quantity>1</acc:Quantity>
<acc:Reference />
<acc:Weight>500</acc:Weight>
<acc:Width>36</acc:Width>
</acc:FreightItem>
</acc:FreightItems>
<acc:IsPickUpRequired>true</acc:IsPickUpRequired>
<acc:PONumber>TEST1234</acc:PONumber>
<acc:PickUpCloseTime>16:00</acc:PickUpCloseTime>
<acc:PickUpDate>2022-04-18T15:37:30.728532-07:00</acc:PickUpDate>
<acc:PickUpReadyTime>09:00</acc:PickUpReadyTime>
<acc:QuoteDetailId>299803241</acc:QuoteDetailId>
<acc:ReferenceNumber>Test</acc:ReferenceNumber>
<acc:ShipperAddress1>666 Test Dr</acc:ShipperAddress1>
<acc:ShipperCompany>XYZ Company</acc:ShipperCompany>
<acc:ShipperContact>Jags</acc:ShipperContact>
<acc:ShipperEmail>xyz@test.com</acc:ShipperEmail>
<acc:ShipperPhone>(666) 666-6666</acc:ShipperPhone>
<acc:ShipperReferenceCode />
<acc:SpecialInstructions>Test shipment</acc:SpecialInstructions>
</tem:request>
</tem:CreateShipment>
</soapenv:Body>
</soapenv:Envelope>
Sample CreateShipment Response Payload
<s:Envelope
xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<CreateShipmentResponse
xmlns="http://tempuri.org/">
<CreateShipmentResult
xmlns:a="http://schemas.datacontract.org/2004/07/accufRATE.accufRATE"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:BolID>999999</a:BolID>
<a:ErrorMessages
xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<b:string />
</a:ErrorMessages>
<a:IsRequestValid>true</a:IsRequestValid>
<a:LabelImageData i:nil="true" />
<a:PRONumber>TEST1234
</a:PRONUmber>
<a:PickupNumber>12345678
</a:PickupNUmber>
<a:TmsOrderNumber i:nil="true" />
<a:TmwOrderNumber i:nil="true" />
<a:WGAgentAddress i:nil="true" />
<a:WGTrackingNumber i:nil="true" />
</CreateShipmentResult>
</CreateShipmentResponse>
</s:Body>
</s:Envelope>
TMS Field Updates
Object | Field | Type | AccuFRATE Field |
---|---|---|---|
Load | API Load Id | Text(40) | WGTrackingNumber |
Load | Bill of Lading Number | Text(55) | BolID |
Load | PRO Number | Text(40) | PRONumber |
Stop | References | Text(255) | PickUpNumber |
Track Shipment/Track Request
The Bill of Lading Number or PRO Number or API Load Id fields are used as tracking numbers.
Field Reference
Object | Field | Type | AccuFRATE Field |
---|---|---|---|
Account | Account Name | Consignee (Ship To) Name | ConsigneeCompany |
Account | Account Name | Shipper (Ship From) Name | ShipperCompany |
Account | Shipping Address | Consignee (Ship To) Address | ConsigneeAddress1 |
Account | Shipping Address | Shipper (Ship From) Address | ShipperAddress1 |
Carrier Quote | Carrier Quote Reference | Text(100) | AccountNumber and QuoteDetailId |
Contact | Consignee (Ship To) Email | ConsigneeEmail | |
Contact | Phone | Consignee (Ship To) Phone | ConsigneePhone |
Contact | Name | Consignee (Ship To) Name | ConsigneeContact |
Contact | Name | Shipper (Ship From) Name | *ShipperContact |
Contact | Shipper (Ship From) Email | ShipperEmail | |
Contact | Phone | Shipper (Ship From) Phone | ShipperPhone |
Line Item | Handling Units | Picklist | ItemTypeCode |
Line Item | Item Description | Text(255) | Description |
Line Item | Item Number | Text(80) | Reference |
Line Item | HU Count | Number(18, 0) | Quantity |
Line Item | NMFC Class | Picklist | ClassCode |
Line Item | NMFC Number | Text(20) | NMFCCode |
Line Item | Weight | Number(18, 0) | Weight |
Load | API Load Id | Text(40) | WGTrackingNumber |
Load | Bill of Lading Number | Text(55) | BolID |
Load | Expected Ship Date | Formula (Date) | PickUpDate |
Load | PO Number | Text(100) | PONumber |
Load | PRO Number | Text(40) | PRONumber |
Stop (Pickup) | Appointment Time | Text(11) | PickUpReadyTime, PickUpCloseTime |
Stop (Delivery) | Instructions | Long Text Area(2000) | SpecialInstructions |
Stop (Pickup) | Instructions | Long Text Area(2000) | SpecialInstructions |
Stop | References | Text(255) | PickUpNumber |
Stop (Pickup) | Shipping/Receiving Hours | Text(11) | PickUpReadyTime, PickUpCloseTime |
TMS sends ‘true’ | IsPickUpRequired |
Errors
Error Code/Message | Resolution/Description |
---|---|
Carrier authentication failed. | UserId and/or password is incorrect. |
For more information visit: http://www.accufrate.com/.