---
title: "Get an Orders Report"
method: POST
path: "/reporting/reports/orders"
---

# Get an Orders Report

`POST /reporting/reports/orders`

## Headers

- `x-publisher-token` string, required

## Request body

- object
  - `startDate` string, date-time, required — The start date of the query in UTC ISO 8601 time format.
  - `endDate` string, date-time, required — The end date of the query in UTC ISO 8601 time format.
  - `recordLimit` integer, required — The returned records limit to be used in pagination.
  - `offset` integer, required — The bulk offset to be used in pagination.
  - `statuses` string[], required — List of order statuses to filter by. Pass an empty list to retrieve reports for all statuses.
  - `isFree` boolean — Query paid or free orders (false - query paid orders, true - query free orders).

## Response `200`

Get an Orders Report

- object
  - `totalCount` integer, required — The total count of orders that were returned.
  - `results` object[], required
    - `acOrderId` string, required — AppCharge order Id.
    - `publisherId` string, required — The publisher Id.
    - `currency` string, required — The ISO 4217 currency code that the player paid with.
    - `currencyExchangeCost` number, required — The cost of the currency exchange, sent only if the local currency requires a conversion to USD.
    - `priceInCents` number, required — The player paid price amount in cents of the local currency.
    - `priceInDollar` number, required — The paid price without taxes converted in real-time to USD dollars cents.
    - `priceNetInDollar` number, required — Price in dollar with no tax.
    - `subTotal` number, required — The price paid by the player in their local currency without taxes.
    - `originalPriceInDollar` number, required — The base price of the offer.
    - `currencySymbol` string
    - `acOfferId` string, required — AppCharge offer Id.
    - `publisherOfferId` string, required — The publisher offer Id as was reported to AppCharge.
    - `offerName` string, required — The name of the offer.
    - `createdAt` string, date-time, required — The time when the order was created, in UTC.
    - `playerId` string, required — The ID of the player that placed the order.
    - `state` string, required — The status of the order.
    - `reason` string — The reason in case of a failure.
    - `offerDetails` object, required
      - `products` object[], required
        - `name` string, required — The name of the product.
        - `publisherProductId` string, required — The Id that the publisher assigned to the product.
        - `amount` number, required — The quantity of the product.
        - `price` number, required — The price point (in USD) of the offer.
        - `currencyCode` string
        - `description` string
        - `sku` string — The SKU identifier for the product.
        - `type` string — The type of the offer (e.g., 'offer').
        - `sessionMetadata` string — Metadata related to the session.
      - `playerGeo` object — The geographical details of the player.
    - `tax` number, required — The player paid tax amount in cents of the local currency.
    - `taxInDollar` number, required — The player paid tax amount in cents in USD.
    - `paymentMethod` string, required — The payment method used by the player.
    - `zipCode` string, required — The player's postal code.
    - `playerEmail` string, required — The player's email address.
    - `estimatedPublisherNetAmount` number, required — The estimated amount the publisher receives after all deductions.
    - `estimatedAppchargeFee` number, required — The estimated Appcharge fee for the transaction.
    - `receiptId` string, required — The receipt identifier for the order.
    - `discount` number — The discount amount in the currency the order was placed in.
    - `discountRatePoints` number — The rate of the discount as a percentage.
    - `promoCodeName` string — The name of the promo code being applied
    - `pricePointMetaData` integer — The base price of the price point in USD cents.

## Other responses

- `400` — Wrong payload - bad request

---

[API](https://skmtc.net/appcharge/apis/grant-award.md) · [All operations](https://skmtc.net/appcharge/apis/grant-award/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/appcharge/grant-award/versions/b4f6759240d5/schema)