---
updatedAt: 2025-04-24T20:27:54.000Z
agentTools:
  projectIndex: https://api-docs.shippedsuite.com/llms.txt
---

# /v1/orders/{external_order_id}/carbon_credits

Returns a list of all the Carbon Credits for an Order

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Shipped Suite API",
    "description": "API provides access to Shipped Suite functions",
    "contact": {
      "name": "Steven Ou",
      "email": "steven@invisiblecommerce.com"
    },
    "version": "v1"
  },
  "servers": [
    {
      "url": "//api.shippedsuite.com/"
    }
  ],
  "security": [
    {
      "secretKey": []
    }
  ],
  "tags": [
    {
      "name": "Carbon Credits",
      "description": "Operations about Carbon Credits"
    }
  ],
  "paths": {
    "/v1/orders/{external_order_id}/carbon_credits": {
      "get": {
        "tags": [
          "Carbon Credits"
        ],
        "description": "Returns a list of all the Carbon Credits for an Order",
        "operationId": "getV1OrdersExternalOrderIdCarbonCredits",
        "parameters": [
          {
            "name": "external_order_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page offset to fetch.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "per_page",
            "in": "query",
            "description": "Number of results to return per page.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 20
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Pad a number of results.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a list of all the Carbon Credits for an Order",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CarbonCredit"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Shipment": {
        "required": [
          "external_id",
          "shipment_items",
          "tracking_number"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of Shipment in partner platform",
            "example": "9477990309572"
          },
          "tracking_number": {
            "type": "string",
            "description": "Tracking number associated with the Shipment",
            "example": "1Z71E8390396779841"
          },
          "shipment_items": {
            "type": "array",
            "description": "Collection of ShipmentItems belonging to the Shipment",
            "items": {
              "$ref": "#/components/schemas/ShipmentItem"
            }
          }
        },
        "description": "Shipment model"
      },
      "ShipmentItem": {
        "required": [
          "external_id",
          "external_order_item_id",
          "quantity"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of ShipmentItem in partner platform",
            "example": "769209090444"
          },
          "external_order_item_id": {
            "type": "string",
            "description": "Unique ID of ShipmentItem's OrderItem in partner platform",
            "example": "10312518631616"
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of OrderItem in ShipmentItem",
            "format": "int32",
            "example": 1
          }
        }
      },
      "CarbonCredit": {
        "required": [
          "created_at",
          "id",
          "shipment"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique carbon credit ID"
          },
          "carbon_project": {
            "type": "object",
            "description": "Details about the Carbon Project in which the Carbon Credit was purchased",
            "allOf": [
              {
                "$ref": "#/components/schemas/CarbonProject"
              }
            ]
          },
          "status": {
            "type": "number",
            "description": "Current state of the Carbon Credit order"
          },
          "grams": {
            "type": "number",
            "description": "Number of grams of CO2 offset by Carbon Credit",
            "example": 456
          },
          "url": {
            "type": "string",
            "description": "Link to the receipt for the Carbon Credit",
            "example": "https://registry.patch.io/orders/ord_test_0eae4faf8ec48f01821a000d0d47d6b4"
          },
          "shipment": {
            "type": "object",
            "description": "Shipment the Carbon Credit was purchased for",
            "allOf": [
              {
                "$ref": "#/components/schemas/Shipment"
              }
            ]
          },
          "created_at": {
            "type": "string",
            "description": "The date and time the Carbon Credit order was initiated. RFC 3339. ",
            "format": "date-time"
          }
        },
        "description": "CarbonCredit model"
      },
      "CarbonProject": {
        "required": [
          "id",
          "name"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "ID for the CarbonProject",
            "example": 12
          },
          "name": {
            "type": "string",
            "description": "Name of the CarbonProject",
            "example": "China Hebei Province Wind Farm - Demo"
          },
          "tagline": {
            "type": "string",
            "description": "Tagline of the CarbonProject",
            "example": "Generating wind energy in Hebei Province and displacing fossil-fuel generated energy, improving local air quality."
          },
          "description": {
            "type": "string",
            "description": "Description of the CarbonProject",
            "example": "Hebei Kangbao Sanxiatian Wind Farm Project is located in Zhangjiakou City, Hebei Province, P.R.China. The wind farm contains 33 sets of turbines with a total installed capacity of 49.5 MW. Electricity generated by the project is delivered to the North China Power Grid (NCPG) and displaces power that would have been supplied by fossil-fuel fired power plants, thereby avoiding greenhouse gas emissions and other air pollutants, including SO2, NOx, and PM. The project is well-regarded by the local community and received strong stakeholder support during the construction phase in 2008. Operation of the wind farm commenced in 2009, and the project continues to improve air quality and boost tax revenues for the regional government."
          },
          "technology": {
            "type": "string",
            "description": "The type of technology of the CarbonProject",
            "example": "Wind"
          },
          "classification": {
            "type": "string",
            "description": "The classification of the CarbonProject strategy",
            "example": "avoidance"
          },
          "images": {
            "type": "array",
            "description": "An array of images for the CarbonProject",
            "example": [
              "https://cdn.patch.io/rails/active_storage/blobs/proxy/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBcUVEIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--31c7e8944317bd244de66d3c070a44e804b8cd8e/Hebei%20Kangbao%20Sanxiatian%20Wind%20Farm%20Project_1.jpeg"
            ],
            "items": {
              "type": "string"
            }
          },
          "state": {
            "type": "string",
            "description": "The state/region/province CarbonProject is located in",
            "example": "HE"
          },
          "country": {
            "type": "string",
            "description": "The country CarbonProject is located in",
            "example": "CN"
          }
        }
      }
    },
    "securitySchemes": {
      "secretKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "x-original-swagger-version": "2.0"
}
```