Skip to content
/
Get specified attribute

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

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

Get specified attributeServer-sideAdmin

Request

Gets a specified 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
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/attribute/attribute_id

Responses

Specified attribute was successfully received.

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"
nameobject(admin-attribute-name)

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

Default {"en":"Genre","de":"Genre"}
Example: {"en":"Genre","de":"Genre"}
Response
application/json
{
  "value": [
    { … }
  ]
}

Delete attributeServer-sideAdmin

Request

Deletes an attribute.

Notice

If you delete an item attribute, all its data and connections with items will be lost.
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
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/catalog/v2/project/44056/admin/attribute/attribute_id

Responses

Attribute was successfully deleted.

Response
No content