A fixed value that specifies the type of operation for importing items.
Catalog API (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
Catalog API provides endpoints to manage your in-game store catalog and process purchases. Use the endpoints to configure virtual items, virtual currencies, game keys, bundles, cart and payment flows, item attributes, and import items from external sources.
Download OpenAPI description
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/catalog/
https://store.xsolla.com/api/
Request
Imports items into the store from a JSON file via the specified URL. Refer to the documentation for more information about import from a JSON file.
Security
basicAuth
Path
Bodyapplication/jsonProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
The URL of a file with data in JSON format. The file should be hosted on a storage service with public access. You can download the file template in Publisher Account in the Store > Virtual Items > Catalog Management > Import Items (JSON) section.
Example: "https://my-bucket.s3.amazonaws.com/items.json"
- Mock serverhttps://xsolla.redocly.app/_mock/api/catalog/v1/projects/{project_id}/import/from_external_file
- https://connector.xsolla.com/v1/projects/{project_id}/import/from_external_file
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/catalog/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"
}'Response
application/json
{ "import_id": "af9f3638a16e11ef880da2cd677d2d24" }
Path
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/api/catalog/v1/admin/projects/{project_id}/connectors/import_items/import/status
- https://connector.xsolla.com/v1/admin/projects/{project_id}/connectors/import_items/import/status
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/catalog/v1/admin/projects/44056/connectors/import_items/import/statusThe import status has been successfully retrieved.
Import status.
| Enum Value | Description |
|---|---|
| initialized | Import has been initiated. |
| process | Import is in progress. |
| done | Import was successfull. |
| error | Due to errors, the import was not completed or only partially completed. |
Example: "error"
The timestamp of the import creation operation in GMT+3 timezone.
Example: "2024-11-19T14:27:31+03:00"
The timestamp when the import was interrupted due to an error in GMT+3 timezone.
Example: "2024-11-19T15:27:31+03:00"
The timestamp of completion of the import operation in GMT+3 timezone. If the import was interrupted due to an error and no items were imported, an empty string will be returned.
Example: "2024-11-19T15:27:31+03:00"
An object with data on the import results and import errors for specific items SKU.
Example: {"errors_count":2,"total_entities_count":10,"errors_by_sku":[{"sku":"com.xsolla.sword_1","type":"virtual_items","error_code":4055,"error_message":"[0401-4055]: Item default price not set"},{"sku":"","type":null,"error_code":1817,"error_message":"[0410-1817]: SKU can't be empty"}]}
Response
application/json
{ "status": "error", "date_created": "2024-11-19T14:27:31+03:00", "date_updated": "2024-11-19T15:27:31+03:00", "date_completed": "2024-11-19T15:27:31+03:00", "progress": 100, "error": null, "error_code": null, "result": { "errors_count": 2, "total_entities_count": 10, "errors_by_sku": [ … ] } }