Grant items by purchases to users

post/v2/project/{project_id}/inventory/purchase

Adds the specified items by purchase to the specified user inventories.

Attention

Only 50 operations can be processed at once. Operations that exceed this limit will be ignored.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Default: 44056

Project ID.

Request Body schema: application/json

Array

required

object

id	string Default: "d342dad2-9d59-11e9-a384-42010aa8003f" The unique user identifier on the platform.

required

Array of objects non-empty

Array (non-empty)

sku required	string Default: "booster_mega_1" Item class identifier. The SKU may only contain lowercase Latin alphanumeric characters, periods, dashes, and underscores.
quantity required	number Default: 1 Number of items of this class needed to be granted.

required

object

amount required	string Default: "2.99" Purchase amount prior to any deductions.
currency required	string Default: "USD" Purchase currency in ISO 4217.
external_purchase_id required	string Default: "10-534-35" Purchase invoice identifier from the platform a purchase was made on.
external_purchase_date required	string Default: "2020-01-01T05:00:00+05:00" Purchase date in ISO 8601.

comment

string [ 1 .. 255 ] characters

Default: "Monthly challenge rewards"

Operation description. For example: "Monthly challenge rewards".

platform

string

Default: "xsolla"

Publishing platform the user plays on.

Enum: "playstation_network" "xbox_live" "xsolla" "pc_standalone" "nintendo_shop" "google_play" "app_store_ios" "android_standalone" "ios_standalone" "android_other" "ios_other" "pc_other"

object [ 1 .. 200 ] properties

Project specific parameters.

additional property	Array of arrays or object or string or integer or null or number or boolean
One of: arrays

Responses

200

Successful user purchase.

422

Unprocessable Entity.

Request samples

application/json

[{"purchase": {"amount": "3.5",
"currency": "USD",
"external_purchase_id": "1000000",
"external_purchase_date": "2020-01-01T00:00:00+05:00",
"user": {"id": "672c91cd-65db-4b6e-ad68-6e93b21249d8"
},
"comment": "xsolla",
"platform": "xsolla",
"items": [{"sku": "panda_sdk",
"quantity": 5
},
{"sku": "panda_sdk2",
"quantity": 3
}
],
"custom_parameters": [{"user_public_id": {"nickname": "player1"
},
"user_device_info": {"engine_version": "Unity 2020.2.0b5",
"os": "windows"
}
},
{"purchase": {"amount": "3.5",
"currency": "USD",
"external_purchase_id": "1000001",
"external_purchase_date": "2020-01-01T00:00:00+05:00"
},
"user": {"id": "83857636-65b4-11e8-9ccb-42010a8a001c"
},
"comment": "xsolla",
"platform": "xsolla",
"items": [{"sku": "panda_sdk3",
"quantity": 5
},
{"sku": "panda_sdk2",
"quantity": 3
}
],
"custom_parameters": {"content_creator_rewards": [{"content_creator": {"id": "cc1"
},
"reward": {"amount": "10.00",
"currency": "USD"
}
},
{"content_creator": {"id": "cc2"
},
"reward": {"amount": "15.00",
"currency": "RUB"
}
}
]
}
}
]
}
}
]

Response samples

application/json

{"count": 2,
"operations": [{"user_id": "0125760a-6810-11e9-84c0-42010aa80029",
"order_id": 123456,
"platform": "xbox_live",
"comment": "Quest completed",
"external_purchase_id": "10-534-35",
"external_purchase_date": "2020-01-01T05:00:00+05:00",
"amount": "2.99",
"currency": "USD",
"items": [{"sku": "boots_1",
"quantity": 5
},
{"sku": "crystal_pack_1",
"quantity": 3
}
],
"custom_parameters": {"array_param": [{"user_public_id": {"nickname": "player1"
},
"user_device_info": {"engine_version": "Unity 2020.2.0b5",
"os": "windows"
}
},
{"user_public_id": {"nickname": "player2"
},
"user_device_info": {"engine_version": "UE 4.25",
"os": "mac"
}
}
]
}
},
{"user_id": "a7d10a4e-3f68-43cc-a6b2-893d2c68fd14",
"order_id": 123457,
"platform": "xbox_live",
"comment": "Daily reward",
"external_purchase_id": "10-534-35",
"external_purchase_date": "2020-01-01T05:00:00+05:00",
"amount": "2.99",
"currency": "USD",
"items": [{"sku": "helmet_1",
"quantity": 2
},
{"sku": "minigun_1",
"quantity": 3
}
],
"custom_parameters": null
}
]
}