A lista de conjuntos foi recebida com sucesso.
API Shop Builder (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.
Transferir a descrição da OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/shop-builder/
https://store.xsolla.com/api/
Catálogo personalizado
Essa API permite especificar regras para atributos de usuário. Se o usuário atender a todas as condições para uma regra concreta, serão exibidos itens personalizados.
Para promoções personalizadas, consulte a seção Promotions.
Para passar atributos antes de uma compra, você pode usar a Xsolla Login API ou passá-los para a propriedade user.attributes ao gerar o token usando a Pay Station API.
Operações
Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/{project_id}/admin/items/bundle
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/bundle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/items/bundle?limit=50&offset=0'Resposta
application/json
{ "items": [ { … }, { … } ] }
Caminho
Corpoapplication/jsonobrigatórioID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
Objeto com dados de conjunto.
Lista de atributos.
Atenção. Não é possível especificar mais de 20 atributos para o item. Qualquer tentativa de exceder o limite resulta em um erro.
Tipo de pacote. Use standard para criar um pacote com itens e especificar os SKUs dos itens incluídos no pacote. Use partner_side_content para criar um pacote vazio e adicionar itens do seu lado usando um webhook. Esse tipo é usado somente para a personalização de catálogos no lado do parceiro.
Padrão "standard"
Enum"standard""partner_side_content"
Exemplo: "standard"
Exemplo: [{"quantity":1,"sku":"com.xsolla.kg_1"}]
Um objeto JSON que contém atributos e valores de item. Os atributos permitem que você adicione mais informações a itens como o nível necessário do jogador para usar o item. Os atributos enriquecem a lógica interna do seu jogo e são acessíveis através de métodos GET e webhooks dedicados.
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)obrigatório
Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.
One of:
Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.
Grupos aos quais o item pertence.
Observação: o valor da cadeia de caracteres refere-se ao grupo `external_id`.
Padrão []
Exemplo: ["honor"]
Se estiver desativado, o item não poderá ser encontrado nem comprado.
Padrão true
Exemplo: true
O item está disponível para compra.
Padrão false
Exemplo: true
long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)
Objeto com traduções para a descrição longa do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as variantes para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.
Any of:
Objeto com traduções para a descrição longa do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as variantes para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.
Ativos adicionais do conjunto.
Exemplo: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)obrigatório
Objeto com traduções para o nome do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de idioma de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.
One of:
Objeto com traduções para o nome do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de idioma de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.
ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.
Exemplo: "bundle_1"
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/{project_id}/admin/items/bundle
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/bundle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/items/bundle \
-H 'Content-Type: application/json' \
-d '{
"attributes": [
{
"external_id": "class",
"name": {
"en": "Class"
},
"values": [
{
"external_id": "soldier",
"value": {
"en": "Soldier"
}
},
{
"external_id": "officer",
"value": {
"en": "Officer"
}
}
]
}
],
"content": [
{
"quantity": 1,
"sku": "com.xsolla.iron_gloves_1"
},
{
"quantity": 1,
"sku": "com.xsolla.iron_boots_1"
},
{
"quantity": 1,
"sku": "com.xsolla.iron_shield_1"
},
{
"quantity": 1,
"sku": "com.xsolla.iron_armour_1"
},
{
"quantity": 1,
"sku": "com.xsolla.iron_helmet_1"
}
],
"custom_attributes": {
"purchased": 0,
"type": "lootbox"
},
"description": {
"de": "Brustpanzer für Soldaten",
"en": "Chest of armour for soldiers"
},
"groups": [
"chests"
],
"image_url": "https://picture.bundle-with-many-stuff.png",
"is_enabled": true,
"is_free": true,
"limits": {
"per_item": null,
"per_user": null
},
"long_description": {
"de": "Brustpanzer für Soldaten",
"en": "Chest of armour for soldiers"
},
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"name": {
"de": "Brustpanzer",
"en": "Chest of armour"
},
"order": 1,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [
{
"amount": "9.99",
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": "9.99",
"currency": "EUR",
"is_default": false,
"is_enabled": true
}
],
"sku": "com.xsolla.armour_chest_1",
"vc_prices": []
}'Resposta
application/json
{ "sku": "com.xsolla.kg_1" }
Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/items/bundle/group/external_id/{external_id}?limit=50&offset=0'Resposta
application/json
{ "items": [ { … }, { … } ] }