Saltar al contenido
/
Obtener el estado de la i...

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

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

Obtener el estado de la importación de artículosServer-sideAdmin

Solicitud

Recupera información sobre el progreso de la importación de artículos al proyecto. Esta llamada API recupera datos sobre la última importación realizada mediante la API o mediante Cuenta del editor.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v1/admin/projects/44056/connectors/import_items/import/status

Respuestas

El estado de la importación se ha recuperado correctamente.

Cuerpoapplication/json
date_completedstring

La fecha y hora de finalización de la operación de importación está en la zona horaria GMT+3. Si la importación se interrumpió debido a un error y no se importó ningún artículo, se devolverá una cadena (string) vacía.

Ejemplo: "2024-11-19T15:27:31+03:00"
date_createdstring

La fecha y hora de la operación de creación de la importación expresada en la zona horaria GMT+3.

Ejemplo: "2024-11-19T14:27:31+03:00"
date_updatedstring

La fecha y hora en que se interrumpió la importación debido a un error, en la zona horaria GMT+3.

Ejemplo: "2024-11-19T15:27:31+03:00"
errorstring

Descripción del error general de importación.

error_codestring

El código del error general de importación.

progressinteger

El progreso de la ejecución de la importación en porcentaje.

Ejemplo: 100
resultobject

Un objeto con datos sobre los resultados de la importación y los errores de importación para SKU de artículos específicos.

Ejemplo: {"errors_by_sku":[{"error_code":4055,"error_message":"[0401-4055]: Item default price not set","sku":"com.xsolla.sword_1","type":"virtual_items"},{"error_code":1817,"error_message":"[0410-1817]: SKU can't be empty","sku":"","type":null}],"errors_count":2,"total_entities_count":10}
statusstring

Estado de la importación.

Enumeración ValorDescripción
done

La importación se realizó correctamente.

error

Debido a errores, la importación no se completó o solo se completó parcialmente.

initialized

Se ha iniciado la importación.

process

La importación está en curso.

Ejemplo: "error"
Respuesta
application/json
{
  "date_completed": "2024-11-19T15:27:31+03:00",
  "date_created": "2024-11-19T14:27:31+03:00",
  "date_updated": "2024-11-19T15:27:31+03:00",
  "error": null,
  "error_code": null,
  "progress": 100,
  "result": {
    "errors_by_sku": [ … ],
    "errors_count": 2,
    "total_entities_count": 10
  },
  "status": "error"
}

Importar artículos mediante un archivo JSONServer-sideAdmin

Solicitud

Importa artículos a la tienda desde un archivo JSON mediante la URL especificada. Consulte la documentación para obtener más información sobre la importación desde un archivo JSON.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
Cuerpoapplication/json
connector_external_idstringrequerido

Valor fijo que especifica el tipo de operación para importar artículos.

Valor"import_items"
file_urlstringrequerido

La URL de un archivo con datos en formato JSON. El archivo debe estar alojado en un servicio de almacenamiento con acceso público. Puede descargar la plantilla del archivo en Cuenta del editor en la sección Store > Artículos virtuales > Gestionar catálogo > Importar artículos (JSON).

Ejemplo: "https://my-bucket.s3.amazonaws.com/items.json"
modestring

Acciones de importación:

Predeterminado "create_and_update"
Enumeración ValorDescripción
create

Añadir nuevos artículos.

create_and_update

Añadir nuevos artículos y actualizar los existentes.

sync

Añadir nuevos artículos, actualizar los existentes y desactivar los que faltan.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v1/projects/44056/import/from_external_file \
  -H 'Content-Type: application/json' \
  -d '{
    "connector_external_id": "import_items",
    "file_url": "https://my-bucket.s3.amazonaws.com/items.json",
    "mode": "create"
  }'

Respuestas

El archivo se ha importado correctamente y se está procesando.

Cuerpoapplication/json
import_idstring

ID de operación de importación. Si necesita ayuda para importar el archivo JSON, comunique este ID a su gestor de éxito del cliente o envíe un correo electrónico a csm@xsolla.com.

Ejemplo: "af9f3638a16e11ef880da2cd677d2d24"
Respuesta
application/json
{
  "import_id": "af9f3638a16e11ef880da2cd677d2d24"
}