inStore

Scope queries and mutations to a single store by its key — carts, orders, customers, shopping lists and product selections limited to that store.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the inStore action (under In).
Fill in the fields below, then reference the result from later steps as {{instore.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 InStore($key: KeyReferenceInput!) {
  inStore(key: $key) {
    me {
      customer {
        id
        customerNumber
        email
        addresses
        defaultShippingAddressId
        defaultBillingAddressId
        shippingAddressIds
        billingAddressIds
        isEmailVerified
        customerGroupRef
        externalId
        key
        authenticationMode
        firstName
        lastName
        middleName
        title
        locale
        salutation
        dateOfBirth
        companyName
        vatId
        password
        customerGroup
        defaultShippingAddress
        defaultBillingAddress
        shippingAddresses
        billingAddresses
        storesRef
        stores
        customerGroupAssignments
        custom
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      activeCart {
        customerId
        customer
        customerEmail
        anonymousId
        customLineItems
        totalPrice
        taxedPrice
        discountOnTotalPrice
        shippingAddress
        billingAddress
        inventoryMode
        taxMode
        priceRoundingMode
        taxRoundingMode
        taxCalculationMode
        customerGroup
        customerGroupRef
        country
        shippingKey
        shippingInfo
        discountCodes
        directDiscounts
        refusedGifts
        refusedGiftsRefs
        paymentInfo
        locale
        shippingRateInput
        origin
        storeRef
        store
        itemShippingAddresses
        businessUnit
        businessUnitRef
        shipping
        taxedShippingPrice
        shippingMode
        shippingCustomFields
        placement
        discountTypeCombination
        cartState
        key
        purchaseOrderNumber
        lock
        custom
        deleteDaysAfterLastModification
        totalLineItemQuantity
        recurringPaymentConfiguration
        freezeStrategy
        warnings
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
    }
  }
}

Variables

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

keystringrequired

json

{
  "key": "string"
}

Response

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

meobject

customerobject37 fields

activeCartobject40 fields

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

Was this page helpful?