Skip to main content

ShippingMethod

Representation of a shipping method

type ShippingMethod {
  id: Int!
  name: [LocalizedString]!
  description: ShippingDescription
  image: Media
  shippingClass: ShippingClass
  price: MonetaryValue!
  active: Boolean
  address: Address
  isPickupPoint: Boolean
  isSuperMethod: Boolean
  pickupPoints(
    limit: Int! = 10
  ): [PickupPoint] @deprecated
  provider: String
  erpReference: String
  serviceCode: String
  trackingLinkTemplate: String
  shippingCompany: String
  updatedAt: DateTime
}

Fields​

id ● Int!​

Internal id of the shipping method

name ● [LocalizedString]!​

The name of the shipping method

description ● ShippingDescription​

The description of the shipping method

image ● Media​

The aimage of the shipping method

shippingClass ● ShippingClass​

The shipping class of the shipping method

price ● MonetaryValue!​

The price of using this shipping method

active ● Boolean​

Is the shipping method active

address ● Address​

The address of a shipping method

isPickupPoint ● Boolean​

Is the shipping method a pickuo point

isSuperMethod ● Boolean​

Is the shipping method a parent to other methods

provider ● String​

The provider name of the shipping method

erpReference ● String​

Reference number used by ERP

serviceCode ● String​

Service code used by ERP

trackingLinkTemplate ● String​

Tracking link template. Template used to generate the tracking link

shippingCompany ● String​

Shipping company name

updatedAt ● DateTime​

Time when the shipping method was last updated

Show deprecated

Example​

{
  "name": [
    {
      "language": "EN",
      "value": "String"
    }
  ],
  "description": {},
  "image": {
    "link": [
      {
        "alternateUrls": [
          {}
        ],
        "redirect": {}
      }
    ],
    "modifiedAt": "2024-05-03T11:52:33Z"
  },
  "shippingClass": {},
  "price": {
    "currency": {
      "code": "USD",
      "rate": 11.355,
      "prefix": "$"
    },
    "tax": {}
  },
  "address": {
    "organizationRegistrationId": "SE5566395256",
    "organizationName": "Askås Internet- & Reklambyrå AB",
    "organizationNumber": "556639-5256",
    "ssn": 191212,
    "firstName": "John",
    "lastName": "Doe",
    "streetAddress": "Järnvägsgatan 11",
    "houseNumber": 11,
    "streetAddress2": 11,
    "postalCode": 66133,
    "city": "Säffle",
    "country": "Sverige",
    "state": {
      "country": {
        "phonePrefix": "+46"
      }
    },
    "email": "[email protected]",
    "phone": "+1123456789",
    "reference": "Project 221",
    "doorCode": 1234,
    "attention": "Jane"
  },
  "pickupPoints": [
    {
      "details": {
        "openHours": [
          {}
        ]
      }
    }
  ]
}