Description

Topic: Shipping Providers

Fields

auspost_options: AuspostOptions

canadapost_options: CanadapostOptions

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"

fedex_options: FedexOptions

id: String!

Unique identifier for shipping provider

Example: "sp_EQzGqWoY"

lead_time_hours_max: Int

The maximum amount of time the inventory location will take to fulfill the order using this shipping provider

Example: 5

lead_time_hours_min: Int

The minimum amount of time the inventory location will take to fulfill the order using this shipping provider

Example: 2

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

test: Boolean!

Whether shipping provider test mode is enabled

Example: false

tracking: Boolean!

Is it allowed to use this shipping provider for tracking requests?

Example: true

type: ShippingProviderType!

Type of the shipping provider

Example: "fixed"

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)

ups_options: UPSOptions

usps_options: USPSOptions

whitelist: [ShippingProviderWhitelist!]

Shipping rate whilelist for non-fixed providers

Used By

Mutations

shippingProvidersCreate, shippingProvidersModify

Queries

shippingProviders

Types

Packaging, PromotionCondition, ReturnPolicyCondition, ShippingRate

Preview (typescript)

Loading module