Skip to main content

order

Retrieve a single order by ID.
query {
  order(id: "order_xyz789") {
    id
    externalId
    totalCarbonFootprint
    offsetStatus
    items {
      product { id name }
      quantity
      carbonFootprint
    }
    impactSummary {
      totalCo2Equivalent
      shippingImpact
      productionImpact
      breakdown {
        phase
        contribution
        percentage
      }
    }
    equivalency {
      description
      value
    }
  }
}
Arguments:
ArgumentTypeRequiredDescription
idID!YesOrder identifier

orders

List orders with filtering.
query {
  orders(
    first: 50
    filter: {
      dateRange: { from: "2025-01-01", to: "2025-12-31" }
      offsetStatus: NOT_OFFSET
    }
    sort: { field: CREATED_AT, direction: DESC }
  ) {
    totalCount
    edges {
      node {
        id
        externalId
        totalCarbonFootprint
        offsetStatus
        createdAt
      }
      cursor
    }
    pageInfo {
      hasNextPage
      endCursor
    }
    aggregation {
      totalCo2Equivalent
      averageCo2PerOrder
      orderCount
    }
  }
}
Arguments:
ArgumentTypeRequiredDescription
firstIntNoResults to return (default: 20, max: 100)
afterStringNoCursor for pagination
filterOrderFilterNoFilter criteria
sortOrderSortNoSort order

OrderFilter

FieldTypeDescription
dateRangeDateRangeInputFilter by creation date
offsetStatusOffsetStatusFilter by offset status
externalIdStringFilter by external order ID
customerIdIDFilter by customer