Fall '24 Worldwide Express (WWEX) Speedship

Overview

The Worldwide Express (WWEX) Speedship integration allows users to:

• Receive LTL Carrier rates and services.

• Obtain cargo insurance on a per-load basis.

• Tender loads to Carriers. 

• Track load status. 

The Winter ‘25 Revenova TMS release package must be installed to configure and use the WWEX Speedship integration.

Setup

WWEX is replacing their existing integration with the new Speedship integration. For existing users, disable the old version first before configuring the new Speedship integration. Navigate to the Worldwide Express card in TMS Admin, Credentials. Uncheck the Enabled box and click Save.

Enter Credentials

Enable the Worldwide Express integration by completing the following steps.

1. Navigate to TMS Admin.

2. Select Credentials. 

3. Select the Global Services tab.

4. Find WWEX Speedship in the list and open the card. 

5. Check the Enabled box.

6. Enter the User ID and Password 1 into the text fields. 

7. Click the Save button when finished.

Valid credentials are required from a Worldwide Express subscription. See examples in the table below.

See Instructions for requesting an API Authentication Key.

Remote Site Settings

If upgrading from a previous release of the TMS, check that the Remote Site Settings for the WWEX integration URL are current.

1. Click the Setup gear icon in the top right corner.

2. From the drop-down, click Setup.

3. In the Quick Find Toolbar type Remote Site Settings and click the link.

4. From the list of remote sites find Worldwide Express and click the Edit link.

5. Update the Remote Site URL to match the Service URL below: 

Service URL: https://www.speedship.com

Test Service URL: https://speedship.staging-wwex.com

TMS Admin

Set the following fields in TMS Admin, Configuration to mange how often load status updates are requested by the TMS. These requests are handled by the LoadStatusUpdateJob, which should be running to request load tracking information.

• Load Status Start Time

• Load Status API Frequency (Hrs)

WWEX Speedship-specific Carrier Services

Carrier Service(s) are required for LTL WWEX Speedship Carriers. Create a Carrier Service for each Carrier receiving quotes and tendering loads through WWEX.

See Carrier Service Setup documentation for more specific instructions.

Insurance Setup

Requesting cargo insurance through the WWEX Speedship requires several fields. It is recommended to add the following fields to the corresponding field sets and set the fields as required. Any missing fields present an error to the user.

• Commodity Condition: Load Field Sets - TMS1, (Also available in Load TMS7, TMS10).

• Insured Commodity Category: Line Item Field Set - TMS1. (Also available in TMS4, TMS6).

All line items must have the same Insured Commodity Category.

• Cargo Value: Load Field Set - TMS1.

• NMFC Class, HU Count or Handling Units: Line Item - TMS7

• Shipping/Receiving Contact for all Load Stops: Stop - TMS1.

• Add any other additional Line Item fields to Line Item Field Set - TMS7, as necessary.

By default All Risk Insurance is set as the Cargo Insurance Accessorial. Another accessorial may be used by navigating to TMS Admin → Configuration and setting another accessorial in the Cargo Insurance Accessorial field.

Ensure the All Risk Insurance (or another configured accessorial) is available during load creation.

1. From TMS Admin → Accessorials, click Edit for All Risk Insurance.

2. Check the Pre-Quote box.

3. Click Save.

During load configuration, the Cargo Insurance Accessorial must also be added as a Load Accessorial. Select it on the Load Configuration LWC or add it via the Load Accessorials related list. When the Cargo Insurance Accessorial is added to a load, the Location Names and Addresses of the Stops are also sent to WWEX.

• When insurance is requested, WWEX returns Carrier quotes including insurance and quotes without. For convenience, the TMS does not display quotes without insurance.

• All insurance quote information received from the WWEX integration is stored on the Carrier Quote record. The WWEX-specific insurance information is NOT available in the Insurance LWC.

Insurance in the Customer Portal Quote Wizard

To successfully receive quotes from WWEX with cargo insurance in the Customer Portal, each stop must have a contact. It is possible to provide Customer Portal users the ability to see Stop contacts.

1. Navigate to Setup.

2. Search for Digital Experiences.

3. Click the Settings link.

4. Check the box for, “Allow users to see contacts that have not been enabled for partner or customer accounts.”

5. Click Save.

When checked, Customer Portal users can view all Shipping/Receiving contacts. If left un-checked, they only see contacts enabled as partner or customer accounts. With either setting, Customer Portal users may create new Stop contacts.

The Insured Commodity Category field must be the same for all line items on a single load.

Ensure the LTL Mode and the All Risk Insurance (or custom) accessorial are available to Customer Portal users.

From TMS Admin → Modes, confirm the Customer Portal Selection box is checked for the LTL Mode.

From TMS Admin → Accessorials, confirm the Customer Portal Selection box is checked for the All Risk Insurance accessorial.

When using the Customer Portal and requesting cargo insurance through WWEX, there are multiple recommendations for ease of use.

• Set the Cargo Insurance Option field to Hide. This hides fields related to acquiring insurance through the Falvey integration.

• Add the Commodity Condition field to the Load TMS10 field set.

• Add the Cargo Value field to the Load TMS10 field set.

• Add the Insured Commodity Category field to the Line Item TMS6 field set.

