ABF: API Dispatching Documentation

AAA Cooper Transportation API Integration Documentation

Overview of the Integration

This integration connects our system with AAA Cooper Transportation's web services to obtain pickup numbers for freight shipments. The API allows us to automatically schedule pickups by sending shipment details and receiving a confirmation number, streamlining the logistics process.

Data Points & Mapping

Shipper Information

| Frontend Label | Backend Property | API Data Point | Data Type | Description |

|---------------|------------------|----------------|-----------|-------------|

| Company Name | Shipper.CompanyName | PkupCompanyName | String | Name of the shipping company |

| Address | Shipper.Address.AddressLine | PkupCompanyAddress | String | Street address of pickup location |

| City | Shipper.Address.City | PkupCompanyCity | String | City of pickup location |

| State | Shipper.Address.State | PkupCompanyState | String | State of pickup location |

| ZIP Code | Shipper.Address.Zip | PkupCompanyZip | String | ZIP code of pickup location |

| Country | Shipper.Address.Country | PkupCompanyCountry | String | Country of pickup location |

| Contact Person | Shipper.ContactPerson | PkupCompanyContact | String | Contact person at pickup location |

| Phone | Shipper.Phone | PkupCompanyPhone | String | Contact phone number |

| Email | Shipper.Email | PkupCompanyEmail | String | Contact email address |

Consignee (Recipient) Information

| Frontend Label | Backend Property | API Data Point | Data Type | Description |

|---------------|------------------|----------------|-----------|-------------|

| Company Name | Consignee.CompanyName | DestinationCompanyName | String | Name of receiving company |

| Contact Person | Consignee.ContactPerson | DestinationCompanyContact | String | Contact at delivery location |

| Address | Consignee.Address.AddressLine | DestinationCompanyAddress | String | Delivery street address |

| City | Consignee.Address.City | DestinationCity | String | Delivery city |

| State | Consignee.Address.State | DestinationState | String | Delivery state |

| ZIP Code | Consignee.Address.Zip | DestinationZip | String | Delivery ZIP code |

| Country | Consignee.Address.Country | DestinationCountry | String | Delivery country |

| Phone | Consignee.Phone | DestinationCompanyPhone | String | Delivery contact phone |

| Email | Consignee.Email | DestinationCompanyEmail | String | Delivery contact email |

Shipment Details

| Frontend Label | Backend Property | API Data Point | Data Type | Description |

|---------------|------------------|----------------|-----------|-------------|

| Pickup Date | PickupDate | PickupDate | Date | Requested pickup date |

| Ready Time | ReadyTime | ReadyTime | Time (HH:mm) | When shipment will be ready |

| Close Time | CloseTime | CloseTime | Time (HH:mm) | Latest pickup time |

| Number of Pieces | Commodities.Pieces | Pieces | String | Total number of items |

| Total Weight | Commodities.Weight | TotalWeight | String | Total shipment weight |

| Load ID | ClientLoadId | BOLID | String | Bill of Lading ID |

| Hazardous Materials | Commodities.Hzmt | IsHazmat | String (Y/N) | Indicates hazardous materials |

| Number of Pallets | NumberOfPallet | Pieces | String | Number of pallets if applicable |

Note: When pallets are used, the Pieces field represents pallet count instead of individual pieces.

Accessorials

| Frontend Label | Backend Property | API Data Point | Data Type | Description |

|---------------|------------------|----------------|-----------|-------------|

| Guaranteed Delivery | Commodities.Description | IsACTGuaranteedDay | String (Y/N) | Premium guaranteed delivery service |

Workflow & Integration Details

1. User enters shipment details in our system

2. System prepares the data and sends it to AAA Cooper's web service

3. API processes the request and returns either:

4. A pickup request number (success)

5. An error code and message (failure)

6. System stores the response and displays confirmation or error to user

Technical Setup

·  Endpoint: http://wsportal.aaacooper.com:8188/wsportal20/wsPickUpRq

·  Authentication: TokenID required

·  Character Encoding: ISO-8859-1

·  Message Format: SOAP 1.1

Key Considerations & Edge Cases

·  Comments field is limited to 100 characters

·  Development mode includes "Testing do not process" message

·  System combines multiple reference numbers and comments into a single field

·  Special handling for palletized shipments vs. individual pieces

Example Scenario

A typical pickup request might look like:

1. User enters shipping details for 5 pallets of non-hazardous materials

·  System sends request to AAA Cooper

·  API returns a pickup number

·  System displays confirmation to user with pickup number

Additional Notes

·  The integration supports both regular and guaranteed delivery services

·  References (PO, Shipper Number) and comments are combined in the pickup comments field

·  System automatically calculates total pieces and weight from individual commodity entries