Xsolla-logo

Create bundle

post/v2/project/{project_id}/admin/items/bundle

Creates a bundle.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

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

Example: 44056
Request Body schema: application/json

Object with bundle data.

sku
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, periods, dashes, and underscores.

required
object

Object with localizations for item's name. Two-letter lowercase language code.

en
string or null
ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
string or null
es
string or null
fr
string or null
he
string or null
it
string or null
ja
string or null
ko
string or null
pl
string or null
pt
string or null
ro
string or null
ru
string or null
th
string or null
tr
string or null
tw
string or null
vi
string or null
required
object

Object with localizations for item's description. Two-letter lowercase language code.

en
string or null
ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
string or null
es
string or null
fr
string or null
he
string or null
it
string or null
ja
string or null
ko
string or null
pl
string or null
pt
string or null
ro
string or null
ru
string or null
th
string or null
tr
string or null
tw
string or null
vi
string or null
groups
Array of strings
Default: []

Groups the item belongs to.

Note. The string value refers to group `external_id`.
Array of objects <= 20 items

List of attributes.

Attention. You can't specify more than 20 attributes for the item. Any attempts to exceed the limit result in an error.
Array (<= 20 items)
external_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9-_]+$

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

required
Array of objects
Attention. You can't create more than 6 values for each attribute. Any attempts to exceed the limit result in an error.
Array
required
object
Default: {"en":"Strategy","de":"Strategie"}

Object with localizations of the value's name. Keys are specified in ISO 3166-1.

property name*
additional property
string
external_id
required
string [ 1 .. 255 ] characters ^[-_.\d\w]+$

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

object
Default: {"en":"Genre","de":"Genre"}

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

property name*
additional property
string
object

Object with localizations for long description of item. Two-letter lowercase language code.

en
string or null
ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
string or null
es
string or null
fr
string or null
he
string or null
it
string or null
ja
string or null
ko
string or null
pl
string or null
pt
string or null
ro
string or null
ru
string or null
th
string or null
tr
string or null
tw
string or null
vi
string or null
image_url
string or null

Image URL.

Array of objects

Prices in real currencies.

Array
amount
required
string^\d*\.?\d*$

Item price.

currency
required
string

Purchase currency. Three-letter code per ISO 4217.

is_default
required
boolean

Default price is used to build a catalog if no price in the user's currency is specified.

is_enabled
required
boolean

The price is enabled.

country_iso
string or null

Country where this price is available. Two-letter code per ISO 3166-1 alpha 2.

Array of objects or null
Array
amount
required
integer
is_default
required
boolean
is_enabled
required
boolean
sku
string

Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, periods, dashes, and underscores.

Array of objects non-empty
Array (non-empty)
sku
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, periods, dashes, and underscores.

quantity
integer >= 1
Default: 1

Quantity of the selected items in the bundle.

is_free
boolean
Default: false

If true, the item is free.

is_enabled
boolean
Default: true

If disabled, the item can't be found and purchased.

is_show_in_store
boolean
Default: false

Item is available for purchase.

Array of objects or null

Bundle's additional assets.

Array
type
string

Type of media: image/video.

Enum: "image" "video"
url
string

Resource file.

order
integer
Default: 1

Bundle's order priority in the list.

Array of objects
Array
id
integer >= 1
object

Item limits.

per_user
integer or null

Item limitation for a separate user.

per_item
integer or null

Global item limitation.

object or null

Limit refresh period.

interval_type = daily (object) or interval_type = weekly (object) or interval_type = monthly (object)
One of:

Daily type of user limits refresh.

interval_type
required
string

Recurrent refresh period.

Value: "daily"
time
required
string((0[0-9]|1[0-9]|2[0-3]):00:00)(\+|-)(0[0-9]|1...

Time of limit refresh in the desired time zone (rounding to hours).

Array of objects or null

Item sales period.

Array
date_from
string <date-time>

Date when the specified item will be available for sale.

date_until
string or null <date-time>

Date when the specified item will become unavailable for sale. Can be null.

custom_attributes
object <json> <= 500 characters

A JSON object containing item attributes and values. Attributes allow you to add more info to items like the player's required level to use the item. Attributes enrich your game's internal logic and are accessible through dedicated GET methods and webhooks.

Responses
201

Bundle was successfully created.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

422

Invalid request.

Request samples
application/json
{
  • "sku": "armour_chest",
  • "name": {
    },
  • "is_enabled": true,
  • "is_free": true,
  • "order": 1,
  • "long_description": {
    },
  • "description": {
    },
  • "image_url": "https://picture.bundle-with-many-stuff.png",
  • "media_list": [],
  • "groups": [
    ],
  • "attributes": {
    },
  • "prices": [
    ],
  • "vc_prices": null,
  • "content": [
    ],
  • "limits": {
    },
  • "periods": [
    ],
  • "custom_attributes": {
    }
}
Response samples
application/json
{
  • "sku": "kg_1"
}
System statusAll services operational

Privacy Settings

Privacy PolicyEnd User License Agreement© 2006–2024 Xsolla Inc.