Skip to main content
Shopify.devShopify.devDocs
Log inSign up
Anchor to DeliveryRateProvider

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

Anchor to DeliveryParticipantDeliveryParticipant
•
OBJECT

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

adaptToNewServicesFlag•
Boolean!
non-null

Whether to display new shipping services automatically to the customer when the service becomes available.

carrierService•
DeliveryCarrierService!
non-null

The carrier used for this participant.

fixedFee•
MoneyV2

The merchant-defined fixed fee for this participant.

id•
ID!
non-null

A globally-unique ID.

participantServices•
[DeliveryParticipantService!]!
non-null

The carrier-specific services offered by the participant, and whether each service is active.

percentageOfRateFee•
Float!
non-null

The merchant-defined percentage-of-rate fee for this participant.

Anchor to DeliveryRateDefinitionDeliveryRateDefinition
•
OBJECT

The merchant-defined rate of the DeliveryMethodDefinition.

id•
ID!
non-null

A globally-unique ID.

price•
MoneyV2!
non-null

The price of this rate.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to DeliveryMethodDefinition.rateProviderDeliveryMethodDefinition.rateProvider
•
OBJECT

The provided rate for this method definition, from a rate definition or participant.

Was this section helpful?