> Documentation index: [Saleor](/llms.txt) · [This section](/api-reference/shipping/llms.txt)
> Source: https://docs.saleor.io/api-reference/shipping/objects/shipping-method

# ShippingMethod Object

Shipping methods that can be used as means of shipping for orders and checkouts.

```graphql
type ShippingMethod implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  type: ShippingMethodTypeEnum @deprecated
  name: String!
  description: JSONString
  maximumDeliveryDays: Int
  minimumDeliveryDays: Int
  maximumOrderWeight: Weight @deprecated
  minimumOrderWeight: Weight @deprecated
  translation(
    languageCode: LanguageCodeEnum!
  ): ShippingMethodTranslation
  price: Money!
  maximumOrderPrice: Money @deprecated
  minimumOrderPrice: Money @deprecated
  active: Boolean!
  message: String
}
```

<a id="fields"></a>

### Fields

<a id="id"></a>

#### [`id`](#id) ● [`ID!`](/api-reference/miscellaneous/scalars/id.md)

Unique ID of ShippingMethod available for Order.

<a id="private-metadata"></a>

#### [`privateMetadata`](#private-metadata) ● [`[MetadataItem!]!`](/api-reference/miscellaneous/objects/metadata-item.md)

List of private metadata items. Requires staff permissions to access.

<a id="private-metafield"></a>

#### [`privateMetafield`](#private-metafield) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

<a id="shipping-method-private-metafield-key"></a>

##### [`key`](#shipping-method-private-metafield-key) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

<a id="private-metafields"></a>

#### [`privateMetafields`](#private-metafields) ● [`Metadata`](/api-reference/miscellaneous/scalars/metadata.md)

Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.

<a id="shipping-method-private-metafields-keys"></a>

##### [`keys`](#shipping-method-private-metafields-keys) ● [`[String!]`](/api-reference/miscellaneous/scalars/string.md)

<a id="metadata"></a>

#### [`metadata`](#metadata) ● [`[MetadataItem!]!`](/api-reference/miscellaneous/objects/metadata-item.md)

List of public metadata items. Can be accessed without permissions.

<a id="metafield"></a>

#### [`metafield`](#metafield) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

<a id="shipping-method-metafield-key"></a>

##### [`key`](#shipping-method-metafield-key) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

<a id="metafields"></a>

#### [`metafields`](#metafields) ● [`Metadata`](/api-reference/miscellaneous/scalars/metadata.md)

Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.

<a id="shipping-method-metafields-keys"></a>

##### [`keys`](#shipping-method-metafields-keys) ● [`[String!]`](/api-reference/miscellaneous/scalars/string.md)

<a id="name"></a>

#### [`name`](#name) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

Shipping method name.

<a id="description"></a>

#### [`description`](#description) ● [`JSONString`](/api-reference/miscellaneous/scalars/jsonstring.md)

Shipping method description.

Rich text format. For reference see [https://editorjs.io/](https://editorjs.io/)

<a id="maximum-delivery-days"></a>

#### [`maximumDeliveryDays`](#maximum-delivery-days) ● [`Int`](/api-reference/miscellaneous/scalars/int.md)

Maximum delivery days for this shipping method.

<a id="minimum-delivery-days"></a>

#### [`minimumDeliveryDays`](#minimum-delivery-days) ● [`Int`](/api-reference/miscellaneous/scalars/int.md)

Minimum delivery days for this shipping method.

<a id="translation"></a>

#### [`translation`](#translation) ● [`ShippingMethodTranslation`](/api-reference/shipping/objects/shipping-method-translation.md)

Returns translated shipping method fields for the given language code.

<a id="shipping-method-translation-language-code"></a>

##### [`languageCode`](#shipping-method-translation-language-code) ● [`LanguageCodeEnum!`](/api-reference/miscellaneous/enums/language-code-enum.md)

A language code to return the translation for shipping method.

<a id="price"></a>

#### [`price`](#price) ● [`Money!`](/api-reference/miscellaneous/objects/money.md)

The price of selected shipping method.

<a id="active"></a>

#### [`active`](#active) ● [`Boolean!`](/api-reference/miscellaneous/scalars/boolean.md)

Describes if this shipping method is active and can be selected.

<a id="message"></a>

#### [`message`](#message) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

Message connected to this shipping method.

Show deprecatedHide deprecated

<a id="type"></a>

#### [`type`](#type) ● [`ShippingMethodTypeEnum`](/api-reference/shipping/enums/shipping-method-type-enum.md)

DEPRECATED

No longer supported

Type of the shipping method.

<a id="maximum-order-weight"></a>

#### [`maximumOrderWeight`](#maximum-order-weight) ● [`Weight`](/api-reference/miscellaneous/objects/weight.md)

DEPRECATED

No longer supported

Maximum order weight for this shipping method.

<a id="minimum-order-weight"></a>

#### [`minimumOrderWeight`](#minimum-order-weight) ● [`Weight`](/api-reference/miscellaneous/objects/weight.md)

DEPRECATED

No longer supported

Minimum order weight for this shipping method.

<a id="maximum-order-price"></a>

#### [`maximumOrderPrice`](#maximum-order-price) ● [`Money`](/api-reference/miscellaneous/objects/money.md)

DEPRECATED

No longer supported

Maximum order price for this shipping method.

<a id="minimum-order-price"></a>

#### [`minimumOrderPrice`](#minimum-order-price) ● [`Money`](/api-reference/miscellaneous/objects/money.md)

DEPRECATED

No longer supported

Minimal order price for this shipping method.

<a id="interfaces"></a>

### Interfaces

<a id="node"></a>

#### [`Node`](/api-reference/miscellaneous/interfaces/node.md)

An object with an ID

<a id="objectwithmetadata"></a>

#### [`ObjectWithMetadata`](/api-reference/miscellaneous/interfaces/object-with-metadata.md)

<a id="member-of"></a>

### Member Of

[`Checkout`](/api-reference/checkout/objects/checkout.md) object  ● [`CheckoutFilterShippingMethods`](/api-reference/checkout/objects/checkout-filter-shipping-methods.md) object  ● [`Delivery`](/api-reference/miscellaneous/objects/delivery.md) object  ● [`Order`](/api-reference/orders/objects/order.md) object  ● [`OrderFilterShippingMethods`](/api-reference/orders/objects/order-filter-shipping-methods.md) object  ● [`ShippingListMethodsForCheckout`](/api-reference/checkout/objects/shipping-list-methods-for-checkout.md) object  ● [`ShippingMethodsPerCountry`](/api-reference/shipping/objects/shipping-methods-per-country.md) object  ● [`Shop`](/api-reference/miscellaneous/objects/shop.md) object

<a id="implemented-by"></a>

### Implemented By

[`DeliveryMethod`](/api-reference/miscellaneous/unions/delivery-method.md) union
