UPS Ground Freight

warning

UPS Ground Freight Temporarily Unavailable in Batches

UPS Ground Freight labels are unavailable in batches. This means that all UPS ground freight labels need to be created individually. This is expected to be updated in the near future.

Last Updated January 22, 2018

info

Unlisted in Carrier Services and Advanced Options

This is an advanced feature. ShipEngine does not currently list ups_ground_freight as a service; nor, do we list the additional advanced_options in the carrier options.

ShipEngine allows you to take advantage of UPS Ground Freight pricing (GFP).

These advanced options will allow you to Get Rates for a UPS Ground Freight Shipment and Create a Label for a UPS Ground Freight Shipment.

Understanding Freight Classifications (NMFC)

Freight classifications are derived from the National Motor Freight Traffic Association. Your freight package will fall into one of the 18 supported freight classification (otherwise known as the NMFC, short for National Motor Freight Classification).

The classes range from 50 to 500, and there are many tools online to help determine which estimated freight class you'll fall into. For example, lighter but larger items are going to be the higher classes; and heavier but smaller items are going to be the lower classes.

Defined Freight Classes

  • 50
  • 55
  • 60
  • 65
  • 70
  • 77.5
  • 85
  • 92.5
  • 100
  • 110
  • 125
  • 150
  • 175
  • 200
  • 250
  • 300
  • 400
  • 500

Rating a UPS Ground Freight Shipment

warning

UPS Ground Freight Pricing Is Not Returned by Default

When getting rates, GFP rates will not be returned unless explicitly requested. This means, you need to make two separate rate calls for ups_ground and ups_ground_freight, in order to compare them.

To use UPS Ground Freight rating, you should provide two advanced options in the shipment object.

{
  "advanced_options": {
    "use_ups_ground_freight_pricing": true,
    "freight_class": "50"
  }
}

POST /v1/rates HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "shipment": {
    "advanced_options": {
      "use_ups_ground_freight_pricing": true,
      "freight_class": "175"
    },
    "validate_address": "no_validation",
    "ship_to": {
      "name": "Amanda Miller",
      "phone": "555-555-5555",
      "address_line1": "525 S Winchester Blvd",
      "city_locality": "San Jose",
      "state_province": "CA",
      "postal_code": "95128",
      "country_code": "US",
      "address_residential_indicator": "yes"
    },
    "ship_from": {
      "company_name": "Example Corp.",
      "name": "John Doe",
      "phone": "111-111-1111",
      "address_line1": "4009 Marathon Blvd",
      "address_line2": "Suite 300",
      "city_locality": "Austin",
      "state_province": "TX",
      "postal_code": "78756",
      "country_code": "US",
      "address_residential_indicator": "no"
    },
    "packages": [
      {
        "weight": {
          "value": 20.0,
          "unit": "pound"
        },
        "dimensions": {
          "unit": "inch",
          "length": 20.0,
          "width": 20.0,
          "height": 20.0
        }
      }
    ]
  },
  "rate_options": {
    "carrier_ids": [
      "se-123890"
    ]
  }
}

