Get RateGroup by ID

This operation retrieves a RateGroups using the provided RateGroup ID with metadata such as the RateGroup ID, display name, origin country, status (active/inactive), audience type, included carriers and services, archival status available in the system. Read How to create RateGroup

SecuritybearerAuth
Request
path Parameters
rateGroupId
required
string

Unique identifier of the RateGroup created. This Id is used in rate shipment and create shipment requests for automatic rate shopping.

Example: Q6Wp3onr3JNlDXx
Responses
200

Retrieved the specified RateGroup.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/rategroups/{rateGroupId}
Request samples 
Response samples 
application/json
{
  • "rateGroupId": "Q6Wp3onr3JNlDXx",
  • "uid": "Ae6vn3VD5voQ46R",
  • "name": "FEDEX-UPS-NDA",
  • "countryCode": "US",
  • "permissionEntityBy": "E",
  • "status": "active",
  • "items": [
    ],
  • "archived": false,
  • "updateTimestamp": "2025-08-14T10:03:47.063Z",
  • "permissions": [
    ]
}