Choose a version:

DeliveryRateProvider

union

Requires Any of assigned_shipping or shipping access scopes or manage_delivery_settings user permission.

A rate provided by a merchant-defined rate or a participant.

Anchor to Possible typesPossible types

•OBJECT

A participant defines carrier-calculated rates for shipping services with a possible merchant-defined fixed fee or a percentage-of-rate fee.

Anchor to adaptToNewServicesFlagadaptToNewServicesFlag •Boolean! non-null: Whether to display new shipping services automatically to the customer when the service becomes available.
Anchor to carrierServicecarrierService •DeliveryCarrierService! non-null: The carrier used for this participant.
Anchor to fixedFeefixedFee •MoneyV2: The merchant-defined fixed fee for this participant.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to participantServicesparticipantServices •[DeliveryParticipantService!]! non-null: The carrier-specific services offered by the participant, and whether each service is active.
Anchor to percentageOfRateFeepercentageOfRateFee •Float! non-null: The merchant-defined percentage-of-rate fee for this participant.

•OBJECT

The merchant-defined rate of the DeliveryMethodDefinition.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to priceprice •MoneyV2! non-null: The price of this rate.
Anchor to rateClassrateClass •DeliveryRateClass: The class of the rate. The corresponding delivery method definition must have the same name.

Was this section helpful?

Anchor to DeliveryMethodDefinition.rateProvider DeliveryMethodDefinition.rateProvider •OBJECT: A method definition contains the delivery rate and the conditions that must be met for the method to be applied.

Was this section helpful?