Types > StorefrontShippingProvider
Storefront APITypesStorefrontShippingProvider
StorefrontShippingProvider

Description

Topic: Shipping Providers

Fields

created_at: String!

The date and time when the shipping provider was created, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


currency: String!

Currency code

Example: "USD"


delivery_date_guaranteed: Boolean

Whether delivery date is guaranteed or not (fixed providers)

Example: true


delivery_days_max: Int

Maximum days it would take to deliver a package (fixed providers)

Example: 5


delivery_days_min: Int

Minimum days it would take to deliver a package (fixed providers)

Example: 2


description: String!

Description text visible to the customer

Translatable

Example: "TODO"


id: String!

Unique identifier for shipping provider

Example: "sp_EQzGqWoY"


name: String!

Name of the shipping provider

Translatable

Example: "Fixed 20$"


rate: Int

Shipping rate for fixed providers

Example: 2000


surcharge_fixed: Int!

For non-fixed shipping provider types, fixed amount to add on top of the rate

Example: 500


surcharge_percentage: Float!

For non-fixed shipping provider types, percentage to add on top of the rate

Example: 1.0


type: ShippingProviderType!

Type of the shipping provider


updated_at: String!

The date and time when the shipping provider was last updated, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


Used By

Queries

storefrontShippingProviders

Types

StorefrontShippingRate

Preview (typescript)

Loading module