Create a new rating request.

Create a new rating request with the provided data.

SecurityAPIKeyHeader

Request

Request Body schema: application/json
required

	Preferred Currency (string) or Preferred Currency (null) (Preferred Currency) Default: "USD" Rates will be returned in this currency if available. Expected valid ISO 4217 three-letter standard currency codes
	Locale (string) or Locale (null) (Locale) Default: "en-US" Messages will be returned using this locale if supported
	Shipment Id (string) or Shipment Id (null) (Shipment Id) Shipment ID to use on the request.
required	TransportationMode (string) or null The transportation mode for the rating request.
	Array of objects (Capacity Providers) List of providers to get rates from.
required	Array of objects (Equipment) List of equipment types to get rates from.
	Customer Reference Number (string) or Customer Reference Number (null) (Customer Reference Number) Reference number provided by the Customer. Some providers require this. When booking using a Rate returned by this process. It is highly recommended that this identifier be sent along with the request
accessorials	Array of strings (Accessorials) Only support accessorials from a Shipwell accessorials codes standard. Items Enum: "AFTER_HOURS_DELIVERY" "AIRPORT_DELIVERY" "AIRPORT_PICKUP" "APPOINTMENT_DELIVERY" "BLIND_SHIPMENT" "CFS_DELIVERY" "CFS_PICKUP" "CHURCH_DELIVERY" "CHURCH_PICKUP" "CONSTRUCTION_SITE_DELIVERY" "CONSTRUCTION_SITE_PICKUP" "CONTAINER_FREIGHT_STATION_DELIVERY" "CONTAINER_FREIGHT_STATION_PICKUP" "CONVENTION_TRADESHOW_DELIVERY" "CONVENTION_TRADESHOW_PICKUP" "CAPLOAD" "CAPLOADPUP" "CAPLOADTRA" "DELAY_CHARGE" "DELIVERY_NOTIFICATION" "DRIVER_ASSIST_DELIVERY" "DROP_TRAILER_DELIVERY" "EXCESSIVE_LENGTH" "EXCESSIVE_LENGTH_11FT" "EXCESSIVE_LENGTH_15FT" "EXCESSIVE_LENGTH_19FT" "EXCESSIVE_LENGTH_27FT" "EV" "EXHIBITION" "EXPEDITED_DELIVERY" "FAIR_AMUSEMENT_DELIVERY" "FAIR_AMUSEMENT_PICKUP" "FARM_DELIVERY" "FARM_PICKUP" "FOOD" "FLATBED" "FREEZABLE" "GOVERNMENT_SITE_DELIVERY" "GROCERY_WAREHOUSE_DELIVERY" "GROCERY_WAREHOUSE_PICKUP" "GUARANTEED" "GUARANTEED_BY_15" "GUARANTEED_BY_AM" "HAZMAT" "HAZMAT_PICKUP" "HEAT" "HIGH_COST_AREA" "HOLD_AT_LOCATION" "HOLIDAY_DELIVERY" "HOLIDAY_PICKUP" "HOSPITAL_PICKUP" "INBOUND_SHIPMENT" "INSIDE_DELIVERY" "INSIDE_EDELIVERY" "INSIDE_INGDELIVERY" "INSIDE_INNEDELIVERY" "INSIDE_PICKUP" "LIFT_GATE" "LIFTGATE_DELIVERY" "LIFTGATE_PICKUP" "LIMITED_ACCESS_DELIVERY" "LIMITED_ACCESS_PICKUP" "LUMPER" "MALL_DELIVERY" "MILITARY_INSTALLATION_DELIVERY" "MILITARY_INSTALLATION_PICKUP" "MINE_SITE_DELIVERY" "MINE_SITE_PICKUP" "NO_ROLLUP" "NOTIFY_BEFORE_DELIVERY" "OVER_DIMENSION_FREIGHT" "OVER_LENGTH" "OVERSIZE" "PALLET" "PALLET_JACK_DELIVERY" "PICKUP_APPOINTMENT" "PICKUP_NOTIFICATION" "PIER_DELIVERY" "PIER_PICKUP" "POISON" "PORT_CUSTOMS_PAPERWORK" "PRISON_DELIVERY" "PRISON_PICKUP" "PROTECT_FROM_FREEZING" "RESIDENTIAL_DELIVERY" "RESIDENTIAL_PICKUP" "SATURDAY_DELIVERY" "SATURDAY_PICKUP" "SCHOOL_DELIVERY" "SCHOOL_PICKUP" "SELF_STORAGE_DELIVERY" "SELF_STORAGE_PICKUP" "SHIPLDPU" "SINGLE_SHIPMENT" "SORT_AND_SEGREGATE" "STOP_OFF" "STORAGE" "SUNDAY_DELIVERY" "SUNDAY_PICKUP" "UNLOAD_AT_DESTINATION"
required	Array of objects (Stops) Stops for this Shipment.
	CommonBillTo (object) or null
	Weight (object) or null
	CurrencyAmount (object) or null Optional value declaration of all the goods.
	Array of objects (References) Reference for this Shipment.
required	Array of objects (Handling Units) Handling units for this Shipment.
	Child Customer Id (string) or Child Customer Id (null) (Child Customer Id) Optional child customer ID to filter provider accounts. When provided, only accounts associated with this customer (or accounts with no customer restriction) will be used for rating.
	object (Custom Data) Optional custom data associated with the rating request. See https://docs.shipwell.com/docs/api-concepts/custom-data/ for more information.
resource_type	string (Resource Type) Default: "rating_job" Type of the resource
	object (Request Options) Options used for the rating request execution.
status	string (RateStatus) Default: "PROCESSING" Overall status of the batch rating job. Enum: "CREATED" "PROCESSING" "ERRORED" "SUCCEEDED" "CANCELLED" "EXPIRED" "REVOKED" "COMPLETED"

Responses

201

Successful Response

Response Schema: application/json

required

string (Id)

Unique identifier for the rating job (maps to OrmRateRequest.id)

400

Validation Error

404

The resource requested was not found either because you do not have permissions to access it or it does not exist.

409

The resource being updated or created already exists.

500

An unknown internal server issue occured while processing a request. A report is created and logged.

post/rating

Request samples

application/json

{"equipment": [{"equipment_type": "DRY_VAN"
}
],
"transportation_mode": "LTL",
"stops": [{"sequence_number": 1,
"location": {"country": "US",
"line_1": "456 Dummy St",
"postal_code": "12345",
"region": "CA"
},
"requested_window": {"earliest": "2026-02-09T13:00:00-04:00",
"latest": "2026-02-10T21:00:00-04:00"
},
"accessorials": [ ]
},
{"sequence_number": 2,
"location": {"country": "US",
"line_1": "3700 Seawall Blvd",
"postal_code": "77550",
"region": "TX"
},
"requested_window": {"earliest": "2026-02-04T11:30:00-05:00",
"latest": "2026-02-06T21:00:00-05:00"
},
"accessorials": [ ]
}
],
"accessorials": [ ],
"handling_units": [{"dimensions": {"measurement_type": "DIMENSIONS",
"unit": "IN",
"length": {"unit": "IN",
"value": 10
},
"width": {"unit": "IN",
"value": 10
},
"height": {"unit": "IN",
"value": 10
}
},
"weight": {"unit": "LB",
"value": 100
},
"quantity": 1,
"packaging_type": "BOX",
"freight_class": "50"
}
]
}

Response samples

application/json

{"id": "rj_01hzkd8qkzq8z7xv9mkz5qxw3h"
}