---
title: "Retrieve an Order Report"
method: GET
path: "/reporting/orders/"
tags: ["Reports"]
---

# Retrieve an Order Report

`GET /reporting/orders/`

> 📘 Fully Hosted And Custom Integrations Only
>
> Order Reports are only relevant to Fully Hosted and Custom integrations. Only Fully Hosted and Custom integrations generate Forage `Orders`. Use any of the other `/reporting/` endpoints if you’re building with an SDK.

A `GET` request to `/reporting/orders/` retrieves an Order Report.

On success, the API returns a list of Forage `Orders` created during the provided reporting period.

## Query parameters

- `start_date` string, date, required
- `end_date` string, date, required
- `limit` integer
- `cursor` string
- `status` string

## Headers

- `Merchant-Account` string
- `API-Version` string

## Response `200`

__OK__ - Success

- OrderAndTaxesReportResponse
  - `next` string, nullable — A URL that you can send a `GET` to in order to retrieve the next set of results. Alternatively, you can retrieve the `cursor` value from the URL and pass it in the body of a new request. This value is `null` if there are no more results.
  - `previous` string, nullable — A URL that you can send a `GET` to in order to retrieve the previous set of results. Alternatively, you can retrieve the `cursor` value from the URL and pass it in the body of a new request. This value is `null` if the response includes the first set of results.
  - `results` object[] — An array of objects that detail information about each `Order` during the provided reporting period.
    - `ref` string — A unique reference hash for the Forage `Order` object.
    - `status` 'canceled' | 'draft' | 'failed' | 'processing' | 'succeeded' — The status of the order in the Forage lifecycle. One of: - `canceled` - `draft` - `failed` - `processing` - `succeeded`
    - `snap_eligible_total` string, decimal — The SNAP-only eligible portion of the order cost in USD.
    - `ebt_cash_eligible_total` string, decimal — The EBT Cash-only eligible portion of the order cost in USD.
    - `remaining_total` string, decimal — The portion of the `Order` total, in USD, that is neither SNAP eligible nor EBT Cash eligible. This amount must be charged to a credit or debit card.
    - `sales_tax_applied` string, decimal, nullable — The amount of sales tax that Forage added to the order total, calculated after the customer distributed tender across payment methods. This value is always `0` for Custom integrations. Forage only calculates taxes for Fully Hosted integrations. If the value is nonzero, then some of the `ebt_cash_paid` or `credit_debit_paid` amount covered taxes. Per FNS regulations, `snap_paid` is tax-exempt. The sum of (`snap_paid`, `ebt_cash_paid`, `credit_debit_paid`) should always equal the sum of (`sales_tax_applied`, `snap_eligible_total`, `remaining_total`). _The value of this field is `null` if the `status` of the `Order` is not `succeeded` or `failed`_.
    - `snap_paid` string, decimal, nullable — The portion of the order cost in USD that the customer paid for with SNAP benefits. _The value of this field is `null` if the `status` of the `Order` is not `succeeded` or `failed`_.
    - `ebt_cash_paid` string, decimal, nullable — The portion of the order cost in USD that the customer paid for with EBT Cash benefits. _The value of this field is `null` if the `status` of the `Order` is not `succeeded` or `failed`_.
    - `credit_debit_paid` string, decimal, nullable — The portion of the order cost in USD that the customer paid for with credit/debit card. _The value of this field is `null` if the `status` of the `Order` is not `succeeded` or `failed`_.
    - `merchant_fns_number` string — The FNS number of the merchant that created this order.
    - `created` string, date-time — A UTC timestamp of when the `Order` was created, represented as an [ISO 8601 date-time](https://www.iso.org/iso-8601-date-and-time-format.html) string.
    - `success_date` string, date-time — A UTC timestamp of when all `OrderPayments` associated with the `Order` were successfully processed, represented as an [ISO 8601 date-time](https://www.iso.org/iso-8601-date-and-time-format.html) string.
    - `payments` string[] — An array of the unique reference hashes for any Forage `OrderPayments` associated with the `Order`.
    - `refunds` string[] — An array of the unique reference hashes for any Forage `OrderRefunds` associated with the `Order`.
    - `psp_customer_id` string, nullable — The third-party credit/debit payment processor’s unique identifier for the customer. _The value of this field is null if the `Order` was created via a POST to `/capture_sessions/`_ **You must build with Forage Version `2023-05-15` or later to use `psp_customer_id`.** Either pass `2023-05-15` as the `API-Version` header on a per request basis, or set the version for all requests in the Forage dashboard.
    - `external_order_id` string — A unique identifier for the order as created by the merchant or platform (not Forage). When a merchant or platform passes this order ID to Forage, it persists in each Forage transaction related to the `Order`. This field enables merchants to map order IDs in their system to corresponding Forage `Order` IDs. **You must build with Forage Version `2023-05-15` or later to use `external_order_id`.** Either pass `2023-05-15` as the `API-Version` header on a per request basis, or set the version for all requests in the Forage dashboard.
    - `external_location_id` string — A unique identifier, provided by the merchant or platform (not Forage), that indicates the physical fulfillment location for the order. For example, this field could specify which location of a grocery store chain fulfilled an order.

## Other responses

- `400` — Bad Request
- `401` — __Unauthorized__
- `429` — __Too Many Requests__
- `500` — Internal Server Error

---

[API](https://skmtc.net/joinforage/apis/forage-payments-api.md) · [All operations](https://skmtc.net/joinforage/apis/forage-payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/joinforage/forage-payments-api/versions/4b7212706fae/schema)