Skip to main content
POST
/
reporting
/
reports
/
orders
Get an Orders Report
curl --request POST \
  --url https://api-sandbox.appcharge.com/reporting/reports/orders \
  --header 'Content-Type: application/json' \
  --header 'x-publisher-token: <x-publisher-token>' \
  --data '{
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "recordLimit": 123,
  "offset": 123,
  "statuses": [
    "created"
  ],
  "isFree": false
}'
{
  "totalCount": 123,
  "results": [
    {
      "acOrderId": "<string>",
      "publisherId": "<string>",
      "currency": "<string>",
      "currencyExchangeCost": 123,
      "priceInCents": 123,
      "priceInDollar": 123,
      "priceNetInDollar": 123,
      "subTotal": 123,
      "originalPriceInDollar": 123,
      "currencySymbol": "<string>",
      "acOfferId": "<string>",
      "publisherOfferId": "<string>",
      "offerName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "playerId": "<string>",
      "state": "<string>",
      "reason": "<string>",
      "offerDetails": {
        "products": [
          {
            "name": "<string>",
            "publisherProductId": "<string>",
            "amount": 123,
            "price": 123,
            "currencyCode": "<string>",
            "description": "<string>",
            "sku": "<string>",
            "type": "<string>",
            "sessionMetadata": "<string>"
          }
        ],
        "playerGeo": {}
      },
      "tax": 123,
      "taxInDollar": 123,
      "paymentMethod": "<string>",
      "zipCode": "<string>",
      "playerEmail": "<string>",
      "estimatedPublisherNetAmount": 123,
      "estimatedAppchargeFee": 123,
      "receiptId": "<string>",
      "discount": 123,
      "discountRatePoints": 123,
      "promoCodeName": "<string>",
      "pricePointMetaData": 123
    }
  ]
}
When a player makes a purchase, Appcharge processes the transaction. After the player is charged, Appcharge sends an update to the publisher with all the transaction details using a predefined webhook.

​
Statuses Parameter Options

This table lists the possible values for the statuses parameter, each representing a different stage or outcome of a transaction. The values range from the initial creation of a transaction to the various stages of payment, refund, charge, and dispute processes.
StatusDescription
createdThe order has been created.
payment_pendingThe transaction has been initiated, but payment information has not yet been submitted.
payment_expiredThe checkout session has expired after being open for 1 hour.
payment_failedFailed to initiate a payment, and the award was not granted.
payment_refund_pendingRefund has been requested and is awaiting processing.
payment_refund_requires_actionAdditional action is needed to process the refund.
payment_refundedRefund has been successfully processed.
payment_refund_failedRefund attempt was unsuccessful.
payment_refund_canceledRefund process has been canceled.
payment_canceledPayment has been canceled.
charge_pendingThe award is being processed but is not yet completed.
charge_succeedPayment was successful, and the award was granted.
charge_failedThe award attempt was unsuccessful.
payment_dispute_openA dispute has been opened against the payment.
payment_dispute_lostThe dispute has been resolved in favor of the customer.
payment_dispute_wonThe dispute has been resolved in favor of the merchant.
payment_dispute_evidence_submittedEvidence has been submitted for the dispute.
payment_dispute_inquiry_openAn inquiry has been opened regarding a potential dispute.
payment_dispute_inquiry_evidence_submittedEvidence has been submitted for the dispute inquiry.
payment_dispute_inquiry_wonThe inquiry has been resolved in favor of the merchant.

Headers

​
x-publisher-token
string
required

The publisher token.

Body

application/json
​
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
enum<string>[]
required

List of order statuses to filter by. Pass an empty list to retrieve reports for all statuses.

​
isFree
boolean
default:false

Query paid or free orders (false - query paid orders, true - query free orders).

Response

Get an Orders Report

​
totalCount
integer
required

The total count of orders that were returned.

​
results
object[]
required
⌘I