Documentation Index
Fetch the complete documentation index at: https://docs.heychocolate.com/llms.txt
Use this file to discover all available pages before exploring further.
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:
| Argument | Type | Required | Description |
|---|
id | ID! | Yes | Order 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:
| Argument | Type | Required | Description |
|---|
first | Int | No | Results to return (default: 20, max: 100) |
after | String | No | Cursor for pagination |
filter | OrderFilter | No | Filter criteria |
sort | OrderSort | No | Sort order |
OrderFilter
| Field | Type | Description |
|---|
dateRange | DateRangeInput | Filter by creation date |
offsetStatus | OffsetStatus | Filter by offset status |
externalId | String | Filter by external order ID |
customerId | ID | Filter by customer |