{
  "rate_response": {
    "rates": [
      {
        "rate_id": "se-10523",
        "rate_type": "shipment",
        "carrier_id": "se-3143",
        "shipping_amount": {
          "currency": "usd",
          "amount": 206.38
        },
        "insurance_amount": {
          "currency": "usd",
          "amount": 0.00
        },
        "confirmation_amount": {
          "currency": "usd",
          "amount": 0.00
        },
        "other_amount": {
          "currency": "usd",
          "amount": 0.00
        },
        "zone": null,
        "package_type": null,
        "delivery_days": 5,
        "guaranteed_service": false,
        "estimated_delivery_date": "2019-07-25T05:00:00.000ZPlus3$",
        "carrier_delivery_days": "Tuesday 1/23 by 11:00 PM",
        "ship_date": "2019-07-25T05:00:00.000Z",
        "negotiated_rate": false,
        "service_type": "UPS® Ground",
        "service_code": "ups_ground_freight",
        "trackable": true,
        "carrier_code": "ups",
        "carrier_nickname": "UPS",
        "carrier_friendly_name": "UPS",
        "validation_status": "valid",
        "warning_messages": [],
        "error_messages": []
      }
    ],
    "invalid_rates": [],
    "rate_request_id": "se-10126",
    "shipment_id": "se-1001161",
    "created_at": "2019-07-25T15:24:46.657Z",
    "status": "completed",
    "errors": []
  },
  "shipment_id": "se-1001161",
  "carrier_id": null,
  "service_code": null,
  "external_shipment_id": null,
  "ship_date": "2019-07-25T05:00:00.000Z",
  "created_at": "2019-07-25T15:24:46.657Z",
  "modified_at": "2019-07-25T15:24:46.657Z",
  "shipment_status": "pending",
  "ship_to": {
    "name": "Amanda Miller",
    "phone": "555-555-5555",
    "address_line1": "525 S Winchester Blvd",
    "city_locality": "San Jose",
    "state_province": "CA",
    "postal_code": "95128",
    "country_code": "US",
    "address_residential_indicator": "yes"
  },
  "ship_from": {
    "company_name": "Example Corp.",
    "name": "John Doe",
    "phone": "111-111-1111",
    "address_line1": "4009 Marathon Blvd",
    "address_line2": "Suite 300",
    "city_locality": "Austin",
    "state_province": "TX",
    "postal_code": "78756",
    "country_code": "US",
    "address_residential_indicator": "no"
  },
  "warehouse_id": null,
  "return_to": {
    "company_name": "Example Corp.",
    "name": "John Doe",
    "phone": "111-111-1111",
    "address_line1": "4009 Marathon Blvd",
    "address_line2": "Suite 300",
    "city_locality": "Austin",
    "state_province": "TX",
    "postal_code": "78756",
    "country_code": "US",
    "address_residential_indicator": "no"
  },
  "confirmation": "none",
  "customs": null,
  "advanced_options": {
    "bill_to_account": null,
    "bill_to_country_code": null,
    "bill_to_party": null,
    "bill_to_postal_code": null,
    "contains_alcohol": false,
    "custom_field1": null,
    "custom_field2": null,
    "custom_field3": null,
    "non_machinable": false,
    "saturday_delivery": false,
    "delivered_duty_paid": false,
    "use_ups_ground_freight_pricing": true,
    "freight_class": "175"
  },
  "insurance_provider": "none",
  "tags": [],
  "packages": [
    {
      "package_code": "package",
      "weight": {
        "value": 20.00,
        "unit": "pound"
      },
      "dimensions": {
        "unit": "inch",
        "length": 20.00,
        "width": 20.00,
        "height": 20.00
      },
      "insured_value": {
        "currency": "usd",
        "amount": 0.00
      },
      "label_messages": {
        "reference1": null,
        "reference2": null,
        "reference3": null
      }
    }
  ],
  "total_weight": {
    "value": 20.00,
    "unit": "pound"
  }
}

Create a Label for UPS Ground Freight

Similar to rating a Ground Freight Shipment, a label requires a service code and then a freight class.

{
  "service_code": "ups_ground_freight",
  "advanced_options": {
    "freight_class": "50"
  }
}

POST /v1/labels HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "shipment": {
    "service_code": "ups_ground_freight",
    "advanced_options": {
      "freight_class": "150"
    },
    "ship_to": {
      "name": "Amanda Miller",
      "phone": "555-555-5555",
      "address_line1": "525 S Winchester Blvd",
      "city_locality": "San Jose",
      "state_province": "CA",
      "postal_code": "95128",
      "country_code": "US",
      "address_residential_indicator": "yes"
    },
    "ship_from": {
      "company_name": "Example Corp.",
      "name": "John Doe",
      "phone": "111-111-1111",
      "address_line1": "4009 Marathon Blvd",
      "address_line2": "Suite 300",
      "city_locality": "Austin",
      "state_province": "TX",
      "postal_code": "78756",
      "country_code": "US",
      "address_residential_indicator": "no"
    },
    "packages": [
      {
        "weight": {
          "value": 20.0,
          "unit": "pound"
        },
        "dimensions": {
          "unit": "inch",
          "length": 20.0,
          "width": 20.0,
          "height": 20.0
        }
      }
    ]
  }
}

{
  "label_id": "se-1021",
  "status": "completed",
  "shipment_id": "se-1001165",
  "ship_date": "2019-07-29T05:00:00.000Z",
  "created_at": "2019-07-29T13:33:10.169Z",
  "shipment_cost": {
    "currency": "usd",
    "amount": 176.86
  },
  "insurance_cost": {
    "currency": "usd",
    "amount": 0.0
  },
  "tracking_number": "1ZR3890Y0395642846",
  "is_return_label": false,
  "is_international": false,
  "batch_id": "",
  "carrier_id": "se-3143",
  "service_code": "ups_ground_freight",
  "package_code": "package",
  "voided": false,
  "voided_at": null,
  "label_format": "pdf",
  "label_layout": "4x6",
  "trackable": true,
  "carrier_code": "ups",
  "tracking_status": "in_transit",
  "label_download": {
    "href": "https://api.shipengine.com/v1/downloads/1/xG1ydsrzJkuRsG3VL_Talg/label-1021.pdf"
  },
  "form_download": null,
  "insurance_claim": null,
  "packages": [
    {
      "package_code": "package",
      "weight": {
        "value": 20.00,
        "unit": "pound"
      },
      "dimensions": {
        "unit": "inch",
        "length": 20.00,
        "width": 20.00,
        "height": 20.00
      },
      "insured_value": {
        "currency": "usd",
        "amount": 0.00
      },
      "tracking_number": "1ZR3890Y0395642846",
      "label_messages": {
        "reference1": null,
        "reference2": null,
        "reference3": null
      }
    }
  ]
}