Get virtual currency package list

Attention

All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.

Note

In general, the use of catalog of items is available without authorization.
Only authorized users can get a personalized catalog.

SecurityXsollaLoginUserJWT

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

query Parameters

limit	integer Limit for the number of elements on the page. Example: limit=50
offset	integer Number of the element from which the list is generated (the count starts from 0). Example: offset=0
locale	string Default: "en" Response language. Two-letter lowercase language code per ISO 639-1.
additional_fields[]	Array of strings The list of additional fields. These fields will be in the response if you send them in your request. Items Enum: "media_list" "order" "long_description" "custom_attributes"
country	string Two-letter uppercase country code per ISO 3166-1 alpha-2. Shows regional prices and restrictions for a catalog if those were specified while creating an item. Note If you do not specify the country explicitly, it will be set based on user's IP address. Example: country=US
promo_code	string [ 1 .. 128 ] characters Unique case sensitive code. Contains letters and numbers. Example: promo_code=WINTER2021
show_inactive_time_limited_items	integer Default: 0 Shows time-limited items that are not available to the user. The validity period of such items has not started or has already expired. Example: show_inactive_time_limited_items=1

Responses

200

The list of virtual currency packages was successfully received.

Request samples

Response samples

application/json

{"has_more": false,
"items": [{"sku": "vc_package_1",
"name": "VC Name first package",
"groups": [ ],
"attributes": [ ],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [{"description": "Big Rocket - short description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "big_rocket",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": null
}
}
],
"virtual_prices": [ ],
"promotions": [{"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {"percent": "50.00"
},
"bonus": [{"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {"per_user": {"total": 5,
"available": 3,
"recurrent_schedule": {"interval_type": "weekly",
"reset_next_date": 1746057600
}
}
},
"can_be_bought": true,
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {"purchased": 0,
"attr": "value"
},
"vp_rewards": [ ]
},
{"sku": "vc_package_3",
"name": "VC Name third package",
"groups": [ ],
"attributes": [ ],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [{"description": "description",
"image_url": "http://image.png",
"sku": "shotgun_raider",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"quantity": 200,
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": null
}
}
],
"virtual_prices": [ ],
"promotions": [{"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {"percent": "50.00"
},
"bonus": [{"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {"per_user": {"total": 5,
"available": 3,
"recurrent_schedule": {"interval_type": "weekly",
"reset_next_date": 1746057600
}
}
},
"can_be_bought": true,
"periods": [{"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": [ ]
}
]
}