• If using a custom accessorial, clone the All Risk Insurance accessorial and rename it to the preferred name. Add the new accessorial name to the Cargo Insurance Accessorial under TMS Admin → Configuration.

Integration Calls

• The WWEX Speedship integration only supports 2 Stop Loads. If more than 2 Stop locations are included on a Load, no information returns.

• WWEX Speedship 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.

• The WWEX Speedship integration only supports USD currency.

shopFlow

When an action occurs in the TMS that initiates a load rating, the shopFlow LTL request is sent. Load Stop addresses, contact, and accessorial information are sent to the WWEX endpoint. Carrier quotes return to the TMS.

Each quote returns with the offerId and productTransactionId fields and stored in the Carrier Quote Quote/Contract ID field. These fields are stored and included in subsequent calls to the WWEX Speedship integration. These fields are used as WWEX internal reference fields to track the load within their system.

Quote Requirements

Loads are rated when:

1. A user navigates to the Freight Quote Assistant for the first time.

2. A user refreshes quotes on the Carrier Quote Builder portion of the FQA.

3. A user clicks the Rerate action on the Customer Quote Builder portion of the FQA.

4. A user refreshes quotes on the Carrier Quote List LWC.

5. Users create loads with the Quote Wizard in the Customer Portal.

6. Creating loads with the LTL Pricing Workbench.

7. A new load is saved with the Save & Rate feature enabled. 

When Save & Rate is enabled, loads are rated:

1. By clicking Save & Rate as part of new load creation.

2. When loads are cloned and Save & Rate is checked.

3. When inbound EDI 204 LTL load tenders are received.

The Save & Rate feature uses a Platform Event to contact WWEX for quotes. Users see the error message depending on the method of creating the load.

• Load Configuration LWC: Error displays when the load record is created.

• Load Clone VFP: Error displays when first navigating to the Freight Quote Assistant.

• Inbound EDI 204: Error displays when first navigating to the Freight Quote Assistant.

A message displays success or any error information when retrieving Carrier quotes from WWEX.

When Logging is enabled, messages are displayed to the user with the number & description describing why Carrier quotes were filtered out.  Reasons include:

• Insurance was requested but the Carrier quotes did not contain the insurance accessorial.

• Received a quote from a Carrier but there is not an existing WWEX Speedship Carrier Service.

• There were duplicate quotes for that Carrier with the same Cost, Service Level, and Transit Time.

Exhibition Trade Show Delivery or Exhibition Trade Show Pickup accessorial charges require NMFC Class 125 for all line items included on a load.

The following fields are required to receive quotes from the WWEX integration.

• Handling Units (for each line item)

• HU Count (for each line item)

• Location Name (Origin & Destination)

• Mode (Must be LTL)

• NMFC Class (for each line item)

• Stop City (Origin & Destination)

• Stop State (Origin & Destination)

• Stop Zip (Origin & Destination)

• Shipping/Receiving Contact Phone (Origin & Destination)

• Weight

• Weight Units

The WWEX Speedship integration requires weight in pounds. Weights in kilograms are automatically calculated to pounds before sending to WWEX Speedship.

The provided sample payloads do not contain hazardous materials information. See the API Field Mapping section below for reference regarding sending and receiving hazardous materials information to WWEX.

Sample Get Quotes Operation (with Insurance) Request Payload

{
  "request": {
    "productType": "LTL",
    "shipment": {
      "shipmentDate": "2024-02-07 09:00:00",
      "originAddress": {
        "address": {
          "addressLineList": [
            "1901 West Madison Street"
          ],
          "locality": "Chicago",
          "region": "IL",
          "postalCode": "60612",
          "countryCode": "US",
          "companyName": "Chicago Bulls",
          "phone": "3129997777",
          "contactList": [
            {
              "phone": "3129997777"
            }
          ]
        }
      },
      "destinationAddress": {
        "address": {
          "addressLineList": [
            "1435 Fox St."
          ],
          "locality": "Denver",
          "region": "CO",
          "postalCode": "80204",
          "countryCode": "US",
          "companyName": "Denver Deli Meats",
          "phone": "3129997777",
          "contactList": [
            {
              "phone": "3129997777"
            }
          ]
        }
      },
      "handlingUnitList": [
        {
          "billedDimension": {
            "length": {
              "value": "30.00",
              "unit": "cm"
            },
            "width": {
              "value": "60.00",
              "unit": "cm"
            },
            "height": {
              "value": "60.00",
              "unit": "cm"
            }
          },
          "isStackable": false,
          "packagingType": "BAG",
          "quantity": 6,
          "shippedItemList": [
            {
              "commodityClass": "125",
              "commodityDescription": "Material78*(",
              "commodityType": "BAG",
              "isHazMat": false,
              "hazMatItemInfo": [
                {
                  "hazIdentificationNbr": "N/A",
                  "hazProperShippingName": "Material78*("
                }
              ],
              "name": "Material78*(",
              "NMFCDescription": "Material78*(",
              "weight": {
                "value": 2200,
                "unit": "LB"
              }
            }
          ],
          "sortAndSegregateFlag": false,
          "weight": {
            "value": 2200,
            "unit": "LB"
          }
        }
      ],
      "totalWeight": {
        "value": 2200,
        "unit": "LB"
      },
      "insuranceRequestFlag": true,
      "insuredItemConditions": "NEW",
      "insuredCommodityCategory": "403",
      "totalDeclaredValue": {
        "value": "50000.00",
        "unit": "USD"
      },
      "totalHandlingUnitCount": 6,
      "shipmentReferenceList": [
        {
          "type": "Load Number",
          "value": "L-5",
          "isPrintAsBarCode": false
        }
      ],
      "holdAtTerminalFlag": false,
      "insideDeliveryFlag": false,
      "insidePickupFlag": false,
      "carrierTerminalPickupFlag": false,
      "liftgateDeliveryFlag": false,
      "liftgatePickupFlag": false,
      "notifyBeforeDeliveryFlag": false,
      "protectionFromColdFlag": false,
      "protectionFromHeatFlag": false,
      "residentialDeliveryFlag": false,
      "residentialPickupFlag": false,
      "sortAndSegregateFlag": false,
      "pickupSpecialInstructions": "Pickup Instructions",
      "deliverySpecialInstructions": "Delivery Instructions",
      "tradeshowDeliveryFlag": true,
      "tradeshowDeliveryName": "Denver Deli Meats",
      "tradeshowPickupFlag": false
    }
  },
  "correlationId": "WWEX-M2M-shopFlow-ltl"
}

Sample Get Quotes Operation (with Insurance) Response Payload

{
    "generalVendorContract": {
        "id": "63eadab6-1b53-4656-8565-64e98d418492"
    },
    "primaryVendor": {
        "vendorId": "CTII",
        "preferredName": "CENTRAL TRANSPORT",
        "contactList": [{
                "lastName": "NA",
                "apiVersion": "2",
                "preferredContactMethod": "Phone",
                "phone": "586-467-1900",
                "contactType": "ACCOUNT",
                "id": "1211275003",
                "email": "vendor@noemailprovided.com"
            },
            {
                "lastName": "NA",
                "apiVersion": "2",
                "preferredContactMethod": "Email",
                "contactType": "REMITTANCE",
                "id": "-392708112",
                "email": "KMCCARDY@CENTRALTRANSPORTINT.COM"
            }
        ],
        "scac": "CTII"
    },
    "offeredProductList": [{
            "offerPrice": {
                "unit": "USD",
                "apiVersion": "1",
                "value": 1151.72
            },
            "creationMode": "AUTO",
            "linearFootCharge": {
                "unit": "USD",
                "apiVersion": "1"
            },
            "serviceDetail": {
                "name": "DEFAULT"

            },
            "offeredProductId": "936d1b0e-4c31-4802-a684-25ecba3236c2",
            "linearFootWeight": {
                "unit": "LB",
                "apiVersion": "1"
            },
            "apiVersion": "1",
            "chargeItemList": [{
                    "matchOnRequestChargeItem": true,
                    "itemCode": "FRT",
                    "customerChargeCode": "FREIGHT",
                    "customerPrice": {
                        "unit": "USD",
                        "apiVersion": "1",
                        "value": 722.12
                    },
                    "chargeCodeCategory": "FREIGHT",
                    "isIncludedInFuelSurcharge": true,
                    "chargeItemId": "8da4b0ce-6815-4630-bdc7-9e35addfcee3",
                    "description": "FREIGHT",
                    "customerDescription": "FREIGHT",
                    "uplift": null,
                    "upliftPercent": null
                },
                {
                    "hideOnVendorInvoice": false,
                    "chargeType": "Fuel",
                    "customerPrice": {
                        "unit": "USD",
                        "apiVersion": "1",
                        "value": 191.36
                    },
                    "customerChargeCode": "FSC",
                    "createDateTime": "2024-02-07 20:08:30",
                    "apiVersion": "4",
                    "chargeCodeCategory": "FUEL",
                    "chargeItemId": "90089ec7-d733-4d29-8f13-788e6d9d1277",

                    "isIPMChargeItem": false,
                    "description": "FUEL SURCHARGE",

                    "customerDescription": "FUEL SURCHARGE"
                },
                {
                    "hideOnVendorInvoice": false,
                    "customerChargeCode": "CNVDEL",
                    "customerPrice": {
                        "unit": "USD",
                        "apiVersion": "1",
                        "value": 150
                    },
                    "apiVersion": "4",
                    "chargeCodeCategory": "ACCESSORIAL",
                    "chargeItemId": "4fbefb62-ec60-4204-890f-0fe7a435493a",

                    "isIPMChargeItem": false,
                    "description": "CONVENTION/TRADESHOW DELIVERY",
                    "customerDescription": "CONVENTION/TRADESHOW DELIVERY"
                },
                {
                    "hideOnVendorInvoice": false,
                    "description": "HIGH COST PICKUP",
                    "customerChargeCode": "HCP",
                    "customerPrice": {
                        "unit": "USD",
                        "apiVersion": "1",
                        "value": 88.24
                    },
                    "createDateTime": "2024-02-07 20:08:30",
                    "apiVersion": "4",
                    "chargeCodeCategory": "ACCESSORIAL",
                    "chargeItemId": "565fcdba-93dc-4276-9f39-d687c944e94d",

                    "isIPMChargeItem": false,
                    "customerDescription": "HIGH COST PICKUP"
                }
            ],
            "shopRQShipment": {
                "notifyBeforeDeliveryFlag": false,
                "totalVolume": {
                    "unit": "CU_FT",
                    "apiVersion": "1",
                    "value": 600

                },
                "utilitySiteDeliveryFlag": false,
                "totalDeclaredValue": {
                    "value": "50000.00",
                    "unit": "USD"
                },
                "militaryPickupFlag": false,
                "insideDeliveryFlag": false,
                "largestLinearFeet": {
                    "unit": "IN",
                    "apiVersion": "1",
                    "value": 30
                },
                "deliverySpecialInstructions": "Delivery Instructions",
                "originalTotalVolume": {
                    "unit": "CU_FT",
                    "apiVersion": "1",
                    "value": 62.5
                },
                "pierPortWarfPickupFlag": false,
                "securedLocationDeliveryFlag": false,
                "constructionSitePickupFlag": false,
                "tradeshowDeliveryFlag": true,
                "unspecifiedPickupFlag": false,
                "totalLinearLength": {
                    "unit": "IN",
                    "apiVersion": "1",
                    "value": 180
                },
                "billedDestinationAddress": {
                    "address": {
                        "addressLineList": [
                            "1435 Fox St."
                        ],
                        "contactList": [{
                            "phone": "3129997777"
                        }],
                        "phone": "3129997777",
                        "countryCode": "US",
                        "postalCode": "80204",
                        "companyName": "Denver Deli Meats",
                        "latitude": "39.7348",
                        "locality": "Denver",
                        "region": "CO",
                        "longitude": "-105.021"
                    }
                },
                "containerFreightStationDeliveryFlag": false,
                "callPCMilerApi": true,
                "constructionSiteDeliveryFlag": false,
                "pierPortWarfDeliveryFlag": false,
                "cemeteryDeliveryFlag": false,
                "carrierTerminalDeliveryFlag": false,
                "totalHandlingUnitCount": 6,
                "sourceShipment": "WWEXM2M",
                "isInternationalShipment": false,
                "billToInfoList": [{
                    "billToCountryCode": "US",
                    "billToAccountNbr": "2RY229",
                    "shipmentChargeType": "Transportation",
                    "billToType": "SENDER",
                    "companyName": "Chicago Bulls",
                    "billToPostalCode": "60612"
                }],
                "pickupSpecialInstructions": "Pickup Instructions",
                "totalPcsCount": 0,
                "maxWeightOnHUPerPLT": 366.67,
                "parkPickupFlag": false,
                "commercialDeliveryFlag": false,
                "totalNewLimitsOfLiability": {
                    "unit": "USD",
                    "apiVersion": "1",
                    "value": 15400
                },
                "insuranceRequestFlag": true,
                "securedLocationPickupFlag": false,
                "mallShoppingCenterDeliveryFlag": false,
                "minePickupFlag": false,
                "tradeshowDeliveryName": "Denver Deli Meats",
                "containerFreightStationPickupFlag": false,

                "limitedAccessAirportDeliveryFlag": false,
                "distributionCenterPickupFlag": false,
                "insuredCommodityCategory": "403",
                "insidePickupFlag": false,
                "carrierTerminalPickupFlag": false,
                "tradeshowPickupFlag": false,
                "liftgateDeliveryFlag": false,
                "limitedAccessPickupFlag": false,
                "limitedAccessGovernmentFacilityDeliveryFlag": false,
                "commercialPickupFlag": false,
                "protectionFromColdFlag": false,
                "isMultiClass": false,
                "mallShoppingCenterPickupFlag": false,
                "billedOriginAddress": {
                    "address": {
                        "postalCode": "60612",
                        "companyName": "Chicago Bulls",
                        "latitude": "41.8797",
                        "locality": "Chicago",
                        "timeZone": "America/Chicago",
                        "addressLineList": [
                            "1901 West Madison Street"
                        ],
                        "contactList": [{
                            "phone": "3129997777"
                        }],
                        "phone": "3129997777",
                        "countryCode": "US",
                        "region": "IL",
                        "longitude": "-87.686"
                    }
                },
                "packageTypes": "BAG",
                "shipmentReferenceList": [{
                    "type": "Load Number",
                    "value": "L-5",
                    "isPrintAsBarCode": false
                }],

                "timeInTransit": {
                    "apiVersion": "2",
                    "scac": "CTII",
                    "milesInTransit": "1003.52",
                    "transitDays": 3,
                    "serviceLevel": "STANDARD",
                    "estimatedDeliveryDate": "2024-02-12",
                    "productType": "LTL",
                    "originTerminal": {
                        "apiVersion": "3",
                        "terminal": {
                            "apiVersion": "1",
                            "terminalCode": "606"
                        },
                        "service": "Direct"
                    },
                    "destTerminal": {
                        "apiVersion": "3",
                        "terminal": {
                            "apiVersion": "1",
                            "terminalCode": "802"
                        },
                        "service": "Direct"
                    }
                },
                "protectionFromHeatFlag": false,
                "shipmentDate": "2024-02-07 09:00:00",
                "handlingUnitList": [{
                    "handlingUnitId":

                        "24df92be-6201-4909-9260-3b85896d7496",

                    "quantity": 6,
                    "billedDimension": {
                        "length": {
                            "value": "30.00",
                            "unit": "cm"
                        },
                        "width": {
                            "value": "60.00",
                            "unit": "cm"
                        },
                        "height": {

                            "value": "60.00",
                            "unit": "cm"
                        }
                    },
                    "weight": {
                        "value": 2200,
                        "unit": "LB"
                    },
                    "isMixedClass": false,
                    "shippedItemList": [{
                        "NMFCDescription": "Material78*(",
                        "itemId":

                            "37b32016-f3de-4bd8-b566-007eb3eb1f6d",

                        "updatedCommodityClass": "125",
                        "commodityDescription": "Material78*(",
                        "name": "Material78*(",
                        "weight": {
                            "value": 2200,
                            "unit": "LB"
                        },
                        "commodityClass": "125",
                        "commodityType": "BAG",
                        "isHazMat": false,
                        "hazMatItemInfo": [{
                            "hazIdentificationNbr": "N/A",
                            "hazProperShippingName":

                                "Material78*("

                        }]
                    }],
                    "isStackable": false,
                    "billedWeight": {
                        "unit": "LB",
                        "apiVersion": "1",
                        "value": 2200
                    },
                    "deficitWeight": {
                        "unit": "LB",
                        "apiVersion": "1",

                        "value": 0
                    },
                    "class": "125",
                    "packagingType": "BAG",
                    "sortAndSegregateFlag": false
                }],
                "limitedAccessAirportPickupFlag": false,
                "liftgatePickupFlag": false,
                "cemeteryPickupFlag": false,
                "averageDensity": {
                    "unit": "LB_PER_CU_FT",
                    "apiVersion": "1",
                    "value": 3.67
                },
                "countryGolfDeliveryFlag": false,
                "holdAtTerminalFlag": false,
                "distributionCenterDeliveryFlag": false,
                "limitedAccessGovernmentFacilityPickupFlag": false,
                "totalOldLimitsOfLiability": {
                    "unit": "USD",
                    "apiVersion": "1",
                    "value": 220
                },
                "parkDeliveryFlag": false,
                "countryGolfPickupFlag": false,
                "limitedAccessDeliveryFlag": false,
                "mineDeliveryFlag": false,
                "utilitySitePickupFlag": false,
                "specialInstructions": "Do Not Stack Some Items - See
                Descriptions, Trade Show Delivery - Denver Deli Meats ",
                "militaryDeliveryFlag": false,
                "vendorBasePriceQualified": true,
                "totalWeight": {
                    "unit": "LB",
                    "apiVersion": "1",
                    "value": 2200
                },
                "insuredItemConditions": "NEW",
                "residentialPickupFlag": false,
                "unspecifiedDeliveryFlag": false,
                "sortAndSegregateFlag": false,

                "residentialDeliveryFlag": false
            },
            "productType": "LTL"
        },
        {
            "insurance": {
                "certificateNumber": "874d580c59564da59839d059be8495ab",
                "deductibleAmount": {
                    "unit": "USD",
                    "value": "0.00"
                },
                "termsAndConditions": "All Risk Coverage. Warranted must
                be properly packed
                for intended transport with itemized inventory.All packaging and
                packing materials must be new.Pictures may be required upon request.Concealed damage
                must be reported within 30 days of delivery.
                ",
                "insuredAmount": {
                    "unit": "USD",
                    "value": "50000.00"
                },
                "premiumAmount": {
                    "unit": "USD",
                    "value": "257.00"
                },
                "quoteDateTime": "2024-02-07T15:08:32",
                "quoteValidTo": "2024-03-08T15:08:32",
                "status": "UNCONFIRMED"
            },
            "apiVersion": "1",
            "offerPrice": {
                "value": 257,
                "unit": "USD"
            },
            "creationMode": "AUTO",
            "offeredProductVendor": {
                "id": "9a754047-4d4b-38a8-a946-4bf6b92de208"
            },
            "chargeItemList": [{
                "apiVersion": "4",
                "hideOnVendorInvoice": false,
                "chargeCodeCategory": "INSURANCE",
                "customerChargeCode": "INSURANCE",

                "customerPrice": {
                    "unit": "USD",
                    "value": "257.00"
                },
                "isIPMChargeItem": false,
                "description": "INSURANCE",
                "customerDescription": "INSURANCE"
            }],
            "offeredProductId": "aea5a152-3ee6-4b95-bfee-5049b80482d2",
            "productType": "INSURANCE"
        }
    ],
    "totalOfferPrice": {
        "value": 1408.72,
        "unit": "USD"
    },
    "apiVersion": "3",
    "offerDate": "2024-02-07 14:08:29",
    "offerId": "9dbaa95a-3d58-4bd0-bff7-32890a049bca",
    "customerUserId": "8h94TCp0N6fg09ipP3yyJmfPPv5l1mCD",
    "status": "Created",
    "expirationDate": "2024-03-08 15:08:32",
    "clonedOfferId": "9468c6e4-375b-4d91-8279-62a4621c8e31",
    "hasInsurance": true,
    "productTransactionId": "344e9b80-b86a-4491-bce1-3228b9587170"
}

TMS Field Updates

• WWEX chargeCodeCategory fields are sent for Freight, Fuel, and Accessorial charges. Freight and Fuel contain chargeTypes and Accessorials do not. When no chargeType is present, the TMS processes these fields as Accessorials. The description in the customerChargeCode is used as the Item Description.

• The Liability Coverage field does not update unless insurance is requested in the TMS. The totalNewLimitsOfLiability field received from WWEX is stored in the Third Party Insurance Information field.

• The Carrier Quote Quote/Contract Id field is a combination of the offerId and productTransactionId sent by WWEX Speedship.

• The Pickup date and time for Stop 1 is determined by the Expected Ship Date & Shipping/Receiving Hours for the stop. The Shipping/Receiving Hours beginning time is sent to the WWEX shipmentDate field. When no Shipping/Receiving Hours are present, 12:00pm is sent as default.

• The WWEX Speedship integration does not support Pick Up or Delivery appointment times. It is recommended to include delivery appointment times on the Bill of Lading.

• The WWEX Speedship integration does not support Carrier quote filtering in the Customer Portal. Setting the Portal Quote Direct/Interline Filter on the Transportation Profile does not filter out matching Carrier quotes.

quoteOrderFlow

After quotes are received from the shopFlow call, select a Carrier quote. Tendering the load to the Carrier initiates the call to the quoteOrderFlow endpoint. The offerId and ProductTransactionId fields received in the shopFlow response are included in this call as identification for the load and the Carrier quote. Additional address, contact, and pickup information is sent in the call.

