Create RateGroup

Use this API to create a RateGroup that groups carriers and their services for automated rate shopping. A RateGroup allows the system to dynamically select the cheapest or fastest delivery option across the defined carriers and services; without manual comparison. Read How to create RateGroup

SecuritybearerAuth
Request
Request Body schema: application/json
name
required
string

Display name of the RateGroup. This will be used as the RateGroup's nickname or label.

countryCode
required
string

Two-letter ISO country code representing the shipment origin for which the RateGroup is created.

status
string

Defines whether the RateGroup is available for use (active) or not (inactive).

Enum: "active" "in-active"
permissionEntityBy
string

Defines the audience who can access and use this RateGroup.

  • E: Enterprise (all users in the organization). If permissionEntityBy is not explicitly provided, Enterprise is set as the default entity.
  • L: Locations (restricted to specific locations)
  • R: User Roles (restricted to specific roles, e.g., Admin or USER)
  • U: Users
Enum: "E" "L" "R" "U"
Array of objects

List of audience identifiers who can access the RateGroup as set in permissionEntityBy.

required
Array of objects

Array of carriers and their services to be included in the RateGroup for rate shopping.

Responses
200

Successfully created a RateGroup.

400

Invalid request.

401

The request could not be authorized.

500

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

post/api/v1/rategroups
Request samples
application/json
{
  • "name": "RATEGROUP USERS2",
  • "countryCode": "US",
  • "status": "active",
  • "permissionEntityBy": "R",
  • "permissions": [
    ],
  • "items": [
    ]
}
Response samples
application/json
{
  • "rateGroupId": "wZJvKEBg0gPVbZ5"
}