· 6 years ago · Oct 08, 2019, 08:46 AM
1---
2swagger: '2.0'
3info:
4 description: ''
5 version: 1.0.0
6 title: Store API
7 contact:
8 name: Xsolla Publisher API
9 url: 'https://xsolla.com'
10 email: integration@xsolla.com
11host: store.xsolla.com
12basePath: /api
13schemes:
14 - https
15securityDefinitions:
16 XsollaLoginUserJWT:
17 type: apiKey
18 in: header
19 name: Authorization
20 PayStationUserAccessToken:
21 type: apiKey
22 in: header
23 name: Authorization
24tags:
25 - name: /v1/cart
26 - name: /v1/inventory
27 - name: /v1/items
28 - name: /v1/groups
29 - name: /v1/order
30 - name: /v1/payment
31 - name: /v2/cart
32 - name: /v2/inventory
33 - name: /v2/items
34 - name: /v2/groups
35 - name: /v2/order
36 - name: /v2/payment
37paths:
38 '/v1/project/{project_id}/items/virtual_items':
39 get:
40 tags:
41 - /v1/items
42 consumes:
43 - application/json
44 produces:
45 - application/json
46 responses:
47 '200':
48 description: The list of items was successfully received.
49 schema:
50 type: object
51 description: Object with items.
52 properties:
53 items:
54 type: array
55 example:
56 - sku: big_rocket
57 name: Big Rocket
58 groups:
59 - accessory
60 attributes:
61 stack_size: 5
62 type: virtual_good
63 description: Big Rocket - description
64 image_url: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
65 is_free: false
66 order: 1
67 price:
68 amount: '100.99'
69 amount_without_discount: '100.99'
70 currency: USD
71 - sku: shotgun_raider
72 name: SHOTGUN FOR TRUE RAIDERS
73 groups:
74 - hair
75 attributes:
76 stack_size: 1
77 rating: '3.9'
78 tags: '["strategy", "tactical", "turn-based"]'
79 type: virtual_good
80 description: description
81 image_url: 'http://image.png'
82 is_free: false
83 order: 1
84 price:
85 amount: '101.0'
86 amount_without_discount: '101.0'
87 currency: USD
88 - sku: shotgun_raider_2
89 name: SHOTGUN FOR TRUE RAIDERS
90 groups: []
91 attributes: []
92 type: virtual_good
93 description: description
94 image_url: 'http://image.png'
95 is_free: true
96 order: 1
97 price: null
98 items:
99 type: object
100 properties:
101 sku:
102 type: string
103 example: big_rocket
104 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
105 name:
106 type: string
107 example: Big Rocket
108 description: Item name.
109 groups:
110 type: array
111 example:
112 - accessory
113 description: Groups the item belongs to.
114 items:
115 type: string
116 example: accessory
117 attributes:
118 type: object
119 description: Item attributes.
120 type:
121 type: string
122 example: virtual_good
123 description: 'Type of Item: Consumable/Expiration/Permanent/Lootboxes/Physical.'
124 description:
125 type: string
126 example: Big Rocket - description
127 description: Item description.
128 image_url:
129 type: string
130 example: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
131 description: Image URL.
132 is_free:
133 type: string
134 example: false
135 description: 'If ''true'', the item is free.'
136 order:
137 type: integer
138 example: 1
139 description: Defines arragement order.
140 price:
141 type: object
142 description: Item prices.
143 properties:
144 amount:
145 type: string
146 example: '100.99'
147 description: Discounted item price.
148 amount_without_discount:
149 type: string
150 example: '100.99'
151 description: Item price.
152 currency:
153 type: string
154 example: USD
155 description: Default purchase currency. Three-letter code per ISO 4217.
156 examples:
157 application/json:
158 items:
159 - sku: big_rocket
160 name: Big Rocket
161 groups:
162 - accessory
163 attributes:
164 stack_size: 5
165 type: virtual_good
166 description: Big Rocket - description
167 image_url: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
168 is_free: false
169 order: 1
170 price:
171 amount: '100.99'
172 amount_without_discount: '100.99'
173 currency: USD
174 - sku: shotgun_raider
175 name: SHOTGUN FOR TRUE RAIDERS
176 groups:
177 - hair
178 attributes:
179 stack_size: 1
180 rating: '3.9'
181 tags: '["strategy", "tactical", "turn-based"]'
182 type: virtual_good
183 description: description
184 image_url: 'http://image.png'
185 is_free: false
186 order: 1
187 price:
188 amount: '101.0'
189 amount_without_discount: '101.0'
190 currency: USD
191 - sku: shotgun_raider_2
192 name: SHOTGUN FOR TRUE RAIDERS
193 groups: []
194 attributes: []
195 type: virtual_good
196 description: description
197 image_url: 'http://image.png'
198 is_free: true
199 order: 1
200 price: null
201 parameters:
202 - name: project_id
203 in: path
204 required: true
205 type: integer
206 description: Project ID.
207 default: 44056
208 - name: limit
209 in: query
210 required: false
211 type: integer
212 description: Limit for the number of elements on the page.
213 - name: offset
214 in: query
215 required: false
216 type: integer
217 description: Number of the element from which the list is generated (the count starts from 0).
218 - name: locale
219 in: query
220 required: false
221 type: string
222 description: Response language.
223 default: en
224 summary: Get items List
225 description: Gets an items list for building a catalog.
226 '/v1/project/{project_id}/items/virtual_items/group/{external_id}':
227 get:
228 tags:
229 - /v1/items
230 consumes:
231 - application/json
232 produces:
233 - application/json
234 responses:
235 '200':
236 description: The list of items was successfully received.
237 schema:
238 type: object
239 properties:
240 items:
241 type: array
242 example:
243 - sku: big_rocket
244 name: Big Rocket
245 groups:
246 - accessory
247 attributes:
248 stack_size: 5
249 type: virtual_good
250 description: Big Rocket - description
251 image_url: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
252 is_free: false
253 order: 1
254 price:
255 amount: '100.99'
256 amount_without_discount: '100.99'
257 currency: USD
258 - sku: shotgun_raider
259 name: SHOTGUN FOR TRUE RAIDERS
260 groups:
261 - hair
262 attributes:
263 stack_size: 1
264 rating: '3.9'
265 tags: '["strategy", "tactical", "turn-based"]'
266 type: virtual_good
267 description: description
268 image_url: 'http://image.png'
269 is_free: false
270 order: 1
271 price:
272 amount: '101.0'
273 amount_without_discount: '101.0'
274 currency: USD
275 - sku: shotgun_raider_2
276 name: SHOTGUN FOR TRUE RAIDERS
277 groups: []
278 attributes: []
279 type: virtual_good
280 description: description
281 image_url: 'http://image.png'
282 is_free: true
283 order: 1
284 price: null
285 items:
286 type: object
287 properties:
288 sku:
289 type: string
290 example: big_rocket
291 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
292 name:
293 type: string
294 example: Big Rocket
295 description: Item name.
296 groups:
297 type: array
298 example:
299 - accessory
300 description: Groups the item belongs to.
301 items:
302 type: string
303 example: accessory
304 attributes:
305 type: object
306 description: Item attributes.
307 type:
308 type: string
309 example: virtual_good
310 description: 'Type of Item: Consumable/Expiration/Permanent/Lootboxes/Physical.'
311 description:
312 type: string
313 example: Big Rocket - description
314 description: Item description.
315 image_url:
316 type: string
317 example: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
318 description: Image URL.
319 is_free:
320 type: string
321 example: false
322 description: 'If ''true'', the item is free.'
323 order:
324 type: integer
325 example: 1
326 description: Defines arragement order.
327 price:
328 type: object
329 description: Item prices.
330 properties:
331 amount:
332 type: string
333 example: '100.99'
334 description: Discounted item price.
335 amount_without_discount:
336 type: string
337 example: '100.99'
338 description: Item price.
339 currency:
340 type: string
341 example: USD
342 description: Default purchase currency. Three-letter code per ISO 4217.
343 examples:
344 application/json:
345 items:
346 - sku: big_rocket
347 name: Big Rocket
348 groups:
349 - accessory
350 attributes:
351 stack_size: 5
352 type: virtual_good
353 description: Big Rocket - description
354 image_url: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
355 is_free: false
356 order: 1
357 price:
358 amount: '100.99'
359 amount_without_discount: '100.99'
360 currency: USD
361 - sku: shotgun_raider
362 name: SHOTGUN FOR TRUE RAIDERS
363 groups:
364 - hair
365 attributes:
366 stack_size: 1
367 rating: '3.9'
368 tags: '["strategy", "tactical", "turn-based"]'
369 type: virtual_good
370 description: description
371 image_url: 'http://image.png'
372 is_free: false
373 order: 1
374 price:
375 amount: '101.0'
376 amount_without_discount: '101.0'
377 currency: USD
378 - sku: shotgun_raider_2
379 name: SHOTGUN FOR TRUE RAIDERS
380 groups: []
381 attributes: []
382 type: virtual_good
383 description: description
384 image_url: 'http://image.png'
385 is_free: true
386 order: 1
387 price: null
388 '404':
389 description: The group wasn’t found. Make sure that the `external_id` is correct and the group isn’t turned off or deleted.
390 schema:
391 type: object
392 properties:
393 statusCode:
394 type: integer
395 example: 404
396 errorCode:
397 type: integer
398 example: 4403
399 errorMessage:
400 type: string
401 example: '[0401-4403]: Item group not found'
402 examples:
403 application/json:
404 statusCode: 404
405 errorCode: 4403
406 errorMessage: '[0401-4403]: Item group not found'
407 parameters:
408 - name: project_id
409 in: path
410 required: true
411 type: integer
412 description: Project ID.
413 default: 44056
414 - name: external_id
415 in: path
416 required: true
417 type: string
418 description: Group external ID.
419 default: featured
420 - name: limit
421 in: query
422 required: false
423 type: integer
424 description: Limit for the number of elements on the page.
425 - name: offset
426 in: query
427 required: false
428 type: integer
429 description: Number of the element from which the list is generated (the count starts from 0).
430 - name: locale
431 in: query
432 required: false
433 type: integer
434 description: Response language.
435 default: en
436 summary: Get Items List by Specified Group
437 description: |
438 Gets a list of items from the specified group for building a catalog.
439 '/v1/project/{project_id}/items/groups':
440 get:
441 tags:
442 - /v1/groups
443 consumes:
444 - application/json
445 produces:
446 - application/json
447 responses:
448 '200':
449 description: The list of items was successfully received.
450 schema:
451 type: object
452 properties:
453 groups:
454 type: array
455 example:
456 - id: 4
457 external_id: hair
458 name: __tn_funko_virtual_good_category_name_hair
459 description: __tn_funko_virtual_good_category_description_hair
460 image_url: null
461 order: 1
462 level: 0
463 children:
464 - id: 2
465 external_id: background
466 name: __tn_funko_virtual_good_category_name_background
467 description: __tn_funko_virtual_good_category_description_background
468 image_url: null
469 order: 1
470 level: 1
471 children:
472 - id: 1
473 external_id: accessory
474 name: Accessory
475 description: Accessory
476 image_url: null
477 order: 1
478 level: 2
479 children: []
480 parent_external_id: background
481 parent_external_id: hair
482 parent_external_id: null
483 - id: 8
484 external_id: group_external_id
485 name: __tn_Item_group_super
486 description: __tn_Super_item_group_for_the_best_items
487 image_url: null
488 order: 1
489 level: 0
490 children: []
491 parent_external_id: null
492 items:
493 type: object
494 properties:
495 id:
496 type: integer
497 example: 4
498 description: Group ID.
499 external_id:
500 type: string
501 example: hair
502 description: External group ID.
503 name:
504 type: string
505 example: __tn_funko_virtual_good_category_name_hair
506 description: Group name.
507 description:
508 type: string
509 example: __tn_funko_virtual_good_category_description_hair
510 description: Group description.
511 image_url:
512 type: string
513 example: null
514 description: Image URL.
515 order:
516 type: integer
517 example: 1
518 description: Defines arrangement order.
519 level:
520 type: integer
521 example: 0
522 description: Group nesting level.
523 children:
524 type: array
525 example:
526 - id: 2
527 external_id: background
528 name: __tn_funko_virtual_good_category_name_background
529 description: __tn_funko_virtual_good_category_description_background
530 image_url: null
531 order: 1
532 level: 1
533 children:
534 - id: 1
535 external_id: accessory
536 name: Accessory
537 description: Accessory
538 image_url: null
539 order: 1
540 level: 2
541 children: []
542 parent_external_id: background
543 parent_external_id: hair
544 description: Child groups.
545 items:
546 type: object
547 properties:
548 id:
549 type: integer
550 example: 2
551 description: Group ID.
552 external_id:
553 type: string
554 example: background
555 description: External group ID.
556 name:
557 type: string
558 example: __tn_funko_virtual_good_category_name_background
559 description: Group name.
560 description:
561 type: string
562 example: __tn_funko_virtual_good_category_description_background
563 description: Group description.
564 image_url:
565 type: string
566 example: null
567 description: Group image url.
568 order:
569 type: integer
570 example: 1
571 description: Defines arrangement order.
572 level:
573 type: integer
574 example: 1
575 description: Group nesting level.
576 children:
577 type: array
578 example:
579 - id: 1
580 external_id: accessory
581 name: Accessory
582 description: Accessory
583 image_url: null
584 order: 1
585 level: 2
586 children: []
587 parent_external_id: background
588 description: Child groups.
589 items:
590 type: object
591 properties:
592 id:
593 type: integer
594 example: 1
595 description: Group ID.
596 external_id:
597 type: string
598 example: accessory
599 description: External group ID.
600 name:
601 type: string
602 example: Accessory
603 description: Group name.
604 description:
605 type: string
606 example: Accessory
607 description: Group description.
608 image_url:
609 type: string
610 example: null
611 description: Image URL.
612 order:
613 type: integer
614 example: 1
615 description: Defines arrangement order.
616 level:
617 type: integer
618 example: 2
619 description: Group nesting level.
620 children:
621 type: array
622 example: []
623 description: Child groups.
624 items:
625 type: string
626 parent_external_id:
627 type: string
628 example: background
629 description: Parent external group ID.
630 parent_external_id:
631 type: string
632 example: hair
633 description: Parent external group ID.
634 parent_external_id:
635 type: string
636 example: null
637 description: Parent external group ID.
638 examples:
639 application/json:
640 groups:
641 - id: 1
642 external_id: accessory
643 name: Accessory
644 description: Accessory
645 image_url: null
646 level: 0
647 order: 1
648 children: []
649 parent_external_id: null
650 - id: 2
651 external_id: background
652 name: Background
653 description: Background
654 image_url: null
655 level: 0
656 order: 1
657 children: []
658 parent_external_id: null
659 - id: 3
660 external_id: hair
661 name: Hair
662 description: Hair
663 image_url: null
664 level: 0
665 order: 1
666 children: []
667 parent_external_id: null
668 - id: 4
669 external_id: outfit
670 name: Outfit
671 description: Outfit
672 image_url: null
673 level: 0
674 order: 1
675 children: []
676 parent_external_id: null
677 - id: 5
678 external_id: body
679 name: Body
680 description: Body
681 image_url: null
682 level: 0
683 order: 1
684 children: []
685 parent_external_id: null
686 - id: 26
687 external_id: delete_group
688 name: Body
689 description: Body
690 image_url: null
691 level: 0
692 order: 1
693 children: []
694 parent_external_id: null
695 - id: 27
696 external_id: new_group_external_id_test_nastya
697 name: Very cool group
698 description: Very cool group
699 image_url: null
700 level: 0
701 order: 1
702 children:
703 - id: 30
704 external_id: prod_tag_01_edited
705 name: Test group secure
706 description: Group description
707 image_url: 'http://static.xsolla.com/img/xsolla-logo2.png'
708 level: 1
709 order: 5
710 children: []
711 parent_external_id: new_group_external_id_test_nastya
712 parent_external_id: null
713 - id: 33
714 external_id: ext_id_20190808_1_prod_tag
715 name: Test group secure
716 description: Group description
717 image_url: 'http://static.xsolla.com/img/xsolla-logo2.png'
718 level: 0
719 order: 1
720 children:
721 - id: 34
722 external_id: ext_id_20190808_1_split_cur
723 name: Test group secure
724 description: Group description
725 image_url: 'http://static.xsolla.com/img/xsolla-logo2.png'
726 level: 1
727 order: 1
728 children: []
729 parent_external_id: ext_id_20190808_1_prod_tag
730 parent_external_id: null
731 summary: Get Items Groups List
732 parameters:
733 - name: project_id
734 in: path
735 required: true
736 type: integer
737 description: Project ID.
738 default: 44056
739 description: |
740 Gets a list of items for building a catalog.
741 '/v1/project/{project_id}/order/{order_id}':
742 get:
743 tags:
744 - /v1/order
745 consumes:
746 - application/json
747 produces:
748 - application/json
749 responses:
750 '200':
751 description: A successful order request.
752 schema:
753 type: object
754 properties:
755 order_id:
756 type: integer
757 example: 1
758 default: Order ID.
759 description: Order ID.
760 status:
761 type: string
762 example: paid
763 description: Order status. May be new/paid/canceled/delivered".
764 content:
765 type: object
766 description: Order details.
767 properties:
768 price:
769 type: object
770 description: Order price.
771 properties:
772 amount:
773 type: string
774 example: '30'
775 description: Order discount price.
776 amount_without_discount:
777 type: string
778 example: '30'
779 description: Order price.
780 currency:
781 type: string
782 example: USD
783 description: Default purchase currency. Three-letter code per ISO 4217.
784 is_free:
785 type: string
786 example: false
787 description: 'If ''true'', the order is free.'
788 items:
789 type: array
790 example:
791 - sku: some_sku
792 quantity: 1
793 is_free: false
794 price:
795 amount: '30'
796 amount_without_discount: '30'
797 currency: USD
798 description: Items list.
799 items:
800 type: object
801 properties:
802 sku:
803 type: string
804 example: some_sku
805 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
806 quantity:
807 type: integer
808 example: 1
809 description: Item quantity.
810 is_free:
811 type: string
812 example: false
813 description: 'If ''true'', the item is free.'
814 price:
815 type: object
816 description: Item price.
817 properties:
818 amount:
819 type: string
820 example: '30'
821 description: Discounted item price.
822 amount_without_discount:
823 type: string
824 example: '30'
825 description: Item price.
826 currency:
827 type: string
828 example: USD
829 description: Default purchase currency. Three-letter code per ISO 4217.
830 examples:
831 application/json:
832 order_id: 1
833 status: paid
834 content:
835 price:
836 amount: '30'
837 amount_without_discount: '30'
838 currency: USD
839 is_free: 'false'
840 items:
841 - sku: some_sku
842 quantity: 1
843 is_free: false
844 price:
845 amount: '30'
846 amount_without_discount: '30'
847 currency: USD
848 '404':
849 description: The order wasn’t found. Make sure the `project_it` and the `order_id` are correct.
850 schema:
851 type: object
852 properties:
853 statusCode:
854 type: integer
855 example: 404
856 errorCode:
857 type: integer
858 example: 9001
859 errorMessage:
860 type: string
861 example: '[0401-9001]: Order not found'
862 examples:
863 application/json:
864 statusCode: 404
865 errorCode: 9001
866 errorMessage: '[0401-9001]: Order not found'
867 security:
868 - XsollaLoginUserJWT: []
869 - PayStationUserAccessToken: []
870 parameters:
871 - name: project_id
872 in: path
873 required: true
874 type: integer
875 description: Project ID.
876 default: 44056
877 - name: order_id
878 in: path
879 required: true
880 type: string
881 description: Order ID.
882 default: '656'
883 summary: Get Order
884 description: |+
885 Retrieves a specified order.
886 '/v1/project/{project_id}/cart':
887 post:
888 tags:
889 - /v1/cart
890 consumes:
891 - application/json
892 produces:
893 - application/json
894 responses:
895 '201':
896 description: The cart was successfully created.
897 schema:
898 type: object
899 properties:
900 id:
901 type: integer
902 example: 504
903 description: Cart ID.
904 examples:
905 application/json:
906 id: 504
907 summary: Create Cart
908 security:
909 - XsollaLoginUserJWT: []
910 - PayStationUserAccessToken: []
911 parameters:
912 - name: project_id
913 in: path
914 required: true
915 type: integer
916 description: Project ID.
917 default: 44056
918 description: |+
919 Creates a cart.
920 '/v1/project/{project_id}/cart/{cart_id}':
921 get:
922 tags:
923 - /v1/cart
924 consumes:
925 - application/json
926 produces:
927 - application/json
928 responses:
929 '200':
930 description: The cart with items was successfully returned.
931 schema:
932 type: object
933 properties:
934 cart_id:
935 type: integer
936 example: 1
937 description: Cart ID.
938 price:
939 type: string
940 example: null
941 description: Cart price.
942 is_free:
943 type: boolean
944 description: 'If ''true'', the cart is free.'
945 items:
946 type: array
947 example:
948 - sku: shotgun_raider
949 groups: []
950 name: SHOTGUN FOR TRUE RAIDERS
951 attributes: []
952 media_list: []
953 type: virtual_good
954 price:
955 amount: null
956 amount_without_discount: null
957 currency: USD
958 vc_prices: []
959 long_description: long description
960 description: description
961 image_url: 'http://image.png'
962 promotion: null
963 quantity: 1
964 is_free: true
965 order: 1
966 purchase_limit: null
967 - sku: headphones_for_pro
968 groups: []
969 name: HEADPHONES
970 attributes:
971 stack_size: 5
972 licensed: true
973 media_list: []
974 type: virtual_good
975 price:
976 amount: null
977 amount_without_discount: null
978 currency: USD
979 vc_prices: []
980 long_description: Main Hand (Ranged)
981 description: Binds To Legacy
982 image_url: 'http://static.swtor-spy.com/icons/rifle.bowcasterlow02.a02_v03.png'
983 promotion: null
984 quantity: 2
985 is_free: true
986 order: 1
987 purchase_limit: null
988 - sku: white-short
989 name: Body Skin 3
990 groups: []
991 attributes: []
992 media_list: []
993 type: virtual_good
994 price:
995 amount: null
996 amount_without_discount: null
997 currency: USD
998 vc_prices: []
999 long_description: Body Skin 3 - description
1000 description: Body Skin 3 - short description
1001 image_url: 'https://popmedia.blob.core.windows.net/popyourself/female/body/female_head_skin3-01.png'
1002 promotion: null
1003 quantity: 5
1004 is_free: true
1005 order: 1
1006 purchase_limit: null
1007 description: Object with the items.
1008 items:
1009 type: object
1010 properties:
1011 sku:
1012 type: string
1013 example: shotgun_raider
1014 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
1015 groups:
1016 type: array
1017 example: []
1018 description: Groups the item belongs to (array).
1019 items:
1020 type: object
1021 name:
1022 type: string
1023 example: SHOTGUN FOR TRUE RAIDERS
1024 description: Item name.
1025 attributes:
1026 type: array
1027 example: []
1028 description: Item attributes.
1029 items:
1030 type: string
1031 media_list:
1032 type: array
1033 example: []
1034 deprecated: true
1035 items:
1036 type: string
1037 type:
1038 type: string
1039 example: virtual_good
1040 description: Type of Item.
1041 price:
1042 type: object
1043 description: Item prices.
1044 properties:
1045 amount:
1046 type: string
1047 example: null
1048 description: Item discount price.
1049 amount_without_discount:
1050 type: string
1051 example: null
1052 description: Item price.
1053 currency:
1054 type: string
1055 example: USD
1056 description: Cart currency. Three-letter code per ISO 4217.
1057 vc_prices:
1058 type: array
1059 example: []
1060 description: 'Price in the in-game currency. If ''null'', the item can only be purchased for real currency.'
1061 items:
1062 type: string
1063 long_description:
1064 type: string
1065 example: long description
1066 description: Extended description of the item.
1067 description:
1068 type: string
1069 example: description
1070 description: Item description.
1071 image_url:
1072 type: string
1073 example: 'http://image.png'
1074 description: Image URL.
1075 promotion:
1076 type:
1077 - string
1078 - array
1079 example: null
1080 description: Promotions the item belongs to (array).
1081 items:
1082 type: object
1083 quantity:
1084 type: integer
1085 example: 1
1086 description: Items quantity.
1087 is_free:
1088 type: boolean
1089 description: 'If ''true'', the item is free.'
1090 order:
1091 type: integer
1092 example: 1
1093 deprecated: true
1094 purchase_limit:
1095 type: string
1096 example: null
1097 description: 'Number of times the item can be purchased. If ''null'', there is no limit on the number of purchases.'
1098 examples:
1099 application/json:
1100 cart_id: 1
1101 price: 'null'
1102 is_free: true
1103 items:
1104 - sku: shotgun_raider
1105 groups: []
1106 name: SHOTGUN FOR TRUE RAIDERS
1107 attributes: []
1108 media_list: []
1109 type: virtual_good
1110 price:
1111 amount: null
1112 amount_without_discount: null
1113 currency: USD
1114 vc_prices: []
1115 long_description: long description
1116 description: description
1117 image_url: 'http://image.png'
1118 promotion: null
1119 quantity: 1
1120 is_free: true
1121 order: 1
1122 purchase_limit: null
1123 - sku: headphones_for_pro
1124 groups: []
1125 name: HEADPHONES
1126 attributes:
1127 stack_size: 5
1128 licensed: true
1129 media_list: []
1130 type: virtual_good
1131 price:
1132 amount: null
1133 amount_without_discount: null
1134 currency: USD
1135 vc_prices: []
1136 long_description: Main Hand (Ranged)
1137 description: Binds To Legacy
1138 image_url: 'http://static.swtor-spy.com/icons/rifle.bowcasterlow02.a02_v03.png'
1139 promotion: null
1140 quantity: 2
1141 is_free: true
1142 order: 1
1143 purchase_limit: null
1144 - sku: white-short
1145 name: Body Skin 3
1146 groups: []
1147 attributes: []
1148 media_list: []
1149 type: virtual_good
1150 price:
1151 amount: null
1152 amount_without_discount: null
1153 currency: USD
1154 vc_prices: []
1155 long_description: Body Skin 3 - description
1156 description: Body Skin 3 - short description
1157 image_url: 'https://popmedia.blob.core.windows.net/popyourself/female/body/female_head_skin3-01.png'
1158 promotion: null
1159 quantity: 5
1160 is_free: true
1161 order: 1
1162 purchase_limit: null
1163 '404':
1164 description: The cart wasn’t found. Make sure the `project_id` and the `cart_id` are correct.
1165 schema:
1166 type: object
1167 properties:
1168 statusCode:
1169 type: integer
1170 example: 404
1171 errorCode:
1172 type: integer
1173 example: 1401
1174 errorMessage:
1175 type: string
1176 example: Cart with Id = 155 not found
1177 examples:
1178 application/json:
1179 statusCode: 404
1180 errorCode: 1401
1181 errorMessage: Cart with Id = 155 not found
1182 summary: Get Cart
1183 security:
1184 - XsollaLoginUserJWT: []
1185 - PayStationUserAccessToken: []
1186 parameters:
1187 - name: project_id
1188 in: path
1189 required: true
1190 type: integer
1191 description: Project ID.
1192 default: 44056
1193 - name: cart_id
1194 in: path
1195 required: true
1196 type: integer
1197 description: Cart ID.
1198 default: 3338
1199 - name: currency
1200 in: query
1201 required: false
1202 type: string
1203 description: The currency which prices are displayed (USD by default). Three-letter currency code per ISO 4217.
1204 default: USD
1205 - name: locale
1206 in: query
1207 required: false
1208 type: string
1209 description: Response language. Two-letter lowercase language code per ISO 639-1.
1210 default: en
1211 description: Returns a user's cart.
1212 '/v1/project/{project_id}/cart/{cart_id}/clear':
1213 put:
1214 tags:
1215 - /v1/cart
1216 consumes:
1217 - application/json
1218 produces:
1219 - application/json
1220 responses:
1221 '204':
1222 description: The cart clearing was successful.
1223 '404':
1224 description: The cart wasn’t found. Make sure the `project_id` and the `cart_id` are correct.
1225 schema:
1226 type: object
1227 properties:
1228 statusCode:
1229 type: integer
1230 example: 404
1231 errorCode:
1232 type: integer
1233 example: 1401
1234 errorMessage:
1235 type: string
1236 example: Cart with Id = 155 not found
1237 examples:
1238 application/json:
1239 statusCode: 404
1240 errorCode: 1401
1241 errorMessage: Cart with Id = 155 not found
1242 summary: Delete All Cart Line Items
1243 security:
1244 - XsollaLoginUserJWT: []
1245 - PayStationUserAccessToken: []
1246 parameters:
1247 - name: project_id
1248 in: path
1249 required: true
1250 type: integer
1251 description: Project ID.
1252 default: 44056
1253 - name: cart_id
1254 in: path
1255 required: true
1256 type: integer
1257 description: Cart ID.
1258 default: 3338
1259 description: Deletes all cart line items.
1260 '/v1/project/{project_id}/cart/{cart_id}/item/{item_sku}':
1261 put:
1262 tags:
1263 - /v1/cart
1264 consumes:
1265 - application/json
1266 produces:
1267 - application/json
1268 responses:
1269 '204':
1270 description: The cart was succefully updated.
1271 '404':
1272 description: 'The item or cart weren’t found. Make sure `item_sku` is correct and the item isn’t turned off or deleted, and make sure the `project_id` and the `cart_id` are correct.'
1273 schema:
1274 oneOf:
1275 - properties:
1276 statusCode:
1277 type: integer
1278 example: 404
1279 errorCode:
1280 type: integer
1281 example: 1401
1282 errorMessage:
1283 type: string
1284 example: Cart with Id = 100 not found
1285 - properties:
1286 statusCode:
1287 type: integer
1288 example: 404
1289 errorCode:
1290 type: integer
1291 example: 4001
1292 errorMessage:
1293 type: string
1294 example: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_5 not found'
1295 type: object
1296 examples:
1297 application/json 1:
1298 statusCode: 404
1299 errorCode: 1401
1300 errorMessage: Cart with Id = 100 not found
1301 application/json 2:
1302 statusCode: 404
1303 errorCode: 4001
1304 errorMessage: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_5 not found'
1305 '422':
1306 description: This type of item cannot be put to the cart. Select another type of item.
1307 schema:
1308 type: object
1309 properties:
1310 statusCode:
1311 type: integer
1312 example: 422
1313 errorCode:
1314 type: integer
1315 example: 1421
1316 errorMessage:
1317 type: string
1318 example: Only Virtual Good Supported
1319 examples:
1320 application/json:
1321 statusCode: 422
1322 errorCode: 1421
1323 errorMessage: Only Virtual Good Supported
1324 summary: Update Cart Line Item
1325 security:
1326 - XsollaLoginUserJWT: []
1327 - PayStationUserAccessToken: []
1328 parameters:
1329 - name: project_id
1330 in: path
1331 required: true
1332 type: integer
1333 description: Project ID.
1334 default: 44056
1335 - name: cart_id
1336 in: path
1337 required: true
1338 type: integer
1339 description: Cart ID.
1340 default: 3338
1341 - name: item_sku
1342 in: path
1343 required: true
1344 type: string
1345 description: Item SKU
1346 default: gun_1
1347 - name: json model
1348 in: body
1349 required: false
1350 schema:
1351 type: object
1352 properties:
1353 quantity:
1354 type: number
1355 description: Item quantity.
1356 default: 123
1357 description: |+
1358 Updates an existing line item or creates the one in the cart.
1359
1360 delete:
1361 tags:
1362 - /v1/cart
1363 consumes:
1364 - application/json
1365 produces:
1366 - application/json
1367 responses:
1368 '204':
1369 description: The item from the user’s inventory was successfully consumed.
1370 '404':
1371 description: |
1372 The item was not found or the cart was not found; or the item was not found in the cart. Check:
1373 * the `project_id` and the `cart_id` are correct
1374 * `item_sku` is correct
1375 * the item is actually in the cart
1376 schema:
1377 oneOf:
1378 - properties:
1379 statusCode:
1380 type: integer
1381 example: 404
1382 errorCode:
1383 type: integer
1384 example: 1411
1385 errorMessage:
1386 type: string
1387 example: Item with Id = 3983 not found in cart with Id = 3339
1388 - properties:
1389 statusCode:
1390 type: integer
1391 example: 404
1392 errorCode:
1393 type: integer
1394 example: 1401
1395 errorMessage:
1396 type: string
1397 example: Cart with Id = 3338 not found
1398 - properties:
1399 statusCode:
1400 type: integer
1401 example: 404
1402 errorCode:
1403 type: integer
1404 example: 4001
1405 errorMessage:
1406 type: string
1407 example: '[0401-4001]: Item with Project Id = 44056 and Sku = gu_1 not found'
1408 type: object
1409 examples:
1410 application/json 1:
1411 statusCode: 404
1412 errorCode: 1401
1413 errorMessage: Cart with Id = 3338 not found
1414 application/json 2:
1415 statusCode: 404
1416 errorCode: 1411
1417 errorMessage: Item with Id = 3983 not found in cart with Id = 3339
1418 application/json 3:
1419 statusCode: 404
1420 errorCode: 4001
1421 errorMessage: '[0401-4001]: Item with Project Id = 44056 and Sku = gu_1 not found'
1422 summary: Delete Cart Line Item
1423 security:
1424 - XsollaLoginUserJWT: []
1425 - PayStationUserAccessToken: []
1426 parameters:
1427 - name: project_id
1428 in: path
1429 required: true
1430 type: integer
1431 description: Project ID.
1432 default: 44056
1433 - name: cart_id
1434 in: path
1435 required: true
1436 type: integer
1437 description: Cart ID.
1438 default: 3338
1439 - name: item_sku
1440 in: path
1441 required: true
1442 type: string
1443 description: Item SKU.
1444 default: gun_1
1445 description: |
1446 Consumes the item from the user’s inventory.
1447 '/v1/project/{project_id}/payment/cart/{cart_id}':
1448 post:
1449 tags:
1450 - /v1/payment
1451 consumes:
1452 - application/json
1453 produces:
1454 - application/json
1455 responses:
1456 '200':
1457 description: The order was successfully created.
1458 schema:
1459 type: object
1460 properties:
1461 order_id:
1462 type: integer
1463 description: Order ID.
1464 token:
1465 type: string
1466 description: Payment token.
1467 examples:
1468 application/json:
1469 order_id: 641
1470 token: f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo
1471 '422':
1472 description: 'Invalid cart. Check that the cart exists, is not empty and all items in it are not free.'
1473 schema:
1474 type: object
1475 properties:
1476 errorCode:
1477 type: integer
1478 example: 1401
1479 statusCode:
1480 type: integer
1481 example: 422
1482 errorMessage:
1483 type: string
1484 example: '[0401-1401]: Invalid cart'
1485 examples:
1486 application/json:
1487 errorCode: 1401
1488 statusCode: 422
1489 errorMessage: '[0401-1401]: Invalid cart'
1490 summary: Create Order With All Items
1491 security:
1492 - XsollaLoginUserJWT: []
1493 - PayStationUserAccessToken: []
1494 parameters:
1495 - name: project_id
1496 in: path
1497 required: true
1498 type: integer
1499 description: Project ID.
1500 default: 44056
1501 - name: cart_id
1502 in: path
1503 required: true
1504 type: string
1505 description: Cart ID.
1506 default: '3338'
1507 - name: json model
1508 in: body
1509 required: false
1510 schema:
1511 type: object
1512 properties:
1513 currency:
1514 type: string
1515 description: The currency which prices are displayed (USD by default). Three-letter currency code per ISO 4217.
1516 default: USD
1517 locale:
1518 type: string
1519 description: Response language.
1520 default: en
1521 sandbox:
1522 type: boolean
1523 description: Creates an order in the sandbox mode. The option is available for the company users only.
1524 default: false
1525 description: 'Creates an order with all items from the cart. The created order will be given a “new” order status. To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN, where ACCESS_TOKEN is the received token. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN.'
1526 '/v1/project/{project_id}/payment/item/{item_sku}':
1527 post:
1528 tags:
1529 - /v1/payment
1530 consumes:
1531 - application/json
1532 produces:
1533 - application/json
1534 responses:
1535 '200':
1536 description: Token is created successfully.
1537 schema:
1538 type: object
1539 properties:
1540 order_id:
1541 type: integer
1542 description: Order ID.
1543 token:
1544 type: string
1545 description: Payment token.
1546 examples:
1547 application/json:
1548 order_id: 641
1549 token: f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo
1550 '422':
1551 description: 'Invalid item. Check that item exists, the item is not turned off or deleted,and it is not free.'
1552 schema:
1553 type: object
1554 properties:
1555 errorCode:
1556 type: integer
1557 example: 1411
1558 statusCode:
1559 type: integer
1560 example: 422
1561 errorMessage:
1562 type: string
1563 example: '[0401-1411]: Invalid item'
1564 examples:
1565 application/json:
1566 errorCode: 1411
1567 statusCode: 422
1568 errorMessage: '[0401-1411]: Invalid item'
1569 summary: Create Order With Specified Item
1570 security:
1571 - XsollaLoginUserJWT: []
1572 - PayStationUserAccessToken: []
1573 parameters:
1574 - name: project_id
1575 in: path
1576 required: true
1577 type: integer
1578 description: Project ID.
1579 default: 44056
1580 - name: item_sku
1581 in: path
1582 required: true
1583 type: string
1584 description: Item SKU.
1585 default: gun_1
1586 - name: json model
1587 in: body
1588 required: false
1589 schema:
1590 type: object
1591 properties:
1592 currency:
1593 type: string
1594 description: The currency which prices are displayed (USD by default). Three-letter currency code per ISO 4217.
1595 default: USD
1596 locale:
1597 type: string
1598 description: Response language.
1599 default: en
1600 sandbox:
1601 type: boolean
1602 description: Creates an order in the sandbox mode. The option is available for the company users only.
1603 default: false
1604 description: 'Creates an order with all items from the cart. The created order will be given a “new” order status. To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN, where ACCESS_TOKEN is the received token. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN.'
1605 '/v1/project/{project_id}/user/inventory/items':
1606 get:
1607 tags:
1608 - /v1/inventory
1609 consumes:
1610 - application/json
1611 produces:
1612 - application/json
1613 responses:
1614 '200':
1615 description: The user’s inventory was successfully retrieved.
1616 schema:
1617 type: object
1618 properties:
1619 items:
1620 type: array
1621 example:
1622 - instance_id: aaaabbbbccccddddaaaabbbbccccdddd
1623 sku: instanciated_item
1624 type: virtual_good
1625 name: Rocket
1626 quantity: null
1627 description: Big Rocket - short description
1628 long_description: Big Rocket - description
1629 image_url: 'https://picture.bigrocket.png'
1630 - instance_id: null
1631 sku: shotgun_raider
1632 type: virtual_good
1633 name: SHOTGUN FOR TRUE RAIDERS
1634 quantity: 2
1635 description: description
1636 long_description: long description
1637 image_url: 'http://image.png'
1638 - instance_id: null
1639 sku: headphones_for_pro
1640 type: virtual_good
1641 name: HEADPHONES
1642 quantity: 5
1643 description: ''
1644 long_description: ''
1645 image_url: ''
1646 - instance_id: null
1647 sku: lootbox_without_slots
1648 type: lootbox
1649 name: LOOTBOX 2
1650 quantity: 2
1651 description: ''
1652 long_description: ''
1653 image_url: ''
1654 key: null
1655 open_price:
1656 amount: 750
1657 sku: some_currency
1658 items:
1659 type: object
1660 properties:
1661 instance_id:
1662 type: string
1663 example: aaaabbbbccccddddaaaabbbbccccdddd
1664 description: Instance item ID.
1665 sku:
1666 type: string
1667 example: instanciated_item
1668 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
1669 type:
1670 type: string
1671 example: virtual_good
1672 description: 'Type of Item: Consumable/Expiration/Permanent/Lootboxes/Physical.'
1673 name:
1674 type: string
1675 example: Rocket
1676 description: Item name.
1677 quantity:
1678 type: string
1679 example: null
1680 description: Item quantity.
1681 description:
1682 type: string
1683 example: Big Rocket - short description
1684 description: Item description.
1685 long_description:
1686 type: string
1687 example: Big Rocket - description
1688 description: Extended item description.
1689 image_url:
1690 type: string
1691 example: 'https://picture.bigrocket.png'
1692 description: Image URL.
1693 examples:
1694 application/json:
1695 items:
1696 - instance_id: aaaabbbbccccddddaaaabbbbccccdddd
1697 sku: instanciated_item
1698 type: virtual_good
1699 name: Rocket
1700 quantity: null
1701 description: Big Rocket - short description
1702 long_description: Big Rocket - description
1703 image_url: 'https://picture.bigrocket.png'
1704 - instance_id: null
1705 sku: shotgun_raider
1706 type: virtual_good
1707 name: SHOTGUN FOR TRUE RAIDERS
1708 quantity: 2
1709 description: description
1710 long_description: long description
1711 image_url: 'http://image.png'
1712 - instance_id: null
1713 sku: headphones_for_pro
1714 type: virtual_good
1715 name: HEADPHONES
1716 quantity: 5
1717 description: ''
1718 long_description: ''
1719 image_url: ''
1720 - instance_id: null
1721 sku: lootbox_without_slots
1722 type: lootbox
1723 name: LOOTBOX 2
1724 quantity: 2
1725 description: ''
1726 long_description: ''
1727 image_url: ''
1728 key: null
1729 open_price:
1730 amount: 750
1731 sku: some_currency
1732 security:
1733 - XsollaLoginUserJWT: []
1734 - PayStationUserAccessToken: []
1735 parameters:
1736 - name: project_id
1737 in: path
1738 required: true
1739 type: integer
1740 description: Project ID.
1741 default: 44056
1742 summary: Get User's Inventory
1743 description: |+
1744 Retrieves the user’s inventory.
1745 '/v1/project/{project_id}/user/inventory/item/consume':
1746 post:
1747 tags:
1748 - /v1/inventory
1749 consumes:
1750 - application/json
1751 produces:
1752 - application/json
1753 responses:
1754 '200':
1755 description: |
1756 An item from the user’s inventory was consumed.
1757 '404':
1758 description: 'The item was not found at all, the item was not found in the inventory, or it is not enough (attempt to consume more than the initial number). ''instance_id'' must be 32 characters long.'
1759 schema:
1760 oneOf:
1761 - properties:
1762 statusCode:
1763 type: integer
1764 example: 404
1765 errorCode:
1766 type: integer
1767 example: 5004
1768 errorMessage:
1769 type: string
1770 example: '[0401-5004]: Could not find instance in inventory: Could not remove 112299999344, user only has 12'
1771 - properties:
1772 statusCode:
1773 type: integer
1774 example: 404
1775 errorCode:
1776 type: integer
1777 example: 4001
1778 errorMessage:
1779 type: string
1780 example: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_5 not found'
1781 type: object
1782 examples:
1783 application/json 1:
1784 statusCode: 404
1785 errorCode: 4001
1786 errorMessage: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_5 not found'
1787 application/json 2:
1788 statusCode: 404
1789 errorCode: 5004
1790 errorMessage: '[0401-5004]: Could not find instance in inventory: Could not remove 112299999344, user only has 12'
1791 '422':
1792 description: Both instance_id and quantity are passed. Make sure that only one parameter is passed (instance_id or quantity). 'instance_id' must be 32 characters long
1793 schema:
1794 type: object
1795 properties:
1796 statusCode:
1797 type: integer
1798 example: 422
1799 errorCode:
1800 type: integer
1801 example: 5002
1802 errorMessage:
1803 type: string
1804 example: '[0401-5002]: Quantity either instance id must be null. Item id must be specified'
1805 examples:
1806 application/json:
1807 statusCode: 422
1808 errorCode: 5002
1809 errorMessage: '[0401-5002]: Quantity either instance id must be null. Item id must be specified'
1810 security:
1811 - XsollaLoginUserJWT: []
1812 - PayStationUserAccessToken: []
1813 parameters:
1814 - name: project_id
1815 in: path
1816 required: true
1817 type: integer
1818 description: Project ID.
1819 default: 44056
1820 - name: json model
1821 in: body
1822 required: false
1823 schema:
1824 type: object
1825 properties:
1826 sku:
1827 type: string
1828 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
1829 default: gun_1
1830 quantity:
1831 description: 'Items quantity. If item is uncountable, should be ''null''.'
1832 type:
1833 - number
1834 - 'null'
1835 default: 1
1836 instance_id:
1837 description: 'Instance item ID. If item is countable, should be ''null''.'
1838 type:
1839 - string
1840 - 'null'
1841 default: 'null'
1842 required:
1843 - sku
1844 summary: Consume Item
1845 description: |+
1846 Consumes an item from user’s inventory.
1847
1848 '/v2/project/{project_id}/items/virtual_items':
1849 get:
1850 tags:
1851 - /v2/items
1852 consumes:
1853 - application/json
1854 produces:
1855 - application/json
1856 responses:
1857 '200':
1858 description: The list of items was successfully received.
1859 schema:
1860 type: object
1861 description: Object with items.
1862 properties:
1863 items:
1864 type: array
1865 example:
1866 - sku: big_rocket
1867 name: Big Rocket
1868 groups:
1869 - accessory
1870 attributes:
1871 stack_size: 5
1872 type: virtual_good
1873 description: Big Rocket - description
1874 image_url: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
1875 is_free: false
1876 order: 1
1877 price:
1878 amount: '100.99'
1879 amount_without_discount: '100.99'
1880 currency: USD
1881 vc_prices:
1882 -
1883 amount: 100
1884 sku: vc_test
1885 is_default: true
1886 amount_without_discount: 100
1887 - sku: shotgun_raider
1888 name: SHOTGUN FOR TRUE RAIDERS
1889 groups:
1890 - hair
1891 attributes:
1892 stack_size: 1
1893 rating: '3.9'
1894 tags: '["strategy", "tactical", "turn-based"]'
1895 type: virtual_good
1896 description: description
1897 image_url: 'http://image.png'
1898 is_free: false
1899 order: 1
1900 price:
1901 amount: '101.0'
1902 amount_without_discount: '101.0'
1903 currency: USD
1904 vc_prices:
1905 -
1906 amount: 100
1907 sku: vc_test
1908 is_default: true
1909 amount_without_discount: 100
1910 -
1911 amount: 200
1912 sku: vc_test_2
1913 is_default: false
1914 amount_without_discount: 200
1915 - sku: shotgun_raider_2
1916 name: SHOTGUN FOR TRUE RAIDERS
1917 groups: []
1918 attributes: []
1919 type: virtual_good
1920 description: description
1921 image_url: 'http://image.png'
1922 is_free: true
1923 order: 1
1924 price: null
1925 vc_prices: []
1926 items:
1927 type: object
1928 properties:
1929 sku:
1930 type: string
1931 example: big_rocket
1932 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
1933 name:
1934 type: string
1935 example: Big Rocket
1936 description: Item name.
1937 groups:
1938 type: array
1939 example:
1940 - accessory
1941 description: Groups the item belongs to.
1942 items:
1943 type: string
1944 example: accessory
1945 attributes:
1946 type: object
1947 description: Item attributes.
1948 type:
1949 type: string
1950 example: virtual_good
1951 description: 'Type of Item: Consumable/Expiration/Permanent/Lootboxes/Physical.'
1952 description:
1953 type: string
1954 example: Big Rocket - description
1955 description: Item description.
1956 image_url:
1957 type: string
1958 example: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
1959 description: Image URL.
1960 is_free:
1961 type: string
1962 example: false
1963 description: 'If ''true'', the item is free.'
1964 order:
1965 type: integer
1966 example: 1
1967 description: Defines arragement order.
1968 price:
1969 type: object
1970 description: Item prices.
1971 properties:
1972 amount:
1973 type: string
1974 example: '100.99'
1975 description: Discounted item price.
1976 amount_without_discount:
1977 type: string
1978 example: '100.99'
1979 description: Item price.
1980 currency:
1981 type: string
1982 example: USD
1983 description: Default purchase currency. Three-letter code per ISO 4217.
1984 vc_prices:
1985 type: array
1986 description: Virtual prices
1987 items:
1988 type: object
1989 description: Virtual price
1990 properties:
1991 amount:
1992 type: integer
1993 example: 100
1994 description: Discounted item price in virtual currency.
1995 amount_without_discount:
1996 type: integer
1997 example: 200
1998 description: Item price.
1999 sku:
2000 type: string
2001 example: vc_test
2002 description: Virtual currency item sku.
2003 is_default:
2004 type: boolean
2005 example: true
2006 description: Whether price is default for item
2007 examples:
2008 application/json:
2009 items:
2010 - sku: big_rocket
2011 name: Big Rocket
2012 groups:
2013 - accessory
2014 attributes:
2015 stack_size: 5
2016 type: virtual_good
2017 description: Big Rocket - description
2018 image_url: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
2019 is_free: false
2020 order: 1
2021 price:
2022 amount: '100.99'
2023 amount_without_discount: '100.99'
2024 currency: USD
2025 vc_prices:
2026 -
2027 amount: 100
2028 sku: vc_test
2029 is_default: true
2030 amount_without_discount: 100
2031 - sku: shotgun_raider
2032 name: SHOTGUN FOR TRUE RAIDERS
2033 groups:
2034 - hair
2035 attributes:
2036 stack_size: 1
2037 rating: '3.9'
2038 tags: '["strategy", "tactical", "turn-based"]'
2039 type: virtual_good
2040 description: description
2041 image_url: 'http://image.png'
2042 is_free: false
2043 order: 1
2044 price:
2045 amount: '101.0'
2046 amount_without_discount: '101.0'
2047 currency: USD
2048 vc_prices:
2049 -
2050 amount: 100
2051 sku: vc_test
2052 is_default: true
2053 amount_without_discount: 100
2054 -
2055 amount: 200
2056 sku: vc_test_2
2057 is_default: false
2058 amount_without_discount: 200
2059 - sku: shotgun_raider_2
2060 name: SHOTGUN FOR TRUE RAIDERS
2061 groups: []
2062 attributes: []
2063 type: virtual_good
2064 description: description
2065 image_url: 'http://image.png'
2066 is_free: true
2067 order: 1
2068 price: null
2069 vc_prices: []
2070 parameters:
2071 - name: project_id
2072 in: path
2073 required: true
2074 type: integer
2075 description: Project ID.
2076 default: 44056
2077 - name: limit
2078 in: query
2079 required: false
2080 type: integer
2081 description: Limit for the number of elements on the page.
2082 - name: offset
2083 in: query
2084 required: false
2085 type: integer
2086 description: Number of the element from which the list is generated (the count starts from 0).
2087 - name: locale
2088 in: query
2089 required: false
2090 type: string
2091 description: Response language.
2092 default: en
2093 summary: Get items List
2094 description: Gets an items list for building a catalog.
2095 /v2/project/{project_id}/items/virtual_currency:
2096 get:
2097 tags:
2098 - /v2/items
2099 consumes:
2100 - application/json
2101 produces:
2102 - application/json
2103 responses:
2104 '200':
2105 description: The list of virtual currency was successfully received.
2106 schema:
2107 type: object
2108 description: Object with items.
2109 properties:
2110 items:
2111 type: array
2112 example:
2113 - sku: vc_test
2114 name: Ruble
2115 groups:
2116 - accessory
2117 attributes:
2118 stack_size: 5
2119 type: virtual_currency
2120 description: Ruble
2121 image_url: null
2122 is_free: false
2123 order: 1
2124 price:
2125 amount: '100.99'
2126 amount_without_discount: '100.99'
2127 currency: USD
2128 vc_prices: []
2129 - sku: vc_test_2
2130 name: Xsollar
2131 groups: []
2132 attributes: []
2133 type: virtual_currency
2134 description: description
2135 image_url: 'http://image.png'
2136 is_free: true
2137 order: 1
2138 price: null
2139 vc_prices: []
2140 items:
2141 type: object
2142 properties:
2143 sku:
2144 type: string
2145 example: big_rocket
2146 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
2147 name:
2148 type: string
2149 example: Big Rocket
2150 description: Item name.
2151 groups:
2152 type: array
2153 example:
2154 - accessory
2155 description: Groups the item belongs to.
2156 items:
2157 type: string
2158 example: accessory
2159 attributes:
2160 type: object
2161 description: Item attributes.
2162 type:
2163 type: string
2164 example: virtual_currency
2165 description: 'Type of Item: virtual_good/virtual_currency/bundle'
2166 description:
2167 type: string
2168 example: Big Rocket - description
2169 description: Item description.
2170 image_url:
2171 type: string
2172 example: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
2173 description: Image URL.
2174 is_free:
2175 type: string
2176 example: false
2177 description: 'If ''true'', the item is free.'
2178 order:
2179 type: integer
2180 example: 1
2181 description: Defines arragement order.
2182 price:
2183 type: object
2184 description: Item prices.
2185 properties:
2186 amount:
2187 type: string
2188 example: '100.99'
2189 description: Discounted item price.
2190 amount_without_discount:
2191 type: string
2192 example: '100.99'
2193 description: Item price.
2194 currency:
2195 type: string
2196 example: USD
2197 description: Default purchase currency. Three-letter code per ISO 4217.
2198 vc_prices:
2199 type: array
2200 description: Virtual prices
2201 items:
2202 type: object
2203 description: Virtual price
2204 properties:
2205 amount:
2206 type: integer
2207 example: 100
2208 description: Discounted item price in virtual currency.
2209 amount_without_discount:
2210 type: integer
2211 example: 200
2212 description: Item price.
2213 sku:
2214 type: string
2215 example: vc_test
2216 description: Virtual currency item sku.
2217 is_default:
2218 type: boolean
2219 example: true
2220 description: Whether price is default for item
2221 examples:
2222 application/json:
2223 items:
2224 - sku: vc_test
2225 name: Ruble
2226 groups:
2227 - accessory
2228 attributes:
2229 stack_size: 5
2230 type: virtual_currency
2231 description: Ruble
2232 image_url: null
2233 is_free: false
2234 order: 1
2235 price:
2236 amount: '100.99'
2237 amount_without_discount: '100.99'
2238 currency: USD
2239 vc_prices: []
2240 - sku: vc_test_2
2241 name: Xsollar
2242 groups: []
2243 attributes: []
2244 type: virtual_currency
2245 description: description
2246 image_url: 'http://image.png'
2247 is_free: true
2248 order: 1
2249 price: null
2250 vc_prices: []
2251 parameters:
2252 - name: project_id
2253 in: path
2254 required: true
2255 type: integer
2256 description: Project ID.
2257 default: 44056
2258 - name: limit
2259 in: query
2260 required: false
2261 type: integer
2262 description: Limit for the number of elements on the page.
2263 - name: offset
2264 in: query
2265 required: false
2266 type: integer
2267 description: Number of the element from which the list is generated (the count starts from 0).
2268 - name: locale
2269 in: query
2270 required: false
2271 type: string
2272 description: Response language.
2273 default: en
2274 summary: Get virtual currency List
2275 description: Gets an virtual currency list for building a catalog.
2276 /v2/project/{project_id}/items/virtual_currency/package:
2277 get:
2278 tags:
2279 - /v2/items
2280 consumes:
2281 - application/json
2282 produces:
2283 - application/json
2284 responses:
2285 '200':
2286 description: The list of virtual currency package was successfully received.
2287 schema:
2288 type: object
2289 description: Object with items.
2290 properties:
2291 items:
2292 type: array
2293 example:
2294 - sku: vc_package_1
2295 name: Ruble x500
2296 groups:
2297 - accessory
2298 attributes:
2299 stack_size: 5
2300 type: bundle
2301 bundle_type: virtual_currency_package
2302 description: Ruble package
2303 image_url: null
2304 is_free: false
2305 order: 1
2306 price:
2307 amount: '100.99'
2308 amount_without_discount: '100.99'
2309 currency: USD
2310 vc_prices: []
2311 content:
2312 -
2313 sku: vc_test
2314 name: Ruble
2315 type: virtual_currency
2316 description: Ruble
2317 image_url: null
2318 quantity: 500
2319 - sku: vc_package_2
2320 name: Xsollar x250
2321 groups: []
2322 attributes: []
2323 type: bundle
2324 bundle_type: virtual_currency_package
2325 description: description
2326 image_url: 'http://image.png'
2327 is_free: true
2328 order: 1
2329 price: null
2330 vc_prices: []
2331 content:
2332 -
2333 sku: vc_test2
2334 name: Xsollar
2335 type: virtual_currency
2336 description: Xsollar
2337 image_url: null
2338 quantity: 250
2339 items:
2340 type: object
2341 properties:
2342 sku:
2343 type: string
2344 example: big_rocket
2345 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
2346 name:
2347 type: string
2348 example: Big Rocket
2349 description: Item name.
2350 groups:
2351 type: array
2352 example:
2353 - accessory
2354 description: Groups the item belongs to.
2355 items:
2356 type: string
2357 example: accessory
2358 attributes:
2359 type: object
2360 description: Item attributes.
2361 type:
2362 type: string
2363 example: bundle
2364 description: 'Type of Item: virtual_good/virtual_currency/bundle'
2365 bundle_type:
2366 type: string
2367 example: virtual_currency_package
2368 description: 'Type of Bundle: standard/virtual_currency_package'
2369 description:
2370 type: string
2371 example: Big Rocket - description
2372 description: Item description.
2373 image_url:
2374 type: string
2375 example: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
2376 description: Image URL.
2377 is_free:
2378 type: string
2379 example: false
2380 description: 'If ''true'', the item is free.'
2381 order:
2382 type: integer
2383 example: 1
2384 description: Defines arragement order.
2385 price:
2386 type: object
2387 description: Item prices.
2388 properties:
2389 amount:
2390 type: string
2391 example: '100.99'
2392 description: Discounted item price.
2393 amount_without_discount:
2394 type: string
2395 example: '100.99'
2396 description: Item price.
2397 currency:
2398 type: string
2399 example: USD
2400 description: Default purchase currency. Three-letter code per ISO 4217.
2401 vc_prices:
2402 type: array
2403 description: Virtual prices
2404 items:
2405 type: object
2406 description: Virtual price
2407 properties:
2408 amount:
2409 type: integer
2410 example: 100
2411 description: Discounted item price in virtual currency.
2412 amount_without_discount:
2413 type: integer
2414 example: 200
2415 description: Item price.
2416 sku:
2417 type: string
2418 example: vc_test
2419 description: Virtual currency item sku.
2420 is_default:
2421 type: boolean
2422 example: true
2423 description: Whether price is default for item
2424 content:
2425 type: array
2426 description: Virtual Currency Package Content
2427 items:
2428 type: object
2429 description: Virtual currency in package
2430 properties:
2431 sku:
2432 type: string
2433 example: big_rocket
2434 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
2435 name:
2436 type: string
2437 example: Big Rocket
2438 description: Item name.
2439 type:
2440 type: string
2441 example: virtual_currency
2442 description: 'Type of Item: virtual_good/virtual_currency/bundle'
2443 description:
2444 type: string
2445 example: Big Rocket - description
2446 description: Item description.
2447 image_url:
2448 type: string
2449 example: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
2450 description: Image URL.
2451 quantity:
2452 type: integer
2453 example: 250
2454 description: Quantity of virtual currency in package
2455 examples:
2456 application/json:
2457 items:
2458 - sku: vc_package_1
2459 name: Ruble x500
2460 groups:
2461 - accessory
2462 attributes:
2463 stack_size: 5
2464 type: bundle
2465 bundle_type: virtual_currency_package
2466 description: Ruble package
2467 image_url: null
2468 is_free: false
2469 order: 1
2470 price:
2471 amount: '100.99'
2472 amount_without_discount: '100.99'
2473 currency: USD
2474 vc_prices: []
2475 content:
2476 -
2477 sku: vc_test
2478 name: Ruble
2479 type: virtual_currency
2480 description: Ruble
2481 image_url: null
2482 quantity: 500
2483 - sku: vc_package_2
2484 name: Xsollar x250
2485 groups: []
2486 attributes: []
2487 type: bundle
2488 bundle_type: virtual_currency_package
2489 description: description
2490 image_url: 'http://image.png'
2491 is_free: true
2492 order: 1
2493 price: null
2494 vc_prices: []
2495 content:
2496 -
2497 sku: vc_test2
2498 name: Xsollar
2499 type: virtual_currency
2500 description: Xsollar
2501 image_url: null
2502 quantity: 250
2503 parameters:
2504 - name: project_id
2505 in: path
2506 required: true
2507 type: integer
2508 description: Project ID.
2509 default: 44056
2510 - name: limit
2511 in: query
2512 required: false
2513 type: integer
2514 description: Limit for the number of elements on the page.
2515 - name: offset
2516 in: query
2517 required: false
2518 type: integer
2519 description: Number of the element from which the list is generated (the count starts from 0).
2520 - name: locale
2521 in: query
2522 required: false
2523 type: string
2524 description: Response language.
2525 default: en
2526 summary: Get virtual currency package List
2527 description: Gets an virtual currency package list for building a catalog.
2528 '/v2/project/{project_id}/items/virtual_items/group/{external_id}':
2529 get:
2530 tags:
2531 - /v2/items
2532 consumes:
2533 - application/json
2534 produces:
2535 - application/json
2536 responses:
2537 '200':
2538 description: The list of items was successfully received.
2539 schema:
2540 type: object
2541 properties:
2542 items:
2543 type: array
2544 example:
2545 - sku: big_rocket
2546 name: Big Rocket
2547 groups:
2548 - accessory
2549 attributes:
2550 stack_size: 5
2551 type: virtual_good
2552 description: Big Rocket - description
2553 image_url: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
2554 is_free: false
2555 order: 1
2556 price:
2557 amount: '100.99'
2558 amount_without_discount: '100.99'
2559 currency: USD
2560 vc_prices:
2561 -
2562 amount: 100
2563 sku: vc_test
2564 is_default: true
2565 amount_without_discount: 100
2566 - sku: shotgun_raider
2567 name: SHOTGUN FOR TRUE RAIDERS
2568 groups:
2569 - hair
2570 attributes:
2571 stack_size: 1
2572 rating: '3.9'
2573 tags: '["strategy", "tactical", "turn-based"]'
2574 type: virtual_good
2575 description: description
2576 image_url: 'http://image.png'
2577 is_free: false
2578 order: 1
2579 price:
2580 amount: '101.0'
2581 amount_without_discount: '101.0'
2582 currency: USD
2583 vc_prices:
2584 -
2585 amount: 100
2586 sku: vc_test
2587 is_default: true
2588 amount_without_discount: 100
2589 -
2590 amount: 200
2591 sku: vc_test_2
2592 is_default: false
2593 amount_without_discount: 200
2594 - sku: shotgun_raider_2
2595 name: SHOTGUN FOR TRUE RAIDERS
2596 groups: []
2597 attributes: []
2598 type: virtual_good
2599 description: description
2600 image_url: 'http://image.png'
2601 is_free: true
2602 order: 1
2603 price: null
2604 vc_prices: []
2605 items:
2606 type: object
2607 properties:
2608 sku:
2609 type: string
2610 example: big_rocket
2611 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
2612 name:
2613 type: string
2614 example: Big Rocket
2615 description: Item name.
2616 groups:
2617 type: array
2618 example:
2619 - accessory
2620 description: Groups the item belongs to.
2621 items:
2622 type: string
2623 example: accessory
2624 attributes:
2625 type: object
2626 description: Item attributes.
2627 type:
2628 type: string
2629 example: virtual_good
2630 description: 'Type of Item: Consumable/Expiration/Permanent/Lootboxes/Physical.'
2631 description:
2632 type: string
2633 example: Big Rocket - description
2634 description: Item description.
2635 image_url:
2636 type: string
2637 example: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
2638 description: Image URL.
2639 is_free:
2640 type: string
2641 example: false
2642 description: 'If ''true'', the item is free.'
2643 order:
2644 type: integer
2645 example: 1
2646 description: Defines arragement order.
2647 price:
2648 type: object
2649 description: Item prices.
2650 properties:
2651 amount:
2652 type: string
2653 example: '100.99'
2654 description: Discounted item price.
2655 amount_without_discount:
2656 type: string
2657 example: '100.99'
2658 description: Item price.
2659 currency:
2660 type: string
2661 example: USD
2662 description: Default purchase currency. Three-letter code per ISO 4217.
2663 vc_prices:
2664 type: array
2665 description: Virtual prices
2666 items:
2667 type: object
2668 description: Virtual price
2669 properties:
2670 amount:
2671 type: integer
2672 example: 100
2673 description: Discounted item price in virtual currency.
2674 amount_without_discount:
2675 type: integer
2676 example: 200
2677 description: Item price.
2678 sku:
2679 type: string
2680 example: vc_test
2681 description: Virtual currency item sku.
2682 is_default:
2683 type: boolean
2684 example: true
2685 description: Whether price is default for item
2686 examples:
2687 application/json:
2688 items:
2689 - sku: big_rocket
2690 name: Big Rocket
2691 groups:
2692 - accessory
2693 attributes:
2694 stack_size: 5
2695 type: virtual_good
2696 description: Big Rocket - description
2697 image_url: 'https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png'
2698 is_free: false
2699 order: 1
2700 price:
2701 amount: '100.99'
2702 amount_without_discount: '100.99'
2703 currency: USD
2704 vc_prices:
2705 -
2706 amount: 100
2707 sku: vc_test
2708 is_default: true
2709 amount_without_discount: 100
2710 - sku: shotgun_raider
2711 name: SHOTGUN FOR TRUE RAIDERS
2712 groups:
2713 - hair
2714 attributes:
2715 stack_size: 1
2716 rating: '3.9'
2717 tags: '["strategy", "tactical", "turn-based"]'
2718 type: virtual_good
2719 description: description
2720 image_url: 'http://image.png'
2721 is_free: false
2722 order: 1
2723 price:
2724 amount: '101.0'
2725 amount_without_discount: '101.0'
2726 currency: USD
2727 vc_prices:
2728 -
2729 amount: 100
2730 sku: vc_test
2731 is_default: true
2732 amount_without_discount: 100
2733 -
2734 amount: 200
2735 sku: vc_test_2
2736 is_default: false
2737 amount_without_discount: 200
2738 - sku: shotgun_raider_2
2739 name: SHOTGUN FOR TRUE RAIDERS
2740 groups: []
2741 attributes: []
2742 type: virtual_good
2743 description: description
2744 image_url: 'http://image.png'
2745 is_free: true
2746 order: 1
2747 price: null
2748 vc_prices: []
2749 '404':
2750 description: The group wasn’t found. Make sure that the `external_id` is correct and the group isn’t turned off or deleted.
2751 schema:
2752 type: object
2753 properties:
2754 statusCode:
2755 type: integer
2756 example: 404
2757 errorCode:
2758 type: integer
2759 example: 4403
2760 errorMessage:
2761 type: string
2762 example: '[0401-4403]: Item group not found'
2763 examples:
2764 application/json:
2765 statusCode: 404
2766 errorCode: 4403
2767 errorMessage: '[0401-4403]: Item group not found'
2768 parameters:
2769 - name: project_id
2770 in: path
2771 required: true
2772 type: integer
2773 description: Project ID.
2774 default: 44056
2775 - name: external_id
2776 in: path
2777 required: true
2778 type: string
2779 description: Group external ID.
2780 default: featured
2781 - name: limit
2782 in: query
2783 required: false
2784 type: integer
2785 description: Limit for the number of elements on the page.
2786 - name: offset
2787 in: query
2788 required: false
2789 type: integer
2790 description: Number of the element from which the list is generated (the count starts from 0).
2791 - name: locale
2792 in: query
2793 required: false
2794 type: integer
2795 description: Response language.
2796 default: en
2797 summary: Get Items List by Specified Group
2798 description: |
2799 Gets a list of items from the specified group for building a catalog.
2800 '/v2/project/{project_id}/items/groups':
2801 get:
2802 tags:
2803 - /v2/groups
2804 consumes:
2805 - application/json
2806 produces:
2807 - application/json
2808 responses:
2809 '200':
2810 description: The list of items was successfully received.
2811 schema:
2812 type: object
2813 properties:
2814 groups:
2815 type: array
2816 example:
2817 - id: 4
2818 external_id: hair
2819 name: __tn_funko_virtual_good_category_name_hair
2820 description: __tn_funko_virtual_good_category_description_hair
2821 image_url: null
2822 order: 1
2823 level: 0
2824 children:
2825 - id: 2
2826 external_id: background
2827 name: __tn_funko_virtual_good_category_name_background
2828 description: __tn_funko_virtual_good_category_description_background
2829 image_url: null
2830 order: 1
2831 level: 1
2832 children:
2833 - id: 1
2834 external_id: accessory
2835 name: Accessory
2836 description: Accessory
2837 image_url: null
2838 order: 1
2839 level: 2
2840 children: []
2841 parent_external_id: background
2842 parent_external_id: hair
2843 parent_external_id: null
2844 - id: 8
2845 external_id: group_external_id
2846 name: __tn_Item_group_super
2847 description: __tn_Super_item_group_for_the_best_items
2848 image_url: null
2849 order: 1
2850 level: 0
2851 children: []
2852 parent_external_id: null
2853 items:
2854 type: object
2855 properties:
2856 id:
2857 type: integer
2858 example: 4
2859 description: Group ID.
2860 external_id:
2861 type: string
2862 example: hair
2863 description: External group ID.
2864 name:
2865 type: string
2866 example: __tn_funko_virtual_good_category_name_hair
2867 description: Group name.
2868 description:
2869 type: string
2870 example: __tn_funko_virtual_good_category_description_hair
2871 description: Group description.
2872 image_url:
2873 type: string
2874 example: null
2875 description: Image URL.
2876 order:
2877 type: integer
2878 example: 1
2879 description: Defines arrangement order.
2880 level:
2881 type: integer
2882 example: 0
2883 description: Group nesting level.
2884 children:
2885 type: array
2886 example:
2887 - id: 2
2888 external_id: background
2889 name: __tn_funko_virtual_good_category_name_background
2890 description: __tn_funko_virtual_good_category_description_background
2891 image_url: null
2892 order: 1
2893 level: 1
2894 children:
2895 - id: 1
2896 external_id: accessory
2897 name: Accessory
2898 description: Accessory
2899 image_url: null
2900 order: 1
2901 level: 2
2902 children: []
2903 parent_external_id: background
2904 parent_external_id: hair
2905 description: Child groups.
2906 items:
2907 type: object
2908 properties:
2909 id:
2910 type: integer
2911 example: 2
2912 description: Group ID.
2913 external_id:
2914 type: string
2915 example: background
2916 description: External group ID.
2917 name:
2918 type: string
2919 example: __tn_funko_virtual_good_category_name_background
2920 description: Group name.
2921 description:
2922 type: string
2923 example: __tn_funko_virtual_good_category_description_background
2924 description: Group description.
2925 image_url:
2926 type: string
2927 example: null
2928 description: Group image url.
2929 order:
2930 type: integer
2931 example: 1
2932 description: Defines arrangement order.
2933 level:
2934 type: integer
2935 example: 1
2936 description: Group nesting level.
2937 children:
2938 type: array
2939 example:
2940 - id: 1
2941 external_id: accessory
2942 name: Accessory
2943 description: Accessory
2944 image_url: null
2945 order: 1
2946 level: 2
2947 children: []
2948 parent_external_id: background
2949 description: Child groups.
2950 items:
2951 type: object
2952 properties:
2953 id:
2954 type: integer
2955 example: 1
2956 description: Group ID.
2957 external_id:
2958 type: string
2959 example: accessory
2960 description: External group ID.
2961 name:
2962 type: string
2963 example: Accessory
2964 description: Group name.
2965 description:
2966 type: string
2967 example: Accessory
2968 description: Group description.
2969 image_url:
2970 type: string
2971 example: null
2972 description: Image URL.
2973 order:
2974 type: integer
2975 example: 1
2976 description: Defines arrangement order.
2977 level:
2978 type: integer
2979 example: 2
2980 description: Group nesting level.
2981 children:
2982 type: array
2983 example: []
2984 description: Child groups.
2985 items:
2986 type: string
2987 parent_external_id:
2988 type: string
2989 example: background
2990 description: Parent external group ID.
2991 parent_external_id:
2992 type: string
2993 example: hair
2994 description: Parent external group ID.
2995 parent_external_id:
2996 type: string
2997 example: null
2998 description: Parent external group ID.
2999 examples:
3000 application/json:
3001 groups:
3002 - id: 1
3003 external_id: accessory
3004 name: Accessory
3005 description: Accessory
3006 image_url: null
3007 level: 0
3008 order: 1
3009 children: []
3010 parent_external_id: null
3011 - id: 2
3012 external_id: background
3013 name: Background
3014 description: Background
3015 image_url: null
3016 level: 0
3017 order: 1
3018 children: []
3019 parent_external_id: null
3020 - id: 3
3021 external_id: hair
3022 name: Hair
3023 description: Hair
3024 image_url: null
3025 level: 0
3026 order: 1
3027 children: []
3028 parent_external_id: null
3029 - id: 4
3030 external_id: outfit
3031 name: Outfit
3032 description: Outfit
3033 image_url: null
3034 level: 0
3035 order: 1
3036 children: []
3037 parent_external_id: null
3038 - id: 5
3039 external_id: body
3040 name: Body
3041 description: Body
3042 image_url: null
3043 level: 0
3044 order: 1
3045 children: []
3046 parent_external_id: null
3047 - id: 26
3048 external_id: delete_group
3049 name: Body
3050 description: Body
3051 image_url: null
3052 level: 0
3053 order: 1
3054 children: []
3055 parent_external_id: null
3056 - id: 27
3057 external_id: new_group_external_id_test_nastya
3058 name: Very cool group
3059 description: Very cool group
3060 image_url: null
3061 level: 0
3062 order: 1
3063 children:
3064 - id: 30
3065 external_id: prod_tag_01_edited
3066 name: Test group secure
3067 description: Group description
3068 image_url: 'http://static.xsolla.com/img/xsolla-logo2.png'
3069 level: 1
3070 order: 5
3071 children: []
3072 parent_external_id: new_group_external_id_test_nastya
3073 parent_external_id: null
3074 - id: 33
3075 external_id: ext_id_20190808_1_prod_tag
3076 name: Test group secure
3077 description: Group description
3078 image_url: 'http://static.xsolla.com/img/xsolla-logo2.png'
3079 level: 0
3080 order: 1
3081 children:
3082 - id: 34
3083 external_id: ext_id_20190808_1_split_cur
3084 name: Test group secure
3085 description: Group description
3086 image_url: 'http://static.xsolla.com/img/xsolla-logo2.png'
3087 level: 1
3088 order: 1
3089 children: []
3090 parent_external_id: ext_id_20190808_1_prod_tag
3091 parent_external_id: null
3092 summary: Get Items Groups List
3093 parameters:
3094 - name: project_id
3095 in: path
3096 required: true
3097 type: integer
3098 description: Project ID.
3099 default: 44056
3100 description: |
3101 Gets a list of items for building a catalog.
3102 '/v2/project/{project_id}/order/{order_id}':
3103 get:
3104 tags:
3105 - /v2/order
3106 consumes:
3107 - application/json
3108 produces:
3109 - application/json
3110 responses:
3111 '200':
3112 description: A successful order request.
3113 schema:
3114 type: object
3115 properties:
3116 order_id:
3117 type: integer
3118 example: 1
3119 default: Order ID.
3120 description: Order ID.
3121 status:
3122 type: string
3123 example: paid
3124 description: Order status. May be new/paid/canceled/delivered".
3125 content:
3126 type: object
3127 description: Order details.
3128 properties:
3129 price:
3130 type: object
3131 description: Order price.
3132 properties:
3133 amount:
3134 type: string
3135 example: '30'
3136 description: Order discount price.
3137 amount_without_discount:
3138 type: string
3139 example: '30'
3140 description: Order price.
3141 currency:
3142 type: string
3143 example: USD
3144 description: Default purchase currency. Three-letter code per ISO 4217.
3145 price_vc:
3146 type: object
3147 description: Order price in virtual currency.
3148 properties:
3149 amount:
3150 type: integer
3151 example: 100
3152 description: Order discount price.
3153 amount_without_discount:
3154 type: string
3155 example: 150
3156 description: Order price.
3157 currency:
3158 type: string
3159 example: test_vc
3160 description: Virtual Currency Sku, used in order.
3161 is_free:
3162 type: string
3163 example: false
3164 description: 'If ''true'', the order is free.'
3165 items:
3166 type: array
3167 example:
3168 - sku: some_sku
3169 quantity: 1
3170 is_free: false
3171 price:
3172 amount: '30'
3173 amount_without_discount: '30'
3174 currency: USD
3175 description: Items list.
3176 items:
3177 type: object
3178 properties:
3179 sku:
3180 type: string
3181 example: some_sku
3182 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
3183 quantity:
3184 type: integer
3185 example: 1
3186 description: Item quantity.
3187 is_free:
3188 type: string
3189 example: false
3190 description: 'If ''true'', the item is free.'
3191 price:
3192 type: object
3193 description: Item price.
3194 properties:
3195 amount:
3196 type: string
3197 example: '30'
3198 description: Discounted item price.
3199 amount_without_discount:
3200 type: string
3201 example: '30'
3202 description: Item price.
3203 currency:
3204 type: string
3205 example: USD
3206 description: Default purchase currency. Three-letter code per ISO 4217.
3207 examples:
3208 application/json:
3209 order_id: 1
3210 status: paid
3211 content:
3212 price:
3213 amount: '30'
3214 amount_without_discount: '30'
3215 currency: USD
3216 is_free: 'false'
3217 items:
3218 - sku: some_sku
3219 quantity: 1
3220 is_free: false
3221 price:
3222 amount: '30'
3223 amount_without_discount: '30'
3224 currency: USD
3225 '404':
3226 description: The order wasn’t found. Make sure the `project_it` and the `order_id` are correct.
3227 schema:
3228 type: object
3229 properties:
3230 statusCode:
3231 type: integer
3232 example: 404
3233 errorCode:
3234 type: integer
3235 example: 9001
3236 errorMessage:
3237 type: string
3238 example: '[0401-9001]: Order not found'
3239 examples:
3240 application/json:
3241 statusCode: 404
3242 errorCode: 9001
3243 errorMessage: '[0401-9001]: Order not found'
3244 security:
3245 - XsollaLoginUserJWT: []
3246 - PayStationUserAccessToken: []
3247 parameters:
3248 - name: project_id
3249 in: path
3250 required: true
3251 type: integer
3252 description: Project ID.
3253 default: 44056
3254 - name: order_id
3255 in: path
3256 required: true
3257 type: string
3258 description: Order ID.
3259 default: '656'
3260 summary: Get Order
3261 description: |+
3262 Retrieves a specified order.
3263 '/v2/project/{project_id}/cart/{cart_id}':
3264 get:
3265 tags:
3266 - /v2/cart
3267 consumes:
3268 - application/json
3269 produces:
3270 - application/json
3271 responses:
3272 '200':
3273 description: The cart with items was successfully returned.
3274 schema:
3275 type: object
3276 properties:
3277 cart_id:
3278 type: string
3279 example: current
3280 description: Cart ID.
3281 price:
3282 type: string
3283 example: null
3284 description: Cart price.
3285 is_free:
3286 type: boolean
3287 description: 'If ''true'', the cart is free.'
3288 items:
3289 type: array
3290 example:
3291 - sku: shotgun_raider
3292 groups: []
3293 name: SHOTGUN FOR TRUE RAIDERS
3294 attributes: []
3295 media_list: []
3296 type: virtual_good
3297 price:
3298 amount: null
3299 amount_without_discount: null
3300 currency: USD
3301 vc_prices: []
3302 long_description: long description
3303 description: description
3304 image_url: 'http://image.png'
3305 promotion: null
3306 quantity: 1
3307 is_free: true
3308 order: 1
3309 purchase_limit: null
3310 - sku: headphones_for_pro
3311 groups: []
3312 name: HEADPHONES
3313 attributes:
3314 stack_size: 5
3315 licensed: true
3316 media_list: []
3317 type: virtual_good
3318 price:
3319 amount: null
3320 amount_without_discount: null
3321 currency: USD
3322 vc_prices: []
3323 long_description: Main Hand (Ranged)
3324 description: Binds To Legacy
3325 image_url: 'http://static.swtor-spy.com/icons/rifle.bowcasterlow02.a02_v03.png'
3326 promotion: null
3327 quantity: 2
3328 is_free: true
3329 order: 1
3330 purchase_limit: null
3331 - sku: white-short
3332 name: Body Skin 3
3333 groups: []
3334 attributes: []
3335 media_list: []
3336 type: virtual_good
3337 price:
3338 amount: null
3339 amount_without_discount: null
3340 currency: USD
3341 vc_prices: []
3342 long_description: Body Skin 3 - description
3343 description: Body Skin 3 - short description
3344 image_url: 'https://popmedia.blob.core.windows.net/popyourself/female/body/female_head_skin3-01.png'
3345 promotion: null
3346 quantity: 5
3347 is_free: true
3348 order: 1
3349 purchase_limit: null
3350 description: Object with the items.
3351 items:
3352 type: object
3353 properties:
3354 sku:
3355 type: string
3356 example: shotgun_raider
3357 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
3358 groups:
3359 type: array
3360 example: []
3361 description: Groups the item belongs to (array).
3362 items:
3363 type: object
3364 name:
3365 type: string
3366 example: SHOTGUN FOR TRUE RAIDERS
3367 description: Item name.
3368 attributes:
3369 type: array
3370 example: []
3371 description: Item attributes.
3372 items:
3373 type: string
3374 media_list:
3375 type: array
3376 example: []
3377 deprecated: true
3378 items:
3379 type: string
3380 type:
3381 type: string
3382 example: virtual_good
3383 description: Type of Item.
3384 price:
3385 type: object
3386 description: Item prices.
3387 properties:
3388 amount:
3389 type: string
3390 example: null
3391 description: Item discount price.
3392 amount_without_discount:
3393 type: string
3394 example: null
3395 description: Item price.
3396 currency:
3397 type: string
3398 example: USD
3399 description: Cart currency. Three-letter code per ISO 4217.
3400 vc_prices:
3401 type: array
3402 example: []
3403 description: 'Price in the in-game currency. If ''null'', the item can only be purchased for real currency.'
3404 items:
3405 type: string
3406 long_description:
3407 type: string
3408 example: long description
3409 description: Extended description of the item.
3410 description:
3411 type: string
3412 example: description
3413 description: Item description.
3414 image_url:
3415 type: string
3416 example: 'http://image.png'
3417 description: Image URL.
3418 promotion:
3419 type:
3420 - string
3421 - array
3422 example: null
3423 description: Promotions the item belongs to (array).
3424 items:
3425 type: object
3426 quantity:
3427 type: integer
3428 example: 1
3429 description: Items quantity.
3430 is_free:
3431 type: boolean
3432 description: 'If ''true'', the item is free.'
3433 order:
3434 type: integer
3435 example: 1
3436 deprecated: true
3437 purchase_limit:
3438 type: string
3439 example: null
3440 description: 'Number of times the item can be purchased. If ''null'', there is no limit on the number of purchases.'
3441 examples:
3442 application/json:
3443 cart_id: current
3444 price: 'null'
3445 is_free: true
3446 items:
3447 - sku: shotgun_raider
3448 groups: []
3449 name: SHOTGUN FOR TRUE RAIDERS
3450 attributes: []
3451 media_list: []
3452 type: virtual_good
3453 price:
3454 amount: null
3455 amount_without_discount: null
3456 currency: USD
3457 vc_prices: []
3458 long_description: long description
3459 description: description
3460 image_url: 'http://image.png'
3461 promotion: null
3462 quantity: 1
3463 is_free: true
3464 order: 1
3465 purchase_limit: null
3466 - sku: headphones_for_pro
3467 groups: []
3468 name: HEADPHONES
3469 attributes:
3470 stack_size: 5
3471 licensed: true
3472 media_list: []
3473 type: virtual_good
3474 price:
3475 amount: null
3476 amount_without_discount: null
3477 currency: USD
3478 vc_prices: []
3479 long_description: Main Hand (Ranged)
3480 description: Binds To Legacy
3481 image_url: 'http://static.swtor-spy.com/icons/rifle.bowcasterlow02.a02_v03.png'
3482 promotion: null
3483 quantity: 2
3484 is_free: true
3485 order: 1
3486 purchase_limit: null
3487 - sku: white-short
3488 name: Body Skin 3
3489 groups: []
3490 attributes: []
3491 media_list: []
3492 type: virtual_good
3493 price:
3494 amount: null
3495 amount_without_discount: null
3496 currency: USD
3497 vc_prices: []
3498 long_description: Body Skin 3 - description
3499 description: Body Skin 3 - short description
3500 image_url: 'https://popmedia.blob.core.windows.net/popyourself/female/body/female_head_skin3-01.png'
3501 promotion: null
3502 quantity: 5
3503 is_free: true
3504 order: 1
3505 purchase_limit: null
3506 summary: Get Cart
3507 security:
3508 - XsollaLoginUserJWT: []
3509 - PayStationUserAccessToken: []
3510 parameters:
3511 - name: project_id
3512 in: path
3513 required: true
3514 type: integer
3515 description: Project ID.
3516 default: 44056
3517 - name: cart_id
3518 in: path
3519 required: true
3520 type: string
3521 description: Cart ID.
3522 default: custom_id
3523 - name: currency
3524 in: query
3525 required: false
3526 type: string
3527 description: The currency which prices are displayed (USD by default). Three-letter currency code per ISO 4217.
3528 default: USD
3529 - name: locale
3530 in: query
3531 required: false
3532 type: string
3533 description: Response language. Two-letter lowercase language code per ISO 639-1.
3534 default: en
3535 description: Returns a user's cart.
3536 '/v2/project/{project_id}/cart':
3537 get:
3538 tags:
3539 - /v2/cart
3540 consumes:
3541 - application/json
3542 produces:
3543 - application/json
3544 responses:
3545 '200':
3546 description: The cart with items was successfully returned.
3547 schema:
3548 type: object
3549 properties:
3550 cart_id:
3551 type: string
3552 example: current
3553 description: Cart ID.
3554 price:
3555 type: string
3556 example: null
3557 description: Cart price.
3558 is_free:
3559 type: boolean
3560 description: 'If ''true'', the cart is free.'
3561 items:
3562 type: array
3563 example:
3564 - sku: shotgun_raider
3565 groups: []
3566 name: SHOTGUN FOR TRUE RAIDERS
3567 attributes: []
3568 media_list: []
3569 type: virtual_good
3570 price:
3571 amount: null
3572 amount_without_discount: null
3573 currency: USD
3574 vc_prices: []
3575 long_description: long description
3576 description: description
3577 image_url: 'http://image.png'
3578 promotion: null
3579 quantity: 1
3580 is_free: true
3581 order: 1
3582 purchase_limit: null
3583 - sku: headphones_for_pro
3584 groups: []
3585 name: HEADPHONES
3586 attributes:
3587 stack_size: 5
3588 licensed: true
3589 media_list: []
3590 type: virtual_good
3591 price:
3592 amount: null
3593 amount_without_discount: null
3594 currency: USD
3595 vc_prices: []
3596 long_description: Main Hand (Ranged)
3597 description: Binds To Legacy
3598 image_url: 'http://static.swtor-spy.com/icons/rifle.bowcasterlow02.a02_v03.png'
3599 promotion: null
3600 quantity: 2
3601 is_free: true
3602 order: 1
3603 purchase_limit: null
3604 - sku: white-short
3605 name: Body Skin 3
3606 groups: []
3607 attributes: []
3608 media_list: []
3609 type: virtual_good
3610 price:
3611 amount: null
3612 amount_without_discount: null
3613 currency: USD
3614 vc_prices: []
3615 long_description: Body Skin 3 - description
3616 description: Body Skin 3 - short description
3617 image_url: 'https://popmedia.blob.core.windows.net/popyourself/female/body/female_head_skin3-01.png'
3618 promotion: null
3619 quantity: 5
3620 is_free: true
3621 order: 1
3622 purchase_limit: null
3623 description: Object with the items.
3624 items:
3625 type: object
3626 properties:
3627 sku:
3628 type: string
3629 example: shotgun_raider
3630 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
3631 groups:
3632 type: array
3633 example: []
3634 description: Groups the item belongs to (array).
3635 items:
3636 type: object
3637 name:
3638 type: string
3639 example: SHOTGUN FOR TRUE RAIDERS
3640 description: Item name.
3641 attributes:
3642 type: array
3643 example: []
3644 description: Item attributes.
3645 items:
3646 type: string
3647 media_list:
3648 type: array
3649 example: []
3650 deprecated: true
3651 items:
3652 type: string
3653 type:
3654 type: string
3655 example: virtual_good
3656 description: Type of Item.
3657 price:
3658 type: object
3659 description: Item prices.
3660 properties:
3661 amount:
3662 type: string
3663 example: null
3664 description: Item discount price.
3665 amount_without_discount:
3666 type: string
3667 example: null
3668 description: Item price.
3669 currency:
3670 type: string
3671 example: USD
3672 description: Cart currency. Three-letter code per ISO 4217.
3673 vc_prices:
3674 type: array
3675 example: []
3676 description: 'Price in the in-game currency. If ''null'', the item can only be purchased for real currency.'
3677 items:
3678 type: string
3679 long_description:
3680 type: string
3681 example: long description
3682 description: Extended description of the item.
3683 description:
3684 type: string
3685 example: description
3686 description: Item description.
3687 image_url:
3688 type: string
3689 example: 'http://image.png'
3690 description: Image URL.
3691 promotion:
3692 type:
3693 - string
3694 - array
3695 example: null
3696 description: Promotions the item belongs to (array).
3697 items:
3698 type: object
3699 quantity:
3700 type: integer
3701 example: 1
3702 description: Items quantity.
3703 is_free:
3704 type: boolean
3705 description: 'If ''true'', the item is free.'
3706 order:
3707 type: integer
3708 example: 1
3709 deprecated: true
3710 purchase_limit:
3711 type: string
3712 example: null
3713 description: 'Number of times the item can be purchased. If ''null'', there is no limit on the number of purchases.'
3714 examples:
3715 application/json:
3716 cart_id: current
3717 price: 'null'
3718 is_free: true
3719 items:
3720 - sku: shotgun_raider
3721 groups: []
3722 name: SHOTGUN FOR TRUE RAIDERS
3723 attributes: []
3724 media_list: []
3725 type: virtual_good
3726 price:
3727 amount: null
3728 amount_without_discount: null
3729 currency: USD
3730 vc_prices: []
3731 long_description: long description
3732 description: description
3733 image_url: 'http://image.png'
3734 promotion: null
3735 quantity: 1
3736 is_free: true
3737 order: 1
3738 purchase_limit: null
3739 - sku: headphones_for_pro
3740 groups: []
3741 name: HEADPHONES
3742 attributes:
3743 stack_size: 5
3744 licensed: true
3745 media_list: []
3746 type: virtual_good
3747 price:
3748 amount: null
3749 amount_without_discount: null
3750 currency: USD
3751 vc_prices: []
3752 long_description: Main Hand (Ranged)
3753 description: Binds To Legacy
3754 image_url: 'http://static.swtor-spy.com/icons/rifle.bowcasterlow02.a02_v03.png'
3755 promotion: null
3756 quantity: 2
3757 is_free: true
3758 order: 1
3759 purchase_limit: null
3760 - sku: white-short
3761 name: Body Skin 3
3762 groups: []
3763 attributes: []
3764 media_list: []
3765 type: virtual_good
3766 price:
3767 amount: null
3768 amount_without_discount: null
3769 currency: USD
3770 vc_prices: []
3771 long_description: Body Skin 3 - description
3772 description: Body Skin 3 - short description
3773 image_url: 'https://popmedia.blob.core.windows.net/popyourself/female/body/female_head_skin3-01.png'
3774 promotion: null
3775 quantity: 5
3776 is_free: true
3777 order: 1
3778 purchase_limit: null
3779 summary: Get Cart
3780 security:
3781 - XsollaLoginUserJWT: []
3782 - PayStationUserAccessToken: []
3783 parameters:
3784 - name: project_id
3785 in: path
3786 required: true
3787 type: integer
3788 description: Project ID.
3789 default: 44056
3790 - name: currency
3791 in: query
3792 required: false
3793 type: string
3794 description: The currency which prices are displayed (USD by default). Three-letter currency code per ISO 4217.
3795 default: USD
3796 - name: locale
3797 in: query
3798 required: false
3799 type: string
3800 description: Response language. Two-letter lowercase language code per ISO 639-1.
3801 default: en
3802 description: Returns a user's cart.
3803 '/v2/project/{project_id}/cart/{cart_id}/clear':
3804 put:
3805 tags:
3806 - /v2/cart
3807 consumes:
3808 - application/json
3809 produces:
3810 - application/json
3811 responses:
3812 '204':
3813 description: The cart clearing was successful.
3814 summary: Delete All Cart Line Items
3815 security:
3816 - XsollaLoginUserJWT: []
3817 - PayStationUserAccessToken: []
3818 parameters:
3819 - name: project_id
3820 in: path
3821 required: true
3822 type: integer
3823 description: Project ID.
3824 default: 44056
3825 - name: cart_id
3826 in: path
3827 required: true
3828 type: string
3829 description: Cart ID.
3830 default: custom_id
3831 description: Deletes all cart line items.
3832 '/v2/project/{project_id}/cart/clear':
3833 put:
3834 tags:
3835 - /v2/cart
3836 consumes:
3837 - application/json
3838 produces:
3839 - application/json
3840 responses:
3841 '204':
3842 description: The cart clearing was successful.
3843 summary: Delete All Cart Line Items
3844 security:
3845 - XsollaLoginUserJWT: []
3846 - PayStationUserAccessToken: []
3847 parameters:
3848 - name: project_id
3849 in: path
3850 required: true
3851 type: integer
3852 description: Project ID.
3853 default: 44056
3854 description: Deletes all cart line items.
3855 '/v2/project/{project_id}/cart/{cart_id}/item/{item_sku}':
3856 put:
3857 tags:
3858 - /v2/cart
3859 consumes:
3860 - application/json
3861 produces:
3862 - application/json
3863 responses:
3864 '204':
3865 description: The cart was succefully updated.
3866 '404':
3867 description: 'The item wasn’t found. Make sure `item_sku` is correct and the item isn’t turned off or deleted.'
3868 schema:
3869 oneOf:
3870 - properties:
3871 statusCode:
3872 type: integer
3873 example: 404
3874 errorCode:
3875 type: integer
3876 example: 4001
3877 errorMessage:
3878 type: string
3879 example: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_5 not found'
3880 type: object
3881 examples:
3882 application/json:
3883 statusCode: 404
3884 errorCode: 4001
3885 errorMessage: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_5 not found'
3886 '422':
3887 description: This type of item cannot be put to the cart. Select another type of item.
3888 schema:
3889 type: object
3890 properties:
3891 statusCode:
3892 type: integer
3893 example: 422
3894 errorCode:
3895 type: integer
3896 example: 1421
3897 errorMessage:
3898 type: string
3899 example: Only Virtual Good Supported
3900 examples:
3901 application/json:
3902 statusCode: 422
3903 errorCode: 1421
3904 errorMessage: Only Virtual Good Supported
3905 summary: Update Cart Line Item
3906 security:
3907 - XsollaLoginUserJWT: []
3908 - PayStationUserAccessToken: []
3909 parameters:
3910 - name: project_id
3911 in: path
3912 required: true
3913 type: integer
3914 description: Project ID.
3915 default: 44056
3916 - name: cart_id
3917 in: path
3918 required: true
3919 type: string
3920 description: Cart ID.
3921 default: custom_id
3922 - name: item_sku
3923 in: path
3924 required: true
3925 type: string
3926 description: Item SKU
3927 default: gun_1
3928 - name: json model
3929 in: body
3930 required: false
3931 schema:
3932 type: object
3933 properties:
3934 quantity:
3935 type: number
3936 description: Item quantity.
3937 default: 123
3938 description: |+
3939 Updates an existing line item or creates the one in the cart.
3940
3941 delete:
3942 tags:
3943 - /v2/cart
3944 consumes:
3945 - application/json
3946 produces:
3947 - application/json
3948 responses:
3949 '204':
3950 description: The item from the user’s inventory was successfully consumed.
3951 '404':
3952 description: |
3953 The item was not found. Check:
3954 * `project_id` is correct
3955 * `item_sku` is correct
3956 schema:
3957 oneOf:
3958 - properties:
3959 statusCode:
3960 type: integer
3961 example: 404
3962 errorCode:
3963 type: integer
3964 example: 4001
3965 errorMessage:
3966 type: string
3967 example: '[0401-4001]: Item with Project Id = 44056 and Sku = gu_1 not found'
3968 type: object
3969 examples:
3970 application/json 3:
3971 statusCode: 404
3972 errorCode: 4001
3973 errorMessage: '[0401-4001]: Item with Project Id = 44056 and Sku = gu_1 not found'
3974 summary: Delete Cart Line Item
3975 security:
3976 - XsollaLoginUserJWT: []
3977 - PayStationUserAccessToken: []
3978 parameters:
3979 - name: project_id
3980 in: path
3981 required: true
3982 type: integer
3983 description: Project ID.
3984 default: 44056
3985 - name: cart_id
3986 in: path
3987 required: true
3988 type: string
3989 description: Cart ID.
3990 default: custom_id
3991 - name: item_sku
3992 in: path
3993 required: true
3994 type: string
3995 description: Item SKU.
3996 default: gun_1
3997 description: |
3998 Delete item from the cart.
3999 '/v2/project/{project_id}/cart/item/{item_sku}':
4000 put:
4001 tags:
4002 - /v2/cart
4003 consumes:
4004 - application/json
4005 produces:
4006 - application/json
4007 responses:
4008 '204':
4009 description: The cart was succefully updated.
4010 '404':
4011 description: 'The item wasn’t found. Make sure `item_sku` is correct and the item isn’t turned off or deleted.'
4012 schema:
4013 oneOf:
4014 - properties:
4015 statusCode:
4016 type: integer
4017 example: 404
4018 errorCode:
4019 type: integer
4020 example: 4001
4021 errorMessage:
4022 type: string
4023 example: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_5 not found'
4024 type: object
4025 examples:
4026 application/json:
4027 statusCode: 404
4028 errorCode: 4001
4029 errorMessage: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_5 not found'
4030 '422':
4031 description: This type of item cannot be put to the cart. Select another type of item.
4032 schema:
4033 type: object
4034 properties:
4035 statusCode:
4036 type: integer
4037 example: 422
4038 errorCode:
4039 type: integer
4040 example: 1421
4041 errorMessage:
4042 type: string
4043 example: Only Virtual Good Supported
4044 examples:
4045 application/json:
4046 statusCode: 422
4047 errorCode: 1421
4048 errorMessage: Only Virtual Good Supported
4049 summary: Update Cart Line Item
4050 security:
4051 - XsollaLoginUserJWT: []
4052 - PayStationUserAccessToken: []
4053 parameters:
4054 - name: project_id
4055 in: path
4056 required: true
4057 type: integer
4058 description: Project ID.
4059 default: 44056
4060 - name: item_sku
4061 in: path
4062 required: true
4063 type: string
4064 description: Item SKU
4065 default: gun_1
4066 - name: json model
4067 in: body
4068 required: false
4069 schema:
4070 type: object
4071 properties:
4072 quantity:
4073 type: number
4074 description: Item quantity.
4075 default: 123
4076 description: |+
4077 Updates an existing line item or creates the one in the cart.
4078
4079 delete:
4080 tags:
4081 - /v2/cart
4082 consumes:
4083 - application/json
4084 produces:
4085 - application/json
4086 responses:
4087 '204':
4088 description: The item from the user’s inventory was successfully consumed.
4089 '404':
4090 description: |
4091 The item was not found. Check:
4092 * `project_id` is correct
4093 * `item_sku` is correct
4094 schema:
4095 oneOf:
4096 - properties:
4097 statusCode:
4098 type: integer
4099 example: 404
4100 errorCode:
4101 type: integer
4102 example: 4001
4103 errorMessage:
4104 type: string
4105 example: '[0401-4001]: Item with Project Id = 44056 and Sku = gu_1 not found'
4106 type: object
4107 examples:
4108 application/json 3:
4109 statusCode: 404
4110 errorCode: 4001
4111 errorMessage: '[0401-4001]: Item with Project Id = 44056 and Sku = gu_1 not found'
4112 summary: Delete Cart Line Item
4113 security:
4114 - XsollaLoginUserJWT: []
4115 - PayStationUserAccessToken: []
4116 parameters:
4117 - name: project_id
4118 in: path
4119 required: true
4120 type: integer
4121 description: Project ID.
4122 default: 44056
4123 - name: item_sku
4124 in: path
4125 required: true
4126 type: string
4127 description: Item SKU.
4128 default: gun_1
4129 description: |
4130 Delete item from the cart.
4131 '/v2/project/{project_id}/payment/cart/{cart_id}':
4132 post:
4133 tags:
4134 - /v2/payment
4135 consumes:
4136 - application/json
4137 produces:
4138 - application/json
4139 responses:
4140 '200':
4141 description: The order was successfully created.
4142 schema:
4143 type: object
4144 properties:
4145 order_id:
4146 type: integer
4147 description: Order ID.
4148 token:
4149 type: string
4150 description: Payment token.
4151 examples:
4152 application/json:
4153 order_id: 641
4154 token: f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo
4155 '422':
4156 description: 'Invalid cart. Check that the cart exists, is not empty and all items in it are not free.'
4157 schema:
4158 type: object
4159 properties:
4160 errorCode:
4161 type: integer
4162 example: 1401
4163 statusCode:
4164 type: integer
4165 example: 422
4166 errorMessage:
4167 type: string
4168 example: '[0401-1401]: Invalid cart'
4169 examples:
4170 application/json:
4171 errorCode: 1401
4172 statusCode: 422
4173 errorMessage: '[0401-1401]: Invalid cart'
4174 summary: Create Order With All Items
4175 security:
4176 - XsollaLoginUserJWT: []
4177 - PayStationUserAccessToken: []
4178 parameters:
4179 - name: project_id
4180 in: path
4181 required: true
4182 type: integer
4183 description: Project ID.
4184 default: 44056
4185 - name: cart_id
4186 in: path
4187 required: true
4188 type: string
4189 description: Cart ID.
4190 default: custom_id
4191 - name: json model
4192 in: body
4193 required: false
4194 schema:
4195 type: object
4196 properties:
4197 currency:
4198 type: string
4199 description: The currency which prices are displayed (USD by default). Three-letter currency code per ISO 4217.
4200 default: USD
4201 locale:
4202 type: string
4203 description: Response language.
4204 default: en
4205 sandbox:
4206 type: boolean
4207 description: Creates an order in the sandbox mode. The option is available for the company users only.
4208 default: false
4209 description: 'Creates an order with all items from the cart. The created order will be given a “new” order status. To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN, where ACCESS_TOKEN is the received token. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN.'
4210 '/v2/project/{project_id}/payment/cart':
4211 post:
4212 tags:
4213 - /v2/payment
4214 consumes:
4215 - application/json
4216 produces:
4217 - application/json
4218 responses:
4219 '200':
4220 description: The order was successfully created.
4221 schema:
4222 type: object
4223 properties:
4224 order_id:
4225 type: integer
4226 description: Order ID.
4227 token:
4228 type: string
4229 description: Payment token.
4230 examples:
4231 application/json:
4232 order_id: 641
4233 token: f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo
4234 '422':
4235 description: 'Invalid cart. Check that the cart exists, is not empty and all items in it are not free.'
4236 schema:
4237 type: object
4238 properties:
4239 errorCode:
4240 type: integer
4241 example: 1401
4242 statusCode:
4243 type: integer
4244 example: 422
4245 errorMessage:
4246 type: string
4247 example: '[0401-1401]: Invalid cart'
4248 examples:
4249 application/json:
4250 errorCode: 1401
4251 statusCode: 422
4252 errorMessage: '[0401-1401]: Invalid cart'
4253 summary: Create Order With All Items
4254 security:
4255 - XsollaLoginUserJWT: []
4256 parameters:
4257 - name: project_id
4258 in: path
4259 required: true
4260 type: integer
4261 description: Project ID.
4262 default: 44056
4263 - name: json model
4264 in: body
4265 required: false
4266 schema:
4267 type: object
4268 properties:
4269 currency:
4270 type: string
4271 description: The currency which prices are displayed (USD by default). Three-letter currency code per ISO 4217.
4272 default: USD
4273 locale:
4274 type: string
4275 description: Response language.
4276 default: en
4277 sandbox:
4278 type: boolean
4279 description: Creates an order in the sandbox mode. The option is available for the company users only.
4280 default: false
4281 description: 'Creates an order with all items from the cart. The created order will be given a “new” order status. To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN, where ACCESS_TOKEN is the received token. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN.'
4282 '/v2/project/{project_id}/payment/item/{item_sku}':
4283 post:
4284 tags:
4285 - /v2/payment
4286 consumes:
4287 - application/json
4288 produces:
4289 - application/json
4290 responses:
4291 '200':
4292 description: Token is created successfully.
4293 schema:
4294 type: object
4295 properties:
4296 order_id:
4297 type: integer
4298 description: Order ID.
4299 token:
4300 type: string
4301 description: Payment token.
4302 examples:
4303 application/json:
4304 order_id: 641
4305 token: f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo
4306 '422':
4307 description: 'Invalid item. Check that item exists, the item is not turned off or deleted,and it is not free.'
4308 schema:
4309 type: object
4310 properties:
4311 errorCode:
4312 type: integer
4313 example: 1411
4314 statusCode:
4315 type: integer
4316 example: 422
4317 errorMessage:
4318 type: string
4319 example: '[0401-1411]: Invalid item'
4320 examples:
4321 application/json:
4322 errorCode: 1411
4323 statusCode: 422
4324 errorMessage: '[0401-1411]: Invalid item'
4325 summary: Create Order With Specified Item
4326 security:
4327 - XsollaLoginUserJWT: []
4328 - PayStationUserAccessToken: []
4329 parameters:
4330 - name: project_id
4331 in: path
4332 required: true
4333 type: integer
4334 description: Project ID.
4335 default: 44056
4336 - name: item_sku
4337 in: path
4338 required: true
4339 type: string
4340 description: Item SKU.
4341 default: gun_1
4342 - name: json model
4343 in: body
4344 required: false
4345 schema:
4346 type: object
4347 properties:
4348 currency:
4349 type: string
4350 description: The currency which prices are displayed (USD by default). Three-letter currency code per ISO 4217.
4351 default: USD
4352 locale:
4353 type: string
4354 description: Response language.
4355 default: en
4356 sandbox:
4357 type: boolean
4358 description: Creates an order in the sandbox mode. The option is available for the company users only.
4359 default: false
4360 description: 'Creates an order with all items from the cart. The created order will be given a “new” order status. To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN, where ACCESS_TOKEN is the received token. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN.'
4361 '/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}':
4362 post:
4363 tags:
4364 - /v2/payment
4365 consumes:
4366 - application/json
4367 produces:
4368 - application/json
4369 responses:
4370 '200':
4371 description: Quick virtual purchase is successful.
4372 schema:
4373 type: object
4374 properties:
4375 order_id:
4376 type: integer
4377 description: Order ID.
4378 examples:
4379 application/json:
4380 order_id: 641
4381 '404':
4382 description: Invalid item. Check that item exists, the item is not turned off or deleted.
4383 schema:
4384 type: object
4385 properties:
4386 errorCode:
4387 type: integer
4388 example: 4001
4389 statusCode:
4390 type: integer
4391 example: 404
4392 errorMessage:
4393 type: string
4394 example: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_1 not found'
4395 example:
4396 application/json:
4397 errorCode: 5006
4398 statusCode: 422
4399 errorMessage: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_1 not found'
4400 '422':
4401 description: Not eniugh virtual currency
4402 schema:
4403 type: object
4404 properties:
4405 errorCode:
4406 type: integer
4407 example: 5006
4408 statusCode:
4409 type: integer
4410 example: 422
4411 errorMessage:
4412 type: string
4413 example: '[0401-5006]: Could not find instance in inventory: Could not remove 112299999344, user only has 12'
4414 examples:
4415 application/json:
4416 errorCode: 5006
4417 statusCode: 422
4418 errorMessage: '[0401-5006]: Could not find instance in inventory: Could not remove 112299999344, user only has 12'
4419 summary: Create Order With Specified Item
4420 security:
4421 - XsollaLoginUserJWT: []
4422 - PayStationUserAccessToken: []
4423 parameters:
4424 - name: project_id
4425 in: path
4426 required: true
4427 type: integer
4428 description: Project ID.
4429 default: 44056
4430 - name: item_sku
4431 in: path
4432 required: true
4433 type: string
4434 description: Item SKU.
4435 default: gun_1
4436 - name: virtual_currency_sku
4437 in: path
4438 required: true
4439 type: string
4440 description: Virtual Currency SKU.
4441 default: test_vc
4442 description: Purchase item using virtual currency.
4443 '/v2/project/{project_id}/user/inventory/items':
4444 get:
4445 tags:
4446 - /v2/inventory
4447 consumes:
4448 - application/json
4449 produces:
4450 - application/json
4451 responses:
4452 '200':
4453 description: The user’s inventory was successfully retrieved.
4454 schema:
4455 type: object
4456 properties:
4457 items:
4458 type: array
4459 example:
4460 - instance_id: aaaabbbbccccddddaaaabbbbccccdddd
4461 sku: instanciated_item
4462 type: virtual_good
4463 name: Rocket
4464 quantity: null
4465 description: Big Rocket - short description
4466 long_description: Big Rocket - description
4467 image_url: 'https://picture.bigrocket.png'
4468 - instance_id: null
4469 sku: shotgun_raider
4470 type: virtual_good
4471 name: SHOTGUN FOR TRUE RAIDERS
4472 quantity: 2
4473 description: description
4474 long_description: long description
4475 image_url: 'http://image.png'
4476 - instance_id: null
4477 sku: headphones_for_pro
4478 type: virtual_good
4479 name: HEADPHONES
4480 quantity: 5
4481 description: ''
4482 long_description: ''
4483 image_url: ''
4484 - instance_id: null
4485 sku: lootbox_without_slots
4486 type: lootbox
4487 name: LOOTBOX 2
4488 quantity: 2
4489 description: ''
4490 long_description: ''
4491 image_url: ''
4492 key: null
4493 open_price:
4494 amount: 750
4495 sku: some_currency
4496 items:
4497 type: object
4498 properties:
4499 instance_id:
4500 type: string
4501 example: aaaabbbbccccddddaaaabbbbccccdddd
4502 description: Instance item ID.
4503 sku:
4504 type: string
4505 example: instanciated_item
4506 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
4507 type:
4508 type: string
4509 example: virtual_good
4510 description: 'Type of Item: Consumable/Expiration/Permanent/Lootboxes/Physical.'
4511 name:
4512 type: string
4513 example: Rocket
4514 description: Item name.
4515 quantity:
4516 type: string
4517 example: null
4518 description: Item quantity.
4519 description:
4520 type: string
4521 example: Big Rocket - short description
4522 description: Item description.
4523 long_description:
4524 type: string
4525 example: Big Rocket - description
4526 description: Extended item description.
4527 image_url:
4528 type: string
4529 example: 'https://picture.bigrocket.png'
4530 description: Image URL.
4531 examples:
4532 application/json:
4533 items:
4534 - instance_id: aaaabbbbccccddddaaaabbbbccccdddd
4535 sku: instanciated_item
4536 type: virtual_good
4537 name: Rocket
4538 quantity: null
4539 description: Big Rocket - short description
4540 long_description: Big Rocket - description
4541 image_url: 'https://picture.bigrocket.png'
4542 - instance_id: null
4543 sku: shotgun_raider
4544 type: virtual_good
4545 name: SHOTGUN FOR TRUE RAIDERS
4546 quantity: 2
4547 description: description
4548 long_description: long description
4549 image_url: 'http://image.png'
4550 - instance_id: null
4551 sku: headphones_for_pro
4552 type: virtual_good
4553 name: HEADPHONES
4554 quantity: 5
4555 description: ''
4556 long_description: ''
4557 image_url: ''
4558 - instance_id: null
4559 sku: lootbox_without_slots
4560 type: lootbox
4561 name: LOOTBOX 2
4562 quantity: 2
4563 description: ''
4564 long_description: ''
4565 image_url: ''
4566 key: null
4567 open_price:
4568 amount: 750
4569 sku: some_currency
4570 security:
4571 - XsollaLoginUserJWT: []
4572 - PayStationUserAccessToken: []
4573 parameters:
4574 - name: project_id
4575 in: path
4576 required: true
4577 type: integer
4578 description: Project ID.
4579 default: 44056
4580 summary: Get User's Inventory
4581 description: |+
4582 Retrieves the user’s inventory.
4583 /v2/project/{project_id}/user/virtual_currency_balance:
4584 get:
4585 tags:
4586 - /v2/inventory
4587 consumes:
4588 - application/json
4589 produces:
4590 - application/json
4591 responses:
4592 '200':
4593 description: The user’s virtual balance was successfully retrieved.
4594 schema:
4595 type: object
4596 properties:
4597 items:
4598 type: array
4599 example:
4600 - sku: VC_1
4601 type: virtual_currency
4602 name: Ruble
4603 amount: 10
4604 description: Ruble
4605 image_url: 'https://picture.bigrocket.png'
4606 - sku: VC_2
4607 type: virtual_currency
4608 name: Xsollar
4609 amount: 5000
4610 description: Xsollar
4611 image_url: 'http://image.png'
4612 items:
4613 type: object
4614 properties:
4615 sku:
4616 type: string
4617 example: instanciated_item
4618 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
4619 type:
4620 type: string
4621 example: virtual_currency
4622 description: 'Type of Item: virtual_good/virtual_currency/bundle.'
4623 name:
4624 type: string
4625 example: Rocket
4626 description: Item name.
4627 amount:
4628 type: integer
4629 example: null
4630 description: Item quantity.
4631 description:
4632 type: string
4633 example: Big Rocket - short description
4634 description: Item description.
4635 image_url:
4636 type: string
4637 example: 'https://picture.bigrocket.png'
4638 description: Image URL.
4639 examples:
4640 application/json:
4641 items:
4642 - sku: VC_1
4643 type: virtual_currency
4644 name: Ruble
4645 amount: 10
4646 description: Ruble
4647 image_url: 'https://picture.bigrocket.png'
4648 - sku: VC_2
4649 type: virtual_currency
4650 name: Xsollar
4651 amount: 5000
4652 description: Xsollar
4653 image_url: 'http://image.png'
4654 security:
4655 - XsollaLoginUserJWT: []
4656 - PayStationUserAccessToken: []
4657 parameters:
4658 - name: project_id
4659 in: path
4660 required: true
4661 type: integer
4662 description: Project ID.
4663 default: 44056
4664 summary: Get User's virtual balance
4665 description: |+
4666 Retrieves the user’s virtual balance.
4667 '/v2/project/{project_id}/user/inventory/item/consume':
4668 post:
4669 tags:
4670 - /v2/inventory
4671 consumes:
4672 - application/json
4673 produces:
4674 - application/json
4675 responses:
4676 '200':
4677 description: |
4678 An item from the user’s inventory was consumed.
4679 '404':
4680 description: 'The item was not found at all, the item was not found in the inventory, or it is not enough (attempt to consume more than the initial number). ''instance_id'' must be 32 characters long.'
4681 schema:
4682 oneOf:
4683 - properties:
4684 statusCode:
4685 type: integer
4686 example: 404
4687 errorCode:
4688 type: integer
4689 example: 5004
4690 errorMessage:
4691 type: string
4692 example: '[0401-5004]: Could not find instance in inventory: Could not remove 112299999344, user only has 12'
4693 - properties:
4694 statusCode:
4695 type: integer
4696 example: 404
4697 errorCode:
4698 type: integer
4699 example: 4001
4700 errorMessage:
4701 type: string
4702 example: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_5 not found'
4703 type: object
4704 examples:
4705 application/json 1:
4706 statusCode: 404
4707 errorCode: 4001
4708 errorMessage: '[0401-4001]: Item with Project Id = 44056 and Sku = gun_5 not found'
4709 application/json 2:
4710 statusCode: 404
4711 errorCode: 5004
4712 errorMessage: '[0401-5004]: Could not find instance in inventory: Could not remove 112299999344, user only has 12'
4713 '422':
4714 description: Both instance_id and quantity are passed. Make sure that only one parameter is passed (instance_id or quantity). 'instance_id' must be 32 characters long
4715 schema:
4716 type: object
4717 properties:
4718 statusCode:
4719 type: integer
4720 example: 422
4721 errorCode:
4722 type: integer
4723 example: 5002
4724 errorMessage:
4725 type: string
4726 example: '[0401-5002]: Quantity either instance id must be null. Item id must be specified'
4727 examples:
4728 application/json:
4729 statusCode: 422
4730 errorCode: 5002
4731 errorMessage: '[0401-5002]: Quantity either instance id must be null. Item id must be specified'
4732 security:
4733 - XsollaLoginUserJWT: []
4734 - PayStationUserAccessToken: []
4735 parameters:
4736 - name: project_id
4737 in: path
4738 required: true
4739 type: integer
4740 description: Project ID.
4741 default: 44056
4742 - name: json model
4743 in: body
4744 required: false
4745 schema:
4746 type: object
4747 properties:
4748 sku:
4749 type: string
4750 description: 'Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, dashes, and underscores.'
4751 default: gun_1
4752 quantity:
4753 description: 'Items quantity. If item is uncountable, should be ''null''.'
4754 type:
4755 - number
4756 - 'null'
4757 default: 1
4758 instance_id:
4759 description: 'Instance item ID. If item is countable, should be ''null''.'
4760 type:
4761 - string
4762 - 'null'
4763 default: 'null'
4764 required:
4765 - sku
4766 summary: Consume Item
4767 description: |+
4768 Consumes an item from user’s inventory.
4769...