Conceder itens por compras aos usuários

Digital Distribution Hub API

In-Game Store & Buy Button API

Visão geral

Baixar definição de API

ATRIBUTOS DO USUÁRIO

Admin

Catálogo Personalizado

PACOTES

Admin

Catálogo

CARRINHO E PAGAMENTO

Carrinho (lado do cliente)

Carrinho (lado do servidor)

Pagamento (lado do cliente)

Pagamento (lado do servidor)

Pedido

Itens gratuitos

COMUM

Webhooks

Reservas

Comerciante

Catálogo

Regiões comuns

CHAVES DO JOGO

Catálogo

Direito

Admin

INVENTÁRIO DE JOGADORES

Cliente

Gestão

post

Conceder itens por compras aos usuários

post

Revogar itens de inventário

post

Conceder itens aos usuários

post

Definir itens para usuários

Inventário multiplataforma

PROMOÇÕES

Comum

Cupons

Códigos Promocionais

Ofertas de catálogo exclusivas

Descontos

Bônus

ITENS VIRTUAIS & MOEDA

Admin

Catálogo

Pagamento Virtual

ITENS NFT

Admin

Catálogo

LIMITES

Gestão

REWARD CHAINS & VALUE POINTS

Admin

Cliente

Pay Station API

Publisher Account API

Subscriptions API

Webhooks

Conceder itens por compras aos usuários

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

Adiciona os itens especificados por compra aos inventários de usuários especificados.

Atenção

Apenas 50 operações podem ser processadas de uma só vez. As operações que excederem esse limite serão ignoradas.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Default: 44056

ID do projeto.

Request Body schema: application/json

Array

required

object

id	string Default: "d342dad2-9d59-11e9-a384-42010aa8003f" O identificador de usuário exclusivo na plataforma.

required

Array of objects non-empty

Array (non-empty)

sku required	string Default: "booster_mega_1" Identificador de classe de item. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.
quantity required	number Default: 1 Número de itens dessa classe que precisava ser concedido.

required

object

amount required	string Default: "2.99" Valor da compra antes de qualquer dedução.
currency required	string Default: "USD" Moeda de compra no padrão ISO 4217.
external_purchase_id required	string Default: "10-534-35" Identificador de fatura de compra da plataforma em que uma compra foi feita.
external_purchase_date required	string Default: "2020-01-01T05:00:00+05:00" Data de compra no padrão ISO 8601.

comment

string [ 1 .. 255 ] characters

Default: "Monthly challenge rewards"

Descrição da operação. Por exemplo: "Recompensas mensais por desafio".

object [ 1 .. 200 ] properties

Parâmetros específicos do projeto.

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

platform

string

Default: "xsolla"

Plataforma de publicação em que o usuário joga.

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"

Responses

200

Compra bem-sucedida do usuário.

422

Unprocessable Entity.

Request samples

application/json

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

Response samples

application/json

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