SysRecordTransactionAdvanced

Records a manual transaction. Useful for stores that are not yet directly supported -- or for apps that doing purchases via other means - but still want to record them in brainCloud for reporting purposes.

tip

This is a variant of SysRecordTransaction that bundles the optional parameters (promotionId, sandbox, platform) - plus new campaignCode / scenarioCode options - into a single optionsJson object instead of passing them as individual arguments. campaignCode and scenarioCode must both be provided together to apply a LiveOps campaign/scenario to the transaction.

Service	Operation
appStore	SYS_RECORD_TRANSACTION_ADVANCED

Method Parameters

Parameter	Description
profileId	Profile ID of the user.
storeId	Identifies the store type. See the appendix for Store Ids. Use "_id" (prefix with an underscore) for custom ids.
itemId	Item ID of the product transaction to be recorded.
dataJson	Transaction details from the store's perspective.
receiptData	Receipt information.
processAwards	Whether to deliver rewards/items.
transactionId	Unique id identifying this transaction in the store. Uniqueness enforced across the app.
price	Price in hundredths of the app's currency (e.g. cents)
optionsJson	Optional JSON object bundling additional transaction options. Supported keys: promotionId (optional ID of any promotion that applies), sandbox (whether purchase is sandbox), platform (platform of the store, only used for sending offboard events to downstream systems - can be empty string or use value from platform ids here), campaignCode and scenarioCode (both required together to apply a LiveOps campaign/scenario to this transaction).

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Obj-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Roblox

// N/A

GDScript

N/A

Cloud Code

var profileId = "user_profile_id";
var storeId = "store_id";
var itemId = "product_item_id";
var dataJson = {'quantity': 1};
var receiptData = {'receipt': 'receipt_String'};
var processAwards = true;
var transactionId = "transaction_id";
var priceInCents = 999;
var optionsJson = {
    "promotionId": 5,
    "sandbox": false,
    "platform": "IOS",
    "campaignCode": "summer_sale",
    "scenarioCode": "launch_promo"
};

var appStoreProxy = bridge.getAppStoreServiceProxy();

var postResult = appStoreProxy.sysRecordTransactionAdvanced(profileId, storeId, itemId, dataJson, receiptData, processAwards, transactionId, priceInCents, optionsJson);

Raw

{
    "service":"appStore",
    "operation":"SYS_RECORD_TRANSACTION_ADVANCED",
    "data":{
        "profileId": "user_profile_id",
        "storeId": "store_id",
        "itemId": "product_item_id",
        "dataJson" : {
            "quantity": 1
        },
        "receiptData" : {
            "receipt": "receipt_String"
        },
        "processAwards" : true,
        "transactionId" : "transaction_id",
        "price" : 999,
        "optionsJson" : {
            "promotionId": 5,
            "sandbox": false,
            "platform": "IOS",
            "campaignCode": "summer_sale",
            "scenarioCode": "launch_promo"
        }
    }
}

JSON Response

{
    "data": {
        "userItemRewards": {
            "sword001": {
                "fac9e483-c958-46b9-a478-06c97a85e74a": {
                    "itemId": "fac9e483-c958-46b9-a478-06c97a85e74a",
                    "quantity": 1
                }
            }
        },
        "extra": {
            "customAttr": "value"
        },
        "rewards": {
            "extra": {
                "customAttr": "value"
            },
            "currency": {
                "bar": 10
            },
            "items": {
                "sword001": {
                    "defId": "sword001",
                    "quantity": 1
                }
            }
        },
        "currencies": {
            "currency": {
                "bar": {
                    "consumed": 0,
                    "balance": 30,
                    "purchased": 10,
                    "awarded": 20,
                    "revoked": 0
                },
                "coins": {
                    "consumed": 0,
                    "balance": 24,
                    "purchased": 0,
                    "awarded": 24,
                    "revoked": 0
                }
            }
        }
    },
    "status": 200
}