About evaluated service methods

Evaluated service methods provide additional information on the carriers and service methods that were evaluated but not selected as optimal for a shipment during carrier selection. Your organization can access this information in two ways:

• via a call to Shipium's API for Carrier Selection and Label Service; or
• via the Shipium Console.

Retrieve unselected carrier methods via API call

When calling the Shipium API for Carrier Selection and Label Service, you may opt to include carriers and methods that were evaluated but not selected during carrier selection in your API call response. For each carrier, the carrier name, service method, carrier account ID, total cost, and estimated delivery date will be returned.

The list of unselected carriers does not include carrier methods that were filtered out due to unavailability during the carrier selection process.

You'll need to include the field includeEvaluatedServiceMethodsInResponse with a value of TRUE to return the list of unselected carriers in the call response.

Request example

This example shows the cURL request:

curl --request POST \
  --url <<api_url>>/api/v1/shipment/carrierselection/label \
  --header 'accept: application/json' \
  --header $AUTHSTRING \
  --header 'content-type: application/json' \
  --data 'INSERT REQUEST BODY FROM BELOW'

This example shows the JavaScript Object Notation (JSON):

{
  "currencyCode": "usd",
  "generateLabel": true,
  "includeEvaluatedServiceMethodsInResponse": true, <== EXAMPLE
  "labelParameters": {
    "currencyCode": "usd",
    "labelFormats": [
      "ZPL"
    ],
    "manifest": true,
    "includeLabelImagesInResponse": true
  },
  "shipmentParameters": {
    "partnerShipmentId": "myCustomPartnerShipmentId123",
    "shipiumShipmentId": "49cf130d-b297-4c12-aa7d-82ea80208fde",
    "orderedDateTime": "2019-10-29T09:12:33.123456Z",
    "shippedDateTime": "2019-11-01T12:11:33Z",
    "shipOption": "company-x-expedited-shipments",
    "referenceIdentifier": "yourCustomIdentifier",
    "testMode": true,
    "shipmentTags": [
      "string"
    ],
    "destinationAddress": {
      "addressType": "residential",
      "name": "Wile E. Coyote",
      "company": "ACME",
      "street1": "123 Warehouse St.",
      "street2": "Suite 42",
      "city": "Albuquerque",
      "state": "NM",
      "countryCode": "US",
      "postalCode": "87121"
    },
    "orderItemQuantities": [
      {
        "productDetails": [
          "ormd",
          "lio"
        ],
        "productId": "PRODUCTID001",
        "quantity": 3
      }
    ],
    "packagingType": {
        "packagingMaterial": "box",
        "linearDimensions": {
            "linearUnit": "in",
            "length": 9,
            "width": 6,
            "height": 3
        },
        "packagingWeight": {
            "weight": 6.58,
            "weightUnit": "lb"
        }
    },
    "totalWeight": {
      "weight": 6.58,
      "weightUnit": "lb"
    },
    "shipFromAddress": {
      "addressType": "commercial",
      "city": "Albuquerque",
      "company": "ACME",
      "countryCode": "US",
      "name": "L. Merfudd",
      "postalCode": "87121",
      "state": "NM",
      "street1": "123 Main St.",
      "street2": "Suite 42"
    }
  }
}

Response example

This example shows a JSON response. The evaluatedServiceMethods block, located within the carrierSelection block, contains the carriers and methods that were evaluated but not selected during the carrier selection process. Note that the third element of the array in the example demonstrates use of an injection site.

