younifyd
Menu

shippingMethods

Query shipping methods — supports a `where` predicate, `sort`, and `limit`/`offset` paging.

Use it in a workflow

  1. Add a step and choose the Commercetools connector.
  2. Pick the shippingMethods action (under Shipping).
  3. Fill in the fields below, then reference the result from later steps as {{shippingmethods.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
query ShippingMethods($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  shippingMethods(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      name
      zoneRates {
        shippingRates
        zoneRef
        zone
      }
      active
      isDefault
      predicate
      key
      carrier
      taxCategoryRef {
        typeId
        id
      }
      localizedDescriptionAllLocales {
        locale
        value
      }
      localizedNameAllLocales {
        locale
        value
      }
      storesRef {
        typeId
        key
      }
      stores {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      taxCategory {
        name
        description
        rates
        key
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      custom {
        typeRef
        type
      }
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

wherestring
sortarray<string>
limitnumber
offsetnumber
json
{
  "where": "string",
  "sort": [
    "string"
  ],
  "limit": 0,
  "offset": 0
}

Response

Read the result with {{shippingmethods.response.data.data.shippingMethods}}. If the API returns errors, the step fails and they are at {{shippingmethods.response.data.errors}}.

offsetnumber
countnumber
totalstring
existsboolean
resultsarray<object>
nameobject
zoneRatesobject
activeobject
isDefaultobject
predicateobject
keyobject
carrierobject
taxCategoryRefobject
localizedDescriptionAllLocalesobject
localizedNameAllLocalesobject
storesRefobject
storesobject
taxCategoryobject
customobject
idobject
versionobject
createdAtobject
lastModifiedAtobject
createdByobject
lastModifiedByobject

Need more? See the Commercetools guide for connection setup and behaviour shared by every action.