Vue Storefront is now Alokai! Learn More
Commercetools API GraphQL Queries Documentation

Commercetools API GraphQL Queries Documentation

This documentation provides an overview of the GraphQL queries executed by specific methods in the Commercetools API.

Method: addBillingAddress

  • Query: addBillingAddress
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation addBillingAddress($version: Long!, $actions: [MyCustomerUpdateAction!]!, $storeKey: KeyReferenceInput) {
    user: updateMyCustomer(version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }

Method: addMultipleToMyShoppingList

  • Query: updateShoppingList
mutation updateShoppingList($id: String!, $version: Long!, $actions: [MyShoppingListUpdateAction!]!, $acceptLanguage: [Locale!], $currency: Currency!, $country: Country!, $customerGroupId: String) {
    wishlist: updateMyShoppingList(id: $id, version: $version, actions: $actions) {
      id
      version
      lineItems {
        id
        quantity
        name(acceptLanguage: $acceptLanguage)
        variant {
          sku
          price(currency: $currency, country: $country, customerGroupId: $customerGroupId) {
            tiers {
              value {
                centAmount
              }
            }
            value {
              centAmount
              currencyCode
            }
            discounted {
              value {
                centAmount
                currencyCode
              }
              discount {
                isActive
                name(acceptLanguage: $acceptLanguage)
              }
            }
          }
          images {
            url
            label
          }
        }
      }
    }
  }

Method: addProductReview

  • Query: addReview
fragment DefaultReviewFragment on Review {
    id
    text
    authorName
    rating
    createdAt
    version
    customer {
      id
    }
  }

  mutation createReview($draft: ReviewDraft!) {
    review: createReview(draft: $draft) {
      ...DefaultReviewFragment
    }
  }

Method: addShippingAddress

  • Query: addShippingAddress
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation addShippingAddress($version: Long!, $actions: [MyCustomerUpdateAction!]!, $storeKey: KeyReferenceInput) {
    user: updateMyCustomer(version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }

Method: addToMyShoppingList

  • Query: updateShoppingList
mutation updateShoppingList($id: String!, $version: Long!, $actions: [MyShoppingListUpdateAction!]!, $acceptLanguage: [Locale!], $currency: Currency!, $country: Country!, $customerGroupId: String) {
    wishlist: updateMyShoppingList(id: $id, version: $version, actions: $actions) {
      id
      version
      lineItems {
        id
        quantity
        name(acceptLanguage: $acceptLanguage)
        productSlug(acceptLanguage: $acceptLanguage)
        variant {
          sku
          price(currency: $currency, country: $country, customerGroupId: $customerGroupId) {
            tiers {
              value {
                centAmount
              }
            }
            value {
              centAmount
              currencyCode
            }
            discounted {
              value {
                centAmount
                currencyCode
              }
              discount {
                isActive
                name(acceptLanguage: $acceptLanguage)
              }
            }
          }
          images {
            url
            label
          }
        }
      }
    }
  }

Method: createCart

  • Query: createCart
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  fragment DefaultProductPrice on ProductPrice {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultLineItem on LineItem {
    id
    productId
    name(acceptLanguage: $acceptLanguage)
    productSlug(acceptLanguage: $acceptLanguage)
    quantity
    discountedPricePerQuantity {
      quantity
      discountedPrice {
        value {
          centAmount
          currencyCode
        }
        includedDiscounts {
          discount {
            name(acceptLanguage: $acceptLanguage)
            isActive
          }
        }
      }
    }
    variant {
      id
      sku
      price(currency: $currency) {
        tiers {
          value {
            centAmount
          }
        }
        value {
          centAmount
          currencyCode
        }
        discounted {
          value {
            centAmount
            currencyCode
          }
          discount {
            isActive
            name(acceptLanguage: $acceptLanguage)
          }
        }
      }
      images {
        url
        label
      }
      attributesRaw {
        name
        value
        attributeDefinition {
          type {
            name
          }
          label(locale: $locale)
        }
      }
    }
    price {
      ...DefaultProductPrice
    }
    distributionChannel {
      ...ChannelFragment
    }
    supplyChannel {
      ...ChannelFragment
    }
    shippingDetails {
      targets {
        addressKey
        quantity
      }
      valid
    }
  }

  fragment DefaultShippingMethod on ShippingMethod {
    id
    version
    name
    isDefault
    localizedDescription(acceptLanguage: $acceptLanguage)
    key
    zoneRates {
      zone {
        id
        name
      }
      shippingRates {
        freeAbove {
          type
          centAmount
          currencyCode
        }
        isMatching
        price {
          centAmount
          currencyCode
        }
      }
    }
  }

  fragment DefaultCart on Cart {
    id
    customerId
    customerEmail
    lineItems {
      ...DefaultLineItem
    }
    totalPrice {
      centAmount
      currencyCode
    }
    shippingAddress {
      ...DefaultAddress
    }
    billingAddress {
      ...DefaultAddress
    }
    customer {
      ...DefaultCustomer
    }
    totalPrice {
      centAmount
      currencyCode
    }
    taxedPrice {
      totalNet {
        centAmount
        currencyCode
      }
      totalGross {
        centAmount
        currencyCode
      }
    }
    paymentInfo {
      payments {
        id
      }
    }
    shippingInfo {
      price {
        centAmount
        currencyCode
      }
      shippingMethod {
        ...DefaultShippingMethod
      }
    }
    discountCodes {
      state
      discountCode {
        id
        code
        isActive
        validFrom
        validUntil
        name(acceptLanguage: $acceptLanguage)
      }
    }
    refusedGifts {
      isActive
      validFrom
      validUntil
      name(acceptLanguage: $acceptLanguage)
    }
    custom {
      customFieldsRaw {
        name
        value
      }
    }
    cartState
    version
    inventoryMode
  }

  mutation createCart($draft: MyCartDraft!, $locale: Locale!, $acceptLanguage: [Locale!], $currency: Currency!, $storeKey: KeyReferenceInput) {
    cart: createMyCart(draft: $draft, storeKey: $storeKey) {
      ...DefaultCart
    }
  }

Method: createMyOrderFromCart

  • Query: createMyOrderFromCart
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultProductPrice on ProductPrice {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultLineItem on LineItem {
    id
    productId
    name(acceptLanguage: $acceptLanguage)
    productSlug(acceptLanguage: $acceptLanguage)
    quantity
    discountedPricePerQuantity {
      quantity
      discountedPrice {
        value {
          centAmount
          currencyCode
        }
        includedDiscounts {
          discount {
            name(acceptLanguage: $acceptLanguage)
            isActive
          }
        }
      }
    }
    variant {
      id
      sku
      price(currency: $currency) {
        tiers {
          value {
            centAmount
          }
        }
        value {
          centAmount
          currencyCode
        }
        discounted {
          value {
            centAmount
            currencyCode
          }
          discount {
            isActive
            name(acceptLanguage: $acceptLanguage)
          }
        }
      }
      images {
        url
        label
      }
      attributesRaw {
        name
        value
        attributeDefinition {
          type {
            name
          }
          label(locale: $locale)
        }
      }
    }
    price {
      ...DefaultProductPrice
    }
    distributionChannel {
      ...ChannelFragment
    }
    supplyChannel {
      ...ChannelFragment
    }
    shippingDetails {
      targets {
        addressKey
        quantity
      }
      valid
    }
  }

  fragment DefaultOrder on Order {
    lineItems {
      ...DefaultLineItem
    }
    totalPrice {
      centAmount
      currencyCode
    }
    orderState
    id
    orderNumber
    version
    createdAt
    customerEmail
    shipmentState
    paymentState
    shippingAddress {
      ...DefaultAddress
    }
    billingAddress {
      ...DefaultAddress
    }
    cart {
      id
      version
    }
  }

  mutation createMyOrderFromCart($draft: OrderMyCartCommand!, $locale: Locale!, $acceptLanguage: [Locale!], $currency: Currency!, $storeKey: KeyReferenceInput) {
    order: createMyOrderFromCart(draft: $draft, storeKey: $storeKey) {
      ...DefaultOrder
    }
  }

Method: createMyShoppingList

  • Query: createMyShoppingList
mutation createMyShoppingList($draft: MyShoppingListDraft!, $acceptLanguage: [Locale!], $currency: Currency!, $country: Country!, $customerGroupId: String) {
    wishlist: createMyShoppingList(draft: $draft) {
      id
      version
      lineItems {
        id
        quantity
        name(acceptLanguage: $acceptLanguage)
        productSlug(acceptLanguage: $acceptLanguage)
        variant {
          sku
          price (currency: $currency, country: $country, customerGroupId: $customerGroupId) {
            tiers {
              value {
                centAmount
              }
            }
            value {
              centAmount
              currencyCode
            }
            discounted {
              value {
                centAmount
                currencyCode
              }
              discount {
                isActive
                name(acceptLanguage: $acceptLanguage)
              }
            }
          }
          images {
            url
            label
          }
        }
      }
    }
  }

Method: customerCreatePasswordResetToken

  • Query: customerCreatePasswordResetToken
mutation customerCreatePasswordResetToken($email: String!, $storeKey: KeyReferenceInput) {
    customerCreatePasswordResetToken(email: $email, storeKey: $storeKey) {
      id
      customerId
      expiresAt
      value
      version
      createdAt
      lastModifiedAt
    }
  }

Method: customerResetPassword

  • Query: customerResetPassword
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation customerResetPassword($tokenValue: String!, $newPassword: String!, $storeKey: KeyReferenceInput) {
    customerResetPassword(tokenValue: $tokenValue, newPassword: $newPassword, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }

Method: signIn

  • Query: customerSignMeIn
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  fragment DefaultProductPrice on ProductPrice {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultLineItem on LineItem {
    id
    productId
    name(acceptLanguage: $acceptLanguage)
    productSlug(acceptLanguage: $acceptLanguage)
    quantity
    discountedPricePerQuantity {
      quantity
      discountedPrice {
        value {
          centAmount
          currencyCode
        }
        includedDiscounts {
          discount {
            name(acceptLanguage: $acceptLanguage)
            isActive
          }
        }
      }
    }
    variant {
      id
      sku
      price(currency: $currency) {
        tiers {
          value {
            centAmount
          }
        }
        value {
          centAmount
          currencyCode
        }
        discounted {
          value {
            centAmount
            currencyCode
          }
          discount {
            isActive
            name(acceptLanguage: $acceptLanguage)
          }
        }
      }
      images {
        url
        label
      }
      attributesRaw {
        name
        value
        attributeDefinition {
          type {
            name
          }
          label(locale: $locale)
        }
      }
    }
    price {
      ...DefaultProductPrice
    }
    distributionChannel {
      ...ChannelFragment
    }
    supplyChannel {
      ...ChannelFragment
    }
    shippingDetails {
      targets {
        addressKey
        quantity
      }
      valid
    }
  }

  fragment DefaultShippingMethod on ShippingMethod {
    id
    version
    name
    isDefault
    localizedDescription(acceptLanguage: $acceptLanguage)
    key
    zoneRates {
      zone {
        id
        name
      }
      shippingRates {
        freeAbove {
          type
          centAmount
          currencyCode
        }
        isMatching
        price {
          centAmount
          currencyCode
        }
      }
    }
  }

  fragment DefaultCart on Cart {
    id
    customerId
    customerEmail
    lineItems {
      ...DefaultLineItem
    }
    totalPrice {
      centAmount
      currencyCode
    }
    shippingAddress {
      ...DefaultAddress
    }
    billingAddress {
      ...DefaultAddress
    }
    customer {
      ...DefaultCustomer
    }
    totalPrice {
      centAmount
      currencyCode
    }
    taxedPrice {
      totalNet {
        centAmount
        currencyCode
      }
      totalGross {
        centAmount
        currencyCode
      }
    }
    paymentInfo {
      payments {
        id
      }
    }
    shippingInfo {
      price {
        centAmount
        currencyCode
      }
      shippingMethod {
        ...DefaultShippingMethod
      }
    }
    discountCodes {
      state
      discountCode {
        id
        code
        isActive
        validFrom
        validUntil
        name(acceptLanguage: $acceptLanguage)
      }
    }
    refusedGifts {
      isActive
      validFrom
      validUntil
      name(acceptLanguage: $acceptLanguage)
    }
    custom {
      customFieldsRaw {
        name
        value
      }
    }
    cartState
    version
    inventoryMode
  }

  mutation customerSignMeIn($draft: CustomerSignMeInDraft!, $locale: Locale!, $acceptLanguage: [Locale!], $currency: Currency!, $storeKey: KeyReferenceInput) {
    user: customerSignMeIn(draft: $draft, storeKey: $storeKey) {
      customer {
        ...DefaultCustomer
      }
      cart {
        ...DefaultCart
      }
    }
  }

Method: signUp

  • Query: customerSignMeUp
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  fragment DefaultProductPrice on ProductPrice {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultLineItem on LineItem {
    id
    productId
    name(acceptLanguage: $acceptLanguage)
    productSlug(acceptLanguage: $acceptLanguage)
    quantity
    discountedPricePerQuantity {
      quantity
      discountedPrice {
        value {
          centAmount
          currencyCode
        }
        includedDiscounts {
          discount {
            name(acceptLanguage: $acceptLanguage)
            isActive
          }
        }
      }
    }
    variant {
      id
      sku
      price(currency: $currency) {
        tiers {
          value {
            centAmount
          }
        }
        value {
          centAmount
          currencyCode
        }
        discounted {
          value {
            centAmount
            currencyCode
          }
          discount {
            isActive
            name(acceptLanguage: $acceptLanguage)
          }
        }
      }
      images {
        url
        label
      }
      attributesRaw {
        name
        value
        attributeDefinition {
          type {
            name
          }
          label(locale: $locale)
        }
      }
    }
    price {
      ...DefaultProductPrice
    }
    distributionChannel {
      ...ChannelFragment
    }
    supplyChannel {
      ...ChannelFragment
    }
    shippingDetails {
      targets {
        addressKey
        quantity
      }
      valid
    }
  }

  fragment DefaultShippingMethod on ShippingMethod {
    id
    version
    name
    isDefault
    localizedDescription(acceptLanguage: $acceptLanguage)
    key
    zoneRates {
      zone {
        id
        name
      }
      shippingRates {
        freeAbove {
          type
          centAmount
          currencyCode
        }
        isMatching
        price {
          centAmount
          currencyCode
        }
      }
    }
  }

  fragment DefaultCart on Cart {
    id
    customerId
    customerEmail
    lineItems {
      ...DefaultLineItem
    }
    totalPrice {
      centAmount
      currencyCode
    }
    shippingAddress {
      ...DefaultAddress
    }
    billingAddress {
      ...DefaultAddress
    }
    customer {
      ...DefaultCustomer
    }
    totalPrice {
      centAmount
      currencyCode
    }
    taxedPrice {
      totalNet {
        centAmount
        currencyCode
      }
      totalGross {
        centAmount
        currencyCode
      }
    }
    paymentInfo {
      payments {
        id
      }
    }
    shippingInfo {
      price {
        centAmount
        currencyCode
      }
      shippingMethod {
        ...DefaultShippingMethod
      }
    }
    discountCodes {
      state
      discountCode {
        id
        code
        isActive
        validFrom
        validUntil
        name(acceptLanguage: $acceptLanguage)
      }
    }
    refusedGifts {
      isActive
      validFrom
      validUntil
      name(acceptLanguage: $acceptLanguage)
    }
    custom {
      customFieldsRaw {
        name
        value
      }
    }
    cartState
    version
    inventoryMode
  }

  mutation customerSignMeUp($draft: CustomerSignMeUpDraft!, $locale: Locale!, $acceptLanguage: [Locale!], $currency: Currency!, $storeKey: KeyReferenceInput) {
    user: customerSignMeUp(draft: $draft, storeKey: $storeKey) {
      customer {
        ...DefaultCustomer
      }
      cart {
        ...DefaultCart
      }
    }
  }

Method: customerUpdateMe

  • Query: customerUpdateMe
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation customerUpdateMe($version: Long!, $actions: [MyCustomerUpdateAction!]!, $storeKey: KeyReferenceInput) {
    user: updateMyCustomer(version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }

Method: deleteBillingAddress

  • Query: deleteBillingAddress
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation deleteBillingAddress($version: Long!, $actions: [MyCustomerUpdateAction!]!, $storeKey: KeyReferenceInput) {
    user: updateMyCustomer(version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }

Method: deleteCart

  • Query: deleteCart
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  fragment DefaultProductPrice on ProductPrice {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultLineItem on LineItem {
    id
    productId
    name(acceptLanguage: $acceptLanguage)
    productSlug(acceptLanguage: $acceptLanguage)
    quantity
    discountedPricePerQuantity {
      quantity
      discountedPrice {
        value {
          centAmount
          currencyCode
        }
        includedDiscounts {
          discount {
            name(acceptLanguage: $acceptLanguage)
            isActive
          }
        }
      }
    }
    variant {
      id
      sku
      price(currency: $currency) {
        tiers {
          value {
            centAmount
          }
        }
        value {
          centAmount
          currencyCode
        }
        discounted {
          value {
            centAmount
            currencyCode
          }
          discount {
            isActive
            name(acceptLanguage: $acceptLanguage)
          }
        }
      }
      images {
        url
        label
      }
      attributesRaw {
        name
        value
        attributeDefinition {
          type {
            name
          }
          label(locale: $locale)
        }
      }
    }
    price {
      ...DefaultProductPrice
    }
    distributionChannel {
      ...ChannelFragment
    }
    supplyChannel {
      ...ChannelFragment
    }
    shippingDetails {
      targets {
        addressKey
        quantity
      }
      valid
    }
  }

  fragment DefaultShippingMethod on ShippingMethod {
    id
    version
    name
    isDefault
    localizedDescription(acceptLanguage: $acceptLanguage)
    key
    zoneRates {
      zone {
        id
        name
      }
      shippingRates {
        freeAbove {
          type
          centAmount
          currencyCode
        }
        isMatching
        price {
          centAmount
          currencyCode
        }
      }
    }
  }

  fragment DefaultCart on Cart {
    id
    customerId
    customerEmail
    lineItems {
      ...DefaultLineItem
    }
    totalPrice {
      centAmount
      currencyCode
    }
    shippingAddress {
      ...DefaultAddress
    }
    billingAddress {
      ...DefaultAddress
    }
    customer {
      ...DefaultCustomer
    }
    totalPrice {
      centAmount
      currencyCode
    }
    taxedPrice {
      totalNet {
        centAmount
        currencyCode
      }
      totalGross {
        centAmount
        currencyCode
      }
    }
    paymentInfo {
      payments {
        id
      }
    }
    shippingInfo {
      price {
        centAmount
        currencyCode
      }
      shippingMethod {
        ...DefaultShippingMethod
      }
    }
    discountCodes {
      state
      discountCode {
        id
        code
        isActive
        validFrom
        validUntil
        name(acceptLanguage: $acceptLanguage)
      }
    }
    refusedGifts {
      isActive
      validFrom
      validUntil
      name(acceptLanguage: $acceptLanguage)
    }
    custom {
      customFieldsRaw {
        name
        value
      }
    }
    cartState
    version
    inventoryMode
  }

  mutation deleteCart($id: String!, $version: Long!, $locale: Locale!, $acceptLanguage: [Locale!], $currency: Currency!) {
    cart: deleteMyCart(id: $id, version: $version) {
      ...DefaultCart
    }
  }

Method: deleteProductReview

  • Query: deleteReview
fragment DefaultReviewFragment on Review {
    id
    text
    authorName
    rating
    createdAt
    version
    customer {
      id
    }
  }

  mutation deleteReview($id: String, $version: Long!) {
    review: deleteReview(id: $id, version: $version) {
      ...DefaultReviewFragment
    }
  }

Method: deleteShippingAddress

  • Query: deleteShippingAddress
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation deleteShippingAddress($version: Long!, $actions: [MyCustomerUpdateAction!]!, $storeKey: KeyReferenceInput) {
    user: updateMyCustomer(version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }

Method: getCategories

  • Query: categories
fragment Children on Category {
    id
    slug(acceptLanguage: $acceptLanguage)
    name(acceptLanguage: $acceptLanguage)
    childCount
  }
  fragment DefaultCategory on Category {
    id
    slug(acceptLanguage: $acceptLanguage)
    name(acceptLanguage: $acceptLanguage)
    childCount
    children {
      ...Children
      children {
        ...Children
        children {
          ...Children
        }
      }
    }
  }

  query categories($where: String, $sort: [String!], $limit: Int, $offset: Int, $acceptLanguage: [Locale!]) {
    categories(where: $where, sort: $sort, limit: $limit, offset: $offset) {
      offset
      count
      total
      results {
        id
        slug(acceptLanguage: $acceptLanguage)
        name(acceptLanguage: $acceptLanguage)
        description(acceptLanguage: $acceptLanguage)
        childCount
        parent {
          ...DefaultCategory
          parent {
            ...DefaultCategory
            parent {
              ...DefaultCategory
            }
          }
        }
        children {
          ...DefaultCategory
        }
      }
    }
  }

Method: getChannel

  • Query: getChannelsData
query channels(
    $where: String,
    $limit: Int,
    $offset: Int
    $acceptLanguage: [Locale!]
  ) {
    channels(
      where: $where,
      limit: $limit,
      offset: $offset,
    ) {
      offset
      count
      total
      results {
        id,
        version,
        key,
        roles,
        name(acceptLanguage: $acceptLanguage),
        description(acceptLanguage: $acceptLanguage),
        address {
          additionalAddressInfo
          additionalStreetInfo
          apartment
          building
          city
          company
          country
          department
          email
          fax
          firstName
          id
          key
          lastName
          mobile
          pOBox
          phone
          postalCode
          region
          salutation
          state
          streetName
          streetNumber
          title
        },
        geoLocation {
          ... on Point {
            type
            coordinates
          }
        },
        createdAt,
        lastModifiedAt,
        custom {
          customFieldsRaw {
            name
            value
          }
        }
      }
    }
  }

Method: getFacetCategories

  • Query: categories
fragment category on Category {
    id
    key
    slug(acceptLanguage: $acceptLanguage)
    name(acceptLanguage: $acceptLanguage)
  }

  query categories($where: String, $sort: [String!], $limit: Int, $offset: Int, $acceptLanguage: [Locale!]) {
    categories(where: $where, sort: $sort, limit: $limit, offset: $offset) {
      results {
        ...category
        metaDescription(acceptLanguage: $acceptLanguage)
        ancestors {
          ...category
          ancestors {
            ...category
          }
        }
        parent {
          id
          parent {
            id
            parent {
              id
            }
          }
        }
      }
    }
  }

Method: getFacetProductProjection

  • Query: productProjections
fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultProductPriceSearch on ProductPriceSearch {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }
  fragment ImagesProductSearch on ProductSearchVariant {
    images {
      url
      label
    }
  }
  fragment PriceProductSearch on ProductSearchVariant {
    price(currency: $currency, country: $country, channelId: $channelId, customerGroupId: $customerGroupId) {
      ...DefaultProductPriceSearch
    }
  }
  fragment AttributesProductSearch on ProductSearchVariant {
    attributesRaw {
      name
      value
    }
  }
  fragment AvailabilityProductSearch on ProductSearchVariant {
    availability {
      noChannel {
        isOnStock
        restockableInDays
        availableQuantity
      }
      channels(
        includeChannelIds: $includeChannelIds 
        excludeChannelIds: $excludeChannelIds 
        limit: $channelLimit
        offset: $channelOffset
      ) {
        limit
        offset
        total
        results {
          channelRef {
            id
          }
          availability {
            isOnStock
            restockableInDays
            availableQuantity
          }
          channel {
            ...ChannelFragment
          }
        }
      }
    }
  }
  fragment DefaultVariantProductSearch on ProductSearchVariant {
    id
    sku
    ...ImagesProductSearch
    ...PriceProductSearch
    ...AttributesProductSearch
    ...AvailabilityProductSearch
  }
  query productProjectionsSearch(
    $sorts: [String!],
    $limit: Int,
    $offset: Int,
    $locale: Locale!,
    $acceptLanguage: [Locale!],
    $text: String,
    $facets: [SearchFacetInput!],
    $filters: [SearchFilterInput!],
    $queryFilters: [SearchFilterInput!],
    $facetFilters: [SearchFilterInput!],
    $currency: Currency!,
    $country: Country,
    $channelId: String,
    $includeChannelIds: [String!],
    $excludeChannelIds:[String!],
    $channelLimit: Int,
    $channelOffset: Int,
    $customerGroupId: String
  ) {
    productProjectionSearch(
      sorts: $sorts,
      limit: $limit,
      offset: $offset,
      locale: $locale,
      text: $text,
      facets: $facets
      filters: $filters,
      queryFilters: $queryFilters,
      facetFilters: $facetFilters
    ) {
      count
      total
      offset
      results {
        id
        slug(acceptLanguage: $acceptLanguage)
        name(acceptLanguage: $acceptLanguage)
        masterVariant {
          ...DefaultVariantProductSearch
        }
        variants {
          ...DefaultVariantProductSearch
        }
        reviewRatingStatistics {
          averageRating,
          ratingsDistribution,
          count
        }
        productType {
          attributeDefinitions {
            results {
              name
              label(locale: $locale)
            }
          }
        }
      }
      facets {
        facet,
        value {
          ... on TermsFacetResult {
            terms {
              term
              count
              productCount
            }
          }
        }
      }
    }
  }

Method: getFacetCategories

  • Query: categories
fragment category on Category {
    id
    key
    slug(acceptLanguage: $acceptLanguage)
    name(acceptLanguage: $acceptLanguage)
  }

  query categories($where: String, $sort: [String!], $limit: Int, $offset: Int, $acceptLanguage: [Locale!]) {
    categories(where: $where, sort: $sort, limit: $limit, offset: $offset) {
      results {
        ...category
        metaDescription(acceptLanguage: $acceptLanguage)
        ancestors {
          ...category
          ancestors {
            ...category
          }
        }
        parent {
          id
          parent {
            id
            parent {
              id
            }
          }
        }
      }
    }
  }

Method: getFacetProductProjection

  • Query: productProjections
fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultProductPriceSearch on ProductPriceSearch {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }
  fragment ImagesProductSearch on ProductSearchVariant {
    images {
      url
      label
    }
  }
  fragment PriceProductSearch on ProductSearchVariant {
    price(currency: $currency, country: $country, channelId: $channelId, customerGroupId: $customerGroupId) {
      ...DefaultProductPriceSearch
    }
  }
  fragment AttributesProductSearch on ProductSearchVariant {
    attributesRaw {
      name
      value
    }
  }
  fragment AvailabilityProductSearch on ProductSearchVariant {
    availability {
      noChannel {
        isOnStock
        restockableInDays
        availableQuantity
      }
      channels(
        includeChannelIds: $includeChannelIds 
        excludeChannelIds: $excludeChannelIds 
        limit: $channelLimit
        offset: $channelOffset
      ) {
        limit
        offset
        total
        results {
          channelRef {
            id
          }
          availability {
            isOnStock
            restockableInDays
            availableQuantity
          }
          channel {
            ...ChannelFragment
          }
        }
      }
    }
  }
  fragment DefaultVariantProductSearch on ProductSearchVariant {
    id
    sku
    ...ImagesProductSearch
    ...PriceProductSearch
    ...AttributesProductSearch
    ...AvailabilityProductSearch
  }
  query productProjectionsSearch(
    $sorts: [String!],
    $limit: Int,
    $offset: Int,
    $locale: Locale!,
    $acceptLanguage: [Locale!],
    $text: String,
    $facets: [SearchFacetInput!],
    $filters: [SearchFilterInput!],
    $queryFilters: [SearchFilterInput!],
    $facetFilters: [SearchFilterInput!],
    $currency: Currency!,
    $country: Country,
    $channelId: String,
    $includeChannelIds: [String!],
    $excludeChannelIds:[String!],
    $channelLimit: Int,
    $channelOffset: Int,
    $customerGroupId: String
  ) {
    productProjectionSearch(
      sorts: $sorts,
      limit: $limit,
      offset: $offset,
      locale: $locale,
      text: $text,
      facets: $facets
      filters: $filters,
      queryFilters: $queryFilters,
      facetFilters: $facetFilters
    ) {
      count
      total
      offset
      results {
        id
        slug(acceptLanguage: $acceptLanguage)
        name(acceptLanguage: $acceptLanguage)
        masterVariant {
          ...DefaultVariantProductSearch
        }
        variants {
          ...DefaultVariantProductSearch
        }
        reviewRatingStatistics {
          averageRating,
          ratingsDistribution,
          count
        }
        productType {
          attributeDefinitions {
            results {
              name
              label(locale: $locale)
            }
          }
        }
      }
      facets {
        facet,
        value {
          ... on TermsFacetResult {
            terms {
              term
              count
              productCount
            }
          }
        }
      }
    }
  }

Method: getInventory

  • Query: inventory
fragment ReferenceFragment on Reference {
    typeId
    id
  }

  fragment InitiatorFragment on Initiator {
    isPlatformClient
    externalUserId
    anonymousId
    clientId
    customerRef {
      ...ReferenceFragment
    }
    userRef {
      ...ReferenceFragment
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment InventoryEntryFragment on InventoryEntry {
    id
    sku
    version
    createdAt
    lastModifiedAt
    quantityOnStock
    availableQuantity
    restockableInDays
    expectedDelivery
    supplyChannel {
      ...ChannelFragment
    }
    createdBy {
      ...InitiatorFragment
    }
    lastModifiedBy {
      ...InitiatorFragment
    }
  }

  fragment InventoryEntriesQueryResultFragment on InventoryEntryQueryResult {
    offset
    count
    total
    results {
      ...InventoryEntryFragment
    }
  }

  query inventoryEntries(
    $where: String
    $sort: [String!]
    $limit: Int
    $offset: Int
    $locale: Locale!
  ) {
    inventoryEntries(
      where: $where
      sort: $sort
      limit: $limit
      offset: $offset
    ) {
      ...InventoryEntriesQueryResultFragment
    }
  }

Method: getMe

  • Query: getBasicProfile
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  fragment DefaultProductPrice on ProductPrice {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultLineItem on LineItem {
    id
    productId
    name(acceptLanguage: $acceptLanguage)
    productSlug(acceptLanguage: $acceptLanguage)
    quantity
    discountedPricePerQuantity {
      quantity
      discountedPrice {
        value {
          centAmount
          currencyCode
        }
        includedDiscounts {
          discount {
            name(acceptLanguage: $acceptLanguage)
            isActive
          }
        }
      }
    }
    variant {
      id
      sku
      price(currency: $currency) {
        tiers {
          value {
            centAmount
          }
        }
        value {
          centAmount
          currencyCode
        }
        discounted {
          value {
            centAmount
            currencyCode
          }
          discount {
            isActive
            name(acceptLanguage: $acceptLanguage)
          }
        }
      }
      images {
        url
        label
      }
      attributesRaw {
        name
        value
        attributeDefinition {
          type {
            name
          }
          label(locale: $locale)
        }
      }
    }
    price {
      ...DefaultProductPrice
    }
    distributionChannel {
      ...ChannelFragment
    }
    supplyChannel {
      ...ChannelFragment
    }
    shippingDetails {
      targets {
        addressKey
        quantity
      }
      valid
    }
  }

  fragment DefaultShippingMethod on ShippingMethod {
    id
    version
    name
    isDefault
    localizedDescription(acceptLanguage: $acceptLanguage)
    key
    zoneRates {
      zone {
        id
        name
      }
      shippingRates {
        freeAbove {
          type
          centAmount
          currencyCode
        }
        isMatching
        price {
          centAmount
          currencyCode
        }
      }
    }
  }

  fragment DefaultCart on Cart {
    id
    customerId
    customerEmail
    lineItems {
      ...DefaultLineItem
    }
    totalPrice {
      centAmount
      currencyCode
    }
    shippingAddress {
      ...DefaultAddress
    }
    billingAddress {
      ...DefaultAddress
    }
    customer {
      ...DefaultCustomer
    }
    totalPrice {
      centAmount
      currencyCode
    }
    taxedPrice {
      totalNet {
        centAmount
        currencyCode
      }
      totalGross {
        centAmount
        currencyCode
      }
    }
    paymentInfo {
      payments {
        id
      }
    }
    shippingInfo {
      price {
        centAmount
        currencyCode
      }
      shippingMethod {
        ...DefaultShippingMethod
      }
    }
    discountCodes {
      state
      discountCode {
        id
        code
        isActive
        validFrom
        validUntil
        name(acceptLanguage: $acceptLanguage)
      }
    }
    refusedGifts {
      isActive
      validFrom
      validUntil
      name(acceptLanguage: $acceptLanguage)
    }
    custom {
      customFieldsRaw {
        name
        value
      }
    }
    cartState
    version
    inventoryMode
  }

  query getBasicProfile($locale: Locale!, $acceptLanguage: [Locale!], $currency: Currency!) {
    me {
      activeCart {
        ...DefaultCart
      }
    }
  }

Method: getMe

  • Query: getFullProfile
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  fragment DefaultProductPrice on ProductPrice {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultLineItem on LineItem {
    id
    productId
    name(acceptLanguage: $acceptLanguage)
    productSlug(acceptLanguage: $acceptLanguage)
    quantity
    discountedPricePerQuantity {
      quantity
      discountedPrice {
        value {
          centAmount
          currencyCode
        }
        includedDiscounts {
          discount {
            name(acceptLanguage: $acceptLanguage)
            isActive
          }
        }
      }
    }
    variant {
      id
      sku
      price(currency: $currency) {
        tiers {
          value {
            centAmount
          }
        }
        value {
          centAmount
          currencyCode
        }
        discounted {
          value {
            centAmount
            currencyCode
          }
          discount {
            isActive
            name(acceptLanguage: $acceptLanguage)
          }
        }
      }
      images {
        url
        label
      }
      attributesRaw {
        name
        value
        attributeDefinition {
          type {
            name
          }
          label(locale: $locale)
        }
      }
    }
    price {
      ...DefaultProductPrice
    }
    distributionChannel {
      ...ChannelFragment
    }
    supplyChannel {
      ...ChannelFragment
    }
    shippingDetails {
      targets {
        addressKey
        quantity
      }
      valid
    }
  }

  fragment DefaultShippingMethod on ShippingMethod {
    id
    version
    name
    isDefault
    localizedDescription(acceptLanguage: $acceptLanguage)
    key
    zoneRates {
      zone {
        id
        name
      }
      shippingRates {
        freeAbove {
          type
          centAmount
          currencyCode
        }
        isMatching
        price {
          centAmount
          currencyCode
        }
      }
    }
  }

  fragment DefaultCart on Cart {
    id
    customerId
    customerEmail
    lineItems {
      ...DefaultLineItem
    }
    totalPrice {
      centAmount
      currencyCode
    }
    shippingAddress {
      ...DefaultAddress
    }
    billingAddress {
      ...DefaultAddress
    }
    customer {
      ...DefaultCustomer
    }
    totalPrice {
      centAmount
      currencyCode
    }
    taxedPrice {
      totalNet {
        centAmount
        currencyCode
      }
      totalGross {
        centAmount
        currencyCode
      }
    }
    paymentInfo {
      payments {
        id
      }
    }
    shippingInfo {
      price {
        centAmount
        currencyCode
      }
      shippingMethod {
        ...DefaultShippingMethod
      }
    }
    discountCodes {
      state
      discountCode {
        id
        code
        isActive
        validFrom
        validUntil
        name(acceptLanguage: $acceptLanguage)
      }
    }
    refusedGifts {
      isActive
      validFrom
      validUntil
      name(acceptLanguage: $acceptLanguage)
    }
    custom {
      customFieldsRaw {
        name
        value
      }
    }
    cartState
    version
    inventoryMode
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  query getFullProfile($locale: Locale!, $acceptLanguage: [Locale!], $currency: Currency!) {
    me {
      activeCart {
        ...DefaultCart
      }
      customer {
        ...DefaultCustomer
      }
    }
  }

Method: getMyShoppingList

  • Query: getMe
query getMe($acceptLanguage: [Locale!], $currency: Currency!, $country: Country!, $customerGroupId: String) {
    me {
      shoppingLists(limit: 1, offset: 0) {
        results {
          id
          version
          lineItems {
            id
            quantity
            name(acceptLanguage: $acceptLanguage)
            productSlug(acceptLanguage: $acceptLanguage)
            variant {
              sku
              price(currency: $currency, country: $country, customerGroupId: $customerGroupId) {
                tiers {
                  value {
                    centAmount
                  }
                }
                value {
                  centAmount
                  currencyCode
                }
                discounted {
                  value {
                    centAmount
                    currencyCode
                  }
                  discount {
                    isActive
                    name(acceptLanguage: $acceptLanguage)
                  }
                }
              }
              images {
                url
                label
              }
            }
          }
        }
      }
    }
  }

Method: getOrders

  • Query: getMyOrders
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultProductPrice on ProductPrice {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultLineItem on LineItem {
    id
    productId
    name(acceptLanguage: $acceptLanguage)
    productSlug(acceptLanguage: $acceptLanguage)
    quantity
    discountedPricePerQuantity {
      quantity
      discountedPrice {
        value {
          centAmount
          currencyCode
        }
        includedDiscounts {
          discount {
            name(acceptLanguage: $acceptLanguage)
            isActive
          }
        }
      }
    }
    variant {
      id
      sku
      price(currency: $currency) {
        tiers {
          value {
            centAmount
          }
        }
        value {
          centAmount
          currencyCode
        }
        discounted {
          value {
            centAmount
            currencyCode
          }
          discount {
            isActive
            name(acceptLanguage: $acceptLanguage)
          }
        }
      }
      images {
        url
        label
      }
      attributesRaw {
        name
        value
        attributeDefinition {
          type {
            name
          }
          label(locale: $locale)
        }
      }
    }
    price {
      ...DefaultProductPrice
    }
    distributionChannel {
      ...ChannelFragment
    }
    supplyChannel {
      ...ChannelFragment
    }
    shippingDetails {
      targets {
        addressKey
        quantity
      }
      valid
    }
  }

  fragment DefaultOrder on Order {
    lineItems {
      ...DefaultLineItem
    }
    totalPrice {
      centAmount
      currencyCode
    }
    orderState
    id
    orderNumber
    version
    createdAt
    customerEmail
    shipmentState
    paymentState
    shippingAddress {
      ...DefaultAddress
    }
    billingAddress {
      ...DefaultAddress
    }
    cart {
      id
      version
    }
  }

  query getMyOrders($where: String, $sort: [String!], $limit: Int, $offset: Int, $locale: Locale!, $acceptLanguage: [Locale!], $currency: Currency!) {
    me {
      orders(where: $where, sort: $sort, limit: $limit, offset: $offset) {
        results {
          ...DefaultOrder
        }
        total
        offset
        count
      }
    }
  }

Method: getProducts

  • Query: products
fragment DefaultProductPrice on ProductPrice {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment Images on ProductVariant {
    images {
      url
      label
    }
  }

  fragment Price on ProductVariant {
    price(currency: $currency, country: $country, channelId: $channelId, customerGroupId: $customerGroupId) {
      ...DefaultProductPrice
    }
  }

  fragment Attributes on ProductVariant {
    attributesRaw {
      name
      value
      attributeDefinition {
        type {
          name
        }
        label(locale: $locale)
      }
    }
  }

  fragment Availability on ProductVariant {
    availability {
      noChannel {
        isOnStock
        restockableInDays
        availableQuantity
      }
      channels(
        includeChannelIds: $includeChannelIds 
        excludeChannelIds: $excludeChannelIds 
        limit: $channelLimit
        offset: $channelOffset
      ) {
        limit
        offset
        total
        results {
          channelRef {
            id
          }
          availability {
            isOnStock
            restockableInDays
            availableQuantity
          }
          channel {
            ...ChannelFragment
          }
        }
      }
    }
  }

  fragment DefaultVariant on ProductVariant {
    id
    sku
    ...Images
    ...Price
    ...Attributes
    ...Availability
  }

  fragment category on Category {
    id
    slug(acceptLanguage: $acceptLanguage)
    name(acceptLanguage: $acceptLanguage)
  }

  query products(
    $where: String
    $sort: [String!]
    $limit: Int
    $offset: Int
    $skus: [String!]
    $locale: Locale!
    $acceptLanguage: [Locale!]
    $currency: Currency!
    $country: Country!
    $channelId: String
    $includeChannelIds: [String!]
    $excludeChannelIds: [String!]
    $channelLimit: Int
    $channelOffset: Int,
    $customerGroupId: String
  ) {
    products(
      where: $where
      sort: $sort
      limit: $limit
      offset: $offset
      skus: $skus
    ) {
      offset
      count
      total
      results {
        id
        reviewRatingStatistics {    
          averageRating,
          ratingsDistribution,
          count
        }
        masterData {
          current {
            slug(acceptLanguage: $acceptLanguage)
            name(acceptLanguage: $acceptLanguage)
            metaTitle(acceptLanguage: $acceptLanguage)
            metaKeywords(acceptLanguage: $acceptLanguage)
            metaDescription(acceptLanguage: $acceptLanguage)
            description(acceptLanguage: $acceptLanguage)
            categoriesRef {
              id
            }
            categories {
              ...category
              parent {
                ...category
                parent {
                  ...category
                  parent {
                    ...category
                  }
                }
              }
            }
            allVariants {
              ...DefaultVariant
            }
            masterVariant {
              ...DefaultVariant
            }
          }
        }
      }
    }
  }

Method: getProductReviews

  • Query: reviews
fragment DefaultReviewFragment on Review {
    id
    text
    authorName
    rating
    createdAt
    version
    customer {
      id
    }
  }

  query reviews(
    $where: String!
    $limit: Int
    $offset: Int
    $sort: [String!]
  ) {
    reviews(
      where: $where
      limit: $limit
      offset: $offset
      sort: $sort
    ) {
      offset
      count
      total
      results {
        ...DefaultReviewFragment
      }
    }
  }

Method: getShippingMethods

  • Query: shippingMethods
fragment DefaultShippingMethod on ShippingMethod {
    id
    version
    name
    isDefault
    localizedDescription(acceptLanguage: $acceptLanguage)
    key
    zoneRates {
      zone {
        id
        name
      }
      shippingRates {
        freeAbove {
          type
          centAmount
          currencyCode
        }
        isMatching
        price {
          centAmount
          currencyCode
        }
      }
    }
  }

  query shippingMethods($acceptLanguage: [Locale!], $cartId: String!) {
    shippingMethods: shippingMethodsByCart(id: $cartId) {
      ...DefaultShippingMethod
    }
  }

Method: getShoppingList

  • Query: getMe
query getMe(
    $acceptLanguage: [Locale!],
    $currency: Currency!,
    $country: Country!,
    $where: String,
    $sort: [String!],
    $limit: Int,
    $offset: Int,
    $customerGroupId: String
  ) {
    me {
      shoppingLists(
        where: $where,
        sort: $sort,
        limit: $limit,
        offset: $offset
      ) {
        results {
          id
          version
          lineItems {
            id
            quantity
            name(acceptLanguage: $acceptLanguage)
            productSlug(acceptLanguage: $acceptLanguage)
            variant {
              sku
              price(currency: $currency, country: $country, customerGroupId: $customerGroupId) {
                tiers {
                  value {
                    centAmount
                  }
                }
                value {
                  centAmount
                  currencyCode
                }
                discounted {
                  value {
                    centAmount
                    currencyCode
                  }
                  discount {
                    isActive
                    name(acceptLanguage: $acceptLanguage)
                  }
                }
              }
              images {
                url
                label
              }
            }
          }
        }
      }
    }
  }

Method: getStores

  • Query: stores
fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment ReferenceFragment on Reference {
    typeId
    id
  }

  fragment InitiatorFragment on Initiator {
    isPlatformClient
    externalUserId
    anonymousId
    clientId
    customerRef {
      ...ReferenceFragment
    }
    userRef {
      ...ReferenceFragment
    }
  }

  fragment StoreFragment on Store {
    id
    version
    key
    languages
    createdAt
    lastModifiedAt
    name (locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    distributionChannels {
      ...ChannelFragment
    }
    supplyChannels {
      ...ChannelFragment
    }
    createdBy {
      ...InitiatorFragment
    }
    lastModifiedBy {
      ...InitiatorFragment
    }
  }

  fragment StoreQueryResultFragment on StoreQueryResult {
    offset
    count
    total
    results {
      ...StoreFragment
    }
  }

  query stores(
    $where: String
    $sort: [String!]
    $limit: Int
    $offset: Int
    $locale: Locale!
  ) {
    stores(
      where: $where
      sort: $sort
      limit: $limit
      offset: $offset
    ) {
      ...StoreQueryResultFragment
    }
  }

Method: removeFromMyShoppingList

  • Query: updateShoppingList
mutation updateShoppingList($id: String!, $version: Long!, $actions: [MyShoppingListUpdateAction!]!, $acceptLanguage: [Locale!], $currency: Currency!, $country: Country!, $customerGroupId: String) {
    wishlist: updateMyShoppingList(id: $id, version: $version, actions: $actions) {
      id
      version
      lineItems {
        id
        quantity
        name(acceptLanguage: $acceptLanguage)
        productSlug(acceptLanguage: $acceptLanguage)
        variant {
          sku
          price(currency: $currency, country: $country, customerGroupId: $customerGroupId) {
            tiers {
              value {
                centAmount
              }
            }
            value {
              centAmount
              currencyCode
            }
            discounted {
              value {
                centAmount
                currencyCode
              }
              discount {
                isActive
                name(acceptLanguage: $acceptLanguage)
              }
            }
          }
          images {
            url
            label
          }
        }
      }
    }
  }

Method: setDefaultBillingAddress

  • Query: setDefaultBillingAddress
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation setDefaultBillingAddress($version: Long!, $actions: [MyCustomerUpdateAction!]!, $storeKey: KeyReferenceInput) {
    user: updateMyCustomer(version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }

Method: setDefaultShippingAddress

  • Query: setDefaultShippingAddress
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation setDefaultShippingAddress($version: Long!, $actions: [MyCustomerUpdateAction!]!, $storeKey: KeyReferenceInput) {
    user: updateMyCustomer(version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }

Method: updateBillingAddress

  • Query: updateBillingAddress
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation updateBillingAddress($version: Long!, $actions: [MyCustomerUpdateAction!]!, $storeKey: KeyReferenceInput) {
    user: updateMyCustomer(version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }

Method: updateCart

  • Query: updateCart
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  fragment DefaultProductPrice on ProductPrice {
    discounted {
      value {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discount {
        validFrom
        validUntil
        isActive
        name(acceptLanguage: $acceptLanguage)
      }
    }
    value {
      type
      currencyCode
      centAmount
      fractionDigits
    }
  }

  fragment LocalizedStringFragment on LocalizedString {
    value
    locale
  }

  fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment ChannelFragment on Channel {
    id
    version
    key
    roles
    name(locale: $locale)
    description(locale: $locale)
    nameAllLocales {
      ...LocalizedStringFragment
    }
    descriptionAllLocales {
      ...LocalizedStringFragment
    }
    address {
      ...DefaultAddress
    }
  }

  fragment DefaultLineItem on LineItem {
    id
    productId
    name(acceptLanguage: $acceptLanguage)
    productSlug(acceptLanguage: $acceptLanguage)
    quantity
    discountedPricePerQuantity {
      quantity
      discountedPrice {
        value {
          centAmount
          currencyCode
        }
        includedDiscounts {
          discount {
            name(acceptLanguage: $acceptLanguage)
            isActive
          }
        }
      }
    }
    variant {
      id
      sku
      price(currency: $currency) {
        tiers {
          value {
            centAmount
          }
        }
        value {
          centAmount
          currencyCode
        }
        discounted {
          value {
            centAmount
            currencyCode
          }
          discount {
            isActive
            name(acceptLanguage: $acceptLanguage)
          }
        }
      }
      images {
        url
        label
      }
      attributesRaw {
        name
        value
        attributeDefinition {
          type {
            name
          }
          label(locale: $locale)
        }
      }
    }
    price {
      ...DefaultProductPrice
    }
    distributionChannel {
      ...ChannelFragment
    }
    supplyChannel {
      ...ChannelFragment
    }
    shippingDetails {
      targets {
        addressKey
        quantity
      }
      valid
    }
  }

  fragment DefaultShippingMethod on ShippingMethod {
    id
    version
    name
    isDefault
    localizedDescription(acceptLanguage: $acceptLanguage)
    key
    zoneRates {
      zone {
        id
        name
      }
      shippingRates {
        freeAbove {
          type
          centAmount
          currencyCode
        }
        isMatching
        price {
          centAmount
          currencyCode
        }
      }
    }
  }

  fragment DefaultCart on Cart {
    id
    customerId
    customerEmail
    lineItems {
      ...DefaultLineItem
    }
    totalPrice {
      centAmount
      currencyCode
    }
    shippingAddress {
      ...DefaultAddress
    }
    billingAddress {
      ...DefaultAddress
    }
    customer {
      ...DefaultCustomer
    }
    totalPrice {
      centAmount
      currencyCode
    }
    taxedPrice {
      totalNet {
        centAmount
        currencyCode
      }
      totalGross {
        centAmount
        currencyCode
      }
    }
    paymentInfo {
      payments {
        id
      }
    }
    shippingInfo {
      price {
        centAmount
        currencyCode
      }
      shippingMethod {
        ...DefaultShippingMethod
      }
    }
    discountCodes {
      state
      discountCode {
        id
        code
        isActive
        validFrom
        validUntil
        name(acceptLanguage: $acceptLanguage)
      }
    }
    refusedGifts {
      isActive
      validFrom
      validUntil
      name(acceptLanguage: $acceptLanguage)
    }
    custom {
      customFieldsRaw {
        name
        value
      }
    }
    cartState
    version
    inventoryMode
  }

  mutation updateCart(
    $id: String!,
    $version: Long!,
    $actions: [MyCartUpdateAction!]!,
    $locale: Locale!,
    $acceptLanguage: [Locale!],
    $currency: Currency!,
    $storeKey: KeyReferenceInput
  ) {
    cart: updateMyCart(id: $id, version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCart
    }
  }

Method: updateCustomer

  • Query: updateMyCustomer
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation updateMyCustomer($version: Long!, $actions: [MyCustomerUpdateAction!]!, $storeKey: KeyReferenceInput) {
    user: updateMyCustomer(version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }

Method: updateShippingAddress

  • Query: updateShippingAddress
fragment DefaultAddress on Address {
    id
    title
    firstName
    lastName
    streetName
    streetNumber
    postalCode
    city
    country
    state
    region
    company
    apartment
    phone
    mobile
    salutation
  }

  fragment DefaultCustomer on Customer {
    version
    firstName
    lastName
    email
    dateOfBirth
    id
    title
    salutation
    addresses {
      id
    }
    shippingAddresses {
      ...DefaultAddress
    }
    billingAddresses {
      ...DefaultAddress
    }
    defaultBillingAddressId
    defaultShippingAddressId
    customerGroup {
      id
    }
  }

  mutation updateShippingAddress($version: Long!, $actions: [MyCustomerUpdateAction!]!, $storeKey: KeyReferenceInput) {
    user: updateMyCustomer(version: $version, actions: $actions, storeKey: $storeKey) {
      ...DefaultCustomer
    }
  }