Saltar al contenido
/
Obtener artículo vendible...

Shop Builder API (2.0.0)

Overview

  • 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.

Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/shop-builder/
https://store.xsolla.com/api/

Admin

Operaciones

Catálogo personalizado

Esta API permite especificar reglas para los atributos de usuario. Si el usuario cumple todas las condiciones de una regla específica, se mostrarán los elementos personalizados.

Para promociones personalizadas, consulte la sección Promotions.

Para transmitir atributos antes de una compra, puede utilizar Xsolla Login API o transmitirlos a la propiedad user.attributes mientras se genera el token utilizando Pay Station API.

Operaciones

Admin

Operaciones

Catálogo

Operaciones

Cesta (cliente)

Operaciones

Cesta (lado del servidor)

Operaciones

Pago (lado del cliente)

Operaciones

Pago (lado del servidor)

Operaciones

Pedido

Operaciones

Artículos gratuitos

Operaciones

Webhooks

Operaciones

Pedidos anticipados

Operaciones

Comerciante

Operaciones

Catálogo

Esta API permite obtener cualquier tipo de artículo vendible o artículo específico.

Operaciones

Obtener artículo vendible por IDClient-side

Solicitud

Obtiene un artículo vendible por su ID.

Nota

Este punto final, accesible sin autorización, devuelve datos genéricos. No obstante, la autorización enriquece la respuesta con detalles específicos del usuario para obtener un resultado personalizado, como los límites de usuario y las promociones disponibles.
Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 59080
item_idstringrequerido

ID del artículo.

Ejemplo: 259774
Consulta
promo_codestring[ 1 .. 128 ] characters

Código único que distingue entre mayúsculas y minúsculas. Contiene letras y números.

Ejemplo: promo_code=WINTER2021
show_inactive_time_limited_itemsinteger

Muestra los artículos de duración limitada que no están disponibles para el usuario. El periodo de validez de dichos artículos no ha comenzado o ya ha expirado.

Predeterminado 0
Ejemplo: show_inactive_time_limited_items=1
additional_fields[]Array of strings

La lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud.

Elementos Enumeración"media_list""order""long_description""custom_attributes""item_order_in_group"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/59080/items/id/259774?promo_code=WINTER2021&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

El artículo vendible se recibió correctamente.

Cuerpoapplication/json
attributesArray of objects(Virtual-Items-Currency_client-attributes)

Lista de atributos y sus valores correspondientes al artículo. Puede utilizarse para filtrar el catálogo.

Predeterminado []
Ejemplo: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
can_be_boughtboolean

Si es true, el usuario puede comprar un artículo.

Ejemplo: true
custom_attributesobject(json)(item-custom-attributes-response)

Un objeto JSON que contiene los atributos y valores del artículo.

descriptionstring

Descripción del artículo.

Ejemplo: "Electric shield"
groupsArray of objects(items_client_groups_response)

Grupos a los que pertenece el artículo.

Predeterminado []
Ejemplo: [{"external_id":"exclusive","name":"Exclusive"}]
image_urlstring

URL de la imagen.

Ejemplo: "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png"
is_freeboolean(value-is_free)

Si es true, el artículo es gratuito.

Predeterminado false
Ejemplo: false
item_idinteger

ID único interno del artículo que se proporciona al crearlo.

Ejemplo: 259774
limitsobject or null(Catalog_item_limits)

Límites del artículo.

namestring

Nombre del artículo.

Ejemplo: "Electric shield"
priceobject

Precios de artículos.

promotionsArray of objects(Catalog_item_promotions)

Promociones aplicadas para artículos específicos de la cesta. La matriz se devuelve en los siguientes casos:

  • Se configura un descuento promocional para un artículo específico.

  • Se aplica un código promocional con el parámetro Descuento en artículos seleccionados.

Si no se aplican promociones a nivel de artículo, se devuelve una matriz vacía.

skustring

ID único del artículo. El SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

Ejemplo: "electric_shield"
typestring

Tipo de artículo: virtual_good/virtual_currency/bundle/game_key/physical_good.

Enumeración"virtual_good""virtual_currency""bundle""game_key""physical_good"
Ejemplo: "virtual_good"
virtual_item_typestring

Tipo de artículo virtual.

Enumeración ValorDescripción
consumable

Artículo que desaparece del inventario tras su uso (p. ej., munición).

non_consumable

Un artículo que permanece en el inventario durante un periodo ilimitado.

non_renewing_subscription

Artículo de duración limitada que puede representar el acceso a servicios o contenidos durante un periodo limitado.

Ejemplo: "non-consumable"
virtual_pricesArray of objects

Precios virtuales.

vp_rewardsArray of objects(client-item-value-point-reward)

Recompensa de artículo del punto de valor.

Respuesta
application/json
{
  "attributes": [],
  "can_be_bought": true,
  "custom_attributes": {
    "attr": "value",
    "purchased": 0
  },
  "description": "Electric shield",
  "groups": [
    { … }
  ],
  "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
  "is_free": false,
  "item_id": 259774,
  "limits": {
    "per_user": { … }
  },
  "name": "Electric shield",
  "price": {
    "amount": "9.99",
    "amount_without_discount": "9.99",
    "currency": "USD"
  },
  "promotions": [
    { … }
  ],
  "sku": "com.xsolla.electric_shield_1",
  "type": "virtual_good",
  "virtual_item_type": "non_consumable",
  "virtual_prices": [
    { … },
    { … },
    { … }
  ],
  "vp_rewards": [
    { … },
    { … }
  ]
}