Sending a Tender request to the WWEX Speedship API requires Location Names and Contact information for each Stop on the Load.

• The screenshot below shows Stop 1 with Reference field information populated by the WWEX Speedship integration. The WWEX BOL number is listed as the Bill of Lading Number on the BOL given to the Driver at the time of pick-up. If using a custom BOL, edit the document to use the WWEX Bill of Lading Number.

• The Carrier Remit To field on the Load is used to generate the “Third Party Freight Charges Bill To” information on the Bill of Lading. This information should match the account information below. If using customer-specific pricing, contact a WWEX representative to provide the correct account information.

  • Carrier Payment Processing - Customer Number {WWEX Account Number}

  • PO Box 192629

  • Dallas, TX 75219

When tendering a load to a Carrier, if the Appointment Required field is Checked, the appointmentDeliveryFlag is set as TRUE. No appointment time information is included. The WWEX Speedship integration only supports the Appointment Required field for delivery stops. If the Appointment Required field is Checked for the first Pickup Stop, users receive an error.

Sample Tender load to Carrier Request Payload

{
  "request": {
    "shipmentProductTransactionId": "e04e28c1-3f39-4884-b95e-433f78ad6060",
    "shipmentOfferId": "ff069921-2f5e-42db-aebb-976b55cfc78e",
    "shipment": {
      "originAddress": {
        "address": {
          "addressLineList": [
            "182 W Lake St."
          ],
          "contactList": [
            {
              "firstName": "Joe",
              "lastName": "WWEXSpeedShip Customer",
              "contactType": "SENDER",
              "phone": "3129997777",
              "email": "p45724134@revenova.com"
            }
          ],
          "phone": "3129997777",
          "companyName": "WWEXSpeedShip Customer",
          "countryCode": "US",
          "locality": "Chicago",
          "postalCode": "60601",
          "region": "IL"
        }
      },
      "destinationAddress": {
        "address": {
          "addressLineList": [
            "526 Beacon Street"
          ],
          "contactList": [
            {
              "firstName": "Joe",
              "lastName": "Boston Beans",
              "contactType": "RECEIVER",
              "phone": "3129997777",
              "email": "p98762345@revenova.com"
            }
          ],
          "phone": "3129997777",
          "companyName": "Boston Beans",
          "countryCode": "US",
          "locality": "Boston",
          "postalCode": "02215",
          "region": "MA"
        }
      }
    },
    "isSelfScheduled": true,
    "pickupDate": "2024-02-16 09:00:00",
    "closeTime": "22:00",
    "readyTime": "09:00"
  }
}

