Delivery Emissions

Associate a late emissions estimate

Associates a valid temporary estimate with a confirmed contribution. Idempotency-Key is required. At most one valid association exists per confirmed contribution and per estimate.

The contribution must already be confirmed. Association failure is non-fatal: status stays confirmed and you must not restore points. After association, the immutable snapshot is the reporting record.

The confirmed contribution may be Loyalty Points or Direct Contribution. Association failure must not change that contribution to failed or authorize reversing customer value. When Delivery Emissions is disabled, this operation returns capability_disabled.

POST

impact-transactions

{transaction_id}

emissions-associations

cURL

curl -X POST "{baseUrl}/v1/impact-transactions/txn_01HZX6M4N5P6Q7R8S9T0U1V2/emissions-associations" \
  -H "X-API-Key: $AKHDAR_API_KEY" \
  -H "Idempotency-Key: idem_assoc_01HZX8A1B2C3D4E5F6G7H8" \
  -H "Content-Type: application/json" \
  -d '{"calculation_id":"calc_01HZX4K9M2Q8R7N6P5T4V3W2X1"}'

const response = await fetch(
  `${baseUrl}/v1/impact-transactions/txn_01HZX6M4N5P6Q7R8S9T0U1V2/emissions-associations`,
  {
    method: "POST",
    headers: {
      "X-API-Key": process.env.AKHDAR_API_KEY,
      "Idempotency-Key": "idem_assoc_01HZX8A1B2C3D4E5F6G7H8",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      calculation_id: "calc_01HZX4K9M2Q8R7N6P5T4V3W2X1"
    })
  }
);

import os
import requests

response = requests.post(
    f"{baseUrl}/v1/impact-transactions/txn_01HZX6M4N5P6Q7R8S9T0U1V2/emissions-associations",
    headers={
        "X-API-Key": os.environ["AKHDAR_API_KEY"],
        "Idempotency-Key": "idem_assoc_01HZX8A1B2C3D4E5F6G7H8",
        "Content-Type": "application/json",
    },
    json={"calculation_id": "calc_01HZX4K9M2Q8R7N6P5T4V3W2X1"},
)

{
  "association": {
    "status": "associated",
    "link": {
      "association_id": "link_01HZX7A1B2C3D4E5F6G7H8J9",
      "transaction_id": "txn_01HZX6M4N5P6Q7R8S9T0U1V2",
      "calculation_id": "calc_01HZX4K9M2Q8R7N6P5T4V3W2X1",
      "partner_order_ref": "ord_9f3c2a71",
      "estimated_emissions_kgco2e": "1.059902",
      "estimated_emissions_unit": "kgco2e",
      "distance_km": "7.400",
      "distance_unit": "km",
      "vehicle_category": "motorcycle_gasoline",
      "methodology_version": "DEM-WTW-v1.0.0",
      "emission_factor_version": "EF-DESNZ-2026-MOTORCYCLE-GASOLINE-AVG-WTW-v1.0.0",
      "calculated_at": "2026-08-03T12:00:00.000Z",
      "associated_at": "2026-08-03T12:00:00.000Z",
      "environment": "sandbox",
      "immutable": true
    }
  },
  "contribution_status": "confirmed",
  "request": {
    "correlation_id": "corr_7c2e9b1a4d6f8e0c",
    "idempotency_key": "idem_01HZX5Z9Y8X7W6V5U4T3S2R1"
  }
}

Authorizations

X-API-Key

string

header

required

Canonical server-to-server API key header name: X-API-Key. Partner customer applications must not use this credential. Examples must never include raw API secrets.

Headers

Idempotency-Key

string

required

Transport/request idempotency key required for delivery-emissions estimate creation, contribution confirmation, and emissions-association creation. Same key + same canonical payload returns the original result. Same key + conflicting canonical payload returns idempotency_conflict.

Non-PII transport idempotency key.

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Example:

"idem_01HZX5Z9Y8X7W6V5U4T3S2R1"

X-Correlation-ID

string

