younifyd
Menu

order

Fetch a single order by ID or key.

Use it in a workflow

  1. Add a step and choose the Commercetools connector.
  2. Pick the order action (under Order).
  3. Fill in the fields below, then reference the result from later steps as {{order.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 Order($id: String, $orderNumber: String) {
  order(id: $id, orderNumber: $orderNumber) {
    customerId
    customer {
      id
      customerNumber
      email
      addresses {
        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
      }
      defaultShippingAddressId
      defaultBillingAddressId
      shippingAddressIds
      billingAddressIds
      isEmailVerified
      customerGroupRef {
        typeId
        id
      }
      externalId
      key
      authenticationMode
      firstName
      lastName
      middleName
      title
      locale
      salutation
      dateOfBirth
      companyName
      vatId
      password
      customerGroup {
        id
        version
        name
        key
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      defaultShippingAddress {
        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
      }
      defaultBillingAddress {
        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
      }
      shippingAddresses {
        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
      }
      billingAddresses {
        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
      }
      storesRef {
        typeId
        key
      }
      stores {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      customerGroupAssignments {
        customerGroupRef
        customerGroup
      }
      custom {
        typeRef
        type
      }
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    customerEmail
    anonymousId
    customLineItems {
      id
      key
      nameAllLocales {
        locale
        value
      }
      money {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      totalPrice {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      slug
      quantity
      state {
        quantity
        stateRef
        state
      }
      taxCategory {
        name
        description
        rates
        key
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      taxCategoryRef {
        typeId
        id
      }
      taxRate {
        name
        amount
        includedInPrice
        country
        state
        id
        key
        subRates
      }
      taxedPrice {
        totalNet
        totalGross
        taxPortions
        totalTax
      }
      taxedPricePortions {
        shippingMethodKey
        taxedPrice
      }
      perMethodTaxRate {
        shippingMethodKey
        taxRate
      }
      discountedPricePerQuantity {
        quantity
        discountedPrice
      }
      custom {
        typeRef
        type
      }
      shippingDetails {
        targets
        valid
      }
      priceMode
      recurrenceInfo {
        recurrencePolicy
        recurrencePolicyRef
        expiresAt
      }
    }
    totalPrice {
      type
      currencyCode
      centAmount
      fractionDigits
    }
    taxedPrice {
      totalNet {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      totalGross {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      taxPortions {
        rate
        amount
        name
      }
      totalTax {
        type
        currencyCode
        centAmount
        fractionDigits
      }
    }
    discountOnTotalPrice {
      discountedAmount {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      includedDiscounts {
        discount
        discountRef
        discountedAmount
      }
      discountedNetAmount {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      discountedGrossAmount {
        type
        currencyCode
        centAmount
        fractionDigits
      }
    }
    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 {
        typeRef
        type
      }
    }
    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 {
        typeRef
        type
      }
    }
    inventoryMode
    taxMode
    priceRoundingMode
    taxRoundingMode
    taxCalculationMode
    customerGroup {
      id
      version
      name
      key
      createdAt
      lastModifiedAt
      custom {
        typeRef
        type
      }
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    customerGroupRef {
      typeId
      id
    }
    country
    shippingKey
    shippingInfo {
      shippingMethodName
      price {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      shippingRate {
        price
        freeAbove
        isMatching
        tiers
      }
      taxRate {
        name
        amount
        includedInPrice
        country
        state
        id
        key
        subRates
      }
      deliveries {
        id
        key
        createdAt
        items
        parcels
        address
        custom
      }
      discountedPrice {
        value
        includedDiscounts
      }
      shippingMethodState
      estimatedDelivery {
        from
        until
      }
      shippingMethod {
        name
        zoneRates
        active
        isDefault
        predicate
        key
        carrier
        taxCategoryRef
        localizedDescriptionAllLocales
        localizedNameAllLocales
        storesRef
        stores
        taxCategory
        custom
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      shippingMethodRef {
        typeId
        id
      }
      taxCategory {
        name
        description
        rates
        key
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      taxCategoryRef {
        typeId
        id
      }
      taxedPrice {
        totalNet
        totalGross
        taxPortions
        totalTax
      }
    }
    discountCodes {
      discountCodeRef {
        typeId
        id
      }
      state
      discountCode {
        code
        key
        isActive
        maxApplications
        maxApplicationsPerCustomer
        cartPredicate
        applicationVersion
        groups
        cartDiscounts
        validFrom
        validUntil
        referenceRefs
        nameAllLocales
        descriptionAllLocales
        custom
        applicationCount
        storesRef
        stores
        cartDiscountRefs
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
    }
    directDiscounts {
      id
      value {
        type
      }
      target {
        type
      }
    }
    refusedGifts {
      cartPredicate
      stackingMode
      isActive
      requiresDiscountCode
      key
      discountGroupRef {
        typeId
        id
      }
      nameAllLocales {
        locale
        value
      }
      descriptionAllLocales {
        locale
        value
      }
      referenceRefs {
        typeId
        id
      }
      custom {
        typeRef
        type
      }
      validFrom
      validUntil
      storesRef {
        typeId
        key
      }
      stores {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      discountGroup {
        id
        version
        key
        sortOrder
        isActive
        nameAllLocales
        descriptionAllLocales
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      value {
        type
      }
      target {
        type
      }
      sortOrder
      recurringOrderScope {
        type
      }
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    refusedGiftsRefs {
      typeId
      id
    }
    paymentInfo {
      payments {
        key
        customerRef
        customer
        anonymousId
        interfaceId
        amountPlanned
        paymentMethodInfo
        paymentStatus
        transactions
        custom
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      paymentRefs {
        typeId
        id
      }
    }
    locale
    shippingRateInput {
      type
    }
    origin
    storeRef {
      typeId
      key
    }
    store {
      id
      version
      key
      nameAllLocales {
        locale
        value
      }
      languages
      countries {
        code
      }
      productSelections {
        productSelectionRef
        productSelection
        active
      }
      distributionChannelsRef {
        typeId
        id
      }
      distributionChannels {
        id
        version
        key
        roles
        nameAllLocales
        descriptionAllLocales
        address
        geoLocation
        createdAt
        lastModifiedAt
        reviewRatingStatistics
        custom
        createdBy
        lastModifiedBy
      }
      supplyChannelsRef {
        typeId
        id
      }
      supplyChannels {
        id
        version
        key
        roles
        nameAllLocales
        descriptionAllLocales
        address
        geoLocation
        createdAt
        lastModifiedAt
        reviewRatingStatistics
        custom
        createdBy
        lastModifiedBy
      }
      storefront {
        checkoutUrlTemplate
        orderUrlTemplate
        termsOfServiceUrl
        privacyPolicyUrl
        refundPolicyUrl
        shippingPolicyUrl
        cookiePolicyUrl
        imprintUrl
        faqUrl
        contactUrl
      }
      createdAt
      lastModifiedAt
      custom {
        typeRef
        type
      }
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    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 {
        typeRef
        type
      }
    }
    businessUnit {
      id
      key
      name
      contactEmail
      addresses {
        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
      }
      defaultShippingAddress {
        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
      }
      defaultBillingAddress {
        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
      }
      defaultShippingAddressId
      defaultBillingAddressId
      shippingAddresses {
        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
      }
      billingAddresses {
        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
      }
      shippingAddressIds
      billingAddressIds
      status
      storesRef {
        typeId
        key
      }
      stores {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      storeMode
      unitType
      associates {
        associateRoleAssignments
        customerRef
        customer
      }
      associateMode
      inheritedAssociates {
        associateRoleAssignments
        customerRef
        customer
      }
      custom {
        typeRef
        type
      }
      parentUnitRef {
        typeId
        key
      }
      parentUnit
      ancestors
      inheritedStores {
        store
        storeRef
      }
      topLevelUnitRef {
        typeId
        key
      }
      topLevelUnit
      approvalRuleMode
      customerGroupAssignments {
        customerGroupRef
        customerGroup
      }
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    businessUnitRef {
      typeId
      key
    }
    shipping {
      shippingKey
      shippingInfo {
        shippingMethodName
        price
        shippingRate
        taxRate
        deliveries
        discountedPrice
        shippingMethodState
        estimatedDelivery
        shippingMethod
        shippingMethodRef
        taxCategory
        taxCategoryRef
        taxedPrice
      }
      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
      }
      shippingRateInput {
        type
      }
      shippingCustomFields {
        typeRef
        type
      }
    }
    taxedShippingPrice {
      totalNet {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      totalGross {
        type
        currencyCode
        centAmount
        fractionDigits
      }
      taxPortions {
        rate
        amount
        name
      }
      totalTax {
        type
        currencyCode
        centAmount
        fractionDigits
      }
    }
    shippingMode
    shippingCustomFields {
      typeRef {
        typeId
        id
      }
      type {
        key
        nameAllLocales
        descriptionAllLocales
        resourceTypeIds
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
    }
    placement
    discountTypeCombination {
      type
    }
    completedAt
    orderNumber
    orderState
    stateRef {
      typeId
      id
    }
    state {
      id
      version
      key
      type
      roles
      nameAllLocales {
        locale
        value
      }
      descriptionAllLocales {
        locale
        value
      }
      builtIn
      transitionsRef {
        typeId
        id
      }
      transitions
      initial
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    shipmentState
    paymentState
    syncInfo {
      channelRef {
        typeId
        id
      }
      channel {
        id
        version
        key
        roles
        nameAllLocales
        descriptionAllLocales
        address
        geoLocation
        createdAt
        lastModifiedAt
        reviewRatingStatistics
        custom
        createdBy
        lastModifiedBy
      }
      externalId
      syncedAt
    }
    returnInfo {
      items {
        type
        id
        key
        quantity
        comment
        shipmentState
        paymentState
        custom
        lastModifiedAt
        createdAt
      }
      returnTrackingId
      returnDate
    }
    purchaseOrderNumber
    lastMessageSequenceNumber
    cartRef {
      typeId
      id
    }
    cart {
      customerId
      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
      }
      customerEmail
      anonymousId
      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
      }
      discountOnTotalPrice {
        discountedAmount
        includedDiscounts
        discountedNetAmount
        discountedGrossAmount
      }
      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
      }
      inventoryMode
      taxMode
      priceRoundingMode
      taxRoundingMode
      taxCalculationMode
      customerGroup {
        id
        version
        name
        key
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      customerGroupRef {
        typeId
        id
      }
      country
      shippingKey
      shippingInfo {
        shippingMethodName
        price
        shippingRate
        taxRate
        deliveries
        discountedPrice
        shippingMethodState
        estimatedDelivery
        shippingMethod
        shippingMethodRef
        taxCategory
        taxCategoryRef
        taxedPrice
      }
      discountCodes {
        discountCodeRef
        state
        discountCode
      }
      directDiscounts {
        id
        value
        target
      }
      refusedGifts {
        cartPredicate
        stackingMode
        isActive
        requiresDiscountCode
        key
        discountGroupRef
        nameAllLocales
        descriptionAllLocales
        referenceRefs
        custom
        validFrom
        validUntil
        storesRef
        stores
        discountGroup
        value
        target
        sortOrder
        recurringOrderScope
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      refusedGiftsRefs {
        typeId
        id
      }
      paymentInfo {
        payments
        paymentRefs
      }
      locale
      shippingRateInput {
        type
      }
      origin
      storeRef {
        typeId
        key
      }
      store {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      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
      }
      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
      }
      shipping {
        shippingKey
        shippingInfo
        shippingAddress
        shippingRateInput
        shippingCustomFields
      }
      taxedShippingPrice {
        totalNet
        totalGross
        taxPortions
        totalTax
      }
      shippingMode
      shippingCustomFields {
        typeRef
        type
      }
      placement
      discountTypeCombination {
        type
      }
      cartState
      key
      purchaseOrderNumber
      lock {
        createdAt
        clientId
      }
      custom {
        typeRef
        type
      }
      deleteDaysAfterLastModification
      totalLineItemQuantity
      recurringPaymentConfiguration {
        paymentStrategy
        paymentAllocations
      }
      freezeStrategy
      warnings {
        code
        message
      }
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    quoteRef {
      typeId
      id
    }
    quote {
      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
      }
    }
    recurringOrderRef {
      typeId
      id
    }
    recurringOrder {
      key
      recurringOrderState
      cartRef {
        typeId
        id
      }
      cart {
        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
      }
      startsAt
      resumesAt
      expiresAt
      lastOrderAt
      nextOrderAt
      skipConfiguration {
        type
      }
      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
      }
      custom {
        typeRef
        type
      }
      stateRef {
        typeId
        id
      }
      state {
        id
        version
        key
        type
        roles
        nameAllLocales
        descriptionAllLocales
        builtIn
        transitionsRef
        transitions
        initial
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      originOrderRef {
        typeId
        id
      }
      originOrder
      schedule {
        type
      }
      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
      }
      customerEmail
      storeRef {
        typeId
        key
      }
      store {
        id
        version
        key
        nameAllLocales
        languages
        countries
        productSelections
        distributionChannelsRef
        distributionChannels
        supplyChannelsRef
        supplyChannels
        storefront
        createdAt
        lastModifiedAt
        custom
        createdBy
        lastModifiedBy
      }
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
    custom {
      typeRef {
        typeId
        id
      }
      type {
        key
        nameAllLocales
        descriptionAllLocales
        resourceTypeIds
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
    }
    id
    version
    createdAt
    lastModifiedAt
    createdBy {
      isPlatformClient
      clientId
      externalUserId
      anonymousId
      customerRef {
        typeId
        id
      }
      userRef {
        typeId
        id
      }
      associateRef {
        typeId
        id
      }
      attributedTo {
        clientId
        source
        userRef
      }
    }
    lastModifiedBy {
      isPlatformClient
      clientId
      externalUserId
      anonymousId
      customerRef {
        typeId
        id
      }
      userRef {
        typeId
        id
      }
      associateRef {
        typeId
        id
      }
      attributedTo {
        clientId
        source
        userRef
      }
    }
  }
}

Variables

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

idstring

Queries with specified ID

orderNumberstring
json
{
  "id": "string",
  "orderNumber": "string"
}

Response

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

customerIdstring
customerobject
idstring
customerNumberstring
emailstring
addressesarray<object>
defaultShippingAddressIdstring
defaultBillingAddressIdstring
shippingAddressIdsarray<object>
billingAddressIdsarray<object>
isEmailVerifiedboolean
customerGroupRefobject2 fields
externalIdstring
keystring
authenticationModestring

One ofExternalAuthPassword

firstNamestring
lastNamestring
middleNamestring
titlestring
localestring
salutationstring
dateOfBirthstring
companyNamestring
vatIdstring
passwordstring
customerGroupobject9 fields
defaultShippingAddressobject26 fields
defaultBillingAddressobject26 fields
shippingAddressesarray<object>
billingAddressesarray<object>
storesRefarray<object>
storesarray<object>
customerGroupAssignmentsarray<object>
customobject2 fields
versionstring
createdAtstring
lastModifiedAtstring
createdByobject8 fields
lastModifiedByobject8 fields
customerEmailstring
anonymousIdstring
customLineItemsarray<object>
idobject
keyobject
nameAllLocalesobject
moneyobject
totalPriceobject
slugobject
quantityobject
stateobject
taxCategoryobject
taxCategoryRefobject
taxRateobject
taxedPriceobject
taxedPricePortionsobject
perMethodTaxRateobject
discountedPricePerQuantityobject
customobject
shippingDetailsobject
priceModeobject
recurrenceInfoobject
totalPriceobject
typestring
currencyCodestring
centAmountstring
fractionDigitsnumber
taxedPriceobject
totalNetobject4 fields
totalGrossobject4 fields
taxPortionsarray<object>
totalTaxobject4 fields
discountOnTotalPriceobject
discountedAmountobject4 fields
includedDiscountsarray<object>
discountedNetAmountobject4 fields
discountedGrossAmountobject4 fields
shippingAddressobject
idstring
streetNamestring
streetNumberstring
additionalStreetInfostring
postalCodestring
citystring
regionstring
statestring
countrystring
companystring
departmentstring
buildingstring
apartmentstring
pOBoxstring
additionalAddressInfostring
externalIdstring
keystring
phonestring
mobilestring
emailstring
faxstring
titlestring
salutationstring
firstNamestring
lastNamestring
customobject2 fields
billingAddressobject
idstring
streetNamestring
streetNumberstring
additionalStreetInfostring
postalCodestring
citystring
regionstring
statestring
countrystring
companystring
departmentstring
buildingstring
apartmentstring
pOBoxstring
additionalAddressInfostring
externalIdstring
keystring
phonestring
mobilestring
emailstring
faxstring
titlestring
salutationstring
firstNamestring
lastNamestring
customobject2 fields
inventoryModestring

One ofNoneReserveOnCartReserveOnOrderTrackOnly

taxModestring

One ofDisabledExternalExternalAmountPlatform

priceRoundingModestring

One ofHalfDownHalfEvenHalfUp

taxRoundingModestring

One ofHalfDownHalfEvenHalfUp

taxCalculationModestring

One ofLineItemLevelUnitPriceLevel

customerGroupobject
idstring
versionstring
namestring
keystring
createdAtstring
lastModifiedAtstring
customobject2 fields
createdByobject8 fields
lastModifiedByobject8 fields
customerGroupRefobject
typeIdstring
idstring
countrystring
shippingKeystring
shippingInfoobject
shippingMethodNamestring
priceobject4 fields
shippingRateobject4 fields
taxRateobject8 fields
deliveriesarray<object>
discountedPriceobject2 fields
shippingMethodStatestring

One ofDoesNotMatchCartMatchesCart

estimatedDeliveryobject2 fields
shippingMethodobject20 fields
shippingMethodRefobject2 fields
taxCategoryobject10 fields
taxCategoryRefobject2 fields
taxedPriceobject4 fields
discountCodesarray<object>
discountCodeRefobject
stateobject
discountCodeobject
directDiscountsarray<object>
idobject
valueobject
targetobject
refusedGiftsarray<object>
cartPredicateobject
stackingModeobject
isActiveobject
requiresDiscountCodeobject
keyobject
discountGroupRefobject
nameAllLocalesobject
descriptionAllLocalesobject
referenceRefsobject
customobject
validFromobject
validUntilobject
storesRefobject
storesobject
discountGroupobject
valueobject
targetobject
sortOrderobject
recurringOrderScopeobject
idobject
versionobject
createdAtobject
lastModifiedAtobject
createdByobject
lastModifiedByobject
refusedGiftsRefsarray<object>
typeIdobject
idobject
paymentInfoobject
paymentsarray<object>
paymentRefsarray<object>
localestring
shippingRateInputobject
typestring
originstring

One ofCustomerMerchantQuoteRecurringOrder

storeRefobject
typeIdstring
keystring
storeobject
idstring
versionstring
keystring
nameAllLocalesarray<object>
languagesarray<object>
countriesarray<object>
productSelectionsarray<object>
distributionChannelsRefarray<object>
distributionChannelsarray<object>
supplyChannelsRefarray<object>
supplyChannelsarray<object>
storefrontobject10 fields
createdAtstring
lastModifiedAtstring
customobject2 fields
createdByobject8 fields
lastModifiedByobject8 fields
itemShippingAddressesarray<object>
idobject
streetNameobject
streetNumberobject
additionalStreetInfoobject
postalCodeobject
cityobject
regionobject
stateobject
countryobject
companyobject
departmentobject
buildingobject
apartmentobject
pOBoxobject
additionalAddressInfoobject
externalIdobject
keyobject
phoneobject
mobileobject
emailobject
faxobject
titleobject
salutationobject
firstNameobject
lastNameobject
customobject
businessUnitobject
idstring
keystring
namestring
contactEmailstring
addressesarray<object>
defaultShippingAddressobject26 fields
defaultBillingAddressobject26 fields
defaultShippingAddressIdstring
defaultBillingAddressIdstring
shippingAddressesarray<object>
billingAddressesarray<object>
shippingAddressIdsarray<object>
billingAddressIdsarray<object>
statusstring

One ofActiveInactive

storesRefarray<object>
storesarray<object>
storeModestring
unitTypestring

One ofCompanyDivision

associatesarray<object>
associateModestring

One ofExplicitExplicitAndFromParent

inheritedAssociatesarray<object>
customobject2 fields
parentUnitRefobject2 fields
parentUnitobject

Recursive reference to BusinessUnit, not further expanded.

ancestorsarray<object>
inheritedStoresarray<object>
topLevelUnitRefobject2 fields
topLevelUnitobject

Recursive reference to BusinessUnit, not further expanded.

approvalRuleModestring

One ofExplicitExplicitAndFromParent

customerGroupAssignmentsarray<object>
versionstring
createdAtstring
lastModifiedAtstring
createdByobject8 fields
lastModifiedByobject8 fields
businessUnitRefobject
typeIdstring
keystring
shippingarray<object>
shippingKeyobject
shippingInfoobject
shippingAddressobject
shippingRateInputobject
shippingCustomFieldsobject
taxedShippingPriceobject
totalNetobject4 fields
totalGrossobject4 fields
taxPortionsarray<object>
totalTaxobject4 fields
shippingModestring

One ofMultipleSingle

shippingCustomFieldsobject
typeRefobject2 fields
typeobject10 fields
placementstring

One ofInStoreOnline

discountTypeCombinationobject
typestring
completedAtstring

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

Was this page helpful?
order — Commercetools — Documentation