Sample Tender load to Carrier Response Payload

{
  "apiVersion": "1",
  "clientStatus": {
    "apiVersion": "1",
    "success": true,
    "message": ""
  },
  "correlationId": "NG-d6154b5b-4772-4714-a158-0f19e9e213de",
  "executionId": "NG-d6154b5b-4772-4714-a158-0f19e9e213de",
  "response": {
    "message": "pickup order successful",
    "pickupOrderResponse": {
      "order": {
        "orderedItemList": [
          {
            "apiVersion": "1",
            "orderedBy": "8h94TCp0N6fg09ipP3yyJmfPPv5l1mCD",
            "orderedItemId": "4f656dea-a1d6-489b-9305-99496a7db542",
            "offerId": "b3dd56ec-db9a-4a20-9011-3246563f0fc2",
            "pickupTxnId": "e1ddedb7-8e9a-42eb-9e3a-b837869972fc",
            "offeredProductId": "8bbc5505-c8b7-4e1f-940b-d7178b742973",
            "status": "ORDERED"
          }
        ],
        "apiVersion": "3",
        "orderId": "82b313b9-6172-462e-8e0e-18db129f8112",
        "orderDate": "2024-02-13",
        "status": "ORDERED"
      }
    },
    "shipmentOrderResponse": {
      "order": {
        "orderedItemList": [
          {
            "orderedItemId": "41140fa0-76d9-488f-8159-a7c2d5e1e1bb",
            "documentList": [
              {
                "s3fileName": "NUD10803646-e04e28c1-3f39-4884-b95e-433f78ad6060-BILL_OF_LADING.pdf",
                "apiVersion": "2",
                "docFormat": "PDF",
                "docType": "BILL_OF_LADING",
                "name": "BILL_OF_LADING",
                "cachingEnabled": false
              },
              {
                "s3fileName": "NUD10803646-e04e28c1-3f39-4884-b95e-433f78ad6060-QUOTE.pdf",
                "apiVersion": "2",
                "docFormat": "PDF",
                "docType": "QUOTE",
                "name": "QUOTE",
                "cachingEnabled": false
              },
              {
                "s3fileName": "NUD10803646-e04e28c1-3f39-4884-b95e-433f78ad6060-PACKING_LIST.pdf",
                "apiVersion": "2",
                "docFormat": "PDF",
                "docType": "PACKING_LIST",
                "name": "PACKING_LIST",
                "cachingEnabled": false
              },
              {
                "s3fileName": "NUD10803646-e04e28c1-3f39-4884-b95e-433f78ad6060-PALLET_LABEL.pdf",
                "apiVersion": "2",
                "docFormat": "PDF",
                "docType": "PALLET_LABEL",
                "name": "PALLET_LABEL",
                "cachingEnabled": false
              }
            ],
            "isPrimary": true,
            "secondaryTxnIdList": [
              {
                "type": "BILL_OF_LADING",
                "value": "NUD10803646"
              }
            ],
            "offerId": "ff069921-2f5e-42db-aebb-976b55cfc78e",
            "handlingUnitIdList": [
              "c049caa6-c7ae-496d-941c-8de133382d49"
            ],
            "error": {
              "errorMessage": "/order/offer/productList/0/shipment/handlingUnit/0/weight/unit LBS is not a valid enum value\n Location: \n Position: Line 0, Column 0",
              "errorDetails": [
                {
                  "severity": "ERROR",
                  "diagnostic": "NG-d6154b5b-4772-4714-a158-0f19e9e213de",
                  "source": "staging-exp-api-vendor-order-v1",
                  "message": "/order/offer/productList/0/shipment/handlingUnit/0/weight/unit LBS is not a valid enum value\n Location: \n Position: Line 0, Column 0"
                }
              ]
            },
            "offeredProductId": "6364d8d7-40c3-49ea-8a99-789ac89887ae"
          }
        ],
        "orderId": "NUD10803646",
        "combinedLabel": "NUD10803646-e04e28c1-3f39-4884-b95e-433f78ad6060-BILL_OF_LADING.pdf",
        "orderDate": "2024-02-13",
        "quoteNumber": "Q10193597",
        "status": "ERROR",
        "createdBy": "8h94TCp0N6fg09ipP3yyJmfPPv5l1mCD"
      }
    },
    "error": {
      "apiVersion": "1"
    },
    "freightBillDetails": "Carrier Payment Processing \nP O Box 999999 \nDallas, TX 75219 United States \nCustomer Number: W000907156"
  }
}

