Skip to main content

ShippingMethod

A shipping method known to the shop. Referenced by the deliveries of an order.

type ShippingMethod implements Node {
id: ID!
active: Boolean
name: String
orderDeliveries(
first: Int = 10
after: String
filter: OrderDeliveryFilterInput
): OrderDeliveryConnection
salesChannelDefaultAssignments(
first: Int = 10
after: String
filter: SalesChannelFilterInput
): SalesChannelConnection
salesChannels(
first: Int = 10
after: String
filter: SalesChannelFilterInput
): SalesChannelConnection
tags(
first: Int = 10
after: String
filter: TagFilterInput
): TagConnection
}

Fields​

ShippingMethod.id ● ID! non-null scalar​

Global identifier for this entity.

ShippingMethod.active ● Boolean scalar​

Whether the shipping method is active.

ShippingMethod.name ● String scalar​

Localised display name of the shipping method.

ShippingMethod.orderDeliveries ● OrderDeliveryConnection object​

ShippingMethod.orderDeliveries.first ● Int scalar​
ShippingMethod.orderDeliveries.after ● String scalar​
ShippingMethod.orderDeliveries.filter ● OrderDeliveryFilterInput input​

ShippingMethod.salesChannelDefaultAssignments ● SalesChannelConnection object​

ShippingMethod.salesChannelDefaultAssignments.first ● Int scalar​
ShippingMethod.salesChannelDefaultAssignments.after ● String scalar​
ShippingMethod.salesChannelDefaultAssignments.filter ● SalesChannelFilterInput input​

ShippingMethod.salesChannels ● SalesChannelConnection object​

ShippingMethod.salesChannels.first ● Int scalar​
ShippingMethod.salesChannels.after ● String scalar​
ShippingMethod.salesChannels.filter ● SalesChannelFilterInput input​

ShippingMethod.tags ● TagConnection object​

ShippingMethod.tags.first ● Int scalar​
ShippingMethod.tags.after ● String scalar​
ShippingMethod.tags.filter ● TagFilterInput input​

Interfaces​

Node interface​

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By​

shippingMethod query

Member Of​

FulfillmentOrder object ● OrderDelivery object ● Quote object ● SalesChannel object ● ShippingMethodEdge object