Optional request correlation header. If omitted, Akhdar generates one. Every success and error response includes X-Correlation-ID. Error payloads include correlation_id.

Non-PII request correlation identifier.

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Example:

"corr_7c2e9b1a4d6f8e0c"

Path Parameters

transaction_id

string

required

Akhdar-generated impact transaction identifier.

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Example:

"txn_01HZX6M4N5P6Q7R8S9T0U1V2"

Body

application/json

calculation_id

string

required

Akhdar-generated emissions estimate identifier.

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Example:

"calc_01HZX4K9M2Q8R7N6P5T4V3W2X1"

Response

Idempotent replay of the same association returned the original link.

association

object

required

Closed association outcomes. associated includes link. rejected includes rejection. not_requested includes neither.

Option 1
Option 2
Option 3

Show child attributes

contribution_status

enum<string>

required

Contribution status after the association attempt. Association failure must leave a confirmed contribution as confirmed.

Available options:

pending,

confirmed,

failed

Example:

"confirmed"

request

object

required

Show child attributes

cURL

curl -X POST "{baseUrl}/v1/impact-transactions/txn_01HZX6M4N5P6Q7R8S9T0U1V2/emissions-associations" \
  -H "X-API-Key: $AKHDAR_API_KEY" \
  -H "Idempotency-Key: idem_assoc_01HZX8A1B2C3D4E5F6G7H8" \
  -H "Content-Type: application/json" \
  -d '{"calculation_id":"calc_01HZX4K9M2Q8R7N6P5T4V3W2X1"}'

const response = await fetch(
  `${baseUrl}/v1/impact-transactions/txn_01HZX6M4N5P6Q7R8S9T0U1V2/emissions-associations`,
  {
    method: "POST",
    headers: {
      "X-API-Key": process.env.AKHDAR_API_KEY,
      "Idempotency-Key": "idem_assoc_01HZX8A1B2C3D4E5F6G7H8",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      calculation_id: "calc_01HZX4K9M2Q8R7N6P5T4V3W2X1"
    })
  }
);

import os
import requests

response = requests.post(
    f"{baseUrl}/v1/impact-transactions/txn_01HZX6M4N5P6Q7R8S9T0U1V2/emissions-associations",
    headers={
        "X-API-Key": os.environ["AKHDAR_API_KEY"],
        "Idempotency-Key": "idem_assoc_01HZX8A1B2C3D4E5F6G7H8",
        "Content-Type": "application/json",
    },
    json={"calculation_id": "calc_01HZX4K9M2Q8R7N6P5T4V3W2X1"},
)

{
  "association": {
    "status": "associated",
    "link": {
      "association_id": "link_01HZX7A1B2C3D4E5F6G7H8J9",
      "transaction_id": "txn_01HZX6M4N5P6Q7R8S9T0U1V2",
      "calculation_id": "calc_01HZX4K9M2Q8R7N6P5T4V3W2X1",
      "partner_order_ref": "ord_9f3c2a71",
      "estimated_emissions_kgco2e": "1.059902",
      "estimated_emissions_unit": "kgco2e",
      "distance_km": "7.400",
      "distance_unit": "km",
      "vehicle_category": "motorcycle_gasoline",
      "methodology_version": "DEM-WTW-v1.0.0",
      "emission_factor_version": "EF-DESNZ-2026-MOTORCYCLE-GASOLINE-AVG-WTW-v1.0.0",
      "calculated_at": "2026-08-03T12:00:00.000Z",
      "associated_at": "2026-08-03T12:00:00.000Z",
      "environment": "sandbox",
      "immutable": true
    }
  },
  "contribution_status": "confirmed",
  "request": {
    "correlation_id": "corr_7c2e9b1a4d6f8e0c",
    "idempotency_key": "idem_01HZX5Z9Y8X7W6V5U4T3S2R1"
  }
}

Overview

Contributions

Delivery Emissions

Webhooks

Associate a late emissions estimate

Authorizations

Headers

Path Parameters

Body

Response