Skip to main content

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 type

type Order {
  id: ID!
  externalId: String
  customerId: ID!
  customer: Customer!
  items: [OrderItem!]!
  totalCarbonFootprint: Float!
  offsetStatus: OffsetStatus!
  shippingMethod: TransportMethod
  shippingAddress: Address
  impactSummary: OrderImpactSummary!
  equivalency: Equivalency
  createdAt: DateTime!
  updatedAt: DateTime!
}

type OrderItem {
  productId: ID!
  product: Product!
  quantity: Int!
  carbonFootprint: Float!
}

type OrderImpactSummary {
  totalCo2Equivalent: Float!
  totalMkiScore: Float
  shippingImpact: Float!
  productionImpact: Float!
  breakdown: [ImpactBreakdown!]!
}

type Address {
  country: String!
  postalCode: String
  city: String
}

enum OffsetStatus {
  NOT_OFFSET
  PARTIALLY_OFFSET
  FULLY_OFFSET
}

enum TransportMethod {
  TRUCK
  RAIL
  SHIP
  AIR
  ELECTRIC_TRUCK
  BICYCLE
  STANDARD
  EXPRESS
}

​
Fields

FieldTypeDescription
idID!Unique order identifier
externalIdStringYour system’s order ID (e.g., Shopify order ID)
customerIdID!Customer who placed the order
items[OrderItem!]!Line items with per-product carbon data
totalCarbonFootprintFloat!Total order carbon footprint in kg CO2e
offsetStatusOffsetStatus!Whether emissions have been offset
shippingMethodTransportMethodDelivery transport method
impactSummaryOrderImpactSummary!Aggregated impact data
equivalencyEquivalencyHuman-readable impact comparison

​
Example query

query {
  order(id: "order_xyz789") {
    id
    externalId
    totalCarbonFootprint
    offsetStatus
    items {
      product { id name }
      quantity
      carbonFootprint
    }
    impactSummary {
      totalCo2Equivalent
      shippingImpact
      productionImpact
    }
    equivalency {
      description
      value
    }
  }
}