{
  "carrierSelection": {
    "carrier": "ups",
    "carrierAccountId": "4be237e4-eeb2-4e8a-94ea-6db695313ca6",
    "carrierSelectionDateTime": "2020-11-19T21:08:54.305Z",
    "carrierSelectionId": "5b0514bc-3cae-4311-af44-a95e64003631",
    "partnerId": "96ddb56a-18ba-4034-a14e-3fab072478f4",
    "serviceMethodName": "ground",
    "serviceMethodUrn": "c645ea83-d161-4e28-b8cb-39bf1a620cd3:4e14aaa3-198b-4861-b658-faf51031c84c:83fe5227-a765-45b2-bc2a-cb919ddce922:1",
    "totalCost": 7.53,
    "evaluatedServiceMethods": [
      {
        "carrier": "usps",
        "serviceMethodName": "usps-ground-advantage",
        "carrierAccountId": "5db5b0cd-b965-41e2-b7a9-dd275e9825be",
        "totalCost": 8.01,
        "estimatedDeliveryDate": "2022-12-02T03:00:00Z"
      },
      {
        "carrier": "ups",
        "serviceMethodName": "ups-ground",
        "carrierAccountId": "21032683-9ae9-46d0-830c-498b6c2b99b4",
        "totalCost": 8.04,
        "estimatedDeliveryDate": "2022-12-02T03:00:00Z"
      },
      {
        "carrier": "cdl",
        "serviceMethodName": "cdl-standard",
        "carrierAccountId": "494a7a1f-50ff-4c82-bbdd-7b29230ca84b",
        "injectionDetails": {
              "requestInjectionProfileId": "cdl-injection",
              "partnerInjectionProfileId": "cdl-injection",
              "shipiumInjectionProfileId": "5aj8748a-eb35-40c1-9b3c-a9eb52fd9jjf2",
              "requestInjectionSiteId": "cdl-injection-pheonix",
              "partnerInjectionSiteId": "cdl-injection-pheonix",
              "shipiumInjectionSiteId": "9v38748a-eb35-40c1-9b3c-a9eb52fd9d12",
        },
        "totalCost": 8.12,
        "estimatedDeliveryDate": "2022-12-02T03:00:00Z"
      }
  ],
  },
  "carrierName": "ups",
  "carrierTrackingId": "1Z999AA10123456784",
  "estimatedDeliveryDate": "2022-12-02T03:00:00Z",
  "destinationAddress": {
    "addressType": "residential",
    "name": "Wile E. Coyote",
    "company": "ACME",
    "street1": "123 Warehouse St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "state": "NM",
    "postalCode": "87121",
    "countryCode": "US"
  },
  "fulfillmentCenterId": "74065136-85c2-499b-b893-bd812ac0c00f",
  "carrierLabel": {
    "effectiveShipDateTime": "2022-11-28T03:00:00Z",
    "testMode": true,
    "carrier": "ups",
    "carrierLabelCurrency": "usd",
    "carrierLabelPrice": 7.53,
    "billableWeight": {
      "weight": 6.0,
      "weightUnit": "lb"
    },
    "carrierSelectionId": "5b0514bc-3cae-4311-af44-a95e64003631",
    "carrierServiceName": "ground",
    "carrierTrackingId": "1Z999AA10123456784",
    "carrierTrackingLink": "https://www.ups.com/track?tracknum=%2B1Z999AA10123456784",
    "documents": [
      {
        "labelExpiration": "2020-11-19T21:08:54.305Z",
        "labelFormat": "ZPL",
        "labelImage": {
          "imageContents": "BASE64LOOKINGSTUFFANDWHATHAVEYOUETCETCETC",
          "imageEncoding": "base64"
        },
        "labelUrl": "string"
      }
    ],
    "partnerShipmentId": "myCustomPartnerShipmentId123",
    "shipiumShipmentId": "49cf130d-b297-4c12-aa7d-82ea80208fde",
    "shipiumLabelId": "5b37704e-130e-4893-82e7-600843475bbb",
    "status": "success",
    "statusDetails": "Label created successfully"
  },
  "orderItemQuantities": [
    {
      "productDetails": [
        "string"
      ],
      "productId": "PRODUCTID001",
      "quantity": 3,
    }
  ],
  "orderedDateTime": "2019-10-29T09:12:33.123456Z",
  "packagingType": {
        "packagingMaterial": "box",
        "linearDimensions": {
            "linearUnit": "in",
            "length": 9,
            "width": 6
            "height": 3,
        },
        "packagingWeight": {
            "weight": 6.58,
            "weightUnit": "lb"
        }          
  },
  "partnerShipmentId": "myCustomPartnerShipmentId123",
  "shipFromAddress": {
    "addressType": "commercial",
    "city": "Albuquerque",
    "company": "ACME",
    "countryCode": "US",
    "name": "L. Merfudd",
    "postalCode": "87121",
    "state": "NM",
    "street1": "123 Main St.",
    "street2": "Suite 42"
    "countryCode": "US"
  },
  "shipOption": "Standard",
  "referenceIdentifier": "yourCustomIdentifier",
  "shipiumShipmentId": "0840c7a2-e6ab-4755-8aa2-9a986297ad6d",
  "shipmentTags": [
    "string"
  ],
  "shippedDateTime": "2019-10-29T09:12:33.123456Z",
  "testMode": true,
  "totalWeight": {
    "weight": 6.58,
    "weightUnit": "lb"
  }
}

