Skip to main content
POST
Get an Orders Report
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.

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.

Available options:
created,
payment_pending,
payment_expired,
payment_failed,
payment_refund_pending,
payment_refund_requires_action,
payment_refunded,
payment_refund_failed,
payment_refund_canceled,
payment_canceled,
charge_pending,
charge_succeed,
charge_failed,
payment_dispute_open,
payment_dispute_lost,
payment_dispute_won,
payment_dispute_evidence_submitted,
payment_dispute_inquiry_open,
payment_dispute_inquiry_evidence_submitted,
payment_dispute_inquiry_won
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