Admin Endpoints

This document describes the administrative endpoints for managing orders and in-app purchases.

Get IAP Notifications

Endpoint

• Method: GET
• URL: /api/iap/notifications

Description

Retrieves a list of IAP notifications and transactions.

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer YOUR_API_TOKEN	Yes

Query Parameters

Parameter	Type	Required	Description
start_date	string	No	Start date for fetching notifications (format: YYYY-MM-DD)
end_date	string	No	End date for fetching notifications (format: YYYY-MM-DD)
notification_type	string	No	Filter by notification type
pagination_token	string	No	Token for fetching next page of results
order_ids	array	No	Filter by specific order IDs
get_all	boolean	No	Whether to fetch all results (default: false)
sandbox	boolean	No	Whether to use sandbox environment (default: false)
transaction_id	string	No	Filter by specific transaction ID

Response Format

{
    "success": true,
    "message": "",
    "data": {
        "has_more": false,
        "pagination_token": "string",
        "transaction_count": 0,
        "users_count": 0,
        "orders_count": 0,
        "order_ids": ["string"],
        "user_ids": [0],
        "transactions_ids": ["string"],
        "transactions": [
            {
                "transactionId": "string",
                "originalTransactionId": "string",
                "webOrderLineItemId": "string",
                "bundleId": "string",
                "productId": "string",
                "subscriptionGroupIdentifier": "string",
                "purchaseDate": "string",
                "originalPurchaseDate": 0,
                "expiresDate": "string",
                "quantity": 0,
                "type": "string",
                "appAccountToken": "string",
                "inAppOwnershipType": "string",
                "signedDate": 0,
                "environment": "string",
                "transactionReason": "string",
                "storefront": "string",
                "storefrontId": "string",
                "price": 0,
                "currency": "string",
                "notificationType": "string",
                "subtype": "string"
            }
        ]
    }
}

Response Fields

• has_more: Whether there are more transactions to fetch
• pagination_token: Token for fetching next page of results
• transaction_count: Total number of transactions
• users_count: Number of unique users
• orders_count: Number of orders
• order_ids: List of order IDs
• user_ids: List of user IDs
• transactions_ids: List of transaction IDs
• transactions: Array of transaction objects containing:
  • Transaction details (ID, original ID, etc.)
  • Product information (bundle ID, product ID)
  • Purchase information (dates, price, currency)
  • Subscription details (type, status, environment)
  • Notification information (type, subtype)

Implementation Notes

• Retrieves notifications from App Store Server
• Supports pagination for large result sets
• Includes detailed transaction history
• Provides aggregated counts and IDs

Get IAP Order

Endpoint

• Method: POST
• URL: /api/iap/get-order

Description

Retrieves detailed information about a specific IAP order.

Request Parameters

{
    "order_id": "string"
}

Response Format

{
    "success": true,
    "message": "",
    "data": {
        "transactionId": "string",
        "originalTransactionId": "string",
        "webOrderLineItemId": "string",
        "bundleId": "string",
        "productId": "string",
        "subscriptionGroupIdentifier": "string",
        "purchaseDate": "string",
        "originalPurchaseDate": 0,
        "expiresDate": "string",
        "quantity": 0,
        "type": "string",
        "appAccountToken": "string",
        "inAppOwnershipType": "string",
        "signedDate": 0,
        "environment": "string",
        "transactionReason": "string",
        "storefront": "string",
        "storefrontId": "string",
        "price": 0,
        "currency": "string"
    }
}

Error Handling

• Invalid Order ID: Returns 422
• Order Not Found: Returns 404
• Server Errors: Returns 500