TMS Field Updates

The Quote/Contract ID value received in the shopFlow response is returned in the request to WWEX. This field contains the TransactionId field specific to the original request and the OfferId specific to the Carrier.

Use caution when entering data into the References field on the Stop (Pickup 1) record. Any data contained in this field is overwritten with the pickupTxnId and secondaryTxnIdList tracking information fields received from WWEX.

searchShipmentsFlow

The searchShipmentsFlow endpoint is called to send load tracking information to the TMS. The Last Reported Location of the Load is sent by WWEX. Tracking activity is received based on sending the Bill of Lading (BOL) and/or the Carrier PRO Number with the Carrier SCAC fields. WWEX returns another PRO Number (secondaryTxnIdV2List) that is used to validate the tracking request.

Status updates are not automatically sent by WWEX. Load status updates are received after requesting via the TMS. The LoadStatusUpdateJob automatically requests or by selecting Request Carrier Status on the Carrier Banner LWC.

Load location information is sent with each tracking update with the most recent location as the top response in the payload. The most recent events are always listed first in chronological order. The Bill of Lading field returned from WWEX does not replace the value in the Load Bill of Lading field. The WWEX Bill of Lading field returns from the quoteOrderFlow call and is stored in the Stop (Pickup 1) References field used for load tracking purposes.

Sample Status Operation Request Payload

{
  "request": {
    "trackingInfoList": [
      "123456"
    ],
    "type": "PRO",
    "scac": "FCSY"
  },
  "correlationId": "WWEX-M2M-searchShipmentsFlow"
}

Sample Status Operation Response Payload

