RateGroup APIs (1.0.0)

A RateGroup is used to automate carrier and service selection during shipment processing. Instead of explicitly passing a carrier and service in every request, you can pass a rateGroupId, and get the desired rate (for example, lowest cost or fastest delivery).
RateGroups helps with:

• Atomatic rate shopping across multiple carriers
• Shipping decision depends on price, speed, or available services at runtime

How it works

• Create a RateGroup with a list of

  • carrierCode (e.g., USPS, UPS, FedEx)
  • serviceId (e.g., PM, FEDEX_GROUND, NDA)
    

• Use the returned rateGroupId in

  • Rate API: to fetch the best available rate
  • Create Shipment API: to generate a shipment using the selected service

• When a rateGroupId is provided in a request, carrier and service selection is handled internally based on the configured items.

• Evaluation of carrier-service combinations is dynamic and may vary per request depending on shipment attributes such as origin, destination, and parcel details.

• Only RateGroups with status active are considered for processing.

• RateGroups are country-specific, and only applicable shipments are evaluated.

Read How to Create RateGroup.