salesOrderEmailThread

Requires permission sales:sales_order:read.

The email conversation for one order: every message sent and received.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query SalesOrderEmailThread($salesOrderId: ID!) {
  salesOrderEmailThread(salesOrderId: $salesOrderId) {
    id
    fromName
    toName
    status
    createdAt
    attachmentCount
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SalesOrderEmailThread($salesOrderId: ID!) {\n  salesOrderEmailThread(salesOrderId: $salesOrderId) {\n    id\n    fromName\n    toName\n    status\n    createdAt\n    attachmentCount\n  }\n}",
  "variables": {
    "salesOrderId": "id"
  }
}
EOF

Variables:

{
  "salesOrderId": "id"
}

Response:

{
  "data": {
    "salesOrderEmailThread": [
      {
        "id": "id",
        "fromName": "string",
        "toName": "string",
        "status": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "attachmentCount": 0
      }
    ]
  }
}

salesOrderEmailThread(
  salesOrderId: ID!
): [SalesOrderEmailActivity!]!

Arguments

salesOrderEmailThread.salesOrderId ● ID! non-null scalar

The ID of the sales order.

Type

SalesOrderEmailActivity object

One email sent or received about a sales order, with its delivery and engagement tracking.