{
  "apiVersion": "1",
  "clientStatus": {
    "apiVersion": "1",
    "success": true,
    "message": ""
  },
  "correlationId": "NG-577c21f0-f3fb-456c-8420-6eefab88bc38",
  "executionId": "NG-577c21f0-f3fb-456c-8420-6eefab88bc38",
  "response": {
    "apiVersion": "1",
    "orderedItemFulfillmentStatusList": [
      {
        "status": "DELIVERED",
        "apiVersion": "1",
        "orderedItemId": "e337b2f8-e126-4185-abfc-6c2601ff7b09",
        "fulfillmentStatusList": [
          {
            "code": "DELIVERED",
            "stop": {
              "address": {
                "region": "DC",
                "locality": "WASHINGTON",
                "countryCode": "US"
              },
              "stopWindow": {
                "actualEndTime": "2024-02-02 09:38:00",
                "actualStartTime": "2024-02-02 09:38:00"
              }
            },
            "reasonCode": "NS",
            "description": "Carrier Departed Delivery Location",
            "eventDateTime": "2024-02-02 09:38:00",
            "vendorStatusCode": "CD"
          },
          {
            "code": "AT_DELIVERY",
            "stop": {
              "address": {
                "region": "DC",
                "locality": "WASHINGTON",
                "countryCode": "US"
              },
              "stopWindow": {
                "actualEndTime": "2024-02-02 09:32:00",
                "actualStartTime": "2024-02-02 09:32:00"
              }
            },
            "reasonCode": "NS",
            "description": "Arrived at Delivery Location",
            "eventDateTime": "2024-02-02 09:32:00",
            "vendorStatusCode": "X1"
          },
          {
            "code": "OUT_FOR_DELIVERY",
            "stop": {
              "address": {
                "region": "MD",
                "locality": "GLEN BURNIE",
                "countryCode": "US"
              },
              "stopWindow": {
                "actualEndTime": "2024-02-02 08:10:00",
                "actualStartTime": "2024-02-02 08:10:00"
              }
            },
            "reasonCode": "NS",
            "description": "En Route to Delivery Location",
            "eventDateTime": "2024-02-02 08:10:00",
            "vendorStatusCode": "X6"
          },
          {
            "code": "IN_TRANSIT",
            "stop": {
              "address": {
                "region": "MD",
                "locality": "GLEN BURNIE",
                "countryCode": "US"
              },
              "stopWindow": {
                "actualEndTime": "2024-02-02 01:35:00",
                "actualStartTime": "2024-02-02 01:35:00"
              }
            },
            "reasonCode": "NS",
            "description": "Arrived at Terminal Location",
            "eventDateTime": "2024-02-02 01:35:00",
            "vendorStatusCode": "X4"
          },
          {
            "code": "IN_TRANSIT",
            "stop": {
              "address": {
                "region": "VA",
                "locality": "RICHMOND",
                "countryCode": "US"
              },
              "stopWindow": {
                "actualEndTime": "2024-02-01 22:54:00",
                "actualStartTime": "2024-02-01 22:54:00"
              }
            },
            "reasonCode": "NS",
            "description": "Departed Terminal Location",
            "eventDateTime": "2024-02-01 22:54:00",
            "vendorStatusCode": "P1"
          },
          {
            "code": "IN_TRANSIT",
            "stop": {
              "address": {
                "region": "VA",
                "locality": "RICHMOND",
                "countryCode": "US"
              },
              "stopWindow": {
                "actualEndTime": "2024-02-01 18:30:00",
                "actualStartTime": "2024-02-01 18:30:00"
              }
            },
            "reasonCode": "NS",
            "description": "Arrived at Terminal Location",
            "eventDateTime": "2024-02-01 18:30:00",
            "vendorStatusCode": "X4"
          },
          {
            "code": "IN_TRANSIT",
            "stop": {
              "address": {
                "region": "VA",
                "locality": "VIRGINIA BEACH",
                "countryCode": "US"
              },
              "stopWindow": {
                "actualEndTime": "2024-02-01 15:35:00",
                "actualStartTime": "2024-02-01 15:35:00"
              }
            },
            "reasonCode": "NS",
            "description": "Arrived at Pick-up Location",
            "eventDateTime": "2024-02-01 15:35:00",
            "vendorStatusCode": "X3"
          },
          {
            "code": "PENDING_PICKUP",
            "apiVersion": "2",
            "eventDateTime": "2024-02-01 14:20:00"
          },
          {
            "code": "CREATED",
            "apiVersion": "2",
            "eventDateTime": "2024-02-01 14:19:46"
          }
        ]
      }
    ],
    "secondaryTxnIdV2List": [
      {
        "type": "BILL_OF_LADING",
        "value": "VABXXXXXXX"
      },
      {
        "type": "PRO",
        "value": "XXXXXXXX",
        "source": "VENDOR_TRACKING"
      },
      {
        "type": "CARRIER_QUOTE_NUMBER",
        "value": "XXXXXXX"
      },
      {
        "type": "CERTIFICATE_NBR",
        "value": "XXXXXXX",
        "apiVersion": "2"
      },
      {
        "type": "TRACKING_ID",
        "value": "XXXXXXXX",
        "apiVersion": "2"
      }
    ]
  }
}

When a tracking status of In Transit, Exception, Out For Delivery, or Delivered is received from WWEX, Stop 1 information is updated by the TMS. Stop 1 is set to a status of Departed without any date or time information.

TMS Field Updates

Packaging Types

Location Type List

Insurance Commodity Codes

API Field Mapping

The following table relates TMS data fields with the equivalent WWEX Speedship fields included in API calls.

*Fields marked with an asterisk are required for the WWEX integration.

Accessorial Flag Mapping

When an accessorial is included on a load, a TRUE value is sent to WWEX.