Import and export the item catalog in JSON format
You can create, update, or deactivate items using import from a JSON file.
Note
With this tool, you can:
Import item catalog from JSON file
Note
Import from a JSON file supports all item types — virtual items, virtual currency, virtual currency packages, and bundles.
Items not supported by the canvas UI (virtual currency packages) will be imported, but will not appear in the item list on the canvas.
All imported items are available in the system and can be used outside the canvas — via Publisher Account or API.
To import an item catalog from a JSON file:
In your project in Publisher Account, go to the LiveOps > Canvas section.
In the control panel, click the
icon. In the item list area, click the + icon and select Import items (JSON).
- Choose the desired action:
- Add new items — only items with new SKUs will be added.
- Add new items and update existing ones — items with new SKUs will be added and existing item data will be updated.
- Add new items, update existing and disable missing ones — items with SKUs from the file will be added or updated. If an item exists in the catalog but is not in the file, its status will be changed to Partially available. Such an item can’t be purchased separately but will be available as part of a bundle or as a bonus item.
- Click Continue.
- Fill in the file for import:
- Download the file template in the download window and fill it in according to the example below.
- Export the items and use the exported file as a template.
- Create your own JSON file and fill it out as per the example below.
Example of a completed JSON file:
Copy
- json
1{
2 "virtual_currency": [
3 {
4 "sku": "Gem_test_import",
5 "name": {
6 "en": "Gem_test_import"
7 },
8 "type": "virtual_currency",
9 "description": {
10 "en": "my test imported currency"
11 },
12 "image_url": "https://cdn3.xsolla.com/img/misc/merchant/default-dc-image.png",
13 "description": {
14 "en": "my test imported currency",
15 "de": "meine importierte Testwährung"
16 },
17 "attributes": [],
18 "is_free": false,
19 "order": 1,
20 "groups": [],
21 "regional_prices": [],
22 "prices": [
23 {
24 "amount": 2,
25 "currency": "USD",
26 "is_default": true,
27 "is_enabled": true
28 }
29 ],
30 "media_list": [],
31 "vc_prices": [],
32 "is_enabled": true,
33 "is_show_in_store": true,
34 "regions": [],
35 "limits": {
36 "per_user": null,
37 "per_item": null,
38 "recurrent_schedule": null
39 },
40 "periods": [],
41 "inventory_options": {
42 "consumable": true,
43 "expiration_period": null
44 },
45 "is_hard": false
46 }
47 ],
48 "virtual_items": [
49 {
50 "sku": "event_access_test_import",
51 "name": {
52 "en": "Special Event Access_test_import"
53 },
54 "type": "virtual_good",
55 "description": {
56 "en": "Get special event access as a bonus only on your first purchase. Find the right doggy at the Robo-Dog Exhibition!"
57 },
58 "image_url": "https://cdn3.xsolla.com/img/misc/images/1e3ef1a96cc9dd8d98bc124d5d6fad79.png",
59 "long_description": null,
60 "attributes": [],
61 "is_free": false,
62 "order": 1,
63 "groups": [
64 "my_test_group"
65 ],
66 "regional_prices": [],
67 "prices": [
68 {
69 "amount": 35,
70 "currency": "USD",
71 "is_default": true,
72 "is_enabled": true
73 }
74 ],
75 "media_list": [],
76 "vc_prices": [],
77 "is_enabled": true,
78 "is_show_in_store": true,
79 "regions": [],
80 "limits": {
81 "per_user": null,
82 "per_item": null,
83 "recurrent_schedule": null
84 },
85 "periods": [],
86 "inventory_options": {
87 "consumable": true,
88 "expiration_period": null
89 }
90 }
91 ],
92 "virtual_currency_packages": [
93 {
94 "item_id": 441982,
95 "sku": "small_gold_pack_test_import",
96 "type": "bundle",
97 "name": {
98 "en": "Small gold pack"
99 },
100 "bundle_type": "virtual_currency_package",
101 "description": {
102 "en": "Gold x100"
103 },
104 "image_url": "https://cdn3.xsolla.com/img/misc/images/ba43c46ea75fd5713c210f5736993a92.png",
105 "vc_prices": [],
106 "regional_prices": [],
107 "prices": [
108 {
109 "amount": 5,
110 "currency": "USD",
111 "is_default": true,
112 "is_enabled": true
113 }
114 ],
115 "is_enabled": true,
116 "is_show_in_store": true,
117 "regions": [],
118 "limits": {
119 "per_user": null,
120 "per_item": null,
121 "recurrent_schedule": null
122 },
123 "periods": [],
124 "attributes": [],
125 "long_description": null,
126 "media_list": [],
127 "order": 100000000,
128 "is_free": false,
129 "groups": [],
130 "content": [
131 {
132 "sku": "Gem_test_import",
133 "quantity": 100
134 }
135 ]
136 }
137 ],
138 "bundles": [
139 {
140 "item_id": 684024,
141 "sku": "start_pack_test_import_test_import",
142 "type": "bundle",
143 "name": {
144 "en": "Legendary Start Pack"
145 },
146 "bundle_type": "standard",
147 "description": {
148 "en": "Crystal x 1\nGem x 1"
149 },
150 "image_url": "https://cdn3.xsolla.com/img/misc/merchant/default-dc-image.png",
151 "regional_prices": [],
152 "prices": [
153 {
154 "amount": 20,
155 "currency": "USD",
156 "is_default": true,
157 "is_enabled": true
158 }
159 ],
160 "virtual_prices": [],
161 "is_enabled": true,
162 "is_show_in_store": true,
163 "regions": [],
164 "limits": {
165 "per_user": null,
166 "per_item": null,
167 "recurrent_schedule": null
168 },
169 "periods": [],
170 "attributes": [],
171 "long_description": null,
172 "media_list": [],
173 "order": 5,
174 "is_free": false,
175 "groups": [
176 "my_test_group"
177 ],
178 "content": [
179 {
180 "sku": "Gem_test_import",
181 "quantity": 1
182 },
183 {
184 "sku": "event_access_test_import",
185 "quantity": 1
186 }
187 ]
188 }
189 ]
190}
- Upload the full file to the corresponding field in the import window.
- If there are errors during import, a list of these errors and troubleshooting recommendations will be displayed in the import window. Make the necessary changes to the file and upload it again.
After successful upload, the items with the specified SKUs will be created, updated, or disabled.
Note
You can import items using the Import items via JSON file API call.
To avoid errors during import, follow the recommendations above for filling in the file.
Export item catalog to JSON file
To export an item or the entire item catalog to a JSON file:
- In your project in Publisher Account, go to the LiveOps > Canvas section.
- In the control panel, click the
icon. - In the item list area, click the + icon and select Export items (JSON).
- Choose the desired action:
- Export all items — exports the entire catalog of all item types in the project.
- Export selected items only — exports only the items selected in the Items field.
- Click Export. The JSON file download will start automatically.
Was this article helpful?
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.Found a typo or other text error? Select the text and press Ctrl+Enter.