Retrieve unselected carrier methods via the Shipium Console

Within the Shipium Console, you can conduct a shipment search that returns the service methods that were evaluated but not selected as optimal for a shipment. Each non-selected service method includes the reason(s) it was not selected.

To access the shipment search details, you’ll first need to log in to the Shipium Console. Within the console, you’ll select Delivery Reporting → Shipment Search from the lefthand navigation menu.

Within Shipment Search, you can use the search bar for a simple search by shipment ID or other property, or you can select Advanced Search.

Search

Fields that can narrow your simple search include the:

• date range of your shipment search;
• fulfillment center, which you will select from a dropdown menu (you may choose All or a particular fulfillment center);
• tenant, which you will select from a dropdown menu (you may choose All or a particular tenant); and
• label filter, which you will select from a dropdown menu (ONLY Shipments with Labels, ONLY Carrier Selections without Labels, or All Shipments).

Advanced search

You can use the advanced search parameters to narrow your search results.

For an advanced search, you can populate the following fields to filter your search results:

• Shipment ID. The Shipium shipment identifier
• Shipium Label ID. An identifier passed to Shipium representing your organization’s shipment identifier
• Carrier. The applicable carrier, which you'll select from a dropdown menu
• Shipment Tag. Any tag value you passed in the API request body
• Label Statuses. The label status of your shipment, which you'll select from a dropdown menu. Status values include Success, Success Generated, Success Created, Success Manifested, Success Failover, Success Voided, Failure, and Success Manifest Failure.
• Tracking Statuses. The tracking status of your shipment, which you'll select from a dropdown menu. Status values include Info Received, Picked Up, Arrived at Carrier Facility, Departed Carrier Facility, In Transit, Out for Delivery, Delivered, Hold, Exception, and Unknown.
• Hazmat. You'll select the hazmat value from a dropdown menu. If the shipment contained hazardous materials, this value is True; if it did not contain hazardous materials, this value is False.
• Destination Postal Code. The United States Postal Service postal code of the destination address
• Destination Country. The country of the destination address, which you'll select from a dropdown menu
• Custom Label Key. A string value serving as a key for a custom label value included in the API request body, with the custom label value represented by the key to be printed on the label
• Custom Label Value. A string representing a custom label value passed in the API request body on label creation
• Exclude Test Mode. You'll select the test mode value from a dropdown menu. If the shipment was generated in test mode, this value is True; if it was not generated in test mode, this value is False.

For additional guidance, you can select Supported Search Terms, which displays the search terms with explanations, as shown in the following screenshot.

Field definitions for simple and advanced search results

This section lists terms and descriptions associated with shipment search details within the Shipium platform. They are organized by the search detail categories that appear on the shipment search results screen:

• Request details
• Label
• Shipment order items
• Rate selection results
• Service method

Request details

Information provided in the Request Details section includes the address from which the package was shipped and the address to which the package was shipped. Shipment details are also returned for a shipment search, including the type of shipment, the package's dimensions and weights, the desired delivery date, the shipped date timestamp, and other special shipping properties.

By toggling the carat next to API Request Body, you also can view the JSON request body for the API call.

Label

The Label section includes a print preview of the shipping label along with a unique label identifier, label status, shipping price, carrier and service method for the shipment, and label properties. Shipment details are also returned for a shipment search, including the type of shipment, the package's dimensions and weights, the desired delivery date, the shipped date timestamp, and other special shipping properties.

Shipment order items

Information in the Shipment Order Items section includes a unique product identifier for the shipment, the order quantity, any product tags assigned by your organization, and an indicator for hazardous materials in the order. This section also includes other unique identifiers for the shipment order, such as Shipium Order ID.

Rate selection results

The Rate Selection Results section includes the carrier and service method selected for the shipment, the shipment effective date, shipment weights, a delivery zone identifier, a Shipium-modeled total calculated cost, and a breakdown of cost elements.

Service method

The Service Method section provides details about the carriers and service methods that were evaluated but not selected for a shipment. Information includes a Shipium-modeled cost of the shipment, the estimated delivery date, and the selection status for each carrier and service method. The selection status provides a reason why the carrier and service method were not selected.

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful:

• Terms and Definitions

• Troubleshooting Guide

• Contact Shipium Support