Skip to content
/
Get list of attributes (a...

Catalog 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

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
index.json
index.yaml
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/catalog/
https://store.xsolla.com/api/

Admin

Operations

Catalog

Operations

Virtual payment

Operations

Catalog

Operations

Entitlement

Operations

Admin

Operations

Admin

Operations

Catalog

Operations

Cart (client-side)

Operations

Cart (server-side)

Operations

Payment (client-side)

Operations

Payment (server-side)

Operations

Order

Operations

Free items

Operations

Management

Operations

Admin

Operations

Webhooks

Operations

Pre-Orders

Operations

Merchant

Operations

Catalog

This API allows getting any kind of sellable items or specific item.

Operations

Common regions

Operations

Admin

Operations

Get list of attributes (admin)Server-sideAdmin

Request

Gets the list of attributes from a project for administration.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
Query
limitinteger>= 1

Limit for the number of elements on the page.

Example: limit=50
offsetinteger>= 0

Number of the element from which the list is generated (the count starts from 0).

Example: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/attribute?limit=50&offset=0'

Responses

List of attributes was successfully received.

Bodyapplication/json
attributesArray of objects(admin_attribute_response)
Example: [{"value":[{"external_id":"genre","name":{"en":"Genre","de":"Genre"}}]}]
total_countinteger
Response
application/json
{
  "total_count": 2,
  "attributes": [
    { … },
    { … }
  ]
}

Create attributeServer-sideAdmin

Request

Creates an attribute.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
Bodyapplication/json
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$required

Unique attribute ID. The external_id may contain only lowercase and uppercase Latin alphanumeric characters, dashes, and underscores.

Example: "attribute_1"
nameobject(admin-attribute-name)required

Object with localizations for attribute's name. Keys are specified in ISO 3166-1.

Default {"en":"Genre","de":"Genre"}
Example: {"en":"Genre","de":"Genre"}
name.​property name*stringadditional property
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/attribute \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "genre",
    "name": {
      "en": "Genre",
      "de": "Genre"
    }
  }'

Responses

Attribute was successfully created.

Bodyapplication/json
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

Unique attribute ID. The external_id may contain only lowercase and uppercase Latin alphanumeric characters, dashes, and underscores.

Example: "attribute_1"
Response
application/json
{
  "external_id": "genre"
}

Update attributeServer-sideAdmin

Request

Updates an attribute.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
external_idstringrequired

Attribute external ID.

Example: attribute_id
Bodyapplication/json
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$required

Unique attribute ID. The external_id may contain only lowercase and uppercase Latin alphanumeric characters, dashes, and underscores.

Example: "attribute_1"
nameobject(admin-attribute-name)required

Object with localizations for attribute's name. Keys are specified in ISO 3166-1.

Default {"en":"Genre","de":"Genre"}
Example: {"en":"Genre","de":"Genre"}
name.​property name*stringadditional property
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/attribute/attribute_id \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "genre",
    "name": {
      "en": "Genre",
      "de": "Genre"
    }
  }'

Responses

Attribute was successfully updated.

Body
Response
No content