younifyd
Menu

quotes

Query quotes — 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 quotes action (under Quotes).
  3. Fill in the fields below, then reference the result from later steps as {{quotes.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 Quotes($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  quotes(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      customerRef {
        typeId
        id
      }
      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
      }
      customerGroupRef {
        typeId
        id
      }
      customerGroup {
        id
        version
        name
        key
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      customLineItems {
        id
        key
        nameAllLocales
        money
        totalPrice
        slug
        quantity
        state
        taxCategory
        taxCategoryRef
        taxRate
        taxedPrice
        taxedPricePortions
        perMethodTaxRate
        discountedPricePerQuantity
        custom
        shippingDetails
        priceMode
        recurrenceInfo
      }
      totalPrice {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      taxedPrice {
        totalNet
        totalGross
        taxPortions
        totalTax
      }
      shippingAddress {
        id
        streetName
        streetNumber
        additionalStreetInfo
        postalCode
        city
        region
        state
        country
        company
        department
        building
        apartment
        pOBox
        additionalAddressInfo
        externalId
        key
        phone
        mobile
        email
        fax
        title
        salutation
        firstName
        lastName
        custom
      }
      billingAddress {
        id
        streetName
        streetNumber
        additionalStreetInfo
        postalCode
        city
        region
        state
        country
        company
        department
        building
        apartment
        pOBox
        additionalAddressInfo
        externalId
        key
        phone
        mobile
        email
        fax
        title
        salutation
        firstName
        lastName
        custom
      }
      itemShippingAddresses {
        id
        streetName
        streetNumber
        additionalStreetInfo
        postalCode
        city
        region
        state
        country
        company
        department
        building
        apartment
        pOBox
        additionalAddressInfo
        externalId
        key
        phone
        mobile
        email
        fax
        title
        salutation
        firstName
        lastName
        custom
      }
      inventoryMode
      taxMode
      priceRoundingMode
      taxRoundingMode
      taxCalculationMode
      country
      shippingInfo {
        shippingMethodName
        price
        shippingRate
        taxRate
        deliveries
        discountedPrice
        shippingMethodState
        estimatedDelivery
        shippingMethod
        shippingMethodRef
        taxCategory
        taxCategoryRef
        taxedPrice
      }
      paymentInfo {
        payments
        paymentRefs
      }
      directDiscounts {
        id
        value
        target
      }
      shippingRateInput {
        type
      }
      storeRef {
        typeId
        key
      }
      store {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      businessUnit {
        id
        key
        name
        contactEmail
        addresses
        defaultShippingAddress
        defaultBillingAddress
        defaultShippingAddressId
        defaultBillingAddressId
        shippingAddresses
        billingAddresses
        shippingAddressIds
        billingAddressIds
        status
        storesRef
        stores
        storeMode
        unitType
        associates
        associateMode
        inheritedAssociates
        custom
        parentUnitRef
        parentUnit
        ancestors
        inheritedStores
        topLevelUnitRef
        topLevelUnit
        approvalRuleMode
        customerGroupAssignments
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      businessUnitRef {
        typeId
        key
      }
      key
      quoteState
      stagedQuoteRef {
        typeId
        id
      }
      stagedQuote {
        key
        stagedQuoteState
        quoteRequestRef
        quoteRequest
        quotationCartRef
        quotationCart
        customerRef
        customer
        validTo
        custom
        stateRef
        state
        sellerComment
        businessUnit
        businessUnitRef
        purchaseOrderNumber
        storeRef
        store
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      quoteRequestRef {
        typeId
        id
      }
      quoteRequest {
        customerRef
        customer
        customerGroupRef
        customerGroup
        customLineItems
        totalPrice
        taxedPrice
        shippingAddress
        billingAddress
        itemShippingAddresses
        inventoryMode
        taxMode
        priceRoundingMode
        taxRoundingMode
        taxCalculationMode
        country
        shippingInfo
        paymentInfo
        directDiscounts
        shippingRateInput
        storeRef
        store
        businessUnit
        businessUnitRef
        key
        quoteRequestState
        comment
        custom
        stateRef
        state
        purchaseOrderNumber
        cartRef
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      validTo
      sellerComment
      buyerComment
      custom {
        typeRef
        type
      }
      stateRef {
        typeId
        id
      }
      state {
        id
        version
        key
        type
        roles
        nameAllLocales
        descriptionAllLocales
        builtIn
        transitionsRef
        transitions
        initial
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      purchaseOrderNumber
      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 {{quotes.response.data.data.quotes}}. If the API returns errors, the step fails and they are at {{quotes.response.data.errors}}.

offsetnumber
countnumber
totalstring
existsboolean
resultsarray<object>
customerRefobject
customerobject
customerGroupRefobject
customerGroupobject
customLineItemsobject
totalPriceobject
taxedPriceobject
shippingAddressobject
billingAddressobject
itemShippingAddressesobject
inventoryModeobject
taxModeobject
priceRoundingModeobject
taxRoundingModeobject
taxCalculationModeobject
countryobject
shippingInfoobject
paymentInfoobject
directDiscountsobject
shippingRateInputobject
storeRefobject
storeobject
businessUnitobject
businessUnitRefobject
keyobject
quoteStateobject
stagedQuoteRefobject
stagedQuoteobject
quoteRequestRefobject
quoteRequestobject
validToobject
sellerCommentobject
buyerCommentobject
customobject
stateRefobject
stateobject
purchaseOrderNumberobject
idobject
versionobject
createdAtobject

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