orderEdits

Query staged order edits with a `where` predicate and paging.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the orderEdits action (under Order).
Fill in the fields below, then reference the result from later steps as {{orderedits.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 OrderEdits($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  orderEdits(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      key
      resourceRef {
        typeId
        id
      }
      resource {
        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
        completedAt
        orderNumber
        orderState
        stateRef
        state
        shipmentState
        paymentState
        syncInfo
        returnInfo
        purchaseOrderNumber
        lastMessageSequenceNumber
        cartRef
        cart
        quoteRef
        quote
        recurringOrderRef
        recurringOrder
        custom
        id
        version
        createdAt
        lastModifiedAt
        createdBy
        lastModifiedBy
      }
      stagedActions {
        type
      }
      result {
        type
      }
      comment
      custom {
        typeRef
        type
      }
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
  }
}

Variables

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

wherestring

sortarray<string>

limitnumber

offsetnumber

json

{
  "where": "string",
  "sort": [
    "string"
  ],
  "limit": 0,
  "offset": 0
}

Response

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

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

keyobject

resourceRefobject

resourceobject

stagedActionsobject

resultobject

commentobject

customobject

idobject

versionobject

createdAtobject

lastModifiedAtobject

createdByobject

lastModifiedByobject

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

Was this page helpful?