---
title: "One offset order"
method: GET
path: "/v1/orders/{order_ref}"
tags: ["Store"]
---

# One offset order

`GET /v1/orders/{order_ref}`

## Request

- Base URL: `https://carbonguru.io`
- URL: `https://carbonguru.io/v1/orders/{order_ref}`
- Auth: HTTP bearer

By the reference the merchant reported the order under. An order this merchant never reported and an order belonging to someone else are the same 404. A test key finds the orders a test key posted and no other; a live key finds no order a test key posted.

## Path parameters

- `order_ref` string, required

## Response `200`

The offset order.

- object
  - `order` Order, required: One offset order the merchant reported. Our own WooCommerce order id is not part of the resource: the merchant's order_ref is the reference on every surface.
    - `order_ref` string: The order's id in the merchant's own system, as it was reported.
    - `status` string: preview, pending, offset or failed.
    - `offer_type` string: offset or removal.
    - `carbon_kg` union: The kilograms matched for this order: each product's footprint times its quantity.
      - number
      - string
    - `receipt_url` string, nullable: The CarbonGuru-hosted proof page for this order.
    - `created_at` string, nullable

## Other responses

- `401`: No valid credential. Every authentication failure returns this one document.
- `402`: The account's plan does not include this capability. Carries min_tier and upgrade_url.
- `403`: A missing scope, an exhausted analysis allowance, or an object that is not the caller's.
- `404`: No such resource.

---

[API](https://skmtc.dev/carbonguru/apis/carbonguru-api.md) · [All operations](https://skmtc.dev/carbonguru/apis/carbonguru-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonguru/apis/carbonguru-api/revisions/26dcbe7a8500?raw)