DEV

Type.

ShipmentRating

A Shipment rating quote that can be displayed.

Fields

id

•

ID!

Required

A unique identifier for the ShipmentRating.

amount

•

Decimal!

Required

The quoted amount for the ShipmentRating.

amountSubtotals

•

ShipmentRatingSubtotals!

Required

Subtotal amounts of how the ShipmentRating amount was calculated.

createdAt

•

DateTime!

Required

When this ShipmentRating was created.

createdBy

•

ID!

Required

The user who created the ShipmentRating

currencyCode

•

CurrencyCode!

Required

The currency this ShipmentRating price amount is in.
Breakdown of the details returned from the carrier.

displayName

•

String!

Required

The customer facing display name of the ShipmentRating.

maxTransitAt

•

DateTime

The ISO-8601 timestamp of when the delivery will be delivered

minTransitAt

•

DateTime

The ISO-8601 timestamp of when the delivery could first be delivered

multipleShipFromRatings

•

[ShipmentRating]

For shipments that contain multiple fulfillment warehouses the multipleShipFromRatings will contain the individual ShipmentRating calculations. The aggregated totals will be reflected on the parent object. In these cases the shipFrom location will be null.

organization

•

ID!

Required

The Organization associated with the ShipmentRating

serviceLevel

•

ServiceLevel

The ServiceLevel resolved at rating time. Null for legacy rows that pre-date this column; consumers should fall back to serviceLevelCode.

serviceLevelCode

•

String!

Required

The ServiceLevel code associated with the ShipmentRating.

shipFrom

•

Location

The Location associated with the origin of the shipment.

shipTo

•

Location

Specifies the Carton's destination.

shipmentRatingAmountDetail

•

[ShipmentRatingAmountDetail!]!

Required

Amount details in difference currencies for the rating amount

shipmentRatingCartons

•

[ShipmentRatingCarton!]!

Required

The Carton data included in the ShipmentRating.

shippingProfile

•

ShippingProfile

The ShippingProfile associated with the ShipmentRating.
The source of the rating i.e. LIVE or CACHE

Required

Detailed breakdown of subtotal amounts for the shipment rating, including currency-specific calculations for each component.

updatedAt

•

DateTime!

Required

When this ShipmentRating was most recently updated.

updatedBy

•

ID!

Required

The user who most recently updated the ShipmentRating.

Was this page helpful?


Get support·Legal docs·© 2026 Zonos