Skip to Content

ShippingMethod

Describes a shipping method.

Type Definition

type ShippingMethod { title: String shortDescription: String description: String logo: String }

Fields

FieldTypeNullableDescriptionRelationships
titleStringYesReturns the title.None
shortDescriptionStringYesReturns the short description.None
descriptionStringYesReturns the description.None
logoStringYesReturns the logo.None

Relationships

The ShippingMethod object type does not have any direct relationships to other types.

Usage Examples

Basic Query

{ shippingMethod { title shortDescription description logo } }

Field Selection

{ shippingMethod { title logo } }

Nested Queries

The ShippingMethod type does not contain nested object fields, so nested queries are not applicable.

Filtering and Sorting

Filtering, sorting, and pagination are not applicable directly on the ShippingMethod type fields as defined.

Implements

The ShippingMethod type does not implement any interfaces.

Connections

There are no connection fields defined on the ShippingMethod type.

No related types are explicitly connected to ShippingMethod in the current schema.

Best Practices

  • Select only the fields you need to optimize query performance.
  • Use the title and shortDescription fields for concise UI displays.
  • Use the description field for detailed shipping method information.
  • The logo field can be used to display a visual representation of the shipping method.
  • Since all fields are optional, always handle potential null values in your client code.

Notes

  • All fields in ShippingMethod are optional and may return null.
  • The API currently requires no authentication, but this may change in future versions.
  • The logo field returns a string, typically a URL, which can be used to fetch the shipping method’s logo image.
  • There are no computed or derived fields in this type.
  • No field arguments are defined for any of the fields.
  • Since ShippingMethod fields are scalar and optional, queries are lightweight and performant. However, always consider caching responses where shipping methods rarely change to reduce unnecessary network calls.
Last updated on