Obtener artículo vendible por SKUClient-side

Solicitud

Obtiene un artículo vendible por SKU para crear un catálogo.

Nota

Este punto final, accesible sin autorización, devuelve datos genéricos. Sin embargo, la autorización enriquece la respuesta con detalles específicos del usuario para obtener un resultado personalizado, como los límites de usuario y las promociones disponibles.
Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 59080
skustringrequerido

Código (SKU) del artículo.

Ejemplo: electric_shield
Consulta
promo_codestring[ 1 .. 128 ] characters

Código único que distingue entre mayúsculas y minúsculas. Contiene letras y números.

Ejemplo: promo_code=WINTER2021
show_inactive_time_limited_itemsinteger

Muestra los artículos de duración limitada que no están disponibles para el usuario. El periodo de validez de dichos artículos no ha comenzado o ya ha expirado.

Predeterminado 0
Ejemplo: show_inactive_time_limited_items=1
additional_fields[]Array of strings

La lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud.

Elementos Enumeración"media_list""order""long_description""custom_attributes""item_order_in_group"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/59080/items/sku/electric_shield?promo_code=WINTER2021&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

El artículo vendible se recibió correctamente.

Cuerpoapplication/json
attributesArray of objects(Virtual-Items-Currency_client-attributes)

Lista de atributos y sus valores correspondientes al artículo. Puede utilizarse para filtrar el catálogo.

Predeterminado []
Ejemplo: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
can_be_boughtboolean

Si es true, el usuario puede comprar un artículo.

Ejemplo: true
custom_attributesobject(json)(item-custom-attributes-response)

Un objeto JSON que contiene los atributos y valores del artículo.

descriptionstring

Descripción del artículo.

Ejemplo: "Electric shield"
groupsArray of objects(items_client_groups_response)

Grupos a los que pertenece el artículo.

Predeterminado []
Ejemplo: [{"external_id":"exclusive","name":"Exclusive"}]
image_urlstring

URL de la imagen.

Ejemplo: "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png"
is_freeboolean(value-is_free)

Si es true, el artículo es gratuito.

Predeterminado false
Ejemplo: false
item_idinteger

ID único interno del artículo que se proporciona al crearlo.

Ejemplo: 259774
limitsobject or null(Catalog_item_limits)

Límites del artículo.

namestring

Nombre del artículo.

Ejemplo: "Electric shield"
priceobject

Precios de artículos.

promotionsArray of objects(Catalog_item_promotions)

Promociones aplicadas para artículos específicos de la cesta. La matriz se devuelve en los siguientes casos:

  • Se configura un descuento promocional para un artículo específico.

  • Se aplica un código promocional con el parámetro Descuento en artículos seleccionados.

Si no se aplican promociones a nivel de artículo, se devuelve una matriz vacía.

skustring

ID único del artículo. El SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

Ejemplo: "electric_shield"
typestring

Tipo de artículo: virtual_good/virtual_currency/bundle/game_key/physical_good.

Enumeración"virtual_good""virtual_currency""bundle""game_key""physical_good"
Ejemplo: "virtual_good"
virtual_item_typestring

Tipo de artículo virtual.

Enumeración ValorDescripción
consumable

Artículo que desaparece del inventario tras su uso (p. ej., munición).

non_consumable

Un artículo que permanece en el inventario durante un periodo ilimitado.

non_renewing_subscription

Artículo de duración limitada que puede representar el acceso a servicios o contenidos durante un periodo limitado.

Ejemplo: "non-consumable"
virtual_pricesArray of objects

Precios virtuales.

vp_rewardsArray of objects(client-item-value-point-reward)

Recompensa de artículo del punto de valor.

Respuesta
application/json
{
  "attributes": [],
  "can_be_bought": true,
  "custom_attributes": {
    "attr": "value",
    "purchased": 0
  },
  "description": "Electric shield",
  "groups": [
    { … }
  ],
  "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
  "is_free": false,
  "item_id": 259774,
  "limits": {
    "per_user": { … }
  },
  "name": "Electric shield",
  "price": {
    "amount": "9.99",
    "amount_without_discount": "9.99",
    "currency": "USD"
  },
  "promotions": [
    { … }
  ],
  "sku": "com.xsolla.electric_shield_1",
  "type": "virtual_good",
  "virtual_item_type": "non_consumable",
  "virtual_prices": [
    { … },
    { … },
    { … }
  ],
  "vp_rewards": [
    { … },
    { … }
  ]
}

Regiones comunes

Operaciones

Catálogo

Operaciones

Derechos

Operaciones

Admin

Operaciones

Común

Operaciones

Cupones

Esta API le permite gestionar cupones.

Operaciones

Códigos promocionales

Esta API permite gestionar códigos promocionales.

Operaciones

Ofertas únicas por catálogo

Esta API le permite gestionar ofertas de catálogo únicas.

Operaciones

Descuentos

Esta API le permite gestionar promociones de descuento.

Operaciones

Bonificaciones

Esta API permite gestionar promociones de bonificaciones.

Operaciones

Admin

Operaciones

Catálogo

Operaciones

Pago virtual

Operaciones

Gestión

Operaciones

Admin

Operaciones

Cliente

Operaciones

Cliente de clanes

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones