{ "components": { "examples": { "200-admin-daily-chain": { "summary": "每日奖励示例", "value": { "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "en": "Daily reward short description" }, "id": 3, "is_enabled": true, "is_recurrent": false, "name": { "en": "Daily reward", "ru": "Ежедневная награда" }, "number_of_steps": 3, "order": 1, "steps": [ { "items": [ { "description": { "en": "Allows to see the stars", "ru": "Позволяет увидеть звезды" }, "image_url": "https://picture.bundle-picture.png", "item_id": 9010, "name": { "en": "Telescope", "ru": "Телескоп" }, "quantity": 1, "sku": "telescope", "type": "virtual_good" }, { "description": { "en": "Heal 10% of your health", "ru": "Лечит 10% здоровья" }, "image_url": "https://picture.bundle-picture.png", "item_id": 9012, "name": { "en": "Healing potion", "ru": "Зелье лечения" }, "quantity": 2, "sku": "health_potion", "type": "virtual_good" } ], "step_id": 7, "step_number": 1 }, { "items": [ { "description": { "en": "Allows to see the stars", "ru": "Позволяет увидеть звезды" }, "image_url": "https://picture.bundle-picture.png", "item_id": 9010, "name": { "en": "Telescope", "ru": "Телескоп" }, "quantity": 5, "sku": "telescope", "type": "virtual_good" } ], "step_id": 6, "step_number": 2 }, { "items": [ { "description": { "en": "Allows to see the stars", "ru": "Позволяет увидеть звезды" }, "image_url": "https://picture.bundle-picture.png", "item_id": 9010, "name": { "en": "Telescope", "ru": "Телескоп" }, "quantity": 2, "sku": "telescope", "type": "virtual_good" } ], "step_id": 5, "step_number": 3 } ], "type": "calendar_hard" } }, "200-admin-daily-chain-list": { "summary": "每日奖励列表示例", "value": { "has_more": false, "items": [ { "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "en": "Daily reward short description" }, "id": 1, "is_enabled": false, "is_recurrent": true, "name": { "en": "Daily reward", "ru": "Ежедневная награда" }, "number_of_steps": 10, "order": 1, "type": "calendar_hard" }, { "date_end": "2025-04-28T15:00:00+08:00", "date_start": "2025-04-15T00:00:00+08:00", "description": { "en": "Monthly daily reward short description" }, "id": 2, "is_enabled": false, "is_recurrent": true, "name": { "en": "Monthly daily reward", "ru": "Ежедневные награды в цепочке на месяц" }, "number_of_steps": 13, "order": 2, "type": "calendar_hard" }, { "date_end": "2025-05-31T18:16:00+05:00", "date_start": "2023-05-01T18:16:00+05:00", "description": { "en": "Login reward short description" }, "id": 3, "is_enabled": true, "is_recurrent": true, "name": { "en": "Login reward" }, "number_of_steps": 7, "order": 3, "type": "rolling_skippable" }, { "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "en": "Daily reward short description" }, "id": 4, "is_enabled": true, "is_recurrent": true, "name": { "en": "Daily reward", "ru": "Ежедневная награда" }, "number_of_steps": 10, "order": 4, "type": "calendar_hard" }, { "date_end": "2025-11-30T10:00:00+05:00", "date_start": "2025-11-01T10:00:00+05:00", "description": { "en": "Unskippable login reward short description" }, "id": 5, "is_enabled": true, "is_recurrent": true, "name": { "en": "Unskippable login reward" }, "number_of_steps": 7, "order": 3, "type": "rolling_unskippable" } ], "total_items_count": 3 } }, "200-admin-offer-chain": { "summary": "优惠链示例", "value": { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "elf" }, { "attribute": "level", "can_be_missing": false, "operator": "ge", "type": "number", "value": "10" }, { "attribute": "10_level_up_date", "can_be_missing": false, "operator": "le", "type": "date", "value": "2026-01-01T00:00:00" } ], "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Personalisierte Angebotskette mit Benutzerattributbedingungen - für Elfen der Stufe 10 und höher, die Stufe 10 spätestens am 2026-01-01 00:00:00 erreicht haben, einschließlich", "en": "Personalized offer chain with user attribute conditions - for level 10 and above elves who reached level 10 no later than 2026-01-01 00:00:00, inclusive", "fr": "Chaîne d'offres personnalisée avec des conditions d'attribut utilisateur - pour les elfes de niveau 10 et plus qui ont atteint le niveau 10 au plus tard le 2026-01-01 00:00:00, inclus", "it": "Catena di offerte personalizzata con condizioni di attributo utente - per elfi di livello 10 e superiore che hanno raggiunto il livello 10 non più tardi del 2026-01-01 00:00:00, inclusi", "ru": "Персонализированная цепочка предложений - для эльфов 10 уровня и выше, достигших 10 уровня не позднее 2026-01-01 00:00:00 включительно" }, "id": 3, "is_always_visible": false, "is_enabled": true, "name": { "de": "Angebotskette", "en": "Offer chain", "fr": "Chaîne d'offres", "it": "Catena di offerte", "ru": "Цепочка" }, "order": 1, "recurrent_schedule": null, "steps": [ { "is_free": false, "items": [ { "description": { "de": "Ermöglicht das Betrachten der Sterne", "en": "Allows to see the stars", "fr": "Permet de voir les étoiles", "it": "Permette di vedere le stelle", "ru": "Позволяет увидеть звезды" }, "image_url": "https://cdn.picture.vg.sku-telescope.png", "item_id": 9010, "name": { "de": "Teleskop", "en": "Telescope", "fr": "Télescope", "it": "Telescopio", "ru": "Телескоп" }, "order": 1, "quantity": 1, "sku": "telescope", "type": "virtual_good" }, { "description": { "de": "Heilt 10% deiner Gesundheit", "en": "Heal 10% of your health", "fr": "Soigne 10% de votre santé", "it": "Cura il 10% della tua salute", "ru": "Лечит 10% здоровья" }, "image_url": "https://cdn.picture/vg-sku-health_potion.png", "item_id": 9012, "name": { "de": "Heiltrank", "en": "Healing potion", "fr": "Potion de soin", "it": "Pozione curativa", "ru": "Зелье лечения" }, "order": 0, "quantity": 2, "sku": "health_potion", "type": "virtual_good" } ], "step_id": 7, "step_number": 1 }, { "is_free": false, "items": [ { "description": { "de": "Ermöglicht das Betrachten der Sterne", "en": "Allows to see the stars", "fr": "Permet de voir les étoiles", "it": "Permette di vedere le stelle", "ru": "Позволяет увидеть звезды" }, "image_url": "https://cdn.picture/vg-sku-telescope.png", "item_id": 9010, "name": { "de": "Teleskop", "en": "Telescope", "fr": "Télescope", "it": "Telescopio", "ru": "Телескоп" }, "order": 0, "quantity": 5, "sku": "telescope", "type": "virtual_good" } ], "step_id": 6, "step_number": 2 }, { "is_free": true, "items": [ { "description": { "de": "Ermöglicht das Betrachten der Sterne", "en": "Allows to see the stars", "fr": "Permet de voir les étoiles", "it": "Permette di vedere le stelle", "ru": "Позволяет увидеть звезды" }, "image_url": "https://cdn.picture/vg-sku-telescope.png", "item_id": 9010, "name": { "de": "Teleskop", "en": "Telescope", "fr": "Télescope", "it": "Telescopio", "ru": "Телескоп" }, "order": 0, "quantity": 2, "sku": "telescope", "type": "virtual_good" } ], "step_id": 5, "step_number": 3 } ] } }, "200-admin-offer-chain-list": { "summary": "优惠链列表示例", "value": { "has_more": false, "items": [ { "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Standard-personalisierte Angebotskette für Benutzer, die die Bedingungen anderer personalisierter Ketten nicht erfüllen", "en": "Default personalized offer chain for users that do not meet the conditions of other personalized chains", "fr": "Chaîne d'offres personnalisée par défaut pour les utilisateurs qui ne répondent pas aux conditions des autres chaînes personnalisées", "it": "Catena di offerte personalizzata predefinita per gli utenti che non soddisfano le condizioni di altre catene personalizzate", "ru": "Персонализированная цепочка по умолчанию для пользователей, не подходящих под условия других персонализированных цепочек" }, "id": 1, "is_always_visible": false, "is_enabled": true, "name": { "de": "Neue personalisierte Standard-Angebotskette", "en": "New personalized default offer chain", "fr": "Nouvelle chaîne d'offres personnalisée par défaut", "it": "Nuova catena di offerte personalizzata predefinita", "ru": "Новая персонализированная цепочка предложений по умолчанию" }, "order": 1, "recurrent_schedule": null }, { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "elf" }, { "attribute": "level", "can_be_missing": false, "operator": "ge", "type": "number", "value": "10" }, { "attribute": "10_level_up_date", "can_be_missing": false, "operator": "le", "type": "date", "value": "2026-01-01T00:00:00" } ], "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Personalisierte Angebotskette mit Benutzerattributbedingungen - für Elfen der Stufe 10 und höher, die Stufe 10 spätestens am 2026-01-01 00:00:00 erreicht haben, einschließlich", "en": "Personalized offer chain with user attribute conditions - for level 10 and above elves who reached level 10 no later than 2026-01-01 00:00:00, inclusive", "fr": "Chaîne d'offres personnalisée avec des conditions d'attribut utilisateur - pour les elfes de niveau 10 et plus qui ont atteint le niveau 10 au plus tard le 2026-01-01 00:00:00, inclus", "it": "Catena di offerte personalizzata con condizioni di attributo utente - per elfi di livello 10 e superiore che hanno raggiunto il livello 10 non più tardi del 2026-01-01 00:00:00, inclusi", "ru": "Персонализированная цепочка предложений с условиями по атрибутам пользователя - для эльфов уровня 10 и выше, достигших 10 уровня не позднее 2026-01-01 00:00:00 включительно" }, "id": 2, "is_always_visible": false, "is_enabled": true, "name": { "de": "Neue personalisierte Angebotskette", "en": "New personalized offer chain", "fr": "Nouvelle chaîne d'offres personnalisée", "it": "Nuova catena di offerte personalizzata", "ru": "Новая персонализированная цепочка предложений" }, "order": 2, "recurrent_schedule": null }, { "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Angebotskette, die sich wöchentlich mittwochs um 07:00 Uhr GMT+3 zurücksetzt", "en": "Offer chain that resets weekly on Wednesdays at 07:00 GMT+3", "fr": "Chaîne d'offres qui se réinitialise chaque semaine le mercredi à 07h00 GMT+3", "it": "Catena di offerte che si resetta settimanalmente il mercoledì alle 07:00 GMT+3", "ru": "Цепочка предложений, которая сбрасывается еженедельно по средам в 07:00 GMT+3" }, "id": 4, "is_always_visible": true, "is_enabled": false, "name": { "de": "Wöchentliche Angebotskette", "en": "Weekly offer chain", "fr": "Chaîne d'offres hebdomadaire", "it": "Catena di offerte settimanale", "ru": "Еженедельная цепочка предложений" }, "order": 3, "recurrent_schedule": { "day_of_week": 3, "displayable_reset_next_date": "2018-12-05T07:00:00+03:00", "displayable_reset_start_date": "2018-12-05T07:00:00+03:00", "interval_type": "weekly", "reset_next_date": 1543982400, "time": "07:00:00+03:00" } }, { "date_end": "2025-08-28T15:00:00+08:00", "date_start": "2025-04-15T00:00:00+08:00", "description": { "de": "Angebotskette, die sich monatlich am 28. um 15:00 Uhr GMT+8 zurücksetzt", "en": "Offer chain that resets monthly on the 28th at 15:00 GMT+8", "fr": "Chaîne d'offres qui se réinitialise mensuellement le 28 à 15h00 GMT+8", "it": "Catena di offerte che si resetta mensilmente il 28 alle 15:00 GMT+8", "ru": "Цепочка предложений, которая сбрасывается ежемесячно 28-го числа в 15:00 GMT+8" }, "id": 5, "is_always_visible": true, "is_enabled": true, "name": { "de": "Monatliche Angebotskette", "en": "Monthly offer chain", "fr": "Chaîne d'offres mensuelle", "it": "Catena di offerte mensile", "ru": "Ежемесячная цепочка предложений" }, "order": 4, "recurrent_schedule": { "day_of_month": 28, "displayable_reset_next_date": "2025-05-28T15:00:00+08:00", "displayable_reset_start_date": "2025-05-28T15:00:00+08:00", "interval_type": "monthly", "reset_next_date": 1748415600, "time": "15:00:00+08:00" } } ] } }, "200-clan-reward-chain": { "summary": "公会奖励链示例", "value": { "clan_type": "guild", "description": { "en": "Clan reward chain description." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_enabled": true, "long_description": { "en": "Clan reward chain long description." }, "name": { "en": "Clan reward chain" }, "order": 1, "periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2021-04-15T18:16:00+05:00" } ], "popup_header": { "en": "How to unlock rewards" }, "popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "popup_instruction": { "en": "You must be a clan member in order to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan." }, "recurrent_schedule": { "day_of_week": 2, "displayable_reset_next_date": "2023-03-07T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "weekly", "reset_next_date": 1677553200, "time": "11:00:00+08:00" }, "reward_chain_id": 1, "steps": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "First step of the reward chain" }, "price": { "amount": 10 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_1" }, { "quantity": 1, "sku": "com.xsolla.item_2" } ], "step_id": 1 }, { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "Second step of the reward chain" }, "price": { "amount": 15 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_3" }, { "quantity": 1, "sku": "com.xsolla.item_4" } ], "step_id": 2 } ], "value_point": { "description": { "en": "Value points for clan reward system." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "is_enabled": true, "long_description": { "en": "Value points given to clans to get new rewards in a certain reward chain." }, "media_list": [], "name": { "en": "Clan Reward VP 1" }, "order": 1, "sku": "com.xsolla.clan_value_point_1" } } }, "200-client-daily-chain": { "summary": "用户每日奖励示例", "value": { "date_end": "2025-04-03T18:16:00+05:00", "date_start": "2025-04-01T18:16:00+05:00", "description": "Active daily reward description", "id": 101, "name": "Active daily reward", "order": 1, "steps": [ { "items": [ { "bundle_type": "standard", "content": [ { "description": "Virtual good one", "image_url": "https://picture.virtual-good-picture.png", "is_free": false, "item_id": 1, "name": "virtual_good_one", "quantity": 1, "sku": "d0df11c5-f7c4-4907-9ae1-7dd40cecab05", "type": "virtual_good" }, { "description": "Gold Coins", "image_url": "https://picture.gold_coins.png", "is_free": false, "item_id": 2, "name": "Gold Coins", "quantity": 100, "sku": "coins", "type": "virtual_currency" } ], "description": "Many stuff", "image_url": "https://picture.bundle-with-many-stuff.png", "is_free": false, "item_id": 10001, "name": "Bundle with awesome stuff!", "quantity": 1, "sku": "bundle_with_items", "type": "bundle" } ], "status": "blocked", "step_number": 1, "unlocked_date": 1711978560 }, { "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "quantity": 1, "sku": "health_potion", "type": "virtual_good" } ], "status": "claimed", "step_number": 2, "unlocked_date": 1712064960 }, { "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "quantity": 2, "sku": "health_potion", "type": "virtual_good" } ], "status": "claimable", "step_number": 3, "unlocked_date": 1712151360 }, { "items": [ { "description": "store_item_0_lost_telescope_2_short_description", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9011, "name": "Free item", "quantity": 1, "sku": "free_item", "type": "virtual_good" } ], "status": "claim_in_future", "step_number": 4, "unlocked_date": 1712237760 } ], "type": "calendar_hard" } }, "200-client-daily-chain-list": { "summary": "用户每日奖励列表示例", "value": { "has_more": false, "items": [ { "date_end": "2025-04-03T18:16:00+05:00", "date_start": "2025-04-01T18:16:00+05:00", "description": null, "id": 101, "name": "Active daily reward", "order": 1, "steps": [ { "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "quantity": 1, "sku": "health_potion", "type": "virtual_good" } ], "status": "claimed", "step_number": 1, "unlocked_date": 1711978560 }, { "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "quantity": 2, "sku": "health_potion", "type": "virtual_good" } ], "status": "claimable", "step_number": 2, "unlocked_date": 1712064960 }, { "items": [ { "description": "store_item_0_lost_telescope_2_short_description", "image_url": "https://picture.bundle-picture.png", "is_free": true, "item_id": 9011, "name": "Free item", "quantity": 1, "sku": "free_item", "type": "virtual_good" } ], "status": "claim_in_future", "step_number": 3, "unlocked_date": 1712151360 } ], "type": "calendar_hard" }, { "date_end": "2025-05-03T18:16:00+05:00", "date_start": "2025-05-01T18:16:00+05:00", "description": null, "id": 102, "name": "Active daily reward 2", "order": 1, "steps": [ { "items": [ { "description": "store_item_0_lost_telescope_2_short_description", "image_url": "https://picture.bundle-picture.png", "is_free": true, "item_id": 9011, "name": "Free item", "quantity": 3, "sku": "free_item", "type": "virtual_good" } ], "status": "claimable", "step_number": 1, "unlocked_date": 1714560960 }, { "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "quantity": 3, "sku": "health_potion", "type": "virtual_good" } ], "status": "claim_in_future", "step_number": 2, "unlocked_date": 1714647360 } ], "type": "calendar_hard" }, { "date_end": "2025-04-03T18:16:00+05:00", "date_start": "2025-04-01T18:16:00+05:00", "description": null, "id": 103, "name": "Active daily reward 3", "order": 1, "steps": [ { "items": [ { "description": "store_item_0_lost_telescope_2_short_description", "image_url": "https://picture.bundle-picture.png", "is_free": true, "item_id": 9011, "name": "Free item", "quantity": 3, "sku": "free_item", "type": "virtual_good" } ], "status": "claimable", "step_number": 1, "unlocked_date": 1711978560 }, { "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "quantity": 3, "sku": "health_potion", "type": "virtual_good" } ], "status": "blocked", "step_number": 2, "unlocked_date": 1712064960 }, { "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "quantity": 3, "sku": "health_potion", "type": "virtual_good" } ], "status": "blocked", "step_number": 3, "unlocked_date": 1712151360 } ], "type": "calendar_hard" }, { "date_end": "2025-04-28T10:00:00+05:00", "date_start": "2025-04-01T10:00:00+05:00", "description": null, "id": 104, "name": "Active daily rolling reward", "order": 1, "steps": [ { "items": [ { "description": "Item one description", "image_url": "https://picture.bundle-picture.png", "is_free": true, "item_id": 1001, "name": "Item One", "quantity": 1, "sku": "item_one", "type": "virtual_good" } ], "status": "claimed", "step_number": 1, "unlocked_date": -1 }, { "items": [ { "description": "Item two description", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 1002, "name": "Item Two", "quantity": 1, "sku": "item_two", "type": "virtual_good" } ], "status": "claimable", "step_number": 2, "unlocked_date": 1712064960 }, { "items": [ { "description": "Item three description", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 1003, "name": "Item Three", "quantity": 1, "sku": "item_three", "type": "virtual_good" } ], "status": "claim_in_future", "step_number": 3, "unlocked_date": 1712151360 } ], "type": "rolling_skippable" } ], "total_items_count": 3 } }, "200-client-get-reward-chains-list": { "value": { "has_more": false, "items": [ { "clan_type": null, "date_end": "2023-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": "Big weekly quest", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "long_description": "You can get a lot of additional items just by shopping during the week", "name": "Weekly quest", "order": 1, "popup_header": null, "popup_image_url": null, "popup_instruction": null, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "reward_chain_id": 10, "steps": [ { "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_claimed": true, "name": "Level 1", "price": { "amount": 100 }, "reward": [ { "description": "Super box with items", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "name": "Super box", "quantity": 1, "sku": "com.xsolla.box_1", "type": "bundle" }, { "description": "Mega box with items", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "name": "Mega box", "quantity": 1, "sku": "com.xsolla.box_2", "type": "bundle" } ], "step_id": 1 }, { "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_claimed": false, "name": "Level 2", "price": { "amount": 200 }, "reward": [ { "description": "Super box with items", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "name": "Super box", "quantity": 2, "sku": "com.xsolla.box_1", "type": "bundle" }, { "description": "Mega box with items", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "name": "Mega box", "quantity": 2, "sku": "com.xsolla.box_2", "type": "bundle" } ], "step_id": 2 } ], "top_contributors": [], "value_point": { "amount": 130, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "long_description": null, "name": "Value point", "sku": "com.xsolla.value_point_1" } }, { "clan_type": "guild", "date_end": "2023-10-15T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": "Major weekly clan quest.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "long_description": "You and your clan members can get additional items for shopping during a certain month.", "name": "Weekly clan quest", "order": 2, "popup_header": { "en": "How to unlock rewards" }, "popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "popup_instruction": { "en": "You should be a clan member to get clan rewards. You join a clan when a clan member invited you to the clan, and you accepted the invite. You can create your own clan." }, "recurrent_schedule": { "interval_type": "monthly", "reset_next_date": 1746057600 }, "reward_chain_id": 12, "steps": [ { "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_claimed": true, "name": "Level 1", "price": { "amount": 100 }, "reward": [ { "description": "Super box with items", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "name": "Super box", "quantity": 1, "sku": "com.xsolla.box_1", "type": "bundle" }, { "description": "Mega box with items", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "name": "Mega box", "quantity": 1, "sku": "com.xsolla.box_2", "type": "bundle" } ], "step_id": 1 }, { "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_claimed": false, "name": "Level 2", "price": { "amount": 200 }, "reward": [ { "description": "Super box with items", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "name": "Super box", "quantity": 2, "sku": "com.xsolla.box_1", "type": "bundle" }, { "description": "Mega box with items", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "name": "Mega box", "quantity": 2, "sku": "com.xsolla.box_2", "type": "bundle" } ], "step_id": 2 } ], "top_contributors": [ { "contributed_amount": 100, "name": "Rabbit" }, { "contributed_amount": 80, "name": "Rocket" }, { "contributed_amount": 40, "name": "Rain" } ], "value_point": { "amount": 80, "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "long_description": "Value points given to clans to get new rewards in a reward chain.", "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } } ], "total_items_count": 1 } }, "200-client-get-user-clan-reward-chain-balance": { "summary": "公会奖励链示例", "value": { "amount": 80, "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "long_description": "Value points given to clans to get new rewards in a reward chain.", "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } }, "200-client-get-user-reward-chain-balance": { "summary": "奖励链示例", "value": { "amount": 130, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": false, "long_description": null, "name": "Value point", "sku": "com.xsolla.value_point_1" } }, "200-client-offer-chain": { "summary": "用户优惠链示例", "value": { "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2010-04-15T18:16:00+05:00", "description": null, "id": 4, "name": "Offer chain with bundles", "next_step_number": 1, "order": 1, "recurrent_schedule": null, "steps": [ { "is_claimed": false, "is_free": false, "items": [ { "bundle_type": "standard", "content": [ { "description": "virtual_good_short_description_d0df11c5-f7c4-4907-9ae1-7dd40cecab05", "image_url": "https://popmedia.blob.core.windows.net/popyourself/female/accessory/female_crossnecklace_2_silver-01.png", "is_free": false, "item_id": 1, "name": "Virtual Good Bundle", "quantity": 1, "sku": "d0df11c5-f7c4-4907-9ae1-7dd40cecab05", "type": "virtual_good" }, { "description": "Big Rocket - short description", "image_url": "https://picture.bigrocket.png", "is_free": false, "item_id": 7009, "name": "Big Rocket", "quantity": 1, "sku": "vg-in-bundle-big-rocket", "type": "virtual_good" }, { "description": "Gold Coins - short description", "image_url": "https://picture.gold_coins.png", "is_free": true, "item_id": 7010, "name": "Gold Coins", "quantity": 100, "sku": "vc-in-bundle-gold-coins", "type": "virtual_currency" }, { "description": "Some Game - short description", "image_url": "https://picture.some_game.png", "is_free": true, "item_id": 7011, "name": "Some Game", "quantity": 1, "sku": "digital-content-drm-in-bundle-awesome-game", "type": "virtual_good" }, { "bundle_type": "standard", "content": [ { "description": "Gold Coins - short description", "image_url": "https://picture.gold_coins.png", "is_free": true, "item_id": 7010, "name": "Gold Coins", "quantity": 1, "sku": "vc-in-bundle-gold-coins", "type": "virtual_currency" } ], "description": "Bundle - short description", "image_url": "https://picture.bundle-picture.png", "is_free": true, "item_id": 7012, "name": "Some Bundle in Bundle", "quantity": 1, "sku": "bundle-in-bundle-another-bundle", "type": "bundle" }, { "description": "Lootbox in bundle - short description", "image_url": "https://picture.lootbox-picture.png", "is_free": true, "item_id": 7013, "name": "Some Lootbox", "quantity": 1, "sku": "lootbox-in-bundle-awesome-game", "type": "lootbox" } ], "description": "Many stuff", "image_url": "https://picture.bundle-with-many-stuff.png", "is_free": false, "item_id": 7008, "name": "Bundle with many awesome stuff!", "order": 0, "quantity": 5, "sku": "bundle_with_many_items", "type": "bundle" } ], "step_number": 1, "step_price": { "amount": 499.95, "currency": "USD" }, "step_vp_rewards": null }, { "is_claimed": false, "is_free": true, "items": [ { "bundle_type": "standard", "content": [], "description": "No", "image_url": "https://picture.bundle-no-items.png", "is_free": true, "item_id": 7007, "name": "Empty bundle", "order": 0, "quantity": 10, "sku": "bundle-empty", "type": "bundle" } ], "step_number": 2, "step_price": null, "step_vp_rewards": null } ] } }, "200-client-offer-chain-list": { "summary": "用户优惠链列表示例", "value": { "has_more": false, "items": [ { "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2018-04-15T18:16:00+05:00", "description": null, "id": 101, "name": "Active offer chain", "next_step_number": 1, "order": 1, "recurrent_schedule": null, "steps": [ { "is_claimed": false, "is_free": false, "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "order": 0, "quantity": 1, "sku": "health_potion", "type": "virtual_good" } ], "step_number": 1, "step_price": { "amount": 99.99, "currency": "USD" }, "step_vp_rewards": [ { "amount": 15, "image_url": "https://popmedia.blob.core.windows.net/popyourself/female/accessory/female_crossnecklace_2_silver-01.png", "is_clan": true, "item_id": 6039, "name": "store_item_0_test_value_point_name", "sku": "test_value_point_39" } ] }, { "is_claimed": false, "is_free": false, "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "order": 0, "quantity": 2, "sku": "health_potion", "type": "virtual_good" } ], "step_number": 2, "step_price": { "amount": 199.98, "currency": "USD" }, "step_vp_rewards": [ { "amount": 30, "image_url": "https://popmedia.blob.core.windows.net/popyourself/female/accessory/female_crossnecklace_2_silver-01.png", "is_clan": true, "item_id": 6039, "name": "store_item_0_test_value_point_name", "sku": "test_value_point_39" } ] }, { "is_claimed": false, "is_free": true, "items": [ { "description": "store_item_0_lost_telescope_2_short_description", "image_url": "https://picture.bundle-picture.png", "is_free": true, "item_id": 9011, "name": "Free item", "order": 0, "quantity": 1, "sku": "free_item", "type": "virtual_good" } ], "step_number": 3, "step_price": null, "step_vp_rewards": null } ] }, { "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2018-04-15T18:16:00+05:00", "description": null, "id": 102, "name": "Active offer chain 2", "next_step_number": 1, "order": 1, "recurrent_schedule": null, "steps": [ { "is_claimed": false, "is_free": true, "items": [ { "description": "store_item_0_lost_telescope_2_short_description", "image_url": "https://picture.bundle-picture.png", "is_free": true, "item_id": 9011, "name": "Free item", "order": 0, "quantity": 3, "sku": "free_item", "type": "virtual_good" } ], "step_number": 1, "step_price": null, "step_vp_rewards": null }, { "is_claimed": false, "is_free": true, "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "order": 0, "quantity": 3, "sku": "health_potion", "type": "virtual_good" } ], "step_number": 2, "step_price": null, "step_vp_rewards": [ { "amount": 45, "image_url": "https://popmedia.blob.core.windows.net/popyourself/female/accessory/female_crossnecklace_2_silver-01.png", "is_clan": true, "item_id": 6039, "name": "store_item_0_test_value_point_name", "sku": "test_value_point_39" } ] }, { "is_claimed": false, "is_free": true, "items": [], "step_number": 3, "step_price": null, "step_vp_rewards": null } ] }, { "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2018-04-15T18:16:00+05:00", "description": null, "id": 103, "name": "Active offer chain 3", "next_step_number": 1, "order": 1, "recurrent_schedule": null, "steps": [ { "is_claimed": false, "is_free": true, "items": [ { "description": "store_item_0_lost_telescope_2_short_description", "image_url": "https://picture.bundle-picture.png", "is_free": true, "item_id": 9011, "name": "Free item", "order": 0, "quantity": 3, "sku": "free_item", "type": "virtual_good" } ], "step_number": 1, "step_price": null, "step_vp_rewards": null }, { "is_claimed": false, "is_free": false, "items": [ { "description": "Heal 10% of your health", "image_url": "https://picture.bundle-picture.png", "is_free": false, "item_id": 9012, "name": "Healing potion", "order": 0, "quantity": 3, "sku": "health_potion", "type": "virtual_good" } ], "step_number": 2, "step_price": { "amount": 299.97, "currency": "USD" }, "step_vp_rewards": [ { "amount": 45, "image_url": "https://popmedia.blob.core.windows.net/popyourself/female/accessory/female_crossnecklace_2_silver-01.png", "is_clan": true, "item_id": 6039, "name": "store_item_0_test_value_point_name", "sku": "test_value_point_39" } ] }, { "is_claimed": false, "is_free": true, "items": [], "step_number": 3, "step_price": null, "step_vp_rewards": null } ] } ], "total_items_count": 3 } }, "200-client-update-user-clan": { "value": { "reward": [ { "bundle_type": "standard", "description": "Super box with items", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "name": "Super box", "quantity": 1, "sku": "com.xsolla.box_1", "type": "bundle" }, { "description": "Mega potion", "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "name": "Mega potion", "quantity": 1, "sku": "com.xsolla.potion_1", "type": "virtual_good" } ] } }, "200-reward-chain": { "summary": "奖励链示例", "value": { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "ork" } ], "description": { "en": "Reward chain description" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_always_visible": true, "is_enabled": true, "is_reset_after_end": true, "long_description": { "en": "Reward chain long description" }, "name": { "en": "Reward chain" }, "order": 1, "periods": [ { "date_from": "2026-01-01T01:00:00+05:00", "date_until": "2026-01-31T23:59:59+05:00" }, { "date_from": "2026-02-01T01:00:00+05:00", "date_until": "2026-02-28T23:59:59+05:00" } ], "recurrent_schedule": { "day_of_week": 2, "displayable_reset_next_date": "2026-01-06T01:00:00+05:00", "displayable_reset_start_date": "2026-01-01T01:00:00+05:00", "interval_type": "weekly", "reset_next_date": 1767643200, "time": "01:00:00+05:00" }, "reward_chain_id": 1, "steps": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "First step of the reward chain" }, "price": { "amount": 10 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_1" }, { "quantity": 1, "sku": "com.xsolla.item_2" } ], "step_id": 1 }, { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "Second step of the reward chain" }, "price": { "amount": 15 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_3" }, { "quantity": 1, "sku": "com.xsolla.item_4" } ], "step_id": 2 } ], "value_point": { "description": { "en": "Value points for reward system." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": false, "is_enabled": true, "long_description": { "en": "Value points given to users to get new rewards in a reward chain." }, "media_list": [], "name": { "en": "Reward VP 1" }, "order": 1, "sku": "com.xsolla.reward_vp_1", "type": "value_point" } } }, "200-reward-chain-list": { "value": { "has_more": true, "items": [ { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "ork" } ], "description": { "en": "Reward chain description" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_always_visible": true, "is_enabled": true, "is_reset_after_end": true, "long_description": { "en": "Reward chain long description" }, "name": { "en": "Reward chain" }, "order": 1, "periods": [ { "date_from": "2026-01-01T01:00:00+05:00", "date_until": "2026-01-31T23:59:59+05:00" }, { "date_from": "2026-02-01T01:00:00+05:00", "date_until": "2026-02-28T23:59:59+05:00" } ], "recurrent_schedule": null, "reward_chain_id": 1, "value_point": { "description": "Value points for standard reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": false, "is_enabled": true, "long_description": "Value points given to users to get new rewards in a reward chain.", "media_list": [], "name": { "en": "Reward VP 1" }, "order": 1, "sku": "com.xsolla.reward_vp_1", "type": "value_point" } }, { "clan_type": "guild", "description": { "en": "Clan reward chain description." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_enabled": true, "long_description": { "en": "Clan reward chain long description." }, "name": { "en": "Clan reward chain" }, "order": 1, "periods": [ { "date_from": "2026-01-01T01:00:00+05:00", "date_until": "2026-01-31T23:59:59+05:00" }, { "date_from": "2026-02-01T01:00:00+05:00", "date_until": "2026-02-28T23:59:59+05:00" } ], "popup_header": { "en": "How to unlock rewards" }, "popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "popup_instruction": { "en": "You must be a clan member in order to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan." }, "recurrent_schedule": { "day_of_month": null, "day_of_week": 2, "displayable_reset_next_date": "2026-01-06T01:00:00+05:00", "displayable_reset_start_date": "2026-01-01T01:00:00+05:00", "interval_type": "weekly", "reset_next_date": 1767643200, "time": "01:00:00+05:00" }, "reward_chain_id": 2, "value_point": { "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "is_enabled": true, "long_description": "Value points given to clans to get new rewards in a reward chain.", "media_list": [], "name": { "en": "Clan Reward VP 1" }, "order": 1, "sku": "com.xsolla.clan_value_point_1" } } ] } }, "200-value-points-reward-chain_admin_get-value-point": { "value": { "can_delete": false, "description": { "en": "Points for reward system" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": false, "is_enabled": true, "long_description": { "en": "Points given to users to get new rewards in a reward chain." }, "media_list": [], "name": { "en": "Reward VP 1" }, "order": 1, "sku": "com.xsolla.reward_vp_1", "type": "value_point" } }, "200-value-points-reward-chain_admin_get-value-point-list": { "value": { "items": [ { "description": { "en": "Points for reward system" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": false, "is_enabled": true, "long_description": { "en": "Points given to users to get new rewards in a reward chain." }, "media_list": [], "name": { "en": "Reward VP 1" }, "order": 1, "sku": "com.xsolla.reward_vp_1", "type": "value_point" }, { "description": { "en": "Value points for reward system." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": false, "is_enabled": false, "long_description": { "en": "Value points given to users to get new rewards in a reward chain." }, "media_list": [], "name": { "en": "Reward VP 2" }, "order": 2, "sku": "com.xsolla.reward_vp_2", "type": "value_point" }, { "description": { "en": "Value points for clan reward system." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "is_enabled": true, "long_description": { "en": "Value points given to clans to get new rewards in a reward chain." }, "media_list": [], "name": { "en": "Clan Reward VP 1" }, "order": 3, "sku": "com.xsolla.clan_value_point_1" } ] } }, "200-value-points-rewards-list": { "value": { "items": [ { "amount": 100, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "item_id": 14232, "name": { "en": "Booster" }, "sku": "com.xsolla.booster_1" }, { "amount": 200, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "item_id": 14232, "name": { "en": "Mega Booster" }, "sku": "com.xsolla.booster_mega" } ] } }, "401-complex-auth-header-not-found": { "value": { "errorCode": 1501, "errorMessage": "[0401-1501]: Authorization failed: Authorization header not sent", "statusCode": 401, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "401-complex-auth-incorrect-credentials": { "value": { "errorCode": 1013, "errorMessage": "[0401-1013]: Token not found.", "statusCode": 401, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-coupon-not-found": { "value": { "errorCode": 9802, "errorMessage": "[0401-9802]: Coupon not found", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-daily-chain-not-found": { "description": "Daily reward was not found.", "summary": "未找到每日奖励", "value": { "errorCode": 6201, "errorMessage": "[0401-6201]: Chain not found", "errorMessageExtended": { "chain_id": 4, "project_id": 0 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-daily-chain-step-not-found": { "description": "Daily reward step was not found.", "summary": "未找到每日奖励步骤", "value": { "errorCode": 6304, "errorMessage": "[0401-6304]: Daily Chain Step not found", "errorMessageExtended": { "chain_id": 100, "step_number": 1 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-offer-chain-not-found": { "description": "Offer chain step was not found.", "summary": "未找到优惠链", "value": { "errorCode": 6201, "errorMessage": "[0401-6201]: Chain not found", "errorMessageExtended": { "chain_id": 4, "project_id": 0 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-offer-chain-step-not-found": { "description": "Offer chain step was not found.", "summary": "未找到链步骤", "value": { "errorCode": 6304, "errorMessage": "[0401-6304]: Offer Chain Step not found", "errorMessageExtended": { "chain_id": 100, "step_number": 1 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-promotion-by-id-not-found": { "value": { "errorCode": 1101, "errorMessage": "[0401-1101]: Promotion not found", "statusCode": 404, "transactionId": "transaction id" } }, "404-user-not-found": { "value": { "errorCode": 5008, "errorMessage": "[0401-5008]: Could not find User", "statusCode": 404, "transactionId": "transaction id" } }, "422-activate-deactivate-promotion": { "value": { "errorCode": 9505, "errorMessage": "[0401-9505]: Error was occurred while promotion was being updated", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-admin-daily-chain-error-activated": { "description": "Active daily reward have to be deactivated before being updated.", "summary": "活跃的每日奖励无法更新", "value": { "errorCode": 6209, "errorMessage": "[0401-6209]: Active chain cannot be updated. Please deactivate it first", "errorMessageExtended": { "chain_id": 2, "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-daily-chain-error-chain-id-mismatch": { "description": "Daily reward ID specified in the body does not match the URL.", "summary": "每日奖励ID不匹配", "value": { "errorCode": 6205, "errorMessage": "[0401-6205]: Chain ID mismatch. Please, check the chain ID in your request body and URL", "errorMessageExtended": { "body_chain_id": 2, "project_id": 0, "url_chain_id": 1 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-daily-chain-error-duplicate-step-ids": { "description": "Please, ensure that daily reward step IDs are unique in the request body.", "summary": "每日奖励步骤ID重复", "value": { "errorCode": 6207, "errorMessage": "[0401-6207]: Duplicate chain step IDs detected in the request body", "errorMessageExtended": { "chain_id": 3, "chain_step_id_list": [ 8, 9, 10 ], "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-daily-chain-error-incorrect-items": { "description": "Specified items are not allowed, disabled or not found. Only enabled items of following types are allowed: virtual item, bundle, virtual currency package.", "summary": "步骤项错误", "value": { "errorCode": 6211, "errorMessage": "[0401-6211]: Chain steps items are not allowed or not found", "errorMessageExtended": { "invalid_items": { "disabled": [ "vg_disabled_item_1", "vg_disabled_item_2", "vc_disabled_1" ], "invalid_item_type": { "allowed_item_type_list": [ "virtual_good", "bundle" ], "sku_map": { "gk_steam_enabled_shown_in_store_1": "game_key", "unit_enabled_shown_in_store_1": "unit", "vc_disabled_1": "virtual_currency", "vc_enabled_shown_in_store_1": "virtual_currency" } }, "not_found": [ "vg_deleted_item_1", "vg_deleted_item_2", "not_existing_sku_404_1", "not_existing_sku_404_2" ] }, "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-xX-x-transactionId-mock-x-x-x" } }, "422-admin-daily-chain-error-incorrect-period": { "description": "Please ensure start date is earlier than end date.", "summary": "每日奖励周期错误", "value": { "errorCode": 6204, "errorMessage": "[0401-6204]: Period of a chain is invalid. Please, check the dates in your request", "errorMessageExtended": { "chain_id": 1, "invalid_periods": [ { "end": "2023-04-15T18:16:00+05:00", "start": "2025-04-25T18:16:00+05:00" } ], "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-daily-chain-error-incorrect-steps-order": { "description": "Daily reward steps numbers sequence is incorrect. Correct step numbers should be sequential without any gaps or duplicates.", "summary": "步骤顺序不正确", "value": { "errorCode": 6210, "errorMessage": "[0401-6210]: Chain step numbers are invalid", "errorMessageExtended": { "incorrect_step_numbers": { "duplicates": [ 2, 7 ], "missing": [ 3, 4, 5, 6 ], "out_of_range": [ 7, 8 ] }, "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-daily-chain-error-invalid-chain-step-ids": { "description": "Some of step IDs was not found. Please, double check if specified daily reward step IDs actually exist.", "summary": "未找到每日奖励步骤ID", "value": { "errorCode": 6206, "errorMessage": "[0401-6206]: Chain step IDs not found", "errorMessageExtended": { "chain_id": 1, "chain_step_id_list": [ 404000 ], "project_id": 0 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-daily-chain-error-invalid-dates": { "description": "Please, ensure dates format is valid.", "summary": "日期格式无效", "value": { "errorCode": 6204, "errorMessage": "[0401-6204]: Period of a chain is invalid. Please, check the dates in your request", "errorMessageExtended": { "chain_id": 1, "invalid_format_dates": { "date_end": "2025-04-25 19:16:00Z", "date_start": "2023-04-15 17:16:00Z" }, "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-daily-chain-error-item-limit-exceeded": { "description": "Daily reward step item count exceeds the allowed limit for some steps. Currently only 1 item per step is allowed.", "summary": "超出商品数量限制", "value": { "errorCode": 6208, "errorMessage": "[0401-6208]: Chain step item count exceeds the allowed limit for some steps", "errorMessageExtended": { "max_items": 1, "project_id": 0, "steps_exceeded_limits": [ { "items_count": 2, "step_number": 1 }, { "items_count": 3, "step_number": 4 } ] }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-daily-chain-error-too-many-steps": { "description": "Daily reward steps max amount limit of 30 items is exceeded. Try specifying less steps.", "summary": "步骤数量过多", "value": { "errorCode": 6203, "errorMessage": "[0401-6203]: Chain step count exceeds the allowed limit", "errorMessageExtended": { "max_steps": 30, "project_id": 0, "step_count": 31 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-offer-chain-error-activated": { "description": "Active offer chain has to be deactivated before being updated. To do this, use the Toggle offer chain call.", "summary": "不可更新活跃中的优惠链", "value": { "errorCode": 6209, "errorMessage": "[0401-6209]: Active chain cannot be updated. Please deactivate it first", "errorMessageExtended": { "chain_id": 2, "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-offer-chain-error-chain-id-mismatch": { "description": "Offer chain ID in the request body does not match the ID in the URL.", "summary": "链ID不匹配", "value": { "errorCode": 6205, "errorMessage": "[0401-6205]: Chain ID mismatch. Please, check the chain ID in your request body and URL", "errorMessageExtended": { "body_chain_id": 2, "project_id": 0, "url_chain_id": 1 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-offer-chain-error-duplicate-step-ids": { "description": "Chain step IDs must be unique in the request body.", "summary": "存在重复的链步骤ID", "value": { "errorCode": 6207, "errorMessage": "[0401-6207]: Duplicate chain step IDs detected in the request body", "errorMessageExtended": { "chain_id": 3, "chain_step_id_list": [ 8, 9, 10 ], "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-offer-chain-error-incorrect-items": { "description": "Specified items are either unavailable, or not found. Only enabled items of the following types are supported: virtual items, bundles, and virtual currency packages.", "summary": "步骤项无效", "value": { "errorCode": 6211, "errorMessage": "[0401-6211]: Chain steps items are not allowed or not found", "errorMessageExtended": { "invalid_items": { "disabled": [ "vg_disabled_item_1", "vg_disabled_item_2", "vc_disabled_1" ], "invalid_item_type": { "allowed_item_type_list": [ "virtual_good", "bundle" ], "sku_map": { "gk_steam_enabled_shown_in_store_1": "game_key", "unit_enabled_shown_in_store_1": "unit", "vc_disabled_1": "virtual_currency", "vc_enabled_shown_in_store_1": "virtual_currency" } }, "not_found": [ "vg_deleted_item_1", "vg_deleted_item_2", "not_existing_sku_404_1", "not_existing_sku_404_2" ] }, "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-xX-x-transactionId-mock-x-x-x" } }, "422-admin-offer-chain-error-incorrect-period": { "description": "The start date must be earlier than the end date.", "summary": "优惠链时间段无效", "value": { "errorCode": 6204, "errorMessage": "[0401-6204]: Period of a chain is invalid. Please, check the dates in your request", "errorMessageExtended": { "chain_id": 1, "invalid_periods": [ { "end": "2023-04-15T18:16:00+05:00", "start": "2025-04-25T18:16:00+05:00" } ], "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-offer-chain-error-incorrect-steps-order": { "description": "The sequence of offer chain step numbers is incorrect. Step numbers must be sequential, without gaps or duplicates.", "summary": "步骤顺序无效", "value": { "errorCode": 6210, "errorMessage": "[0401-6210]: Chain step numbers are invalid", "errorMessageExtended": { "incorrect_step_numbers": { "duplicates": [ 2, 7 ], "missing": [ 3, 4, 5, 6 ], "out_of_range": [ 7, 8 ] }, "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-offer-chain-error-invalid-chain-step-ids": { "description": "Some of the step IDs were not found. Double-check that the specified chain step IDs exist. To do this, use the Get offer chain call.", "summary": "未找到链步骤ID", "value": { "errorCode": 6206, "errorMessage": "[0401-6206]: Chain step IDs not found", "errorMessageExtended": { "chain_id": 1, "chain_step_id_list": [ 404000 ], "project_id": 0 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-offer-chain-error-invalid-dates": { "description": "The date format must be valid. Use ISO 8601 format.", "summary": "日期格式无效", "value": { "errorCode": 6204, "errorMessage": "[0401-6204]: Period of a chain is invalid. Please, check the dates in your request", "errorMessageExtended": { "chain_id": 1, "invalid_format_dates": { "date_end": "2025-04-25 19:16:00Z", "date_start": "2023-04-15 17:16:00Z" }, "project_id": 0 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-offer-chain-error-item-limit-exceeded": { "description": "The number of items in one or more offer chain steps exceeds the allowed limit. Currently, only one item per step is allowed.", "summary": "超出商品数量限制", "value": { "errorCode": 6208, "errorMessage": "[0401-6208]: Chain step item count exceeds the allowed limit for some steps", "errorMessageExtended": { "max_items": 1, "project_id": 0, "steps_exceeded_limits": [ { "items_count": 2, "step_number": 1 }, { "items_count": 3, "step_number": 4 } ] }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-admin-offer-chain-error-too-many-steps": { "description": "The number of offer chain steps exceeds the allowed limit of 30. Try specifying fewer steps.", "summary": "步骤数量过多", "value": { "errorCode": 6203, "errorMessage": "[0401-6203]: Chain step count exceeds the allowed limit", "errorMessageExtended": { "max_steps": 30, "project_id": 0, "step_count": 31 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-daily-chain-claim-error-invalid-step": { "description": "Ensure the user has not previously claimed the reward and that the correct step in the daily reward is selected for claiming.", "summary": "无法领取步骤奖励", "value": { "errorCode": 6405, "errorMessage": "[0401-6405]: This step is not available to be claimed by the user.", "errorMessageExtended": { "chain_id": 1, "step_number": 1 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-offer-chain-claim-error-invalid-step": { "description": "The user must claim all previous steps, and the request must use a valid call – Create order for paid offer chain step, Claim free offer chain step for free ones.\n\nThis error is returned if one or more of the following conditions are not met:", "summary": "无法领取步骤奖励", "value": { "errorCode": 6306, "errorMessage": "[0401-6306]: This step is not valid to claim by user.", "errorMessageExtended": { "chain_id": 1, "step_number": 1 }, "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-promotion-out-of-range-available-user-limit": { "value": { "errorCode": 4511, "errorMessage": "[0401-4511]: Available promotion limit is out of range.", "statusCode": 422, "transactionId": "transaction id" } }, "422-promotion-without-user-limit": { "value": { "errorCode": 4509, "errorMessage": "[0401-4509]: Promotion does not have configured user limits.", "statusCode": 422, "transactionId": "transaction id" } }, "422-property-sku-is-required": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-user_external_id_invalid": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "Must be at least 1 characters long", "property": "user_external_id" }, { "message": "Does not match the regex pattern ^\\S+$", "property": "user_external_id" } ], "statusCode": 404, "transactionId": "transaction id" } }, "Promotions_200-admin-coupons": { "value": { "active_promotions_count": 2, "inactive_promotions_count": 0, "items": [ { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_1" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_1" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_1" } ], "external_id": "coupon_44056_1", "is_enabled": true, "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": null, "redeem_user_limit": null, "total_limit_state": null }, { "bonus": [ { "quantity": 100, "sku": "com.xsolla.diamonds_1" } ], "external_id": "summer2021", "is_enabled": true, "name": { "de-DE": "Gutscheintitel", "en-US": "Coupon name" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } } ], "total_promotions_count": 2 } }, "Promotions_200-admin-promocodes": { "value": { "active_promotions_count": 2, "inactive_promotions_count": 0, "items": [ { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_1" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_1" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_1" } ], "discount": null, "discounted_items": null, "external_id": "promocode_100_crystals", "is_enabled": true, "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": null, "redeem_user_limit": null, "total_limit_state": null }, { "bonus": [ { "quantity": 100, "sku": "com.xsolla.diamonds_1" } ], "discount": { "percent": "10.99" }, "discounted_items": [ { "discount": { "percent": "10.00" }, "sku": "com.xsolla.elven_sword_1" } ], "excluded_promotions": [ 23, 45 ], "external_id": "summer2021", "is_enabled": true, "name": { "de-DE": "Gutscheintitel", "en-US": "Coupon name" }, "price_conditions": [ { "operator": "ge", "value": "10.0000" }, { "operator": "le", "value": "50.0000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": null, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } } ], "total_promotions_count": 2 } }, "Promotions_200-admin-promotions": { "value": { "active_promotions_count": 3, "inactive_promotions_count": 2, "promotions": [ { "bonus": [ { "item": { "bundle_type": "virtual_currency_package", "content": [], "description": null, "image_url": null, "name": { "en": "Diamonds pack", "ru": "Пак кристаллов" }, "sku": "com.xsolla.diamonds_pack_1", "type": "bundle" }, "quantity": 1 } ], "condition": [ { "item": { "description": null, "image_url": null, "name": { "en": "VG name", "ru": "Название VG" }, "sku": "com.xsolla.virtual_good_bonus_2", "type": "virtual_good" } } ], "discount": null, "id": 1, "is_enabled": true, "name": { "en": "promotion_1" }, "promotion_periods": [ { "date_from": "2020-01-01T00:00:00+03:00", "date_until": null } ], "type": "item_bonus" }, { "bonus": [], "condition": [ { "item": { "description": null, "image_url": null, "name": { "en": "VG name", "ru": "Название VG" }, "sku": "com.xsolla.virtual_good_bonus_2", "type": "virtual_good" } } ], "discount": { "percent": "10.99" }, "id": 2, "is_enabled": false, "name": { "en": "promotion_2" }, "promotion_periods": [ { "date_from": "2020-01-01T00:00:00+03:00", "date_until": "2030-01-01T00:00:00+03:00" } ], "type": "item_discount" }, { "bonus": [ { "item": { "description": null, "image_url": null, "name": { "en": "VG name", "ru": "Название VG" }, "sku": "com.xsolla.virtual_good_bonus_2", "type": "virtual_good" }, "quantity": 2 } ], "condition": [ { "item": { "external_id": "coupon_2", "is_enabled": true, "name": { "en": "Coupon name", "ru": "Название купона" }, "redeem_code_limit": 1, "redeem_total_limit": null, "redeem_user_limit": null } } ], "discount": null, "id": 3, "is_enabled": true, "name": { "en": "promotion_3" }, "promotion_periods": [ { "date_from": "2020-01-01T00:00:00+03:00", "date_until": "2030-01-01T00:00:00+03:00" } ], "type": "coupon_bonus" }, { "bonus": [ { "item": { "description": null, "image_url": null, "name": { "en": "VG name", "ru": "Название VG" }, "sku": "com.xsolla.virtual_good_bonus_2", "type": "virtual_good" }, "quantity": 2 } ], "condition": [ { "item": { "external_id": "coupon_3", "is_enabled": true, "name": { "en": "Coupon name", "ru": "Название купона" }, "redeem_code_limit": 1, "redeem_total_limit": null, "redeem_user_limit": null } } ], "discount": { "percent": "12.99" }, "id": 4, "is_enabled": false, "name": { "en": "promotion_4" }, "promotion_periods": [ { "date_from": "2018-01-01T00:00:00+03:00", "date_until": "2031-01-01T00:00:00+03:00" } ], "type": "promocode_bonus_discount" }, { "bonus": [ { "item": { "description": null, "image_url": null, "name": { "en": "VG name", "ru": "Название VG" }, "sku": "com.xsolla.virtual_good_bonus_4", "type": "virtual_good" }, "quantity": 1 } ], "condition": null, "discount": null, "id": 5, "is_enabled": true, "name": { "en": "promotion_5" }, "promotion_periods": [ { "date_from": "2020-01-01T00:00:00+03:00", "date_until": null } ], "type": "cart_bonus" } ], "total_promotions_count": 5 } }, "Promotions_200-admin-unique-catalog-offers": { "value": { "active_promotions_count": 2, "inactive_promotions_count": 0, "items": [ { "external_id": "new_year_bonus", "is_enabled": true, "items": [ "booster", "booster_mega" ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": null, "redeem_user_limit": 1, "total_limit_state": null }, { "external_id": "secret_store", "is_enabled": true, "items": [ "helmet", "armor", "sword" ], "name": { "en-US": "Secret store", "ru-RU": "Тайный магазин" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": null } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } } ], "total_promotions_count": 2 } }, "Promotions_200-coupon-code-list": { "value": { "codes": [ { "code": "CODE001" }, { "code": "CODE002" }, { "code": "CODE003" }, { "code": "CODE004" }, { "code": "CODE005" } ], "total_count": 5 } }, "Promotions_200-get-coupon-rewards": { "value": { "bonus": [ { "item": { "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": { "en": "Game name" }, "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam_key_01", "is_free": false, "name": "Game name", "sku": "com.xsolla.game_key_01", "type": "game_key" }, { "drm_name": "Origin", "drm_sku": "origin_key_02", "name": "Game name", "sku": "game_key_02", "type": "game_key" } ] }, "quantity": 1 }, { "item": { "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": { "en": "Game name" }, "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam_key_01", "name": "Game name", "sku": "com.xsolla.game_key_01", "type": "game_key" } ] }, "quantity": 2 } ], "discount": { "percent": "10.00" }, "is_selectable": true } }, "Promotions_200-get-promocode-rewards": { "value": { "bonus": [ { "item": { "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam_key_01", "is_free": false, "name": "Game name", "sku": "com.xsolla.game_key_01", "type": "game_key" }, { "drm_name": "Origin", "drm_sku": "origin_key_02", "name": "Game name", "sku": "com.xsolla.game_key_02", "type": "game_key" } ] }, "quantity": 1 }, { "item": { "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam_key_01", "name": "Game name", "sku": "com.xsolla.game_key_01", "type": "game_key" } ] }, "quantity": 2 } ], "discount": { "percent": "10.00" }, "discounted_items": [ { "discount": { "percent": "10.00" }, "sku": "com.xsolla.elven_sword_1" } ], "is_selectable": true } }, "Promotions_422-invalid-coupon": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "statusCode": 422 } }, "code-limit": { "value": { "has_more": false, "items": [ { "code": "WINTER2023", "per_code": { "available": 7, "reserved": 1, "total": 10, "used": 2 } }, { "code": "SUMMER2023", "per_code": { "available": 0, "reserved": 2, "total": 5, "used": 3 } } ], "promotion_id": 1, "total_items_count": 2 } } }, "parameters": { "code-path-param": { "description": "唯一区分大小写的代码。包含字母和数字。", "in": "path", "name": "code", "required": true, "schema": { "example": "WINTER2021", "maxLength": 128, "minLength": 1, "type": "string" } }, "codes-query-param": { "description": "区分大小写的唯一代码。仅包含字母和数字。", "in": "query", "name": "codes[]", "schema": { "items": { "maxLength": 128, "minLength": 1, "type": "string" }, "type": "array" } }, "coupon_code-path-param": { "description": "区分大小写的唯一券码。包含字母和数字。", "in": "path", "name": "coupon_code", "required": true, "schema": { "example": "WINTER2021", "maxLength": 128, "minLength": 1, "type": "string" } }, "daily_chain_id-path-param": { "description": "每日奖励ID。", "in": "path", "name": "daily_chain_id", "required": true, "schema": { "example": 101, "type": "integer" } }, "daily_chain_step_number-path-param": { "description": "每日奖励步骤编号。", "in": "path", "name": "step_number", "required": true, "schema": { "example": 1, "type": "integer" } }, "enabled-query-param": { "description": "通过`is_enabled`标志筛选元素。", "in": "query", "name": "enabled", "required": false, "schema": { "type": "integer" } }, "external_id-promotion-path-param": { "description": "促销活动外部ID。项目内的唯一促销活动标识符。", "in": "path", "name": "external_id", "required": true, "schema": { "example": "coupon_44056_1", "type": "integer" } }, "is_enabled-query-param": { "description": "通过`is_enabled`标志筛选元素。", "in": "query", "name": "is_enabled", "required": false, "schema": { "type": "integer" } }, "is_expired-daily-chain-query-param": { "description": "筛选每日奖励，仅显示已过期的奖励。", "in": "query", "name": "is_expired", "required": false, "schema": { "type": "integer" } }, "item_sku-path-param": { "description": "商品SKU。", "in": "path", "name": "item_sku", "required": true, "schema": { "example": "booster_mega_1", "type": "string" } }, "limit-query-param": { "description": "页面上元素数量的限制。", "example": 50, "in": "query", "name": "limit", "required": false, "schema": { "example": 50, "minimum": 1, "type": "integer" } }, "offer_chain_id-path-param": { "description": "优惠链ID。", "in": "path", "name": "offer_chain_id", "required": true, "schema": { "example": 101, "type": "integer" } }, "offer_chain_step_number-path-param": { "description": "优惠链步骤编号。", "in": "path", "name": "step_number", "required": true, "schema": { "example": 1, "type": "integer" } }, "offset-query-param": { "description": "元素编号，从该元素开始生成列表（从0开始数）。", "example": 0, "in": "query", "name": "offset", "required": false, "schema": { "example": 0, "minimum": 0, "type": "integer" } }, "personalized-catalog-rule_id-path-param": { "description": "规则ID。", "in": "path", "name": "rule_id", "required": true, "schema": { "example": 1, "type": "number" } }, "project_id-path-param": { "description": "Project ID. You can find this parameter in your [Publisher Account](https://publisher.xsolla.com/0/projects/0/) next to the project name and in the browser address bar when working with a project. The URL has the following format: `https://publisher.xsolla.com//projects/`.", "in": "path", "name": "project_id", "required": true, "schema": { "example": 44056, "type": "integer" } }, "promocode_code-path-param": { "description": "区分大小写的唯一券码。包含字母和数字。", "in": "path", "name": "promocode_code", "required": true, "schema": { "example": "SO6rew99j9", "maxLength": 128, "minLength": 1, "type": "string" } }, "promotion_id-path-param": { "description": "促销活动ID。项目内的唯一促销活动标识符。", "in": "path", "name": "promotion_id", "required": true, "schema": { "example": 111425, "type": "integer" } }, "reward_chain_id-path-param": { "description": "奖励链ID。", "in": "path", "name": "reward_chain_id", "required": true, "schema": { "example": 101, "type": "integer" } }, "reward_chain_step_id-path-param": { "description": "奖励链步骤ID。", "in": "path", "name": "step_id", "required": true, "schema": { "example": 120, "type": "integer" } }, "type-daily-chain-query-param": { "description": "按指定类型筛选每日奖励。", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "calendar_hard", "rolling_skippable", "rolling_unskippable" ], "type": "string" } }, "user_external_id-query-param": { "description": "用户外部ID", "in": "query", "name": "user_external_id", "required": true, "schema": { "example": "d342dad2-9d59-11e9-a384-42010aa8003f", "type": "string" } }, "value_point_sku-path-param": { "description": "奖励积分SKU。", "in": "path", "name": "value_point_sku", "required": true, "schema": { "example": "value_point_3", "type": "string" } } }, "requestBodies": { "Promotions_cancel-promo-code-model": { "content": { "application/json": { "schema": { "properties": { "cart": { "properties": { "id": { "default": "current", "description": "购物车ID。", "type": "string" } }, "required": [ "id" ], "type": [ "object", "null" ] } }, "type": "object" } } } }, "Promotions_coupon-create": { "content": { "application/json": { "examples": { "personalized": { "value": { "attribute_conditions": [ { "attribute": "account_status", "can_be_missing": false, "operator": "eq", "type": "string", "value": "golden" } ], "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_2" } ], "external_id": "coupon_external_id", "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "simple": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_1" } ], "external_id": "coupon_external_id", "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } } }, "schema": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post" }, "bonus": { "$ref": "#/components/schemas/Promotions_coupon_bonus" }, "external_id": { "$ref": "#/components/schemas/Promotions_coupon-external_id" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit" }, "redeem_user_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit" } }, "required": [ "external_id", "name" ], "type": "object" } } } }, "Promotions_coupon-update": { "content": { "application/json": { "examples": { "personalized": { "value": { "attribute_conditions": [ { "attribute": "account_status", "can_be_missing": false, "operator": "eq", "type": "string", "value": "golden" } ], "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_2" } ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "simple": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_1" } ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } } }, "schema": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post" }, "bonus": { "$ref": "#/components/schemas/Promotions_coupon_bonus" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit" }, "redeem_user_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit" } }, "required": [ "name" ], "type": "object" } } } }, "Promotions_create-coupon-promocode-code": { "content": { "application/json": { "schema": { "properties": { "coupon_code": { "$ref": "#/components/schemas/Promotions_coupon_code" } }, "type": "object" } } } }, "Promotions_create-update-bonus-promotion": { "content": { "application/json": { "examples": { "personalized": { "value": { "attribute_conditions": [ { "attribute": "account_status", "can_be_missing": false, "operator": "eq", "type": "string", "value": "golden" } ], "bonus": [ { "quantity": 50000, "sku": "com.xsolla.mp_credits" } ], "condition": [ { "sku": "com.xsolla.year_1_season_pass" } ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] } }, "simple": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_1" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_1" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_1" } ], "condition": [ { "sku": "com.xsolla.elven_boots_1" }, { "sku": "com.xsolla.elven_knife_1" } ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ] } }, "with excluded promotions": { "value": { "bonus": [ { "quantity": 50000, "sku": "com.xsolla.mp_credits" } ], "condition": [ { "sku": "com.xsolla.year_1_season_pass" } ], "excluded_promotions": [ 12, 789 ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] } }, "with price conditions": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_2" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_2" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_2" } ], "condition": [ { "sku": "com.xsolla.elven_boots_2" }, { "sku": "com.xsolla.elven_knife_2" } ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "price_conditions": [ { "operator": "gt", "value": "10.0000" }, { "operator": "lt", "value": "20.0000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] } } }, "schema": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post" }, "bonus": { "items": { "description": "将作为奖励添加到用户购买项中的商品列表。", "properties": { "quantity": { "default": 1, "description": "商品数量。", "type": "number" }, "sku": { "default": "elven_shield", "description": "商品SKU。", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "condition": { "description": "要应用促销必须在购买项中包含的一组商品。如果此参数为`null`，则促销将应用于项目内的任何购买。", "items": { "properties": { "sku": { "default": "elven_sword", "description": "商品SKU。", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "excluded_promotions": { "$ref": "#/components/schemas/excluded_promotions" }, "id": { "description": "促销活动ID。项目内的唯一促销活动标识符。", "type": "integer" }, "is_enabled": { "$ref": "#/components/schemas/Promotions_is_enabled" }, "limits": { "$ref": "#/components/schemas/Promotions_promotion_limits" }, "name": { "additionalProperties": { "type": "string" }, "description": "促销活动名称。应包含键/值对，其中键是\"^[a-z]{2}-[A-Z]{2}$\"格式的区域设置，值是字符串。", "example": { "de-DE": "Sommersaison Bonus", "en-US": "Summer season bonus" }, "type": "object" }, "price_conditions": { "$ref": "#/components/schemas/price_conditions_bonus" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" } }, "required": [ "condition", "bonus", "name" ], "type": "object" } } } }, "Promotions_create-update-item-promotion": { "content": { "application/json": { "examples": { "personalized": { "value": { "attribute_conditions": [ { "attribute": "race", "operator": "eq", "type": "string", "value": "ork" }, { "attribute": "level", "can_be_missing": true, "operator": "eq", "type": "number", "value": "10" } ], "discount": { "percent": "24.00" }, "is_enabled": true, "items": [], "name": { "en-US": "Ork set discount", "ru-RU": "Скидка на набор для орка" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] } }, "simple": { "value": { "discount": { "percent": "10.00" }, "is_enabled": true, "items": [ { "sku": "com.xsolla.elven_sword_1" }, { "sku": "com.xsolla.elven_helmet_1" }, { "sku": "com.xsolla.elven_armor_1" } ], "name": { "en-US": "Promotion", "ru-RU": "Акция" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-16T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ] } }, "with excluded promotions": { "value": { "discount": { "percent": "24.00" }, "excluded_promotions": [ 12, 789 ], "is_enabled": true, "items": [], "name": { "en-US": "Ork set discount", "ru-RU": "Скидка на набор для орка" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] } }, "with price condition": { "value": { "discount": { "percent": "24.00" }, "items": [], "name": { "en-US": "Ork set discount", "ru-RU": "Скидка на набор для орка" }, "price_conditions": [ { "operator": "ge", "value": "10.5000" }, { "operator": "lt", "value": "20.5000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] } } }, "schema": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post" }, "discount": { "properties": { "percent": { "description": "百分比折扣。\n商品价格将按照此百分比打折，然后四舍五入到小数点后两位。", "example": 10, "type": "string" } }, "required": [ "percent" ], "type": "object" }, "excluded_promotions": { "$ref": "#/components/schemas/excluded_promotions" }, "is_enabled": { "$ref": "#/components/schemas/Promotions_is_enabled" }, "items": { "items": { "description": "适用折扣的商品列表。", "properties": { "sku": { "default": "elven_sword", "description": "商品SKU。", "type": "string" } }, "required": [ "sku" ], "type": "object" }, "type": "array" }, "limits": { "$ref": "#/components/schemas/Promotions_promotion_limits" }, "name": { "additionalProperties": { "type": "string" }, "description": "促销活动名称。应包含键/值对，\n其中键是格式为\"^[a-z]{2}-[A-Z]{2}$\"的区域设置，值是字符串。", "example": { "en-US": "Promotion", "ru-RU": "Акция" }, "type": "object" }, "price_conditions": { "$ref": "#/components/schemas/price_conditions_discount" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" } }, "required": [ "items", "discount", "name" ], "type": "object" } } }, "description": "包含促销活动数据的对象。", "required": true }, "Promotions_promocode-create": { "content": { "application/json": { "examples": { "personalized": { "value": { "attribute_conditions": [ { "attribute": "account_status", "can_be_missing": false, "operator": "eq", "type": "string", "value": "golden" } ], "discount": { "percent": "10.10" }, "external_id": "coupon_external_id", "name": { "de-DE": "Neujahrsrabatt", "en-US": "New Year Discount" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "simple bonus": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_1" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_1" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_1" } ], "external_id": "promo_code_external_id", "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "simple discount": { "value": { "discount": { "percent": "10.10" }, "external_id": "promo_code_external_id", "name": { "de-DE": "Neujahrsrabatt", "en-US": "New Year Discount" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "with excluded promotions": { "value": { "discount": { "percent": "10.10" }, "excluded_promotions": [ 12, 789 ], "external_id": "coupon_external_id", "name": { "de-DE": "Neujahrsrabatt", "en-US": "New Year Discount" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "with item price conditions": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_3" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_3" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_3" } ], "discount": { "percent": "10.10" }, "external_id": "promo_code_external_id", "item_price_conditions": [ { "operator": "ge", "value": "10.5000" }, { "operator": "lt", "value": "50.0000" } ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "with price conditions": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_2" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_2" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_2" } ], "external_id": "promo_code_external_id", "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "price_conditions": [ { "operator": "ge", "value": "10.5000" }, { "operator": "lt", "value": "50.0000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } } }, "schema": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post" }, "bonus": { "$ref": "#/components/schemas/Promotions_coupon_bonus" }, "discount": { "example": { "percent": "10.10" }, "properties": { "percent": { "$ref": "#/components/schemas/Promotions_promotion_discount_percent" } }, "type": [ "object", "null" ] }, "discounted_items": { "$ref": "#/components/schemas/Promotions_discounted_items" }, "excluded_promotions": { "$ref": "#/components/schemas/excluded_promotions" }, "external_id": { "$ref": "#/components/schemas/Promotions_coupon-external_id" }, "item_price_conditions": { "$ref": "#/components/schemas/item_price_conditions_promocode" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "price_conditions": { "$ref": "#/components/schemas/price_conditions_promocode" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit" }, "redeem_user_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit" } }, "required": [ "external_id", "name" ], "type": "object" } } } }, "Promotions_promocode-update": { "content": { "application/json": { "examples": { "personalized": { "value": { "attribute_conditions": [ { "attribute": "account_status", "can_be_missing": false, "operator": "eq", "type": "string", "value": "golden" } ], "discount": { "percent": "10.10" }, "name": { "de-DE": "Neujahrsrabatt", "en-US": "New Year Discount" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "simple bonus": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_1" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_1" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_1" } ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "simple discount": { "value": { "discount": { "percent": "10.10" }, "name": { "de-DE": "Neujahrsrabatt", "en-US": "New Year Discount" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "with excluded promotions": { "value": { "discount": { "percent": "10.10" }, "excluded_promotions": [ 12, 789 ], "name": { "de-DE": "Neujahrsrabatt", "en-US": "New Year Discount" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "with item price conditions": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_3" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_3" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_3" } ], "discount": { "percent": "10.10" }, "item_price_conditions": [ { "operator": "gt", "value": "10.5000" }, { "operator": "lt", "value": "50.0000" } ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "with price conditions": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_2" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_2" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_2" } ], "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "price_conditions": [ { "operator": "gt", "value": "10.5000" }, { "operator": "lt", "value": "50.0000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } } }, "schema": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post" }, "bonus": { "$ref": "#/components/schemas/Promotions_coupon_bonus" }, "discount": { "example": { "percent": "10.10" }, "properties": { "percent": { "$ref": "#/components/schemas/Promotions_promotion_discount_percent" } }, "type": [ "object", "null" ] }, "discounted_items": { "$ref": "#/components/schemas/Promotions_discounted_items" }, "excluded_promotions": { "$ref": "#/components/schemas/excluded_promotions" }, "item_price_conditions": { "$ref": "#/components/schemas/item_price_conditions_promocode" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "price_conditions": { "$ref": "#/components/schemas/price_conditions_promocode" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit" }, "redeem_user_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit" } }, "required": [ "name" ], "type": "object" } } } }, "Promotions_redeem-coupon-model": { "content": { "application/json": { "schema": { "properties": { "coupon_code": { "default": "WINTER2021", "description": "唯一优惠券码。包含字母和数字。", "example": "WINTER2021", "maxLength": 128, "minLength": 1, "type": "string" }, "selected_unit_items": { "$ref": "#/components/schemas/Promotions_selected_unit_items" } }, "type": "object" } } } }, "Promotions_redeem-promo-code-model": { "content": { "application/json": { "schema": { "properties": { "cart": { "properties": { "id": { "default": "current", "description": "购物车ID。", "type": "string" } }, "required": [ "id" ], "type": [ "object", "null" ] }, "coupon_code": { "default": "SUMMER2021", "description": "唯一促销码代码。包含字母和数字。", "example": "SUMMER2021", "maxLength": 128, "minLength": 1, "type": "string" }, "selected_unit_items": { "$ref": "#/components/schemas/Promotions_selected_unit_items" } }, "type": "object" } } } }, "Promotions_unique_catalog_offer-create": { "content": { "application/json": { "examples": { "limited": { "value": { "date_end": "2020-04-25T18:16:00+05:00", "date_start": "2020-04-15T18:16:00+05:00", "external_id": "offer_external_id", "items": [ "elven_sword", "elven_boots" ], "name": { "de-DE": "Neujahrsangebot", "en-US": "New Year Offer" }, "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "simple": { "value": { "date_end": "2020-04-25T18:16:00+05:00", "date_start": "2020-04-15T18:16:00+05:00", "external_id": "offer_external_id", "items": [ "elven_sword", "elven_boots" ], "name": { "de-DE": "Neujahrsangebot", "en-US": "New Year Offer" } } } }, "schema": { "properties": { "date_end": { "$ref": "#/components/schemas/Promotions_coupon_date_end" }, "date_start": { "$ref": "#/components/schemas/Promotions_coupon_date_start" }, "external_id": { "$ref": "#/components/schemas/Promotions_coupon-external_id" }, "items": { "$ref": "#/components/schemas/Promotions_unique_catalog_offer_items", "type": "array" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit" }, "redeem_user_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit" } }, "required": [ "external_id", "name" ], "type": "object" } } } }, "Promotions_unique_catalog_offer-update": { "content": { "application/json": { "examples": { "limited": { "value": { "items": [ "elven_sword", "elven_boots" ], "name": { "de-DE": "Neujahrsangebot", "en-US": "New Year Offer" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1 } }, "simple": { "value": { "items": [ "elven_sword", "elven_boots" ], "name": { "de-DE": "Neujahrsangebot", "en-US": "New Year Offer" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ] } } }, "schema": { "properties": { "items": { "$ref": "#/components/schemas/Promotions_unique_catalog_offer_items" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit" }, "redeem_user_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit" } }, "required": [ "name" ], "type": "object" } } } }, "create-daily-chain": { "content": { "application/json": { "examples": { "calendar_hard": { "summary": "`calendar_hard`类型的每日奖励", "value": { "date_start": "2023-04-15T18:16:00+05:00", "description": { "en": "New daily reward short description" }, "is_enabled": true, "name": { "en": "New daily reward", "ru": "Новая ежедневная награда" }, "order": 4, "steps": [ { "items": [ { "quantity": 2, "sku": "vg_enabled_shown_in_store_1" } ], "step_number": 1 }, { "items": [ { "quantity": 2, "sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg" } ], "step_number": 2 }, { "items": [ { "quantity": 2, "sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1" } ], "step_number": 3 }, { "items": [ { "quantity": 1, "sku": "vg_enabled_shown_in_store_1" } ], "step_number": 4 }, { "items": [ { "quantity": 1, "sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg" } ], "step_number": 5 }, { "items": [ { "quantity": 1, "sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1" } ], "step_number": 6 } ], "type": "calendar_hard" } }, "rolling_skippable": { "summary": "`rolling_skippable`类型每日奖励", "value": { "date_end": "2023-05-31T10:00:00+05:00", "date_start": "2023-05-01T10:00:00+05:00", "description": { "en": "New skippable login reward short description" }, "is_enabled": true, "is_recurrent": true, "name": { "en": "New skippable login reward" }, "order": 1, "steps": [ { "items": [ { "quantity": 1, "sku": "monday_reward_item_one" } ], "step_number": 1 }, { "items": [ { "quantity": 1, "sku": "tuesday_reward_item_two" } ], "step_number": 2 }, { "items": [ { "quantity": 1, "sku": "wednesday_reward_item_three" } ], "step_number": 3 }, { "items": [ { "quantity": 1, "sku": "thursday_reward_item_four" } ], "step_number": 4 }, { "items": [ { "quantity": 1, "sku": "friday_reward_item_five" } ], "step_number": 5 }, { "items": [ { "quantity": 1, "sku": "saturday_reward_item_six" } ], "step_number": 6 }, { "items": [ { "quantity": 1, "sku": "sunday_reward_item_seven" } ], "step_number": 7 } ], "type": "rolling_skippable" } }, "rolling_unskippable": { "summary": "`rolling_unskippable`类型每日奖励", "value": { "date_end": "2023-06-30T10:00:00+05:00", "date_start": "2023-06-01T10:00:00+05:00", "description": { "en": "New unskippable login reward short description" }, "is_enabled": true, "is_recurrent": false, "name": { "en": "New unskippable login reward" }, "order": 2, "steps": [ { "items": [ { "quantity": 1, "sku": "monday_reward_item_one" } ], "step_number": 1 }, { "items": [ { "quantity": 1, "sku": "tuesday_reward_item_two" } ], "step_number": 2 }, { "items": [ { "quantity": 1, "sku": "wednesday_reward_item_three" } ], "step_number": 3 }, { "items": [ { "quantity": 1, "sku": "thursday_reward_item_four" } ], "step_number": 4 }, { "items": [ { "quantity": 1, "sku": "friday_reward_item_five" } ], "step_number": 5 } ], "type": "rolling_unskippable" } } }, "schema": { "oneOf": [ { "$ref": "#/components/schemas/create-calendar-hard-daily-chain-model" }, { "$ref": "#/components/schemas/create-rolling-skippable-daily-chain-model" }, { "$ref": "#/components/schemas/create-rolling-unskippable-daily-chain-model" } ] } } } }, "create-offer-chain": { "content": { "application/json": { "examples": { "default": { "summary": "常规优惠链示例", "value": { "date_end": null, "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Eine kurze Beschreibung einer regulären Angebotskette", "en": "A short description of a regular offer chain", "fr": "Une brève description d'une chaîne d'offres régulière", "it": "Una breve descrizione di una catena di offerte regolare", "ru": "Краткое описание обычной цепочки предложений" }, "is_always_visible": true, "is_enabled": true, "name": { "de": "Neue Angebotskette", "en": "New offer chain", "fr": "Nouvelle chaîne d'offres", "it": "Nuova catena di offerte", "ru": "Новая цепочка предложений" }, "order": 4, "recurrent_schedule": null, "steps": [ { "is_free": false, "items": [ { "quantity": 2, "sku": "chain_step_1_paid_bundle_sku" } ], "step_number": 1 }, { "is_free": true, "items": [ { "quantity": 1, "sku": "chain_step_2_free_virtual_good_sku" } ], "step_number": 2 }, { "is_free": false, "items": [ { "quantity": 5, "sku": "chain_step_3_paid_virtual_currency_package_sku" } ], "step_number": 3 }, { "is_free": true, "items": [ { "quantity": 1, "sku": "chain_step_4_free_bundle_sku" } ], "step_number": 4 } ] } }, "personalized-default": { "summary": "个性化默认优惠链示例", "value": { "date_end": null, "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Standard-personalisierte Angebotskette für Benutzer, die die Bedingungen anderer personalisierter Ketten nicht erfüllen", "en": "Default personalized offer chain for users that do not meet the conditions of other personalized chains", "fr": "Chaîne d'offres personnalisée par défaut pour les utilisateurs qui ne répondent pas aux conditions des autres chaînes personnalisées", "it": "Catena di offerte personalizzata predefinita per gli utenti che non soddisfano le condizioni di altre catene personalizzate", "ru": "Персонализированная цепочка по умолчанию для пользователей, не подходящих под условия других персонализированных цепочек" }, "is_always_visible": false, "is_enabled": true, "name": { "de": "Neue personalisierte Standard-Angebotskette", "en": "New personalized default offer chain", "fr": "Nouvelle chaîne d'offres personnalisée par défaut", "it": "Nuova catena di offerte personalizzata predefinita", "ru": "Новая персонализированная цепочка предложений по умолчанию" }, "order": 4, "recurrent_schedule": null, "steps": [ { "is_free": false, "items": [ { "quantity": 1, "sku": "chain_x_step_1_item_default" } ], "step_number": 1 }, { "is_free": false, "items": [ { "quantity": 2, "sku": "chain_x_step_2_item_default" } ], "step_number": 2 }, { "is_free": true, "items": [ { "quantity": 1, "sku": "chain_x_step_3_free_item_default" } ], "step_number": 3 } ] } }, "personalized-with-conditions": { "summary": "带用户属性条件的个性化优惠链示例", "value": { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "elf" }, { "attribute": "level", "can_be_missing": false, "operator": "ge", "type": "number", "value": "10" }, { "attribute": "10_level_up_date", "can_be_missing": false, "operator": "le", "type": "date", "value": "2026-01-01T00:00:00" } ], "date_end": null, "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Personalisierte Angebotskette mit Benutzerattributbedingungen - für Elfen der Stufe 10 und höher, die Stufe 10 spätestens am 2026-01-01 00:00:00 erreicht haben, einschließlich", "en": "Personalized offer chain with user attribute conditions - for level 10 and above elves who reached level 10 no later than 2026-01-01 00:00:00, inclusive", "fr": "Chaîne d'offres personnalisée avec des conditions d'attribut utilisateur - pour les elfes de niveau 10 et plus qui ont atteint le niveau 10 au plus tard le 2026-01-01 00:00:00, inclus", "it": "Catena di offerte personalizzata con condizioni di attributo utente - per elfi di livello 10 e superiore che hanno raggiunto il livello 10 non più tardi del 2026-01-01 00:00:00, inclusi", "ru": "Персонализированная цепочка предложений с условиями по атрибутам пользователя - для эльфов уровня 10 и выше, достигших 10 уровня не позднее 2026-01-01 00:00:00 включительно" }, "is_always_visible": false, "is_enabled": true, "name": { "de": "Neue personalisierte Angebotskette", "en": "New personalized offer chain", "fr": "Nouvelle chaîne d'offres personnalisée", "it": "Nuova catena di offerte personalizzata", "ru": "Новая персонализированная цепочка предложений" }, "order": 4, "recurrent_schedule": null, "steps": [ { "is_free": false, "items": [ { "quantity": 1, "sku": "chain_x_step_1_item_for_elves_level_10_and_above" } ], "step_number": 1 }, { "is_free": false, "items": [ { "quantity": 2, "sku": "chain_x_step_2_item_for_elves_level_10_and_above" } ], "step_number": 2 }, { "is_free": true, "items": [ { "quantity": 1, "sku": "chain_x_step_3_free_item_for_elves_level_10_and_above" } ], "step_number": 3 } ] } }, "recurrent": { "summary": "重复性优惠链示例", "value": { "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Eine wiederkehrende Angebotskette, die wöchentlich mittwochs um 07:00 Uhr GMT+3 zurückgesetzt wird", "en": "A recurring offer chain that resets weekly on Wednesdays at 07:00 AM GMT+3", "fr": "Une chaîne d'offres récurrente qui se réinitialise chaque semaine le mercredi à 07h00 GMT+3", "it": "Una catena di offerte ricorrente che si resetta settimanalmente il mercoledì alle 07:00 GMT+3", "ru": "Рекуррентная цепочка предложений, которая сбрасывается еженедельно по средам в 07:00 по GMT+3" }, "is_always_visible": true, "is_enabled": false, "name": { "de": "Neue wiederkehrende Angebotskette", "en": "New recurrent offer chain", "fr": "Nouvelle chaîne d'offres récurrente", "it": "Nuova catena di offerte ricorrente", "ru": "Новая рекуррентная цепочка предложений" }, "order": 1, "recurrent_schedule": { "day_of_week": 3, "interval_type": "weekly", "time": "07:00:00+03:00" }, "steps": [ { "is_free": false, "items": [ { "quantity": 2, "sku": "chain_step_1_paid_bundle_sku" } ], "step_number": 1 }, { "is_free": true, "items": [ { "quantity": 3, "sku": "chain_step_2_free_virtual_good_sku" } ], "step_number": 2 } ] } } }, "schema": { "$ref": "#/components/schemas/create-offer-chain-model" } } } }, "create-reward-chain": { "content": { "application/json": { "examples": { "clan": { "summary": "公会奖励链示例", "value": { "clan_type": "guild", "description": { "en": "Clan reward chain description." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_enabled": true, "long_description": { "en": "Clan reward chain long description." }, "name": { "en": "Clan reward chain" }, "order": 1, "periods": [ { "date_from": "2026-01-01T01:00:00+05:00", "date_until": "2026-01-31T23:59:59+05:00" }, { "date_from": "2026-02-01T01:00:00+05:00", "date_until": "2026-02-28T23:59:59+05:00" } ], "popup_header": { "en": "How to unlock rewards" }, "popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "popup_instruction": { "en": "You must be a clan member to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan." }, "recurrent_schedule": { "day_of_week": 1, "interval_type": "weekly", "time": "01:00:00+08:00" }, "steps": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "First step of the reward chain" }, "price": { "amount": 10 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_1" }, { "quantity": 1, "sku": "com.xsolla.item_2" } ] }, { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "Second step of the reward chain" }, "price": { "amount": 15 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_3" }, { "quantity": 1, "sku": "com.xsolla.item_4" } ] } ], "value_point": { "sku": "com.xsolla.clan_value_point_1" } } }, "default": { "summary": "奖励链示例", "value": { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "ork" } ], "description": { "en": "Reward chain description." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_always_visible": true, "is_enabled": true, "is_reset_after_end": true, "long_description": { "en": "Reward chain long description." }, "name": { "en": "Reward chain" }, "order": 1, "periods": [ { "date_from": "2026-01-01T01:00:00+05:00", "date_until": "2026-01-31T23:59:59+05:00" }, { "date_from": "2026-02-01T01:00:00+05:00", "date_until": "2026-02-28T23:59:59+05:00" } ], "recurrent_schedule": { "day_of_week": 1, "interval_type": "weekly", "time": "01:00:00+08:00" }, "steps": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "First step of the reward chain" }, "price": { "amount": 10 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_1" }, { "quantity": 1, "sku": "com.xsolla.item_2" } ] }, { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "Second step of the reward chain" }, "price": { "amount": 15 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_3" }, { "quantity": 1, "sku": "com.xsolla.item_4" } ] } ], "value_point": { "sku": "com.xsolla.value_point_1" } } } }, "schema": { "oneOf": [ { "$ref": "#/components/schemas/create-reward-chain-model" }, { "$ref": "#/components/schemas/create-clan-reward-chain-model" } ] } } } }, "create-upsell": { "content": { "application/json": { "examples": { "fixed_list": { "summary": "使用固定商品列表进行追加销售的示例", "value": { "is_enabled": true, "items": [ "game_sku_1", "game_sku_2", "game_sku_3" ], "type": "fixed_list" } }, "special_type_most_sellable": { "summary": "使用过去30天最畅销商品进行追加销售的示例", "value": { "is_enabled": true, "items": [], "type": "most_sellable" } }, "special_type_promotions": { "summary": "仅使用促销商品进行追加销售的示例", "value": { "is_enabled": true, "items": [], "type": "only_promotions" } } }, "schema": { "oneOf": [ { "$ref": "#/components/schemas/Upsell-model" }, { "$ref": "#/components/schemas/Upsell-model-not-fixed-list" } ] } } } }, "create-value-point": { "content": { "application/json": { "examples": { "clan": { "summary": "公会奖励链的奖励积分", "value": { "description": { "en": "Value points for clan reward system." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "is_enabled": true, "long_description": { "en": "Value points given to clans to get new rewards in a reward chain." }, "media_list": [], "name": { "en": "Clan Reward VP 1" }, "order": 3, "sku": "com.xsolla.clan_value_point_1" } }, "default": { "summary": "奖励链的奖励积分", "value": { "description": { "en": "Value points for reward system." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_enabled": true, "long_description": { "en": "Value points given to users to get new rewards in a reward chain." }, "media_list": [], "name": { "en": "Reward VP 1" }, "order": 1, "sku": "com.xsolla.reward_vp_1" } } }, "schema": { "$ref": "#/components/schemas/admin_value_points-create" } } } }, "personalized-catalog_create-update-body": { "content": { "application/json": { "example": { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "ork" } ], "is_enabled": true, "is_satisfied_for_unauth": false, "items": [ { "item_id": 1 } ], "name": "Ork race armor rule" }, "schema": { "$ref": "#/components/schemas/user-attribute_personalized-catalog-body-required" } } } }, "reset-user-limits": { "content": { "application/json": { "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user" ], "type": "object" } } } }, "reset-user-limits-flexible": { "content": { "application/json": { "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "user": { "$ref": "#/components/schemas/User-limit_user_flexible" } }, "required": [ "user" ], "type": "object" } } } }, "set-item-value-point-reward": { "content": { "application/json": { "example": [ { "amount": 100, "sku": "com.xsolla.booster_1" }, { "amount": 200, "sku": "com.xsolla.booster_mega" } ], "schema": { "$ref": "#/components/schemas/item-value-point-reward-set" } } } }, "set-item-value-point-reward-for-patch": { "content": { "application/json": { "example": [ { "amount": 100, "sku": "booster_1" }, { "amount": 0, "sku": "booster_mega" } ], "schema": { "$ref": "#/components/schemas/item-value-point-reward-set-for-patch" } } } }, "update-daily-chain": { "content": { "application/json": { "examples": { "calendar_hard": { "summary": "`calendar_hard`类型的每日奖励", "value": { "date_start": "2023-04-15T18:16:00+05:00", "description": { "en": "Updated daily reward description" }, "is_enabled": true, "name": { "en": "Updated daily reward", "ru": "Обновленная ежедневная награда" }, "order": 4, "steps": [ { "items": [ { "quantity": 1, "sku": "vg_enabled_shown_in_store_1" } ], "step_number": 1 }, { "items": [ { "quantity": 1, "sku": "vg_enabled_shown_in_store_2" } ], "step_number": 2 }, { "items": [ { "quantity": 1, "sku": "vg_not_shown_in_store" } ], "step_id": 10, "step_number": 3 }, { "items": [ { "quantity": 1, "sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg" } ], "step_id": 8, "step_number": 4 }, { "items": [ { "quantity": 1, "sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1" } ], "step_number": 5 } ], "type": "calendar_hard" } }, "rolling_skippable": { "summary": "`rolling_skippable`类型每日奖励", "value": { "date_end": "2023-08-31T10:00:00+05:00", "date_start": "2023-08-01T10:00:00+05:00", "description": { "en": "Updated login reward description" }, "is_enabled": true, "name": { "en": "Updated login reward" }, "order": 4, "steps": [ { "items": [ { "quantity": 1, "sku": "monday_reward_item_one" } ], "step_number": 1 }, { "items": [ { "quantity": 1, "sku": "tuesday_reward_item_two" } ], "step_number": 2 }, { "items": [ { "quantity": 1, "sku": "wednesday_reward_item_three" } ], "step_number": 3 }, { "items": [ { "quantity": 1, "sku": "thursday_reward_item_four" } ], "step_number": 4 }, { "items": [ { "quantity": 1, "sku": "friday_reward_item_five" } ], "step_number": 5 }, { "items": [ { "quantity": 1, "sku": "saturday_reward_item_six" } ], "step_number": 6 }, { "items": [ { "quantity": 1, "sku": "sunday_reward_item_seven" } ], "step_number": 7 } ], "type": "rolling_skippable" } }, "rolling_unskippable": { "summary": "`rolling_unskippable`类型每日奖励", "value": { "date_end": "2023-09-30T10:00:00+05:00", "date_start": "2023-09-01T10:00:00+05:00", "description": { "en": "Updated unskippable login reward description" }, "is_enabled": true, "name": { "en": "Updated unskippable login reward" }, "order": 2, "steps": [ { "items": [ { "quantity": 1, "sku": "monday_reward_item_one" } ], "step_number": 1 }, { "items": [ { "quantity": 1, "sku": "tuesday_reward_item_two" } ], "step_number": 2 }, { "items": [ { "quantity": 1, "sku": "wednesday_reward_item_three" } ], "step_number": 3 }, { "items": [ { "quantity": 1, "sku": "thursday_reward_item_four" } ], "step_number": 4 }, { "items": [ { "quantity": 1, "sku": "friday_reward_item_five" } ], "step_number": 5 } ], "type": "rolling_unskippable" } } }, "schema": { "oneOf": [ { "$ref": "#/components/schemas/update-calendar-hard-daily-chain-model" }, { "$ref": "#/components/schemas/update-rolling-skippable-daily-chain-model" }, { "$ref": "#/components/schemas/update-rolling-unskippable-daily-chain-model" } ] } } } }, "update-offer-chain": { "content": { "application/json": { "examples": { "default": { "summary": "默认示例", "value": { "date_end": null, "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Eine kurze Beschreibung einer regulären Angebotskette", "en": "A short description of a regular offer chain", "fr": "Une brève description d'une chaîne d'offres régulière", "it": "Una breve descrizione di una catena di offerte regolare", "ru": "Краткое описание обычной цепочки предложений" }, "is_always_visible": true, "is_enabled": true, "name": { "de": "Aktualisierte Angebotskette", "en": "Updated offer chain", "fr": "Chaîne d'offres mise à jour", "it": "Catena di offerte aggiornata", "ru": "Обновляемая цепочка предложений" }, "order": 4, "recurrent_schedule": null, "steps": [ { "is_free": false, "items": [ { "quantity": 2, "sku": "chain_step_1_paid_bundle_sku" } ], "step_id": 10, "step_number": 1 }, { "is_free": true, "items": [ { "quantity": 1, "sku": "chain_step_2_free_virtual_good_sku" } ], "step_number": 2 }, { "is_free": false, "items": [ { "quantity": 5, "sku": "chain_step_3_paid_virtual_currency_package_sku" } ], "step_number": 3 }, { "is_free": true, "items": [ { "quantity": 1, "sku": "chain_step_4_free_bundle_sku" } ], "step_id": 9, "step_number": 4 } ] } }, "personalized-default": { "summary": "个性化默认优惠链示例", "value": { "date_end": null, "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Standard-personalisierte Angebotskette für Benutzer, die die Bedingungen anderer personalisierter Ketten nicht erfüllen", "en": "Default personalized offer chain for users that do not meet the conditions of other personalized chains", "fr": "Chaîne d'offres personnalisée par défaut pour les utilisateurs qui ne répondent pas aux conditions des autres chaînes personnalisées", "it": "Catena di offerte personalizzata predefinita per gli utenti che non soddisfano le condizioni di altre catene personalizzate", "ru": "Персонализированная цепочка по умолчанию для пользователей, не подходящих под условия других персонализированных цепочек" }, "is_always_visible": false, "is_enabled": true, "name": { "de": "Neue personalisierte Standard-Angebotskette", "en": "New personalized default offer chain", "fr": "Nouvelle chaîne d'offres personnalisée par défaut", "it": "Nuova catena di offerte personalizzata predefinita", "ru": "Новая персонализированная цепочка предложений по умолчанию" }, "order": 4, "recurrent_schedule": null, "steps": [ { "is_free": false, "items": [ { "quantity": 1, "sku": "chain_x_step_1_item_default" } ], "step_id": 10, "step_number": 1 }, { "is_free": false, "items": [ { "quantity": 2, "sku": "chain_x_step_2_item_default" } ], "step_number": 2 }, { "is_free": true, "items": [ { "quantity": 1, "sku": "chain_x_step_3_free_item_default" } ], "step_id": 9, "step_number": 3 } ] } }, "personalized-with-conditions": { "summary": "带用户属性条件的个性化优惠链示例", "value": { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "elf" }, { "attribute": "level", "can_be_missing": false, "operator": "ge", "type": "number", "value": "10" }, { "attribute": "10_level_up_date", "can_be_missing": false, "operator": "le", "type": "date", "value": "2026-01-01T00:00:00" } ], "date_end": null, "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Personalisierte Angebotskette mit Benutzerattributbedingungen - für Elfen der Stufe 10 und höher, die Stufe 10 spätestens am 2026-01-01 00:00:00 erreicht haben, einschließlich", "en": "Personalized offer chain with user attribute conditions - for level 10 and above elves who reached level 10 no later than 2026-01-01 00:00:00, inclusive", "fr": "Chaîne d'offres personnalisée avec des conditions d'attribut utilisateur - pour les elfes de niveau 10 et plus qui ont atteint le niveau 10 au plus tard le 2026-01-01 00:00:00, inclus", "it": "Catena di offerte personalizzata con condizioni di attributo utente - per elfi di livello 10 e superiore che hanno raggiunto il livello 10 non più tardi del 2026-01-01 00:00:00, inclusi", "ru": "Персонализированная цепочка предложений с условиями по атрибутам пользователя - для эльфов уровня 10 и выше, достигших 10 уровня не позднее 2026-01-01 00:00:00 включительно" }, "is_always_visible": false, "is_enabled": true, "name": { "de": "Neue personalisierte Angebotskette", "en": "New personalized offer chain", "fr": "Nouvelle chaîne d'offres personnalisée", "it": "Nuova catena di offerte personalizzata", "ru": "Новая персонализированная цепочка предложений" }, "order": 4, "recurrent_schedule": null, "steps": [ { "is_free": false, "items": [ { "quantity": 1, "sku": "chain_x_step_1_item_for_elves_level_10_and_above" } ], "step_id": 10, "step_number": 1 }, { "is_free": false, "items": [ { "quantity": 2, "sku": "chain_x_step_2_item_for_elves_level_10_and_above" } ], "step_id": 8, "step_number": 2 }, { "is_free": true, "items": [ { "quantity": 1, "sku": "chain_x_step_3_free_item_for_elves_level_10_and_above" } ], "step_number": 3 } ] } }, "recurrent": { "summary": "重复性优惠链示例", "value": { "date_end": "2025-04-25T19:16:00+05:00", "date_start": "2023-04-15T17:16:00+05:00", "description": { "de": "Aktualisierte Angebotskette, die wiederkehrend wird und monatlich am 2. Tag um 03:00 Uhr GMT+8 zurückgesetzt wird", "en": "Updated offer chain that becomes recurrent and resets monthly on the 2nd day at 03:00 AM GMT+8", "fr": "Chaîne d'offres mise à jour qui devient récurrente et se réinitialise mensuellement le 2e jour à 03h00 GMT+8", "it": "Catena di offerte aggiornata che diventa ricorrente e si resetta mensilmente il 2° giorno alle 03:00 GMT+8", "ru": "Обновляемая цепочка предложений, которая становится рекуррентной и сбрасывается ежемесячно во 2-й день в 03:00 по GMT+8" }, "id": 1, "is_enabled": true, "name": { "de": "Aktualisierte wiederkehrende Angebotskette", "en": "Updated recurrent offer chain", "fr": "Chaîne d'offres récurrente mise à jour", "it": "Catena di offerte ricorrente aggiornata", "ru": "Обновляемая рекуррентная цепочка предложений" }, "order": 4, "recurrent_schedule": { "day_of_month": 2, "interval_type": "monthly", "time": "03:00:00+08:00" }, "steps": [ { "is_free": false, "items": [ { "quantity": 6, "sku": "chain_bundle_sku" } ], "step_number": 1 }, { "is_free": true, "items": [ { "quantity": 2, "sku": "chain_bundle_sku" } ], "step_number": 1 } ] } } }, "schema": { "$ref": "#/components/schemas/modify-offer-chain-model" } } } }, "update-reward-chain": { "content": { "application/json": { "examples": { "clan": { "summary": "公会奖励链示例", "value": { "clan_type": "guild", "description": { "en": "Clan reward chain description." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_enabled": true, "long_description": { "en": "Clan reward chain long description." }, "name": { "en": "Clan reward chain" }, "order": 1, "periods": [ { "date_from": "2026-01-01T01:00:00+05:00", "date_until": "2026-01-31T23:59:59+05:00" }, { "date_from": "2026-02-01T01:00:00+05:00", "date_until": "2026-02-28T23:59:59+05:00" } ], "popup_header": { "en": "How to unlock rewards" }, "popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "popup_instruction": { "en": "You should be a clan member to get clan rewards. You join a clan when a clan member invited you to the clan, and you accepted the invite. You can create your own clan." }, "recurrent_schedule": { "day_of_week": 1, "interval_type": "weekly", "time": "01:00:00+08:00" }, "steps": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "First step of the reward chain" }, "price": { "amount": 10 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_1" }, { "quantity": 1, "sku": "com.xsolla.item_2" } ], "step_id": 1 }, { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "Second step of the reward chain" }, "price": { "amount": 15 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_3" }, { "quantity": 1, "sku": "com.xsolla.item_4" } ], "step_id": 2 } ] } }, "default": { "summary": "奖励链示例", "value": { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "ork" } ], "description": { "en": "Reward chain description." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_always_visible": true, "is_enabled": true, "is_reset_after_end": true, "long_description": { "en": "Reward chain long description." }, "name": { "en": "Reward chain" }, "order": 1, "periods": [ { "date_from": "2026-01-01T01:00:00+05:00", "date_until": "2026-01-31T23:59:59+05:00" }, { "date_from": "2026-02-01T01:00:00+05:00", "date_until": "2026-02-28T23:59:59+05:00" } ], "recurrent_schedule": { "day_of_week": 1, "interval_type": "weekly", "time": "01:00:00+08:00" }, "steps": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "First step of the reward chain" }, "price": { "amount": 10 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_1" }, { "quantity": 1, "sku": "com.xsolla.item_2" } ], "step_id": 1 }, { "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "name": { "en": "Second step of the reward chain" }, "price": { "amount": 15 }, "reward": [ { "quantity": 5, "sku": "com.xsolla.item_3" }, { "quantity": 1, "sku": "com.xsolla.item_4" } ], "step_id": 2 } ] } } }, "schema": { "oneOf": [ { "$ref": "#/components/schemas/update-reward-chain-model" }, { "$ref": "#/components/schemas/update-clan-reward-chain-model" } ] } } } }, "update-upsell": { "content": { "application/json": { "examples": { "fixed_list": { "summary": "使用固定商品列表进行追加销售的示例", "value": { "is_enabled": true, "items": [ "game_sku_1", "game_sku_2", "game_sku_3" ], "type": "fixed_list" } }, "special_type_most_sellable": { "summary": "使用过去30天最畅销商品进行追加销售的示例", "value": { "is_enabled": true, "items": [], "type": "most_sellable" } }, "special_type_promotions": { "summary": "仅使用促销商品进行追加销售的示例", "value": { "is_enabled": true, "items": [], "type": "only_promotions" } } }, "schema": { "oneOf": [ { "$ref": "#/components/schemas/Upsell-model" }, { "$ref": "#/components/schemas/Upsell-model-not-fixed-list" } ] } } } }, "update-user-limits-flexible": { "content": { "application/json": { "example": { "available": 0, "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "available": { "$ref": "#/components/schemas/User-limit_available_flexible" }, "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user", "available" ], "type": "object" } } } }, "update-user-limits-strict": { "content": { "application/json": { "example": { "available": 1, "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "available": { "$ref": "#/components/schemas/User-limit_available" }, "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user", "available" ], "type": "object" } } } } }, "responses": { "200-admin-get-code-coupon-limits": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/code-limit" } }, "schema": { "properties": { "has_more": { "description": "如果存在其他含代码的页面。", "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/Code-limit-promo-code" }, "type": "array" }, "promotion_id": { "description": "促销活动ID。项目内的唯一促销活动标识符。", "type": "integer" }, "total_items_count": { "description": "代码总数。", "type": "number" } }, "type": "object" } } }, "description": "成功收到代码的优惠券限额。" }, "200-admin-get-code-promo-code-limits": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/code-limit" } }, "schema": { "properties": { "has_more": { "description": "如果存在其他含代码的页面。", "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/Code-limit-promo-code" }, "type": "array" }, "promotion_id": { "description": "促销活动ID。项目内的唯一促销活动标识符。", "type": "integer" }, "total_items_count": { "description": "代码总数。", "type": "number" } }, "type": "object" } } }, "description": "成功收到代码的促销码限制。" }, "200-admin-get-daily-chain": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-daily-chain" } }, "schema": { "$ref": "#/components/schemas/admin-daily-chain-long-model" } } }, "description": "每日奖励数据检索成功。" }, "200-admin-get-list-daily-chains": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-daily-chain-list" } }, "schema": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/admin-daily-chain-short-model" }, "type": "array" }, "total_items_count": { "description": "每日奖励总数。", "example": 3, "type": "integer" } }, "type": "object" } } }, "description": "每日奖励列表检索成功。" }, "200-admin-get-list-offer-chains": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-offer-chain-list" } }, "schema": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/admin-offer-chain-short-model" }, "type": "array" } }, "type": "object" } } }, "description": "优惠链列表获取成功。" }, "200-admin-get-list-reward-chains": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-reward-chain-list" } }, "schema": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "oneOf": [ { "$ref": "#/components/schemas/admin-get-reward-chain-item-basic-model" }, { "$ref": "#/components/schemas/admin-get-reward-chain-item-clan-basic-model" } ] }, "type": "array" } }, "type": "object" } } }, "description": "已成功接收奖励链列表。" }, "200-admin-get-list-value-point-rewards": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-value-points-rewards-list" } }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/admin-item-value-point-reward" }, "type": "array" } }, "type": "object" } } }, "description": "成功收到具有奖励积分的商品列表。" }, "200-admin-get-offer-chain": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-offer-chain" } }, "schema": { "$ref": "#/components/schemas/admin-offer-chain-long-model" } } }, "description": "优惠链数据获取成功。" }, "200-admin-get-redeemable-by-code": { "content": { "application/json": { "examples": { "Coupon Response": { "value": { "bonus": [ { "quantity": 3, "sku": "epic_fall_hammer_1" } ], "external_id": "coupon_fall_hammer_2", "is_enabled": true, "name": { "en": "This is a Coupon code for Epic Fall Hammer", "ru": "Eto kod kupona на Epic Fall Hammer" }, "promotion_periods": [ { "date_from": "2023-04-15T01:00:00+05:00", "date_until": "2023-04-30T23:59:59+05:00" }, { "date_from": "2023-05-15T01:00:00+05:00", "date_until": "2023-05-30T23:59:59+05:00" } ], "redeem_code_limit": null, "redeem_total_limit": 99, "redeem_user_limit": 1 } }, "Promo Code Response": { "value": { "bonus": [], "discount": { "percent": null }, "discounted_items": [ { "discount": { "percent": "20.00" }, "sku": "epic_fall_hammer_1" } ], "external_id": "falls2023", "is_enabled": true, "name": { "en": "Promo Code discount for Epic Fall Hammer", "ru": "Скидка по промокоду на Epic Fall Hammer" }, "promotion_periods": [ { "date_from": "2023-05-01T01:00:00+05:00", "date_until": "2023-05-31T23:59:59+05:00" }, { "date_from": "2023-06-01T01:00:00+05:00", "date_until": "2023-06-30T23:59:59+05:00" } ], "redeem_code_limit": null, "redeem_total_limit": 2, "redeem_user_limit": 3, "total_limit_state": { "available": 1, "reserved": 1, "used": 0 } } } }, "schema": { "$ref": "#/components/schemas/admin-promotions_200-get-redeemable-coupon-promotion-model" } } }, "description": "成功收到促销活动。" }, "200-admin-get-reward-chain": { "content": { "application/json": { "examples": { "clan": { "$ref": "#/components/examples/200-clan-reward-chain" }, "common": { "$ref": "#/components/examples/200-reward-chain" } }, "schema": { "oneOf": [ { "$ref": "#/components/schemas/admin-get-reward-chain-item-full-model" }, { "$ref": "#/components/schemas/admin-get-reward-chain-item-clan-full-model" } ] } } }, "description": "已成功收到指定的奖励链。" }, "200-admin-get-user-coupon-limits": { "content": { "application/json": { "examples": { "response": { "value": { "per_user": { "available": 9, "total": 10 } } } }, "schema": { "$ref": "#/components/schemas/User-limit-coupon" } } }, "description": "成功收到用户的优惠券限制。" }, "200-admin-get-user-promo-code-limits": { "content": { "application/json": { "examples": { "response": { "value": { "per_user": { "available": 9, "total": 10 } } } }, "schema": { "$ref": "#/components/schemas/User-limit-promo-code" } } }, "description": "成功收到用户的促销码限制。" }, "200-admin-get-user-promotion-limits": { "content": { "application/json": { "examples": { "response": { "value": { "per_user": { "available": 9, "total": 10 } } } }, "schema": { "$ref": "#/components/schemas/User-limit-promotion" } } }, "description": "已成功收到用户的促销活动限制。" }, "200-admin-get-value-point": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-value-points-reward-chain_admin_get-value-point" } }, "schema": { "$ref": "#/components/schemas/Value-point-item-model" } } }, "description": "已成功收到指定的奖励积分。" }, "200-admin-get-value-points": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-value-points-reward-chain_admin_get-value-point-list" } }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Value-points-item-model" }, "type": "array" } }, "type": "object" } } }, "description": "成功收到奖励积分列表。" }, "200-client-get-daily-chains-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-client-daily-chain-list" } }, "schema": { "properties": { "has_more": { "description": "用作指示还有更多页面。", "example": true, "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/client-daily-chain-model" }, "type": "array" }, "total_items_count": { "description": "每日奖励总数。", "example": 3, "type": "integer" } }, "type": "object" } } }, "description": "用户每日奖励检索成功。" }, "200-client-get-offer-chains-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-client-offer-chain-list" } }, "schema": { "properties": { "has_more": { "description": "是否有更多分页。", "example": true, "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/client-offer-chain-model" }, "type": "array" }, "total_items_count": { "description": "可用优惠链总数。", "example": 10, "type": "integer" } }, "type": "object" } } }, "description": "优惠链列表接收成功。" }, "200-client-get-reward-chains-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-client-get-reward-chains-list" } }, "schema": { "properties": { "has_more": { "description": "用作指示还有更多页面。", "example": true, "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/client-reward-chain-item-model" }, "type": "array" }, "total_items_count": { "description": "系统中奖励链的总数。", "example": 10, "type": "integer" } }, "type": "object" } } }, "description": "成功获取用户的奖励链。" }, "200-client-get-user-reward-chain-balance": { "content": { "application/json": { "examples": { "clan": { "$ref": "#/components/examples/200-client-get-user-clan-reward-chain-balance" }, "common": { "$ref": "#/components/examples/200-client-get-user-reward-chain-balance" } }, "schema": { "properties": { "amount": { "description": "奖励积分数量。", "type": "integer" }, "description": { "$ref": "#/components/schemas/value-point-description" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "long_description": { "$ref": "#/components/schemas/value-point-long-description" }, "name": { "$ref": "#/components/schemas/value-point-name" }, "sku": { "$ref": "#/components/schemas/value-point-sku" } }, "type": "object" } } }, "description": "已成功获取用户的奖励积分余额。" }, "200-client-update-user-clan": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-client-update-user-clan" } }, "schema": { "properties": { "reward": { "items": { "properties": { "bundle_type": { "description": "捆绑包类型。如果商品类型为捆绑包，则返回。", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "description": { "description": "商品描述。", "example": "Super box with items", "type": "string" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "name": { "description": "商品名称。", "example": "Super box", "type": "string" }, "quantity": { "description": "商品数量。", "example": 2, "type": "integer" }, "sku": { "$ref": "#/components/schemas/sku" }, "type": { "description": "商品类型。", "example": "bundle", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "成功更新了用户的公会。" }, "201-admin-create-daily-chain": { "content": { "application/json": { "examples": { "response": { "value": { "daily_chain_id": 10 } } }, "schema": { "properties": { "daily_chain_id": { "example": 10, "type": "integer" } }, "type": "object" } } }, "description": "每日奖励创建成功。" }, "201-admin-create-offer-chain": { "content": { "application/json": { "examples": { "response": { "value": { "offer_chain_id": 10 } } }, "schema": { "properties": { "offer_chain_id": { "example": 10, "type": "integer" } }, "type": "object" } } }, "description": "优惠链创建成功。" }, "201-admin-create-reward-chain": { "content": { "application/json": { "examples": { "response": { "value": { "reward_chain_id": 10 } } }, "schema": { "properties": { "reward_chain_id": { "example": 10, "type": "integer" } }, "type": "object" } } }, "description": "已成功创建奖励链。" }, "201-admin-create-value-point": { "content": { "application/json": { "examples": { "response": { "value": { "item_id": 10, "sku": "com.xsolla.item_new" } } }, "schema": { "properties": { "item_id": { "example": 10, "type": "integer" }, "sku": { "example": "new-sku", "type": "string" } }, "type": "object" } } }, "description": "已成功创建奖励积分。" }, "204-admin-delete-reward-chain": { "content": {}, "description": "已成功删除奖励链。" }, "204-admin-reset-reward-chain": { "content": {}, "description": "奖励链已重置。" }, "204-admin-toggle-reward-chain": { "content": {}, "description": "已禁用/启用奖励链。" }, "204-admin-update-reward-chain": { "content": {}, "description": "已成功更新奖励链。" }, "401-client-auth-error": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1501, "errorMessage": "[0401-1501]: Authorization failed: Provide authorization", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1501, "type": "integer" }, "errorMessage": { "example": "[0401-1501]: Authorization failed: Provide authorization", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "认证未通过或错误。" }, "401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "基本认证未通过或错误。确保您使用了基本认证或正确的凭据。" }, "403-auth-header-not-sent": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 0, "errorMessage": "Authorization header not sent", "statusCode": 403 } } }, "schema": { "properties": { "errorCode": { "example": 0, "type": "integer" }, "errorMessage": { "example": "Authorization header not sent.", "type": "string" }, "statusCode": { "example": 403, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "未发送授权标头。" }, "404-admin-reward-chain-not-found": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9901, "errorMessage": "[0401-4001]: Reward chain not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Reward chain not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "未找到奖励链。" }, "404-code-not-found": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9811, "errorMessage": "[0401-9811]: Code not found.", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 9811, "type": "integer" }, "errorMessage": { "example": "[0401-9811]: Code not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "未找到兑换码。请确保提供的代码值正确无误。" }, "404-daily-chain-not-found": { "content": { "application/json": { "examples": { "not-found": { "$ref": "#/components/examples/404-daily-chain-not-found" } }, "schema": { "$ref": "#/components/schemas/daily-chain-error-model" } } }, "description": "未找到每日奖励。" }, "404-daily-chain-step-not-found": { "content": { "application/json": { "examples": { "not-found": { "$ref": "#/components/examples/404-daily-chain-step-not-found" } }, "schema": { "$ref": "#/components/schemas/daily-chain-error-model" } } }, "description": "未找到每日奖励或每日奖励步骤。" }, "404-offer-chain-not-found": { "content": { "application/json": { "examples": { "not-found": { "$ref": "#/components/examples/404-offer-chain-not-found" } }, "schema": { "$ref": "#/components/schemas/offer-chain-error-model" } } }, "description": "未找到优惠链。" }, "404-offer-chain-step-not-found": { "content": { "application/json": { "examples": { "not-found": { "$ref": "#/components/examples/404-offer-chain-step-not-found" } }, "schema": { "$ref": "#/components/schemas/offer-chain-error-model" } } }, "description": "未找到优惠链或步骤。" }, "404-reward-chain-step-not-found": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9911, "errorMessage": "[0401-9911]: Reward chain step not found.", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 9911, "type": "integer" }, "errorMessage": { "example": "[0401-9911]: Reward chain step not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "未找到奖励链步骤。" }, "405-method-not-found": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 0, "errorMessage": "Method is not allowed. Method must be one of: OPTIONS", "statusCode": 405 } } }, "schema": { "properties": { "errorCode": { "example": 0, "type": "integer" }, "errorMessage": { "example": "Method is not allowed. Method must be one of: OPTIONS", "type": "string" }, "statusCode": { "example": 405, "type": "integer" } }, "type": "object" } } }, "description": "兑换码格式不正确。该代码只能包含字母和数字。" }, "422-admin-create-error-list": { "content": { "application/json": { "examples": { "incorrect-items": { "$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-items" }, "incorrect-period": { "$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-period" }, "incorrect-steps-order-error": { "$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-steps-order" }, "invalid-dates": { "$ref": "#/components/examples/422-admin-daily-chain-error-invalid-dates" }, "item-limit-exceeded": { "$ref": "#/components/examples/422-admin-daily-chain-error-item-limit-exceeded" }, "too-many-steps-error": { "$ref": "#/components/examples/422-admin-daily-chain-error-too-many-steps" } }, "schema": { "$ref": "#/components/schemas/daily-chain-error-model" } } }, "description": "每日奖励配置错误。" }, "422-admin-create-update-rc-vp-invalid-request": { "content": { "application/json": { "examples": { "The property `sku` is required": { "$ref": "#/components/examples/422-property-sku-is-required" } }, "schema": { "$ref": "#/components/schemas/422-rc-vp-invalid-request" } } }, "description": "无效请求。" }, "422-admin-update-error-list": { "content": { "application/json": { "examples": { "active-daily-chain": { "$ref": "#/components/examples/422-admin-daily-chain-error-activated" }, "chain-id-mismatch": { "$ref": "#/components/examples/422-admin-daily-chain-error-chain-id-mismatch" }, "chain-step-ids-duplication": { "$ref": "#/components/examples/422-admin-daily-chain-error-duplicate-step-ids" }, "incorrect-items": { "$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-items" }, "incorrect-period": { "$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-period" }, "incorrect-steps-order-error": { "$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-steps-order" }, "invalid-chain-step-ids": { "$ref": "#/components/examples/422-admin-daily-chain-error-invalid-chain-step-ids" }, "invalid-dates": { "$ref": "#/components/examples/422-admin-daily-chain-error-invalid-dates" }, "item-limit-exceeded": { "$ref": "#/components/examples/422-admin-daily-chain-error-item-limit-exceeded" }, "too-many-steps-error": { "$ref": "#/components/examples/422-admin-daily-chain-error-too-many-steps" } }, "schema": { "$ref": "#/components/schemas/daily-chain-error-model" } } }, "description": "每日奖励配置错误。" }, "422-create-error-list": { "content": { "application/json": { "examples": { "incorrect-items": { "$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-items" }, "incorrect-period": { "$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-period" }, "incorrect-steps-order-error": { "$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-steps-order" }, "invalid-dates": { "$ref": "#/components/examples/422-admin-offer-chain-error-invalid-dates" }, "item-limit-exceeded": { "$ref": "#/components/examples/422-admin-offer-chain-error-item-limit-exceeded" }, "too-many-steps-error": { "$ref": "#/components/examples/422-admin-offer-chain-error-too-many-steps" } }, "schema": { "$ref": "#/components/schemas/offer-chain-error-model" } } }, "description": "优惠链配置无效。" }, "422-reward-chain-step-reward-can-not-claimed": { "content": { "application/json": { "examples": { "Not enough VP to claim reward chain step reward": { "value": { "errorCode": 9913, "errorMessage": "[0401-9913]: Not enough value points to claim step reward.", "statusCode": 422 } }, "Reward chain step reward already claimed": { "value": { "errorCode": 9912, "errorMessage": "[0401-9912]: Reward already claimed.", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 9912, "type": "integer" }, "errorMessage": { "example": "[0401-9912]: Can't claim the step reward.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "无法领取步骤奖励。" }, "422-update-error-list": { "content": { "application/json": { "examples": { "active-offer-chain": { "$ref": "#/components/examples/422-admin-offer-chain-error-activated" }, "chain-id-mismatch": { "$ref": "#/components/examples/422-admin-offer-chain-error-chain-id-mismatch" }, "chain-step-ids-duplication": { "$ref": "#/components/examples/422-admin-offer-chain-error-duplicate-step-ids" }, "incorrect-items": { "$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-items" }, "incorrect-period": { "$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-period" }, "incorrect-steps-order-error": { "$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-steps-order" }, "invalid-chain-step-ids": { "$ref": "#/components/examples/422-admin-offer-chain-error-invalid-chain-step-ids" }, "invalid-dates": { "$ref": "#/components/examples/422-admin-offer-chain-error-invalid-dates" }, "item-limit-exceeded": { "$ref": "#/components/examples/422-admin-offer-chain-error-item-limit-exceeded" }, "too-many-steps-error": { "$ref": "#/components/examples/422-admin-offer-chain-error-too-many-steps" } }, "schema": { "$ref": "#/components/schemas/offer-chain-error-model" } } }, "description": "优惠链配置无效。" }, "Cart-Payment_200-order-created": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" } } }, "schema": { "properties": { "order_id": { "description": "订单ID。", "type": "integer" }, "token": { "description": "支付令牌。", "type": "string" } }, "type": "object" } } }, "description": "订单已成功创建。" }, "Common_401-complex": { "content": { "application/json": { "examples": { "Authorization header not sent": { "$ref": "#/components/examples/401-complex-auth-header-not-found" }, "Incorrect credentials": { "$ref": "#/components/examples/401-complex-auth-incorrect-credentials" } }, "schema": { "properties": { "errorCode": { "example": 1501, "type": "integer" }, "errorMessage": { "example": "[0401-1501]: Authorization failed: Authorization header not sent", "type": "string" }, "statusCode": { "example": 401, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "身份认证未通过或错误。请确保您使用了身份认证或正确的凭据。" }, "Common_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "基本认证未通过或错误。确保您使用了基本认证或正确的凭据。" }, "Common_422-body-validation": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } } }, "schema": { "$ref": "#/components/schemas/422-invalid-request" } } }, "description": "请求验证错误。" }, "Promotions_200-admin-get-bonus-promotion": { "content": { "application/json": { "examples": { "response": { "value": { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_1" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_1" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_1" } ], "condition": [ { "sku": "com.xsolla.elven_boots_1" }, { "sku": "com.xsolla.elven_knife_1" } ], "excluded_promotions": [ 23, 45 ], "id": 1, "is_enabled": true, "limits": { "per_item": null, "per_user": { "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "price_conditions": [ { "operator": "gt", "value": "10.0000" }, { "operator": "lt", "value": "50.0000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] } } }, "schema": { "$ref": "#/components/schemas/Promotions_200-get-bonus-promotion-model" } } }, "description": "奖励促销活动已成功收到。" }, "Promotions_200-coupon-code-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Promotions_200-coupon-code-list" } }, "schema": { "properties": { "codes": { "items": { "properties": { "code": { "$ref": "#/components/schemas/Promotions_coupon_code" } }, "type": "object" }, "type": "array" }, "total_count": { "description": "优惠券码总数。", "type": "number" } }, "type": "object" } } }, "description": "已成功接收优惠券码列表。" }, "Promotions_200-coupon-redeemed": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [], "description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": true, "name": "Xsolla Booster Mega", "price": null, "quantity": 1, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ] } } }, "schema": { "properties": { "items": { "example": [ { "attributes": [], "description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "items": { "properties": { "attributes": { "type": "array" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_free": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "2.9900", "type": "string" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "优惠券已成功兑换。" }, "Promotions_200-coupon-rewards": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Promotions_200-get-coupon-rewards" } }, "schema": { "properties": { "bonus": { "items": { "$ref": "#/components/schemas/Promotions_200-coupon-bonus-reward" }, "type": "array" }, "discount": { "$ref": "#/components/schemas/Promotions_200-coupon-discount-reward" }, "is_selectable": { "description": "如果为`true`，则用户应在兑换优惠券之前选择奖励。", "type": "boolean" } }, "type": "object" } } }, "description": "已成功接收优惠券奖励列表。" }, "Promotions_200-get-bonus-promotions": { "content": { "application/json": { "examples": { "response": { "value": { "active_promotions_count": 2, "inactive_promotions_count": 0, "promotions": [ { "bonus": [ { "quantity": 1, "sku": "com.xsolla.elven_sword_1" }, { "quantity": 2, "sku": "com.xsolla.elven_shield_1" }, { "quantity": 2, "sku": "com.xsolla.elven_gloves_1" } ], "condition": [ { "sku": "com.xsolla.elven_boots_1" }, { "sku": "com.xsolla.elven_knife_1" } ], "id": 1, "is_enabled": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ] }, { "bonus": [ { "quantity": 100, "sku": "com.xsolla.diamonds_1" } ], "condition": null, "excluded_promotions": [ 1 ], "id": 2, "is_enabled": true, "limits": { "per_item": null, "per_user": { "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "name": { "de-DE": "Sommersaison Bonus", "en-US": "Summer season bonus" }, "price_conditions": [ { "operator": "gt", "value": "10.0000" }, { "operator": "lt", "value": "50.0000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] } ], "total_promotions_count": 2 } } }, "schema": { "properties": { "active_promotions_count": { "$ref": "#/components/schemas/active_promotions_count" }, "inactive_promotions_count": { "$ref": "#/components/schemas/inactive_promotions_count" }, "promotions": { "items": { "$ref": "#/components/schemas/Promotions_200-get-bonus-promotion-model" }, "type": "array" }, "total_promotions_count": { "$ref": "#/components/schemas/total_promotions_count" } }, "type": "object" } } }, "description": "已成功收到奖励促销活动列表。" }, "Promotions_200-get-coupons": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Promotions_200-admin-coupons" } }, "schema": { "properties": { "active_promotions_count": { "$ref": "#/components/schemas/active_promotions_count" }, "inactive_promotions_count": { "$ref": "#/components/schemas/inactive_promotions_count" }, "items": { "items": { "$ref": "#/components/schemas/admin-promotions_200-get-coupon-promotion-model" }, "type": "array" }, "total_promotions_count": { "$ref": "#/components/schemas/total_promotions_count" } }, "type": "object" } } }, "description": "优惠券列表已成功收到。" }, "Promotions_200-get-item-promotions": { "content": { "application/json": { "examples": { "response": { "value": { "active_promotions_count": 4, "inactive_promotions_count": 0, "promotions": [ { "discount": { "percent": "20.00" }, "id": 1, "is_enabled": true, "items": [ { "sku": "com.xsolla.elven_sword_1" } ], "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "name": { "en-US": "Promotion", "ru-RU": "Акция" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ] }, { "discount": { "percent": "10.00" }, "excluded_promotions": [ 1, 3 ], "id": 2, "is_enabled": true, "items": [ { "sku": "com.xsolla.elven_helmet_1" }, { "sku": "com.xsolla.elven_armor_1" } ], "limits": { "per_item": null, "per_user": { "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "name": { "en-US": "Promotion", "ru-RU": "Акция" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] }, { "discount": { "percent": "10.00" }, "id": 3, "is_enabled": true, "items": [ { "sku": "com.xsolla.elven_helmet_2" }, { "sku": "com.xsolla.elven_armor_2" } ], "limits": { "per_item": null, "per_user": { "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "name": { "en-US": "Promotion", "ru-RU": "Акция" }, "price_conditions": [ { "operator": "gt", "value": "10.0000" }, { "operator": "lt", "value": "20.0000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] }, { "discount": { "percent": "10.00" }, "id": 4, "is_enabled": true, "items": null, "limits": { "per_item": null, "per_user": { "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "name": { "en-US": "Promotion", "ru-RU": "Акция" }, "price_conditions": [ { "operator": "lt", "value": "20.0000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] } ], "total_promotions_count": 4 } } }, "schema": { "properties": { "active_promotions_count": { "$ref": "#/components/schemas/active_promotions_count" }, "inactive_promotions_count": { "$ref": "#/components/schemas/inactive_promotions_count" }, "promotions": { "items": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get" }, "discount": { "properties": { "percent": { "default": "10.00", "description": "百分比折扣。\n商品价格使用此百分比计算打折价格。", "type": [ "string", "null" ] } }, "type": "object" }, "excluded_promotions": { "$ref": "#/components/schemas/excluded_promotions" }, "id": { "description": "促销活动ID。项目内的唯一促销活动标识符。", "type": "integer" }, "is_enabled": { "$ref": "#/components/schemas/Promotions_is_enabled" }, "items": { "items": { "description": "适用折扣的商品列表。", "properties": { "sku": { "default": "elven_sword", "description": "物品 SKU。", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "limits": { "$ref": "#/components/schemas/Promotions_promotion_limits_response" }, "name": { "additionalProperties": { "type": "string" }, "description": "促销活动名称。应包含键/值对，其中键是格式为\"^[a-z]{2}-[A-Z]{2}$\"的区域设置，值是字符串。", "example": { "en-US": "Promotion", "ru-RU": "Акция" }, "type": "object" }, "price_conditions": { "$ref": "#/components/schemas/price_conditions_discount" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" } }, "type": "object" }, "type": "array" }, "total_promotions_count": { "$ref": "#/components/schemas/total_promotions_count" } }, "type": "object" } } }, "description": "已成功收到商品促销活动列表。" }, "Promotions_200-get-promocodes": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Promotions_200-admin-promocodes" } }, "schema": { "properties": { "active_promotions_count": { "$ref": "#/components/schemas/active_promotions_count" }, "inactive_promotions_count": { "$ref": "#/components/schemas/inactive_promotions_count" }, "items": { "items": { "$ref": "#/components/schemas/Promotions_200-get-promocode-promotion-model" }, "type": "array" }, "total_promotions_count": { "$ref": "#/components/schemas/total_promotions_count" } }, "type": "object" } } }, "description": "成功收到促销码列表。" }, "Promotions_200-get-promotions": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Promotions_200-admin-promotions" } }, "schema": { "properties": { "active_promotions_count": { "$ref": "#/components/schemas/active_promotions_count" }, "inactive_promotions_count": { "$ref": "#/components/schemas/inactive_promotions_count" }, "promotions": { "items": { "$ref": "#/components/schemas/Promotions_200-get-promotion-model" }, "type": "array" }, "total_promotions_count": { "$ref": "#/components/schemas/total_promotions_count" } }, "type": "object" } } }, "description": "已成功接收促销活动列表。" }, "Promotions_200-get-unique-catalog-offers": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Promotions_200-admin-unique-catalog-offers" } }, "schema": { "properties": { "active_promotions_count": { "$ref": "#/components/schemas/active_promotions_count" }, "inactive_promotions_count": { "$ref": "#/components/schemas/inactive_promotions_count" }, "items": { "items": { "$ref": "#/components/schemas/Promotions_200-get-unique-catalog-offer-promotion-model" }, "type": "array" }, "total_promotions_count": { "$ref": "#/components/schemas/total_promotions_count" } }, "type": "object" } } }, "description": "已成功接收优惠券列表。" }, "Promotions_200-promo-code-canceled": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Xsolla Booster Mega", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" } } } }, "schema": { "properties": { "cart_id": { "description": "购物车ID。", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "items": { "example": [ { "attributes": [], "can_be_bought": true, "description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Xsolla Booster Mega", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "2.9900", "type": "string" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "购物车价格。", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "default": "50.0000000000000000", "type": "string" }, "amount_without_discount": { "default": "100.0000000000000000", "type": "string" }, "currency": { "default": "USD", "type": "string" } }, "type": [ "object", "null" ] } }, "type": "object" } } }, "description": "促销码已成功取消。" }, "Promotions_200-promo-code-redeemed": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Xsolla Booster Mega", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": false, "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel.", "groups": [], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": true, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Sword Xsolla Skin", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": [], "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 1, "sku": "com.xsolla.swords_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "12300.0000000000000000", "currency": "USD" }, "rewards": { "bonus": [ { "item": { "description": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel.", "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "name": "Sword Xsolla Skin", "sku": "com.xsolla.swords_1", "type": "virtual_good", "virtual_item_type": "non_consumable" }, "quantity": 1 } ], "discount": { "percent": null }, "discounted_items": [ { "discount": { "percent": "50.00" }, "sku": "com.xsolla.booster_mega_1" } ], "is_selectable": false } } } }, "schema": { "properties": { "cart_id": { "description": "购物车ID。", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "items": { "example": [ { "attributes": [], "can_be_bought": true, "description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Xsolla Booster Mega", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": false, "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "items": { "properties": { "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "购物车价格。", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "example": "50.0000000000000000", "type": "string" }, "amount_without_discount": { "example": "100.0000000000000000", "type": "string" }, "currency": { "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "rewards": { "$ref": "#/components/schemas/Promo_code_rewards" } }, "type": "object" } } }, "description": "促销码已成功兑换。" }, "Promotions_200-promocode-code-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Promotions_200-coupon-code-list" } }, "schema": { "properties": { "codes": { "items": { "properties": { "code": { "$ref": "#/components/schemas/Promotions_coupon_code" } }, "type": "object" }, "type": "array" }, "total_count": { "description": "促销码总数。", "type": "number" } }, "type": "object" } } }, "description": "已成功接收促销码列表。" }, "Promotions_200-promocode-rewards": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Promotions_200-get-promocode-rewards" } }, "schema": { "$ref": "#/components/schemas/Promo_code_rewards" } } }, "description": "已成功接收促销码奖励列表。" }, "Promotions_200-unique-catalog-offer-code-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Promotions_200-coupon-code-list" } }, "schema": { "properties": { "codes": { "items": { "properties": { "code": { "$ref": "#/components/schemas/Promotions_coupon_code" } }, "type": "object" }, "type": "array" }, "total_count": { "description": "特别目录优惠代码的总数。", "type": "number" } }, "type": "object" } } }, "description": "已成功接收特别目录优惠的代码列表。" }, "Promotions_200-verify-promo-code": { "content": { "application/json": { "examples": { "coupon info": { "value": { "code": "WINTER2023", "rewards": { "bonus": [ { "item": { "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam_key_1", "is_free": false, "name": "Game name", "sku": "com.xsolla.game_key_01", "type": "game_key" }, { "drm_name": "Origin", "drm_sku": "origin_key_1", "name": "Game name", "sku": "com.xsolla.game_key_02", "type": "game_key" } ] }, "quantity": 1 }, { "item": { "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam_key_1", "name": "Game name", "sku": "com.xsolla.game_key_01", "type": "game_key" } ] }, "quantity": 2 } ], "is_selectable": true }, "type": "coupon" } }, "promocode info": { "value": { "code": "SUMMER2023", "rewards": { "bonus": [ { "item": { "description": "Game description", "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam_key_1", "name": "Game name", "sku": "com.xsolla.game_key_01", "type": "game_key" } ] }, "quantity": 2 } ], "discount": { "percent": "10.00" }, "discounted_items": [ { "description": "sword", "discount": { "percent": "10.00" }, "image_url": null, "name": "Elven sword", "sku": "com.xsolla.elven_sword_1", "type": "virtual_good" } ], "is_selectable": true }, "type": "promocode" } } }, "schema": { "properties": { "code": { "$ref": "#/components/schemas/Promotions_coupon_code" }, "rewards": { "oneOf": [ { "$ref": "#/components/schemas/Coupon_rewards" }, { "$ref": "#/components/schemas/Promo_code_rewards_verify" } ] }, "type": { "description": "代码类型：`promocode`/`coupon`。", "type": "string" } }, "type": "object" } } }, "description": "有关代码的信息。" }, "Promotions_201-coupon-promocode-code-created": { "content": { "application/json": { "examples": { "response": { "value": { "code": "WINTER2021" } } }, "schema": { "properties": { "code": { "$ref": "#/components/schemas/Promotions_coupon_code" } }, "type": "object" } } }, "description": "代码创建成功。" }, "Promotions_201-create-promotion": { "content": { "application/json": { "examples": { "response": { "value": { "promotion_id": 2384756 } } }, "schema": { "properties": { "promotion_id": { "description": "促销活动ID。项目内的唯一促销活动标识符。", "type": "integer" } }, "type": "object" } } }, "description": "促销活动已成功创建。" }, "Promotions_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "基本认证未通过或错误。确保您使用了基本认证或正确的凭据。" }, "Promotions_401-invalid-client-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1501, "errorMessage": "[0401-1501]: Authorization failed: Provide authorization", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1501, "type": "integer" }, "errorMessage": { "example": "[0401-1501]: Authorization failed: Provide authorization", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "description": "认证未通过或错误。" }, "Promotions_403-auth-header": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 0, "errorMessage": "Authorization header not sent", "statusCode": 403 } } }, "schema": { "properties": { "errorCode": { "example": 0, "type": "integer" }, "errorMessage": { "example": "Authorization header not sent.", "type": "string" }, "statusCode": { "example": 403, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "未发送授权标头。" }, "Promotions_404-admin-coupon": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-9802]: Coupon not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "未找到优惠券。请确保`external_id`正确无误。" }, "Promotions_404-admin-promocode": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-9802]: Promocode not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "未找到促销码。请确保`external_id`正确无误。" }, "Promotions_404-admin-promotion": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9502, "errorMessage": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 9502, "type": "integer" }, "errorMessage": { "example": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "未找到促销活动。请确保`promotion_id`正确无误。" }, "Promotions_404-coupon": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-9807]: Enter valid coupon code.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "输入有效的优惠券码。" }, "Promotions_404-promo-code": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-9807]: Enter valid promo code.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "输入有效的促销码。" }, "Promotions_404-verify-promo-code": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 9811, "type": "integer" }, "errorMessage": { "example": "[0401-9811]: Code not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "未找到代码。请确保`code`值正确无误。" }, "Promotions_422-activate-deactivate-promotion": { "content": { "application/json": { "examples": { "Error was occurred": { "$ref": "#/components/examples/422-activate-deactivate-promotion" } }, "schema": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-9505]: Error was occurred while promotion was being updated", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "da145238620011eb8e24fe6913ff226a", "type": "string" } }, "type": "object" } } }, "description": "无效的请求。" }, "Promotions_422-admin-promotion-error": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 9502, "type": "integer" }, "errorMessage": { "example": "[0401-9502]: Error occurred while receiving the promotion from the promotion service", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "从促销服务接收促销活动时出错。" }, "Promotions_422-admin-promotion-missed-bonus-property": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `bonus` is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `bonus` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "无效的请求。" }, "Promotions_422-admin-promotion-missed-items-property": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `items` is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `items` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "无效的请求。" }, "Promotions_422-cancel-promo-code": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `id` is required", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `id` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "无效请求。" }, "Promotions_422-coupon-promocode-same-code-exists": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9803, "errorMessage": "[0401-9803]: The code already exists.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "properties": { "errorCode": { "example": 9803, "type": "integer" }, "errorMessage": { "example": "[0401-9803]: The code already exists.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "无效的请求。代码已经存在。" }, "Promotions_422-invalid-coupon": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "无效请求。" }, "Promotions_422-redeem-coupon": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `coupon_code` is required", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `coupon_code` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "无效请求。" }, "Promotions_422-rewards": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Promotions_422_limit_error" }, { "$ref": "#/components/schemas/Promotions_422_reglock_error" } ] } } }, "description": "无效请求。" }, "Promotions_422-verify-promo-code": { "content": { "application/json": { "examples": { "code redemption limit": { "value": { "errorCode": 9804, "errorMessage": "[0401-9804]: You have reached the coupon redemption limit.", "statusCode": 422 } }, "regionally restricted": { "value": { "errorCode": 9808, "errorMessage": "[0401-9808]: Coupon is not available in your region.", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" } }, "type": "object" } } }, "description": "代码促销活动无效。" }, "Upsell-200-get-client-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attributes": [ { "external_id": "stack_size", "name": { "en": "Quantity of items in the upsell set" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": { "en": "accessory" } } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" }, { "quantity": 1, "sku": "com.xsolla.phys_good_1", "type": "physical_good" }, { "bundle_type": "standard", "image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png", "name": "Super Lootbox with items", "quantity": 1, "sku": "com.xsolla.SuperLootboxBundle_1", "type": "bundle" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": null, "name": "Bonus promotion" } ], "sku": "com.xsolla.big_rocket_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [ { "external_id": "stack_size", "name": { "en": "Quantity of items in the upsell set" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": { "en": "Items rating" }, "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "can_be_bought": true, "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } } ], "image_url": "http://image.png", "is_free": false, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [ { "date_from": "2020-08-11T20:00:00+03:00", "date_until": null } ], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_2", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_3", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "description", "groups": [], "image_url": "http://image.png", "is_free": true, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [], "price": null, "promotions": [], "sku": "com.xsolla.shotgun_raider_2", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [], "vp_rewards": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Upsell_item-list" } } }, "description": "成功接收追加销售商品列表。" }, "Upsell-404-item-not-found": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9901, "errorMessage": "[0401-4001]: Items weren't found: sku1, sku2", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Items weren't found: sku1, sku2", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "未找到商品。" }, "Upsell-422-invalid-request": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Upsell-422-invalid-request" } } }, "description": "无效请求。" }, "sellable-item-by-sku_404": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'electric_shiel' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "未找到商品。请确保`project_id`和`sku`正确无误。" } }, "schemas": { "422-invalid-request": { "properties": { "errorCode": { "description": "错误代码。", "example": 1102, "type": "number" }, "errorMessage": { "description": "可读的错误消息。", "example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "type": "string" }, "statusCode": { "description": "响应状态码。", "example": 422, "type": "number" }, "transactionId": { "description": "请求的唯一ID。", "example": "da145238620011eb8e24fe6913ff226a", "type": "string" } }, "type": "object" }, "422-rc-vp-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Can_be_bought": { "description": "如为`true`，则用户可以购买商品。", "example": true, "type": "boolean" }, "Catalog_item_limits": { "description": "商品限制。", "properties": { "per_item": { "description": "商品的购买限制。", "properties": { "available": { "description": "所有用户可购买的剩余商品数量。", "example": 3, "type": "integer" }, "total": { "description": "所有用户可购买的最大商品数量。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "一个用户的购买数量限制。", "properties": { "available": { "description": "当前用户可购买的剩余商品数量。", "example": 3, "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "单个用户可购买的最大商品数量。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "Catalog_item_promotions": { "description": "应用于购物车中指定商品的促销活动。仅在以下情况下返回该数组：\n\n* 为某商品配置了折扣促销活动。\n\n* 应用了**对所选商品提供折扣**设置的促销码。\n\n如果未应用任何商品级促销活动，则返回空数组。", "items": { "properties": { "bonus": { "items": { "properties": { "bundle_type": { "description": "奖励捆绑包商品类型。仅适用于`bundle`奖励品类型。", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "image_url": { "description": "奖励商品图片URL。不适用于`physical_good`奖励品类型。", "type": "string" }, "name": { "description": "奖励品名称。不适用于`physical_good`奖励品类型。", "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "description": "奖励品类型。", "enum": [ "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft" ], "type": "string" } }, "type": "object" }, "type": "array" }, "date_end": { "format": "date-time", "type": [ "string", "null" ] }, "date_start": { "format": "date-time", "type": [ "string", "null" ] }, "discount": { "properties": { "percent": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "limits": { "properties": { "per_user": { "properties": { "available": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "Code-limit-promo-code": { "properties": { "code": { "$ref": "#/components/schemas/Promotions_coupon_code" }, "per_code": { "properties": { "available": { "description": "促销码的剩余可用次数。", "type": "integer" }, "reserved": { "description": "促销码被保留的次数。", "type": "integer" }, "total": { "description": "促销码可以使用的最大次数。", "type": "integer" }, "used": { "description": "促销码被使用的次数。", "type": "integer" } }, "type": "object" } }, "type": "object" }, "Common_admin-image_url": { "description": "图像URL。", "example": "https://image.example.com", "type": "string" }, "Coupon_rewards": { "properties": { "bonus": { "items": { "$ref": "#/components/schemas/Promotions_200-coupon-bonus-reward" }, "type": "array" }, "is_selectable": { "description": "如为`true`，用户应在兑换优惠券之前选择一个奖励。", "type": "boolean" } }, "type": "object" }, "Pagination_has-more": { "description": "用作指示还有更多页面。", "example": true, "type": "boolean" }, "Promo_code_rewards": { "properties": { "bonus": { "items": { "$ref": "#/components/schemas/Promotions_200-promo-code-bonus-reward" }, "type": "array" }, "discount": { "$ref": "#/components/schemas/Promotions_200-coupon-discount-reward" }, "discounted_items": { "$ref": "#/components/schemas/Promotions_discounted_items" }, "is_selectable": { "description": "如果为`true`，则用户应在兑换促销码之前选择奖励。", "type": "boolean" } }, "type": "object" }, "Promo_code_rewards_verify": { "properties": { "bonus": { "items": { "$ref": "#/components/schemas/Promotions_200-promo-code-bonus-reward" }, "type": "array" }, "discount": { "$ref": "#/components/schemas/Promotions_200-coupon-discount-reward" }, "discounted_items": { "$ref": "#/components/schemas/Promotions_discounted_items_verify" }, "is_selectable": { "description": "如果为`true`，则用户应在兑换促销码之前选择奖励。", "type": "boolean" } }, "type": "object" }, "Promotions_200-coupon-bonus-reward": { "properties": { "item": { "properties": { "bundle_type": { "description": "捆绑类型。商品类型是捆绑包时返回。", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "content": { "type": "array" }, "description": { "description": "商品描述。", "example": "Game description", "type": [ "string", "null" ] }, "image_url": { "description": "图像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": [ "string", "null" ] }, "name": { "description": "商品名称。", "example": { "en": "Game name" }, "type": "object" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。", "example": "unit", "type": "string" }, "unit_items": { "description": "如果商品具有单位类型，则它包含单位中的所有商品。大多数情况下，用户应该选择其中之一作为优惠券奖励。", "items": { "properties": { "drm_name": { "description": "DRM名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "唯一DRM ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "steam", "type": "string" }, "is_free": { "type": "boolean" }, "name": { "description": "商品名称。", "example": "Game name", "type": "string" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`game_key`。", "example": "game_key", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "quantity": { "default": 1, "description": "商品数量。", "type": "number" } }, "type": "object" }, "Promotions_200-coupon-discount-reward": { "description": "百分比折扣。\n购物车价格将按照此百分比打折，然后四舍五入到小数点后两位。", "properties": { "percent": { "example": "10.00", "type": "string" } }, "type": [ "object", "null" ] }, "Promotions_200-get-bonus-promotion-model": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get" }, "bonus": { "items": { "description": "将作为奖励添加到用户购买项中的商品列表。", "properties": { "quantity": { "default": 1, "description": "商品数量。", "type": "number" }, "sku": { "default": "elven_shield", "description": "商品SKU。", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "condition": { "description": "要应用促销必须在购买项中包含的一组商品。如果此参数为`null`，则促销将应用于项目内的任何购买。", "items": { "properties": { "sku": { "default": "elven_sword", "description": "商品SKU。", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "excluded_promotions": { "$ref": "#/components/schemas/excluded_promotions" }, "id": { "description": "促销活动ID。项目内的唯一促销活动标识符。", "type": "integer" }, "is_enabled": { "default": true, "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Promotions_promotion_limits_response" }, "name": { "additionalProperties": { "type": "string" }, "description": "促销活动名称。应包含键/值对，\n其中键是\"^[a-z]{2}-[A-Z]{2}$\"格式的区域设置，值是字符串。", "example": { "de-DE": "Sommersaison Bonus", "en-US": "Summer season bonus" }, "type": "object" }, "price_conditions": { "$ref": "#/components/schemas/price_conditions_bonus" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" } }, "type": "object" }, "Promotions_200-get-promocode-promotion-model": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get" }, "bonus": { "$ref": "#/components/schemas/Promotions_coupon_bonus" }, "discount": { "example": { "discount": { "percent": "10.99" } }, "properties": { "percent": { "$ref": "#/components/schemas/Promotions_promotion_discount_percent" } }, "type": [ "object", "null" ] }, "discounted_items": { "$ref": "#/components/schemas/Promotions_discounted_items" }, "excluded_promotions": { "$ref": "#/components/schemas/excluded_promotions" }, "external_id": { "$ref": "#/components/schemas/Promotions_coupon-external_id" }, "is_enabled": { "$ref": "#/components/schemas/Promotions_coupon-is_enabled" }, "item_price_conditions": { "$ref": "#/components/schemas/item_price_conditions_promocode" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "price_conditions": { "$ref": "#/components/schemas/price_conditions_promocode" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit" }, "redeem_user_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit" }, "total_limit_state": { "$ref": "#/components/schemas/Promotions_promocode_total_limit_state" } }, "type": "object" }, "Promotions_200-get-promotion-model": { "properties": { "bonus": { "items": { "$ref": "#/components/schemas/Promotions_200-coupon-bonus-reward" }, "type": "array" }, "condition": { "$ref": "#/components/schemas/Promotions_promotion_condition" }, "discount": { "example": { "discount": { "percent": "10.99" } }, "properties": { "percent": { "$ref": "#/components/schemas/Promotions_promotion_discount_percent" } }, "type": [ "object", "null" ] }, "id": { "$ref": "#/components/schemas/Promotions_promotion_id" }, "is_enabled": { "$ref": "#/components/schemas/Promotions_coupon-is_enabled" }, "limits": { "$ref": "#/components/schemas/Promotions_promotion_limits_response" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" }, "type": { "$ref": "#/components/schemas/Promotions_promotion_type" } }, "type": "object" }, "Promotions_200-get-unique-catalog-offer-promotion-model": { "properties": { "external_id": { "$ref": "#/components/schemas/Promotions_coupon-external_id" }, "is_enabled": { "$ref": "#/components/schemas/Promotions_coupon-is_enabled" }, "items": { "$ref": "#/components/schemas/Promotions_unique_catalog_offer_items" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit" }, "redeem_user_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit" }, "total_limit_state": { "$ref": "#/components/schemas/Promotions_coupon_total_limit_state" } }, "type": "object" }, "Promotions_200-promo-code-bonus-reward": { "properties": { "item": { "properties": { "description": { "description": "商品描述。", "example": "Game description", "type": "string" }, "image_url": { "description": "图像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "商品名称。", "example": "Game name", "type": "string" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。", "example": "unit", "type": "string" }, "unit_items": { "description": "如果商品具有单位类型，则它包含单位中的所有商品。大多数情况下，用户应该选择其中之一作为促销码奖励。", "items": { "properties": { "drm_name": { "description": "DRM名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "唯一DRM ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "steam", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "name": { "description": "商品名称。", "example": "Game name", "type": "string" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`game_key`。", "example": "game_key", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "quantity": { "default": 1, "description": "商品数量。", "type": "number" } }, "type": "object" }, "Promotions_422_limit_error": { "description": "已达到兑换限制。", "example": { "errorCode": 9804, "errorMessage": "[0401-9804]: You have reached the coupon redemption limit.", "statusCode": 422 }, "properties": { "errorCode": { "example": 9804, "type": "integer" }, "errorMessage": { "example": "[0401-9804]: You have reached the coupon redemption limit.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Promotions_422_reglock_error": { "description": "优惠券在用户所在地区不可用。", "example": { "errorCode": 9804, "errorMessage": "[0401-9804]: You have reached the coupon redemption limit.", "statusCode": 422 }, "properties": { "errorCode": { "example": 9808, "type": "integer" }, "errorMessage": { "example": "[0401-9808]: Coupon is not available in your region.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Promotions_cart_item_discount": { "default": "10.00", "description": "百分比折扣。\n\n购物车商品价格将按照此百分比打折，\n然后四舍五入到小数点后两位。\n", "example": "10.00", "nullable": false, "type": "string" }, "Promotions_coupon-external_id": { "default": "coupon_external_id", "description": "唯一促销活动ID。 `external_id`只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "coupon_external_id", "type": "string" }, "Promotions_coupon-generate-count": { "example": 10, "maximum": 100000, "minimum": 1, "type": "integer" }, "Promotions_coupon-is_enabled": { "default": true, "type": "boolean" }, "Promotions_coupon-redeem_total_limit": { "default": 10, "description": "限制优惠券的总数。", "example": 10, "type": [ "integer", "null" ] }, "Promotions_coupon-redeem_user_limit": { "default": 10, "description": "限制单个用户兑换的优惠券总数。", "example": 10, "type": [ "integer", "null" ] }, "Promotions_coupon_bonus": { "items": { "description": "将作为奖励添加到用户购买项中的商品列表。", "properties": { "quantity": { "default": 1, "description": "商品数量。", "type": "number" }, "sku": { "default": "elven_shield", "description": "物品 SKU。", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "Promotions_coupon_code": { "default": "WINTER2021", "description": "区分大小写的唯一券码。包含字母和数字。", "example": "WINTER2021", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "Promotions_coupon_date_end": { "default": "2020-04-15T18:16:00+05:00", "description": "促销活动结束日期。可以是`null`。如果`date_end` 为`null`，则促销活动无时间限制。", "format": "date-time", "type": [ "string", "null" ] }, "Promotions_coupon_date_start": { "default": "2020-04-15T18:16:00+05:00", "description": "促销活动开始日期。", "format": "date-time", "type": [ "string", "null" ] }, "Promotions_coupon_name": { "additionalProperties": { "type": "string" }, "default": { "de-DE": "Gutscheintitel", "en-US": "Coupon title" }, "description": "促销活动名称。应包含键/值对，\n其中键是\"^[a-z]{2}-[A-Z]{2}$\"格式的区域设置，值是字符串。", "example": { "de-DE": "Gutscheintitel", "en-US": "Coupon title" }, "type": "object" }, "Promotions_coupon_total_limit_state": { "description": "每个唯一优惠券码的限制。", "properties": { "available": { "description": "优惠券剩余可使用次数。", "example": 3, "type": "integer" }, "reserved": { "description": "优惠券预留数量。", "example": 3, "type": "integer" }, "used": { "description": "优惠券被使用的次数。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "Promotions_discounted_items": { "description": "通过促销码打折的商品列表。", "items": { "description": "购物车中特定商品的折扣。", "minItems": 1, "properties": { "discount": { "nullable": false, "properties": { "percent": { "$ref": "#/components/schemas/Promotions_cart_item_discount" } }, "required": [ "percent" ], "type": "object" }, "sku": { "default": "elven_shield", "description": "物品 SKU。", "type": "string" } }, "required": [ "sku", "discount" ], "type": "object" }, "type": [ "array", "null" ] }, "Promotions_discounted_items_verify": { "description": "通过促销码打折的商品列表。", "items": { "description": "特定商品的折扣。", "properties": { "description": { "description": "商品描述。", "example": "Game description", "type": "string" }, "discount": { "nullable": false, "properties": { "percent": { "$ref": "#/components/schemas/Promotions_cart_item_discount" } }, "type": "object" }, "image_url": { "description": "图像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "商品名称。", "example": "Game name", "type": "string" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。", "example": "unit", "type": "string" }, "unit_items": { "description": "如果商品具有单位类型，则它包含单位中的所有商品。大多数情况下，用户应该选择其中之一作为促销码奖励。", "items": { "properties": { "drm_name": { "description": "DRM名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "唯一DRM ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "steam", "type": "string" }, "name": { "description": "商品名称。", "example": "Game name", "type": "string" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`game_key`。", "example": "game_key", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": [ "array", "null" ] }, "Promotions_is_enabled": { "description": "是否启用了促销活动。", "example": true, "type": "boolean" }, "Promotions_name": { "additionalProperties": { "type": "string" }, "default": { "de-DE": "Artikeltitel", "en-US": "Item title" }, "description": "商品名称。应包含键/值对，\n其中键是\"^[a-z]{2}-[A-Z]{2}$\"格式的区域设置，值是字符串。", "example": { "de-DE": "Artikeltitel", "en-US": "Item title" }, "type": "object" }, "Promotions_promocode_total_limit_state": { "description": "每个唯一促销码的限制。", "properties": { "available": { "description": "促销码的剩余可用次数。", "example": 3, "type": "integer" }, "reserved": { "description": "促销码被保留的数量。", "example": 3, "type": "integer" }, "used": { "description": "促销码被使用的次数。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "Promotions_promotion_condition": { "items": { "description": "用户购买这些商品而可获得奖励的商品列表。", "properties": { "item": { "properties": { "description": { "description": "商品描述。", "example": "Game description", "type": [ "string", "null" ] }, "external_id": { "description": "促销活动外部ID。项目内的唯一促销活动标识符。", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "image_url": { "description": "图像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": [ "string", "null" ] }, "is_enabled": { "type": "boolean" }, "name": { "$ref": "#/components/schemas/Promotions_name" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "type": [ "integer", "null" ] }, "redeem_user_limit": { "type": [ "integer", "null" ] }, "sku": { "$ref": "#/components/schemas/Promotions_sku" }, "type": { "$ref": "#/components/schemas/Promotions_type" } }, "type": "object" } }, "type": "object" }, "type": [ "array", "null" ] }, "Promotions_promotion_discount_percent": { "default": "10.00", "description": "百分比折扣。\n购物车价格将按照此百分比打折，然后四舍五入到小数点后两位。", "example": "10.00", "type": [ "string", "null" ] }, "Promotions_promotion_id": { "description": "促销活动ID。项目内的唯一促销活动标识符。", "example": 1, "type": "integer" }, "Promotions_promotion_limits": { "description": "促销活动限制。", "properties": { "per_user": { "description": "针对单独用户的促销活动限制。", "type": [ "integer", "null" ] }, "recurrent_schedule": { "$ref": "#/components/schemas/promotion_recurrent_schedule_response" } }, "type": "object" }, "Promotions_promotion_limits_response": { "description": "促销活动限制。", "properties": { "per_item": { "description": "全局商品限制。", "example": 10, "type": [ "integer", "null" ] }, "per_user": { "description": "针对单独用户的促销活动限制。", "properties": { "total": { "description": "用户可以购买的商品总数。您可以在发布商帐户中设置此数字或使用商店实体的管理端点（限制对象）。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "recurrent_schedule": { "$ref": "#/components/schemas/promotion_recurrent_schedule_response" } }, "type": "object" }, "Promotions_promotion_type": { "description": "促销活动类型。", "example": "item_discount", "type": "string" }, "Promotions_redeem_code_limit": { "default": 10, "description": "每个代码的兑换次数。", "example": 10, "type": [ "integer", "null" ] }, "Promotions_selected_unit_items": { "additionalProperties": { "type": "string" }, "description": "用户选择的奖励。\n对象键是单位的SKU，值是单位中一个商品的SKU。", "example": { "game_1": "game_1_steam", "game_2": "game_2_playstation" }, "type": "object" }, "Promotions_sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "booster_mega_1", "type": "string" }, "Promotions_type": { "description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。", "type": "string" }, "Promotions_unique_catalog_offer_items": { "description": "使用特别目录优惠后可用的商品SKU列表。", "items": { "$ref": "#/components/schemas/sku" }, "type": "array" }, "Upsell-422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable entity. The property `is_enabled` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Upsell-model": { "description": "追加销售类型。", "properties": { "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "items": { "default": null, "description": "商品SKU数组。", "example": [ "game_sku" ], "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "fixed_list" ], "example": true, "type": "string" } }, "required": [ "is_enabled", "type", "items" ], "type": "object" }, "Upsell-model-not-fixed-list": { "description": "追加销售类型。", "properties": { "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "items": { "default": null, "description": "空的商品SKU数组。", "example": [ null ], "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "most_sellable", "only_promotions" ], "example": true, "type": "string" } }, "required": [ "is_enabled", "type" ], "type": "object" }, "Upsell_item": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "商品描述。", "example": "Big Rocket - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "image_url": { "description": "图像URL。", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "商品名称。", "example": "Big Rocket", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "big_rocket", "type": "string" }, "type": { "description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "虚拟货币图像。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "vc_test", "type": "string" }, "type": { "description": "虚拟货币类型。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "Upsell_item-list": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Upsell_item" }, "type": "array" } }, "type": "object" }, "User-limit-coupon": { "properties": { "per_user": { "properties": { "available": { "description": "用户可以使用优惠券的剩余次数。", "example": 9, "type": "integer" }, "total": { "description": "用户可以使用优惠券的最大次数。", "example": 10, "type": "integer" } }, "type": "object" } }, "type": "object" }, "User-limit-promo-code": { "properties": { "per_user": { "properties": { "available": { "description": "用户可以使用促销码的剩余次数。", "example": 9, "type": "integer" }, "total": { "description": "用户可以使用促销码的最大次数。", "example": 10, "type": "integer" } }, "type": "object" } }, "type": "object" }, "User-limit-promotion": { "properties": { "per_user": { "properties": { "available": { "description": "用户可以使用促销活动的剩余次数。", "example": 9, "type": "integer" }, "total": { "description": "用户可以使用促销活动的最大次数。", "example": 10, "type": "integer" } }, "type": "object" } }, "type": "object" }, "User-limit_available": { "description": "在应用的限制数内用户可购的剩余商品数或可用的促销活动次数。", "minimum": 1, "type": "integer" }, "User-limit_available_flexible": { "description": "在应用的限制数内用户可购的剩余商品数或可用的促销活动次数。", "minimum": 0, "type": "integer" }, "User-limit_user": { "properties": { "user_external_id": { "$ref": "#/components/schemas/User-limit_user-external-id" } }, "required": [ "user_external_id" ], "type": "object" }, "User-limit_user-external-id": { "description": "用户外部ID。", "minLength": 1, "pattern": "^\\S+$", "type": "string" }, "User-limit_user_flexible": { "properties": { "user_external_id": { "$ref": "#/components/schemas/User-limit_user-external-id" } }, "type": [ "object", "null" ] }, "Value-point-item-model": { "properties": { "can_delete": { "description": "是否可以删除该奖励积分。如为`false`，则无法删除该奖励积分，因为有一个或多个奖励链在使用它。要删除该奖励积分，请先[删除](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-delete-reward-chain/)所有包含它的奖励链。\n\n如为`true`，则该奖励积分不用于任何奖励链，可以[删除](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-delete-value-point/)。", "type": "boolean" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "type": "string" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "is_enabled": { "type": "boolean" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "商品的附加资源，例如屏幕截图、游戏视频等。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "媒体类型：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "资源文件。", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "定义排列顺序。", "example": 1, "type": "integer" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "booster_mega_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "type": { "description": "商品类型。", "type": "string" } }, "type": "object" }, "Value-points-item-model": { "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "type": "string" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "is_enabled": { "type": "boolean" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "商品的附加资源，例如屏幕截图、游戏视频等。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "媒体类型：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "资源文件。", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "定义排列顺序。", "example": 1, "type": "integer" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "booster_mega_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "type": { "description": "商品类型。", "type": "string" } }, "type": "object" }, "Virtual-Items-Currency_admin-groups-response": { "default": [], "description": "商品所属分组。", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "additionalProperties": { "type": "string" }, "default": { "en": "Horror" }, "description": "商品名称。应包含键/值对，\n其中键是\"^[a-z]{2}\"格式的区域设置，值是字符串。", "example": { "de": "Horror", "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_client-attributes": { "default": [], "description": "与商品对应的属性及其值的列表。可用于目录筛选。", "example": { "value": { "external_id": "genre", "name": "Жанр", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "属性名称。", "example": "Genre", "type": "object" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "属性值。", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "active_promotions_count": { "description": "进行中的促销活动的数量。", "type": "integer" }, "admin-attribute-external_id": { "description": "唯一属性ID。 `external_id`只能包含大小写英文字母和数字字符、破折号和下划线。", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "admin-calendar-hard-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/calendar-hard-daily-chain-base" }, { "description": "用于管理员响应的calendar_hard每日奖励。", "properties": { "date_end": { "$ref": "#/components/schemas/daily_chain_date_end" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/daily_chain_id" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "number_of_steps": { "$ref": "#/components/schemas/daily_chain_number_of_step" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/admin-daily-chain-step-model" }, "type": "array" } }, "type": "object" } ] }, "admin-calendar-hard-daily-chain-short-model": { "allOf": [ { "$ref": "#/components/schemas/calendar-hard-daily-chain-base" }, { "description": "`calendar_hard`每日奖励（简短版）。", "properties": { "date_end": { "$ref": "#/components/schemas/daily_chain_date_end" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/daily_chain_id" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "number_of_steps": { "$ref": "#/components/schemas/daily_chain_number_of_step" }, "order": { "$ref": "#/components/schemas/order" } }, "type": "object" } ] }, "admin-daily-chain-item-model": { "properties": { "description": { "$ref": "#/components/schemas/long-description-localization-object" }, "image_url": { "$ref": "#/components/schemas/image_url" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "$ref": "#/components/schemas/two-letter-locale" }, "quantity": { "description": "商品数量。", "example": 1, "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/sku" }, "type": { "$ref": "#/components/schemas/item_type" } }, "type": "object" }, "admin-daily-chain-long-model": { "discriminator": { "mapping": { "calendar_hard": "#/components/schemas/admin-calendar-hard-daily-chain-model", "rolling_skippable": "#/components/schemas/admin-rolling-skippable-daily-chain-model", "rolling_unskippable": "#/components/schemas/admin-rolling-unskippable-daily-chain-model" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/admin-calendar-hard-daily-chain-model" }, { "$ref": "#/components/schemas/admin-rolling-skippable-daily-chain-model" }, { "$ref": "#/components/schemas/admin-rolling-unskippable-daily-chain-model" } ] }, "admin-daily-chain-short-model": { "discriminator": { "mapping": { "calendar_hard": "#/components/schemas/admin-calendar-hard-daily-chain-short-model", "rolling_skippable": "#/components/schemas/admin-rolling-skippable-daily-chain-short-model", "rolling_unskippable": "#/components/schemas/admin-rolling-unskippable-daily-chain-short-model" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/admin-calendar-hard-daily-chain-short-model" }, { "$ref": "#/components/schemas/admin-rolling-skippable-daily-chain-short-model" }, { "$ref": "#/components/schemas/admin-rolling-unskippable-daily-chain-short-model" } ] }, "admin-daily-chain-step-model": { "description": "一个每日奖励步骤。", "properties": { "items": { "items": { "$ref": "#/components/schemas/admin-daily-chain-item-model" }, "type": "array" }, "step_id": { "$ref": "#/components/schemas/daily_chain_step_id" }, "step_number": { "$ref": "#/components/schemas/daily_chain_step_number" } }, "type": "object" }, "admin-get-reward-chain-item-basic-model": { "description": "一个奖励链。", "properties": { "attribute_conditions": { "$ref": "#/components/schemas/chain_user-attribute_conditions_model-get" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/image_url" }, "is_always_visible": { "$ref": "#/components/schemas/chain_is_always_visible" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "is_reset_after_end": { "$ref": "#/components/schemas/is_reset_after_end" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "periods": { "$ref": "#/components/schemas/periods" }, "recurrent_schedule": { "$ref": "#/components/schemas/admin_recurrent_schedule" }, "reward_chain_id": { "$ref": "#/components/schemas/reward_chain_id" }, "value_point": { "properties": { "amount": { "$ref": "#/components/schemas/value-point-amount" }, "description": { "$ref": "#/components/schemas/value-point-description" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "long_description": { "$ref": "#/components/schemas/value-point-long-description" }, "media_list": { "$ref": "#/components/schemas/media_list" }, "name": { "$ref": "#/components/schemas/value-point-name" }, "order": { "$ref": "#/components/schemas/order" }, "sku": { "$ref": "#/components/schemas/value-point-sku" }, "type": { "example": "value_point", "type": "string" } }, "type": "object" } }, "type": "object" }, "admin-get-reward-chain-item-clan-basic-model": { "allOf": [ { "$ref": "#/components/schemas/admin-get-reward-chain-item-basic-model" }, { "description": "公会奖励链。", "properties": { "clan_type": { "$ref": "#/components/schemas/clan_type" }, "popup_header": { "$ref": "#/components/schemas/popup_header-two-letter-locale" }, "popup_image_url": { "$ref": "#/components/schemas/popup_image_url" }, "popup_instruction": { "$ref": "#/components/schemas/popup_instruction-two-letter-locale" }, "value_point": { "description": "为公会奖励链配置的奖励积分。", "properties": { "amount": { "$ref": "#/components/schemas/value-point-amount" }, "description": { "$ref": "#/components/schemas/value-point-description" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "long_description": { "$ref": "#/components/schemas/value-point-long-description" }, "media_list": { "$ref": "#/components/schemas/media_list" }, "name": { "$ref": "#/components/schemas/value-point-name" }, "order": { "$ref": "#/components/schemas/order" }, "sku": { "$ref": "#/components/schemas/value-point-sku" }, "type": { "example": "value_point", "type": "string" } }, "required": [ "sku" ], "type": "object" } }, "type": "object" } ] }, "admin-get-reward-chain-item-clan-full-model": { "allOf": [ { "$ref": "#/components/schemas/admin-get-reward-chain-item-full-model" }, { "description": "公会奖励链。", "properties": { "clan_type": { "$ref": "#/components/schemas/clan_type" }, "popup_header": { "$ref": "#/components/schemas/popup_header-two-letter-locale" }, "popup_image_url": { "$ref": "#/components/schemas/popup_image_url" }, "popup_instruction": { "$ref": "#/components/schemas/popup_instruction-two-letter-locale" }, "top_contributors": { "$ref": "#/components/schemas/top_contributors" }, "value_point": { "description": "为公会奖励链配置的奖励积分。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "sku": { "$ref": "#/components/schemas/sku" }, "type": { "type": "string" } }, "required": [ "sku" ], "type": "object" } }, "type": "object" } ] }, "admin-get-reward-chain-item-full-model": { "description": "一个奖励链。", "properties": { "attribute_conditions": { "$ref": "#/components/schemas/chain_user-attribute_conditions_model-get" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/image_url" }, "is_always_visible": { "$ref": "#/components/schemas/chain_is_always_visible" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "is_reset_after_end": { "$ref": "#/components/schemas/is_reset_after_end" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "periods": { "$ref": "#/components/schemas/periods" }, "recurrent_schedule": { "$ref": "#/components/schemas/admin_recurrent_schedule" }, "reward_chain_id": { "$ref": "#/components/schemas/reward_chain_id" }, "steps": { "items": { "$ref": "#/components/schemas/reward_step_short" }, "type": "array" }, "value_point": { "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "sku": { "$ref": "#/components/schemas/sku" }, "type": { "type": "string" } }, "type": "object" } }, "type": "object" }, "admin-item-value-point-reward": { "properties": { "amount": { "description": "奖励积分的数量。", "type": "integer" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "sku": { "$ref": "#/components/schemas/sku" } }, "type": "object" }, "admin-offer-chain-item-model": { "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/image_url" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "quantity": { "description": "商品数量。", "example": 1, "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/sku" }, "type": { "$ref": "#/components/schemas/item_type" } }, "type": "object" }, "admin-offer-chain-long-model": { "description": "一个优惠链。", "properties": { "attribute_conditions": { "$ref": "#/components/schemas/chain_user-attribute_conditions_model-get" }, "date_end": { "$ref": "#/components/schemas/offer_chain_date_end" }, "date_start": { "$ref": "#/components/schemas/offer_chain_date_start" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/offer_chain_id" }, "is_always_visible": { "$ref": "#/components/schemas/chain_is_always_visible" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "recurrent_schedule": { "$ref": "#/components/schemas/offer_chain_recurrent_schedule" }, "steps": { "items": { "$ref": "#/components/schemas/admin-offer-chain-step-model" }, "type": "array" } }, "type": "object" }, "admin-offer-chain-short-model": { "description": "一个优惠链。", "properties": { "attribute_conditions": { "$ref": "#/components/schemas/chain_user-attribute_conditions_model-get" }, "date_end": { "$ref": "#/components/schemas/offer_chain_date_end" }, "date_start": { "$ref": "#/components/schemas/offer_chain_date_start" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/offer_chain_id" }, "is_always_visible": { "$ref": "#/components/schemas/chain_is_always_visible" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "recurrent_schedule": { "$ref": "#/components/schemas/offer_chain_recurrent_schedule" } }, "type": "object" }, "admin-offer-chain-step-model": { "description": "优惠链步骤。", "properties": { "is_free": { "$ref": "#/components/schemas/offer_chain_is_free" }, "items": { "items": { "$ref": "#/components/schemas/admin-offer-chain-item-model" }, "type": "array" }, "step_id": { "$ref": "#/components/schemas/offer_chain_step_id" }, "step_number": { "$ref": "#/components/schemas/offer_chain_step_number" }, "step_price": { "$ref": "#/components/schemas/offer_chain_step_price" } }, "type": "object" }, "admin-promotions_200-get-coupon-promotion-model": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get" }, "bonus": { "$ref": "#/components/schemas/Promotions_coupon_bonus" }, "external_id": { "$ref": "#/components/schemas/Promotions_coupon-external_id" }, "is_enabled": { "$ref": "#/components/schemas/Promotions_coupon-is_enabled" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit" }, "redeem_user_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit" }, "total_limit_state": { "$ref": "#/components/schemas/Promotions_coupon_total_limit_state" } }, "type": "object" }, "admin-promotions_200-get-redeemable-coupon-promotion-model": { "properties": { "bonus": { "$ref": "#/components/schemas/Promotions_coupon_bonus" }, "discount": { "description": "仅适用于促销码。", "example": { "discount": { "percent": "10.99" } }, "properties": { "percent": { "default": "10.00", "description": "百分比折扣。\n购物车价格将按照此百分比打折，然后四舍五入到小数点后两位。", "example": "10.00", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "discounted_items": { "description": "通过促销码打折的商品列表。仅适用于促销码。", "items": { "description": "购物车中特定商品的折扣。", "minItems": 1, "properties": { "discount": { "nullable": false, "properties": { "percent": { "$ref": "#/components/schemas/Promotions_cart_item_discount" } }, "required": [ "percent" ], "type": "object" }, "sku": { "default": "elven_shield", "description": "商品SKU。", "type": "string" } }, "required": [ "sku", "discount" ], "type": "object" }, "type": [ "array", "null" ] }, "external_id": { "$ref": "#/components/schemas/Promotions_coupon-external_id" }, "is_enabled": { "$ref": "#/components/schemas/Promotions_coupon-is_enabled" }, "name": { "$ref": "#/components/schemas/Promotions_coupon_name" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" }, "redeem_code_limit": { "$ref": "#/components/schemas/Promotions_redeem_code_limit" }, "redeem_total_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit" }, "redeem_user_limit": { "$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit" }, "total_limit_state": { "$ref": "#/components/schemas/Promotions_coupon_total_limit_state" } }, "type": "object" }, "admin-rolling-skippable-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/rolling-skippable-daily-chain-base" }, { "description": "用于管理员响应的rolling_skippable每日奖励。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/daily_chain_id" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "number_of_steps": { "$ref": "#/components/schemas/daily_chain_number_of_step" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/admin-daily-chain-step-model" }, "type": "array" } }, "type": "object" } ] }, "admin-rolling-skippable-daily-chain-short-model": { "allOf": [ { "$ref": "#/components/schemas/rolling-skippable-daily-chain-base" }, { "description": "`rolling_skippable`每日奖励（简短版）。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/daily_chain_id" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "number_of_steps": { "$ref": "#/components/schemas/daily_chain_number_of_step" }, "order": { "$ref": "#/components/schemas/order" } }, "type": "object" } ] }, "admin-rolling-unskippable-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/rolling-unskippable-daily-chain-base" }, { "description": "用于管理员响应的`rolling_unskippable`每日奖励。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/daily_chain_id" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "number_of_steps": { "$ref": "#/components/schemas/daily_chain_number_of_step" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/admin-daily-chain-step-model" }, "type": "array" } }, "type": "object" } ] }, "admin-rolling-unskippable-daily-chain-short-model": { "allOf": [ { "$ref": "#/components/schemas/rolling-unskippable-daily-chain-base" }, { "description": "`rolling_unskippable`每日奖励（简短版）。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/daily_chain_id" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "number_of_steps": { "$ref": "#/components/schemas/daily_chain_number_of_step" }, "order": { "$ref": "#/components/schemas/order" } }, "type": "object" } ] }, "admin_recurrent_schedule": { "description": "奖励链的重置周期。", "oneOf": [ { "description": "每周重置奖励链。", "properties": { "day_of_week": { "$ref": "#/components/schemas/day_of_week" }, "displayable_reset_next_date": { "$ref": "#/components/schemas/displayable_reset_next_date" }, "displayable_reset_start_date": { "$ref": "#/components/schemas/displayable_reset_start_date" }, "interval_type": { "$ref": "#/components/schemas/interval_type_weekly" }, "reset_next_date": { "$ref": "#/components/schemas/reset_next_date" }, "time": { "$ref": "#/components/schemas/time" } }, "title": "interval_type = weekly", "type": "object" }, { "description": "每月重置奖励链。", "properties": { "day_of_month": { "$ref": "#/components/schemas/day_of_month" }, "displayable_reset_next_date": { "$ref": "#/components/schemas/displayable_reset_next_date" }, "displayable_reset_start_date": { "$ref": "#/components/schemas/displayable_reset_start_date" }, "interval_type": { "$ref": "#/components/schemas/interval_type_monthly" }, "reset_next_date": { "$ref": "#/components/schemas/reset_next_date" }, "time": { "$ref": "#/components/schemas/time" } }, "title": "interval_type = monthly", "type": "object" }, { "description": "按指定小时间隔执行奖励链重置。", "properties": { "displayable_reset_next_date": { "$ref": "#/components/schemas/displayable_reset_next_date" }, "displayable_reset_start_date": { "$ref": "#/components/schemas/displayable_reset_start_date" }, "hours_interval": { "$ref": "#/components/schemas/reward_chain_hours_interval" }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly_rc" }, "reset_next_date": { "$ref": "#/components/schemas/reset_next_date" }, "time": { "$ref": "#/components/schemas/time" } }, "title": "interval_type = hourly", "type": "object" } ], "type": [ "object", "null" ] }, "admin_value_points-create": { "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "sku": { "$ref": "#/components/schemas/sku" } }, "required": [ "sku", "name" ], "type": "object" }, "bundle_type": { "description": "捆绑类型。商品类型是捆绑包时返回。", "enum": [ "standard", "virtual_currency_package", "partner_side_content" ], "type": "string" }, "calendar-hard-daily-chain-base": { "description": "`calendar_hard`每日奖励的基础属性。", "properties": { "date_start": { "$ref": "#/components/schemas/calendar_hard_date_start" }, "is_recurrent": { "$ref": "#/components/schemas/calendar_hard_is_recurrent" }, "type": { "allOf": [ { "$ref": "#/components/schemas/daily_chain_type" }, { "enum": [ "calendar_hard" ] } ] } }, "type": "object" }, "calendar_hard_date_start": { "description": "每日奖励开始日期。", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "type": "string" }, "calendar_hard_is_recurrent": { "default": false, "description": "每日奖励是否循环。如果为`true`，每日奖励将在结束日期后自动重置。下个周期的`start_date`和`end_date`基于每日奖励步骤总数和首次`start_date`的时间设定自动计算。", "example": true, "type": "boolean" }, "catalog_recurrent_schedule_client_response": { "description": "用户的商品限制循环刷新周期。", "oneOf": [ { "description": "每天类型的用户限制次数刷新。", "properties": { "interval_type": { "description": "循环刷新周期类型。", "enum": [ "daily" ], "type": "string" }, "reset_next_date": { "description": "重置限制次数的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = daily", "type": "object" }, { "description": "每周类型的用户限制次数刷新。", "properties": { "interval_type": { "description": "循环刷新周期类型。", "enum": [ "weekly" ], "type": "string" }, "reset_next_date": { "description": "重置限制次数的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = weekly", "type": "object" }, { "description": "每月类型的用户限制次数刷新。", "properties": { "interval_type": { "description": "循环刷新周期类型。", "enum": [ "monthly" ], "type": "string" }, "reset_next_date": { "description": "重置限制次数的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = monthly", "type": "object" }, { "description": "按指定小时间隔执行用户限制数重置。", "properties": { "interval_type": { "description": "循环刷新周期类型。", "enum": [ "hourly" ], "type": "string" }, "reset_next_date": { "description": "重置限制次数的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = hourly", "type": "object" } ], "type": [ "object", "null" ] }, "chain_is_always_visible": { "default": true, "description": "Whether the chain is visible to all users. If `true`, the chain is always displayed, regardless of the user's authentication status or attributes.\n\nTo configure personalization, you need to pass `false`. The logic of the chain display will be the following:\n * If `false` is passed and the visibility conditions are specified in the `attribute_conditions` array, the chain is considered personalized and is displayed only to authorized users who meet the specified conditions.\n * If `false` is passed and the `attribute_conditions` array isn’t passed or is empty, the chain is displayed to unauthorized users, as well as in cases when no matching chain is found for the authorized user.", "example": true, "type": "boolean" }, "chain_user-attribute_conditions_model-get": { "allOf": [ { "$ref": "#/components/schemas/user-attribute_conditions_model-get" }, { "description": "用户属性验证条件。\n根据用户属性是否满足所有指定条件来确定优惠链可用性。" } ] }, "chain_user-attribute_conditions_model-post": { "allOf": [ { "$ref": "#/components/schemas/user-attribute_conditions_model-post" }, { "description": "用户属性验证条件。\n根据用户属性是否满足所有指定条件来确定优惠链可用性。" } ] }, "clan_type": { "description": "公会类型。", "enum": [ "clan", "guild", "faction", "community", "team", "squad", "alliance", "association", "coalition", "union", "group", "civilizations", "dynasty", "order", "league", "brotherhood", "kingdom", "organization", "house", "empire", "tribe", "cartel", null ], "type": [ "string", "null" ] }, "client-attributes": { "default": [], "description": "与商品对应的属性及其值的列表。可用于目录筛选。", "example": { "value": { "external_id": "genre", "name": "Жанр", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "description": "属性名称。", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "属性值。", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "client-calendar-hard-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/calendar-hard-daily-chain-base" }, { "description": "用于客户端响应的calendar_hard每日奖励。", "properties": { "date_end": { "$ref": "#/components/schemas/daily_chain_date_end" }, "description": { "description": "每日奖励描述。", "example": "Major weekly quest", "type": [ "string", "null" ] }, "id": { "description": "每日奖励ID。", "example": 9, "type": "integer" }, "name": { "description": "每日奖励名称。", "example": "Weekly quest", "type": "string" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/client-daily-chain-step-model" }, "type": "array" } }, "type": "object" } ] }, "client-daily-chain-item-model": { "properties": { "bundle_type": { "enum": [ "standard", "virtual_currency_package" ], "type": [ "string", "null" ] }, "content": { "items": { "$ref": "#/components/schemas/client-daily-chain-item-model" }, "type": [ "array", "null" ] }, "description": { "description": "商品描述。", "type": [ "string", "null" ] }, "image_url": { "$ref": "#/components/schemas/image_url" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "description": "商品名称。", "type": "string" }, "quantity": { "description": "商品数量。", "example": 1, "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/sku" }, "type": { "$ref": "#/components/schemas/item_type" } }, "type": "object" }, "client-daily-chain-model": { "discriminator": { "mapping": { "calendar_hard": "#/components/schemas/client-calendar-hard-daily-chain-model", "rolling_skippable": "#/components/schemas/client-rolling-skippable-daily-chain-model", "rolling_unskippable": "#/components/schemas/client-rolling-unskippable-daily-chain-model" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/client-calendar-hard-daily-chain-model" }, { "$ref": "#/components/schemas/client-rolling-skippable-daily-chain-model" }, { "$ref": "#/components/schemas/client-rolling-unskippable-daily-chain-model" } ] }, "client-daily-chain-step-model": { "description": "每日奖励步骤。", "properties": { "items": { "items": { "$ref": "#/components/schemas/client-daily-chain-item-model" }, "type": "array" }, "status": { "description": "Defines the step's current claim status.\n\nPossible values:\n- `claimed` — The step has already been claimed.\n- `claimable` — The step may be claimed.\n- `blocked` — The step cannot be claimed: \n - For unauthorized users: All steps are blocked. \n - For `calendar_hard`: The step was not claimed and is now in the past. \n - For `rolling_skippable`: The step is locked until the previous step is claimed.\n- `claim_in_future` — The step was not claimed and the step is in the future.", "enum": [ "claimed", "claimable", "blocked", "claim_in_future" ], "example": "claimed", "type": "string" }, "step_number": { "$ref": "#/components/schemas/daily_chain_step_number" }, "unlocked_date": { "description": "步骤解锁时间的Unix时间戳（秒）。", "format": "int64", "type": "integer" } }, "type": "object" }, "client-item-value-point-reward": { "description": "奖励积分商品奖励。", "items": { "properties": { "amount": { "$ref": "#/components/schemas/value-point-amount" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "$ref": "#/components/schemas/value-point-name" }, "sku": { "$ref": "#/components/schemas/value-point-sku" } }, "type": "object" }, "type": "array" }, "client-offer-chain-item-model": { "properties": { "bundle_type": { "enum": [ "standard", "virtual_currency_package" ], "type": [ "string", "null" ] }, "content": { "items": { "$ref": "#/components/schemas/client-offer-chain-item-model" }, "type": [ "array", "null" ] }, "description": { "description": "商品描述。", "type": [ "string", "null" ] }, "image_url": { "$ref": "#/components/schemas/image_url" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "description": "商品名称。", "type": "string" }, "order": { "$ref": "#/components/schemas/order" }, "quantity": { "description": "商品数量。", "example": 1, "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/sku" }, "type": { "$ref": "#/components/schemas/item_type" } }, "type": "object" }, "client-offer-chain-model": { "description": "一个优惠链。", "properties": { "date_end": { "$ref": "#/components/schemas/offer_chain_date_end" }, "date_start": { "$ref": "#/components/schemas/offer_chain_date_start" }, "description": { "description": "优惠链描述。", "example": "Major weekly quest", "type": [ "string", "null" ] }, "id": { "description": "优惠链ID。", "example": 9, "type": "integer" }, "name": { "description": "优惠链名称。", "example": "Weekly quest", "type": "string" }, "next_step_number": { "description": "下一步优惠链步骤编号，若优惠链已完成则为`null`。", "example": 1, "type": [ "integer", "null" ] }, "order": { "$ref": "#/components/schemas/order" }, "recurrent_schedule": { "$ref": "#/components/schemas/offer_chain_recurrent_schedule_client_side" }, "steps": { "items": { "$ref": "#/components/schemas/client-offer-chain-step-model" }, "type": "array" } }, "type": "object" }, "client-offer-chain-step-model": { "description": "优惠链步骤。", "properties": { "is_claimed": { "description": "是否已领取或购买了该步骤奖励。", "example": false, "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/offer_chain_is_free" }, "items": { "items": { "$ref": "#/components/schemas/client-offer-chain-item-model" }, "type": "array" }, "step_loyalty_rewards": { "items": { "properties": { "amount": { "description": "忠诚积分数量。", "example": 1, "type": "integer" }, "description": { "description": "忠诚积分描述。", "example": "First Loyalty Point Desc", "type": "string" }, "image_url": { "$ref": "#/components/schemas/image_url" }, "name": { "description": "忠诚积分名称。", "example": "First Loyalty Point", "type": "string" }, "sku": { "description": "忠诚积分SKU。", "example": "0c745ef0-4243-46e1-aa90-54dee07da622", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "step_number": { "$ref": "#/components/schemas/offer_chain_step_number" }, "step_price": { "$ref": "#/components/schemas/offer_chain_step_price" }, "step_vp_rewards": { "description": "来自奖励系统的奖励积分数组，作为奖励发放。", "items": { "properties": { "amount": { "$ref": "#/components/schemas/value-point-amount" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "$ref": "#/components/schemas/value-point-name" }, "sku": { "$ref": "#/components/schemas/value-point-sku" } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": "object" }, "client-reward-chain-item-model": { "properties": { "clan_type": { "$ref": "#/components/schemas/clan_type" }, "date_end": { "$ref": "#/components/schemas/date_end" }, "date_start": { "$ref": "#/components/schemas/date_start" }, "description": { "description": "奖励链描述。", "example": "Major weekly quest", "type": [ "string", "null" ] }, "image_url": { "$ref": "#/components/schemas/image_url" }, "long_description": { "description": "奖励链详细描述。", "example": "You can get a lot of additional items just by shopping during the week", "type": [ "string", "null" ] }, "name": { "description": "奖励链名称。", "example": "Weekly quest", "type": "string" }, "order": { "$ref": "#/components/schemas/order" }, "popup_header": { "$ref": "#/components/schemas/popup_header-two-letter-locale" }, "popup_image_url": { "$ref": "#/components/schemas/popup_image_url" }, "popup_instruction": { "$ref": "#/components/schemas/popup_instruction-two-letter-locale" }, "recurrent_schedule": { "$ref": "#/components/schemas/recurrent_schedule_client_side" }, "reward_chain_id": { "description": "奖励链ID。", "example": 9, "type": "integer" }, "steps": { "items": { "description": "奖励链步骤。", "properties": { "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_claimed": { "description": "该步骤奖励是否已领取。", "example": false, "type": "boolean" }, "name": { "description": "步骤名称。", "example": "Level 1", "type": "string" }, "price": { "properties": { "amount": { "description": "用户在该步骤中领取的奖励积分数。", "example": 100, "type": "integer" } }, "type": "object" }, "reward": { "items": { "properties": { "description": { "description": "商品描述。", "example": "Super box with items", "type": "string" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "name": { "description": "商品名称。", "example": "Super box", "type": "string" }, "quantity": { "description": "商品数量。", "example": 2, "type": "integer" }, "sku": { "$ref": "#/components/schemas/sku" }, "type": { "description": "商品类型。", "example": "bundle", "type": "string" } }, "type": "object" }, "type": "array" }, "step_id": { "description": "步骤ID。", "example": 10, "type": "integer" } }, "type": "object" }, "type": "array" }, "top_contributors": { "items": { "$ref": "#/components/schemas/top_contributors" }, "type": "array" }, "value_point": { "properties": { "amount": { "$ref": "#/components/schemas/value-point-amount" }, "description": { "$ref": "#/components/schemas/value-point-description" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "long_description": { "$ref": "#/components/schemas/value-point-long-description" }, "name": { "$ref": "#/components/schemas/value-point-name" }, "sku": { "$ref": "#/components/schemas/value-point-sku" } }, "type": "object" } }, "type": "object" }, "client-rolling-skippable-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/rolling-skippable-daily-chain-base" }, { "description": "用于客户端响应的rolling_skippable每日奖励。", "properties": { "description": { "description": "每日奖励描述。", "example": "Major weekly quest", "type": [ "string", "null" ] }, "id": { "description": "每日奖励ID。", "example": 9, "type": "integer" }, "name": { "description": "每日奖励名称。", "example": "Weekly quest", "type": "string" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/client-daily-chain-step-model" }, "type": "array" } }, "type": "object" } ] }, "client-rolling-unskippable-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/rolling-unskippable-daily-chain-base" }, { "description": "用于客户端响应的`rolling_unskippable`每日奖励。", "properties": { "description": { "description": "每日奖励描述。", "example": "Major weekly quest", "type": [ "string", "null" ] }, "id": { "description": "每日奖励ID。", "example": 9, "type": "integer" }, "name": { "description": "每日奖励名称。", "example": "Weekly quest", "type": "string" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/client-daily-chain-step-model" }, "type": "array" } }, "type": "object" } ] }, "create-calendar-hard-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/calendar-hard-daily-chain-base" }, { "description": "用于`calendar_hard`类型的每日奖励。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/create-daily-chain-step-model" }, "type": "array" } }, "required": [ "name", "date_start", "steps", "is_enabled", "type" ], "type": "object" } ] }, "create-clan-reward-chain-model": { "allOf": [ { "$ref": "#/components/schemas/create-reward-chain-model" }, { "description": "公会奖励链。", "properties": { "clan_type": { "$ref": "#/components/schemas/clan_type" }, "popup_header": { "$ref": "#/components/schemas/popup_header-two-letter-locale" }, "popup_image_url": { "$ref": "#/components/schemas/popup_image_url" }, "popup_instruction": { "$ref": "#/components/schemas/popup_instruction-two-letter-locale" }, "value_point": { "description": "为公会奖励链配置的奖励积分。", "properties": { "sku": { "$ref": "#/components/schemas/sku" } }, "required": [ "sku" ], "type": "object" } }, "required": [ "name", "value_point", "periods", "steps", "is_enabled", "popup_header", "popup_instruction" ], "type": "object" } ] }, "create-daily-chain-step-model": { "properties": { "items": { "items": { "$ref": "#/components/schemas/modify-daily-chain-item-model" }, "minItems": 1, "type": "array" }, "step_number": { "$ref": "#/components/schemas/daily_chain_step_number" } }, "required": [ "step_number", "items" ], "type": "object" }, "create-offer-chain-model": { "description": "一个优惠链。", "properties": { "attribute_conditions": { "$ref": "#/components/schemas/chain_user-attribute_conditions_model-post" }, "date_end": { "$ref": "#/components/schemas/offer_chain_date_end" }, "date_start": { "$ref": "#/components/schemas/offer_chain_date_start" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "is_always_visible": { "$ref": "#/components/schemas/chain_is_always_visible" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "recurrent_schedule": { "$ref": "#/components/schemas/offer_chain_recurrent_schedule_create_update" }, "steps": { "items": { "$ref": "#/components/schemas/create-offer-chain-step-model" }, "type": "array" } }, "required": [ "name", "date_start", "steps", "is_enabled" ], "type": "object" }, "create-offer-chain-step-model": { "properties": { "is_free": { "$ref": "#/components/schemas/offer_chain_is_free" }, "items": { "items": { "$ref": "#/components/schemas/modify-offer-chain-item-model" }, "minItems": 1, "type": "array" }, "step_number": { "$ref": "#/components/schemas/offer_chain_step_number" } }, "required": [ "step_number", "is_free", "items" ], "type": "object" }, "create-reward-chain-model": { "description": "一个奖励链。", "properties": { "attribute_conditions": { "$ref": "#/components/schemas/chain_user-attribute_conditions_model-post" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/image_url" }, "is_always_visible": { "$ref": "#/components/schemas/chain_is_always_visible" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "is_reset_after_end": { "$ref": "#/components/schemas/is_reset_after_end" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "periods": { "$ref": "#/components/schemas/periods" }, "recurrent_schedule": { "$ref": "#/components/schemas/recurrent_schedule_create_update" }, "steps": { "items": { "$ref": "#/components/schemas/create_reward_step" }, "type": "array" }, "value_point": { "properties": { "sku": { "$ref": "#/components/schemas/sku" } }, "required": [ "sku" ], "type": "object" } }, "required": [ "name", "value_point", "periods", "steps", "is_enabled" ], "type": "object" }, "create-rolling-skippable-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/rolling-skippable-daily-chain-base" }, { "description": "用于`rolling_skippable`类型的每日奖励。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/create-daily-chain-step-model" }, "type": "array" } }, "required": [ "name", "date_start", "steps", "is_enabled", "type" ], "type": "object" } ] }, "create-rolling-unskippable-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/rolling-unskippable-daily-chain-base" }, { "description": "用于`rolling_unskippable`类型的每日奖励。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/create-daily-chain-step-model" }, "type": "array" } }, "required": [ "name", "date_start", "steps", "is_enabled", "type" ], "type": "object" } ] }, "create_reward_step": { "description": "奖励链步骤。", "properties": { "image_url": { "$ref": "#/components/schemas/image_url" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "price": { "$ref": "#/components/schemas/reward_step_price" }, "reward": { "items": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/reward-chain-step-reward_user-attribute_conditions_model-post" }, "quantity": { "$ref": "#/components/schemas/reward_item_quantity" }, "sku": { "$ref": "#/components/schemas/sku" } }, "required": [ "sku", "quantity" ], "type": "object" }, "type": "array" } }, "required": [ "name", "price", "reward" ], "type": "object" }, "daily-chain-error-model": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "type": [ "object", "null" ] }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "daily_chain_date_end": { "description": "每日奖励结束日期。可以为`null`。类型设置为`calendar_hard`时将根据添加的步骤数量自动设置此日期，因此可以将其保留为`null`。", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "type": [ "string", "null" ] }, "daily_chain_id": { "description": "唯一每日奖励ID。", "example": 9, "type": "integer" }, "daily_chain_number_of_step": { "description": "每日奖励中配置的步骤数量。这里的每个步骤代表每日奖励中的一天。", "example": 3, "type": "integer" }, "daily_chain_step_id": { "description": "每日奖励步骤唯一标识符", "example": 10, "minimum": 1, "type": [ "integer", "null" ] }, "daily_chain_step_number": { "description": "步骤编号。", "example": 2, "minimum": 1, "nullable": false, "type": "integer" }, "daily_chain_type": { "description": "Daily reward type that determines when users can claim rewards.\n\nPossible values:\n- `calendar_hard` — Unlocks the next step reward every 24 hours. Any unclaimed step rewards are permanently lost once\nthe next step reward becomes available.\n- `rolling_skippable` — Unlocks the next step reward every 24 hours based on `date_start`. Progression is sequential:\na new reward will not unlock until the previous one has been claimed. If a user skips one or more days, they continue\nfrom where they left off; missed days do not grant multiple rewards.\n- `rolling_unskippable` — Unlocks the next step reward every 24 hours based on `date_start`. Progression is\nsequential: a new reward will not unlock until the previous one has been claimed. However, if a user skips a day,\ntheir progress is reset, and they must start again from the first step.", "enum": [ "calendar_hard", "rolling_skippable", "rolling_unskippable" ], "type": "string" }, "daily_chain_update_step_id": { "description": "每日奖励步骤唯一标识符。更新时指定以保留用户进度。", "example": 10, "minimum": 1, "type": [ "integer", "null" ] }, "daily_rolling_chain_date_start": { "description": "每日奖励的开始日期和时间。此时间点同时定义用户可领取奖励的每日重置时间。", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "type": "string" }, "date_end": { "description": "奖励链促销活动的结束日期。可以是`null`。如果`date_end`为`null`，则奖励链无时间限制。", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "type": [ "string", "null" ] }, "date_start": { "description": "奖励链的开始日期。", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "type": "string" }, "day_of_month": { "description": "在一个月中的哪一天重置奖励链。如果该月的天数小于指定日期，则奖励链重置发生在该月的最后一天。", "maximum": 31, "minimum": 1, "type": "integer" }, "day_of_week": { "description": "在一周中的哪一天重置奖励链，其中“1”是星期一，“7”是星期日。", "maximum": 7, "minimum": 1, "type": "integer" }, "description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "包含本地化商品描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的区域设置代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。", "type": [ "object", "null" ] }, "displayable_reset_next_date": { "description": "计算的下次奖励链重置的日期和时间(ISO 8601)。

例如，从2024年3月1日吉隆坡时间01:00开始，奖励链每月重置一次。下一次奖励链重置的日期和时间：吉隆坡时间2024年4月1日01:00，即ISO 8601格式下的`2024-04-01T01:00:00+08:00`。

示例：`2024-04-01T01:00:00+08:00`", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "奖励链首次重置的日期和时间。

例如，奖励链第一次重置的日期和时间是2024年3月1日，吉隆坡时间01:00，或者ISO 8601格式下的`2024-03-01T01:00:00+08:00`。

示例：`2024-03-01T01:00:00+08:00`", "format": "date-time", "type": "string" }, "drm_name": { "description": "游戏密钥DRM名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "DRM唯一ID。", "example": "steam", "type": "string" }, "excluded_promotions": { "description": "应用此促销活动时要排除的促销活动ID列表。
Example：`[12, 789]`", "example": [ 12, 789 ], "items": { "type": "integer" }, "type": "array" }, "five-letter-locale": { "description": "五个字符的区域设置代码。", "properties": { "ar-AE": { "description": "阿拉伯语", "type": [ "string", "null" ] }, "bg-BG": { "description": "保加利亚语", "type": [ "string", "null" ] }, "cs-CZ": { "description": "捷克语", "type": [ "string", "null" ] }, "de-DE": { "description": "德语", "type": [ "string", "null" ] }, "en-US": { "description": "英语", "type": [ "string", "null" ] }, "es-ES": { "description": "西班牙语（西班牙）", "type": [ "string", "null" ] }, "fr-FR": { "description": "法语", "type": [ "string", "null" ] }, "he-IL": { "description": "希伯来语", "type": [ "string", "null" ] }, "id-ID": { "description": "印度尼西亚语", "type": [ "string", "null" ] }, "it-IT": { "description": "意大利语", "type": [ "string", "null" ] }, "ja-JP": { "description": "日语", "type": [ "string", "null" ] }, "km-KH": { "description": "高棉语", "type": [ "string", "null" ] }, "ko-KR": { "description": "韩语", "type": [ "string", "null" ] }, "lo-LA": { "description": "老挝语", "type": [ "string", "null" ] }, "my-MM": { "description": "缅甸语", "type": [ "string", "null" ] }, "ne-NP": { "description": "尼泊尔语", "type": [ "string", "null" ] }, "ph-PH": { "description": "菲律宾语", "type": [ "string", "null" ] }, "pl-PL": { "description": "波兰语", "type": [ "string", "null" ] }, "pt-BR": { "description": "葡萄牙语（巴西）", "type": [ "string", "null" ] }, "ro-RO": { "description": "罗马尼亚语", "type": [ "string", "null" ] }, "ru-RU": { "description": "俄语", "type": [ "string", "null" ] }, "th-TH": { "description": "泰语", "type": [ "string", "null" ] }, "tr-TR": { "description": "土耳其语", "type": [ "string", "null" ] }, "vi-VN": { "description": "越南语", "type": [ "string", "null" ] }, "zh-CN": { "description": "中文（简体）", "type": [ "string", "null" ] }, "zh-TW": { "description": "中文（繁体）", "type": [ "string", "null" ] } }, "title": "five-letter", "type": [ "object", "null" ] }, "image_url": { "description": "图像URL。", "example": "https://image.example.com", "type": [ "string", "null" ] }, "inactive_promotions_count": { "description": "已停用的促销活动的数量。", "type": "integer" }, "interval_type_hourly_rc": { "description": "奖励链定期重置的频率。", "enum": [ "hourly" ], "type": "string" }, "interval_type_monthly": { "description": "奖励链定期重置的频率。", "enum": [ "monthly" ], "type": "string" }, "interval_type_weekly": { "description": "奖励链定期重置的频率。", "enum": [ "weekly" ], "type": "string" }, "is_clan": { "description": "该奖励积分是否用于公会奖励链。", "example": true, "type": "boolean" }, "is_enabled": { "example": true, "type": "boolean" }, "is_reset_after_end": { "default": false, "description": "是否在结束日期后重置奖励链（所有用户的奖励积分和进度）：\n* 如为`true`，奖励链将在结束日期后重置。\n* 如为`false`，奖励链在结束日期后不重置。\n\n
\n
注意

\n以下情况不能设置为true：
\n
    \n
  • recurrent_schedule中已设置重置周期。
    • \n
  • periods.date_until中传入了null值。
    • \n
\n
", "example": false, "type": "boolean" }, "item-custom-attributes-response": { "description": "包含商品属性和值的JSON对象。", "format": "json", "type": "object" }, "item-periods": { "description": "商品促销时间段。", "items": { "properties": { "date_from": { "description": "指定商品促销开始的日期。", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": "string" }, "date_until": { "description": "指定商品停止促销的日期。可以为`null`。", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "item-periods-response": { "description": "商品促销时间段。", "items": { "properties": { "date_from": { "description": "指定商品促销开始的日期。", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] }, "date_until": { "description": "指定商品停止促销的日期。可以为`null`。", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "item-value-point-reward-set": { "items": { "properties": { "amount": { "description": "奖励积分的数量。", "type": "integer" }, "sku": { "$ref": "#/components/schemas/sku" } }, "required": [ "sku", "amount" ], "type": "object" }, "type": "array" }, "item-value-point-reward-set-for-patch": { "items": { "maxItems": 100, "properties": { "amount": { "description": "奖励积分的数量。", "minimum": 0, "type": "integer" }, "sku": { "$ref": "#/components/schemas/sku" } }, "required": [ "sku", "amount" ], "type": "object" }, "type": "array" }, "item_id": { "description": "内部唯一物品ID。", "example": 1, "type": "integer" }, "item_price_conditions_promocode": { "description": "包含条件的对象数组，用于设置对购物车中某些商品应用促销活动的价格范围。
\n将用户购物车中每个商品的价格与条件中指定的价格范围进行比较。将只对购物车中价格满足条件的商品应用[奖励](/zh/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request)和[折扣](/zh/api/shop-builder/operation/create-promo-code/#!path=discount&t=request)
\n如果传递此数组，请将[discounted_items](/zh/api/shop-builder/operation/create-promo-code/#!path=discounted_items&t=request)数组的值设置为`null`。", "items": { "$ref": "#/components/schemas/price_conditions_items" }, "type": [ "array", "null" ] }, "item_type": { "description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`unit`。", "type": "string" }, "limit_exceeded_visibility": { "default": "show", "description": "Determines the visibility of the item in the catalog after the purchase limit is reached, until the next limit reset.\n\nApplies to items for which recurring limit resets are configured in the `recurrent_schedule` array.\n\nIf limit resets are not configured, the item doesn't appear in the catalog after the purchase limit is reached,\nregardless of the `limit_exceeded_visibility` value.\n\nPossible values:\n- `show` — The item is returned in catalog retrieval API calls after the purchase limit is reached. In client-side\ncatalog retrieval API calls, once the limit is reached, the item is returned with the `can_be_bought: false` flag. The\nnext reset date is returned in `reset_next_date`.\n- `hide` — The item is not returned in catalog retrieval API calls after the purchase limit is reached, until the\nlimit is reset.", "enum": [ "show", "hide" ], "example": "show", "type": "string" }, "long-description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "包含商品详细本地化描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的区域设置代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。", "type": [ "object", "null" ] }, "media_list": { "description": "商品的附加资源，例如屏幕截图、游戏视频等。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "媒体类型：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "资源文件。", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "modify-daily-chain-item-model": { "properties": { "quantity": { "description": "此sku的每日奖励步骤数量", "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/sku" } }, "required": [ "sku", "quantity" ], "type": "object" }, "modify-daily-chain-step-model": { "properties": { "items": { "items": { "$ref": "#/components/schemas/modify-daily-chain-item-model" }, "minItems": 1, "type": "array" }, "step_id": { "$ref": "#/components/schemas/daily_chain_update_step_id" }, "step_number": { "$ref": "#/components/schemas/daily_chain_step_number" } }, "required": [ "step_number", "items" ], "type": "object" }, "modify-offer-chain-item-model": { "properties": { "order": { "description": "优惠链步骤奖励顺序。", "minimum": 0, "type": [ "integer", "null" ] }, "quantity": { "description": "此步骤的奖励品数量。", "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/sku" } }, "required": [ "sku", "quantity" ], "type": "object" }, "modify-offer-chain-model": { "description": "一个优惠链。", "properties": { "attribute_conditions": { "$ref": "#/components/schemas/chain_user-attribute_conditions_model-post" }, "date_end": { "$ref": "#/components/schemas/offer_chain_date_end" }, "date_start": { "$ref": "#/components/schemas/offer_chain_date_start" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/offer_chain_id" }, "is_always_visible": { "$ref": "#/components/schemas/chain_is_always_visible" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "recurrent_schedule": { "$ref": "#/components/schemas/offer_chain_recurrent_schedule_create_update" }, "steps": { "items": { "$ref": "#/components/schemas/modify-offer-chain-step-model" }, "type": "array" } }, "required": [ "name", "date_start", "steps", "is_enabled" ], "type": "object" }, "modify-offer-chain-step-model": { "properties": { "is_free": { "$ref": "#/components/schemas/offer_chain_is_free" }, "items": { "items": { "$ref": "#/components/schemas/modify-offer-chain-item-model" }, "minItems": 1, "type": "array" }, "step_id": { "$ref": "#/components/schemas/update_step_id" }, "step_number": { "$ref": "#/components/schemas/offer_chain_step_number" } }, "required": [ "step_number", "is_free", "items" ], "type": "object" }, "modify_reward_step": { "description": "奖励链步骤。", "properties": { "image_url": { "$ref": "#/components/schemas/image_url" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "price": { "$ref": "#/components/schemas/reward_step_price" }, "reward": { "items": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/reward-chain-step-reward_user-attribute_conditions_model-post" }, "quantity": { "$ref": "#/components/schemas/reward_item_quantity" }, "sku": { "$ref": "#/components/schemas/sku" } }, "required": [ "sku", "quantity" ], "type": "object" }, "type": "array" }, "step_id": { "$ref": "#/components/schemas/step_id" } }, "required": [ "name", "price", "reward", "step_id" ], "type": "object" }, "name-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "包含商品本地化名称的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的语言代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。", "type": [ "object", "null" ] }, "offer-chain-error-model": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "type": [ "object", "null" ] }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "offer_chain_date_end": { "description": "优惠链结束日期。可为`null`，若`date_end`为`null`则无时间限制。", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "type": [ "string", "null" ] }, "offer_chain_date_start": { "description": "优惠链开始日期。", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "type": "string" }, "offer_chain_day_of_month": { "description": "每月优惠链重置日，若当月天数不足，则在该月最后一天重置。", "maximum": 31, "minimum": 1, "type": "integer" }, "offer_chain_day_of_week": { "description": "每周优惠链重置日，`1`为周一，`7`为周日。", "maximum": 7, "minimum": 1, "type": "integer" }, "offer_chain_displayable_reset_next_date": { "description": "下次优惠链重置的计算时间，遵循ISO 8601格式。

例如：月度优惠链重置从2024-03-01 01:00（吉隆坡时间）开始，下次重置为2024-04-01 01:00（吉隆坡时间），使用ISO 8601格式即`2024-04-01T01:00:00+08:00`。

示例：`2024-04-01T01:00:00+08:00`", "format": "date-time", "type": "string" }, "offer_chain_displayable_reset_start_date": { "description": "首次优惠链重置的日期和时间。

例如：首次重置为2024-03-01 01:00（吉隆坡时间），使用ISO 8601格式即`2024-03-01T01:00:00+08:00`。

示例：`2024-03-01T01:00:00+08:00`", "format": "date-time", "type": "string" }, "offer_chain_hours_interval": { "description": "优惠链重置的小时间隔。

计时从date_start参数指定的时间开始。

例如，若`date_start = \"2025-11-15T18:15:00+05:00\"`且`hours_interval = 2`，则优惠链将从`\"2025-11-15T20:15:00+05:00\"`开始每2小时重置一次。", "maximum": 10000, "minimum": 1, "type": "integer" }, "offer_chain_id": { "description": "优惠链唯一ID。", "example": 9, "type": "integer" }, "offer_chain_interval_type_hourly": { "description": "优惠链重置频率。", "enum": [ "hourly" ], "type": "string" }, "offer_chain_interval_type_monthly": { "description": "优惠链重置频率。", "enum": [ "monthly" ], "type": "string" }, "offer_chain_interval_type_weekly": { "description": "优惠链重置频率。", "enum": [ "weekly" ], "type": "string" }, "offer_chain_is_free": { "description": "是否为免费步骤：", "type": "boolean" }, "offer_chain_recurrent_schedule": { "description": "重复性优惠链的重置周期。", "oneOf": [ { "description": "每周重置优惠链。", "properties": { "day_of_week": { "$ref": "#/components/schemas/offer_chain_day_of_week" }, "displayable_reset_next_date": { "$ref": "#/components/schemas/offer_chain_displayable_reset_next_date" }, "displayable_reset_start_date": { "$ref": "#/components/schemas/offer_chain_displayable_reset_start_date" }, "interval_type": { "$ref": "#/components/schemas/offer_chain_interval_type_weekly" }, "reset_next_date": { "$ref": "#/components/schemas/offer_chain_reset_next_date" }, "time": { "$ref": "#/components/schemas/offer_chain_time" } }, "title": "interval_type = weekly", "type": [ "object", "null" ] }, { "description": "每月重置优惠链。", "properties": { "day_of_month": { "$ref": "#/components/schemas/offer_chain_day_of_month" }, "displayable_reset_next_date": { "$ref": "#/components/schemas/offer_chain_displayable_reset_next_date" }, "displayable_reset_start_date": { "$ref": "#/components/schemas/offer_chain_displayable_reset_start_date" }, "interval_type": { "$ref": "#/components/schemas/offer_chain_interval_type_monthly" }, "reset_next_date": { "$ref": "#/components/schemas/offer_chain_reset_next_date" }, "time": { "$ref": "#/components/schemas/offer_chain_time" } }, "title": "interval_type = monthly", "type": "object" }, { "description": "按指定小时间隔执行优惠链重置。", "properties": { "hours_interval": { "$ref": "#/components/schemas/offer_chain_hours_interval" }, "interval_type": { "$ref": "#/components/schemas/offer_chain_interval_type_hourly" } }, "title": "interval_type = hourly", "type": "object" } ], "type": [ "object", "null" ] }, "offer_chain_recurrent_schedule_client_side": { "description": "优惠链的重置周期。", "properties": { "interval_type": { "description": "优惠链重置频率。", "enum": [ "weekly", "monthly", "hourly" ], "type": "string" }, "reset_next_date": { "$ref": "#/components/schemas/offer_chain_reset_next_date" } }, "type": [ "object", "null" ] }, "offer_chain_recurrent_schedule_create_update": { "description": "优惠链的重置周期。", "oneOf": [ { "description": "每周重置优惠链。", "properties": { "day_of_week": { "$ref": "#/components/schemas/offer_chain_day_of_week" }, "interval_type": { "$ref": "#/components/schemas/offer_chain_interval_type_weekly" }, "time": { "$ref": "#/components/schemas/offer_chain_time" } }, "required": [ "interval_type", "time", "day_of_week" ], "title": "interval_type = weekly", "type": [ "object", "null" ] }, { "description": "每月重置优惠链。", "properties": { "day_of_month": { "$ref": "#/components/schemas/offer_chain_day_of_month" }, "interval_type": { "$ref": "#/components/schemas/offer_chain_interval_type_monthly" }, "time": { "$ref": "#/components/schemas/offer_chain_time" } }, "required": [ "interval_type", "time", "day_of_month" ], "title": "interval_type = monthly", "type": "object" }, { "description": "按指定小时间隔执行优惠链重置。", "properties": { "hours_interval": { "$ref": "#/components/schemas/offer_chain_hours_interval" }, "interval_type": { "$ref": "#/components/schemas/offer_chain_interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = hourly", "type": "object" } ], "type": [ "object", "null" ] }, "offer_chain_reset_next_date": { "description": "计算的下次优惠链重置的日期和时间，Unix时间戳格式。

例如：月度优惠链重置从2024-03-01 01:00（吉隆坡时间，GMT+8）开始，下次重置为2024-04-01 01:00（吉隆坡时间，GMT+8），对应GMT+0为2024-03-31 17:00，Unix时间戳为`1711904400000`。

示例：`1711904400000`", "type": "integer" }, "offer_chain_step_id": { "description": "链步骤的唯一ID。", "example": 10, "minimum": 1, "type": [ "integer", "null" ] }, "offer_chain_step_number": { "description": "步骤编号。", "example": 2, "minimum": 1, "nullable": false, "type": "integer" }, "offer_chain_step_price": { "properties": { "amount": { "$ref": "#/components/schemas/offer_chain_step_price_amount" }, "currency": { "$ref": "#/components/schemas/offer_chain_step_price_currency" } }, "required": [ "amount", "currency" ], "type": [ "object", "null" ] }, "offer_chain_step_price_amount": { "description": "步骤的真实货币价格。", "example": 99.99, "type": "number" }, "offer_chain_step_price_currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。", "example": "USD", "type": "string" }, "offer_chain_time": { "description": "用指定时区重置奖励链的时间（四舍五入到小时）。

例如：吉隆坡时区（GMT+8）重置时间为01:00，则`time`参数值为`01:00:00+08:00`。", "example": "01:00:00+08:00", "pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])", "type": "string" }, "order": { "description": "定义排列顺序。", "example": 1, "type": "integer" }, "periods": { "description": "奖励链有效期。若指定了多个时间段，则`date_from`和`date_until`均为必需。", "items": { "properties": { "date_from": { "description": "指定奖励链的开始日期。", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "nullable": false, "type": "string" }, "date_until": { "description": "指定奖励链的结束日期。仅在指定单个有效期时可为`null`。", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "date_from" ], "type": "object" }, "nullable": false, "type": "array" }, "personalized-catalog_user-attribute_conditions_model-get": { "allOf": [ { "$ref": "#/components/schemas/user-attribute_conditions_model-get" }, { "description": "用户属性验证条件。\n根据用户属性是否满足所有指定条件来确定目录商品可用性。" } ] }, "personalized-catalog_user-attribute_conditions_model-post": { "allOf": [ { "$ref": "#/components/schemas/user-attribute_conditions_model-post" }, { "description": "用户属性验证条件。\n根据用户属性是否满足所有指定条件来确定目录商品可用性。" } ] }, "popup_header-two-letter-locale": { "description": "包含公会奖励链提示弹窗本地化标题的对象。两个小写字母的[语言代码](https://developers.xsolla.com/zh/doc/pay-station/features/localization/)。", "properties": { "ar": { "example": null, "type": [ "string", "null" ] }, "bg": { "example": null, "type": [ "string", "null" ] }, "cn": { "example": null, "type": [ "string", "null" ] }, "cs": { "example": null, "type": [ "string", "null" ] }, "de": { "example": "Wie man Belohnungen freischaltet", "type": [ "string", "null" ] }, "en": { "example": "How to unlock rewards", "type": [ "string", "null" ] }, "es": { "example": "Cómo desbloquear recompensas", "type": [ "string", "null" ] }, "fr": { "example": "Comment débloquer des récompenses", "type": [ "string", "null" ] }, "he": { "example": null, "type": [ "string", "null" ] }, "it": { "example": "Come sbloccare ricompense", "type": [ "string", "null" ] }, "ja": { "example": "報酬をアンロックする方法", "type": [ "string", "null" ] }, "ko": { "example": null, "type": [ "string", "null" ] }, "pl": { "example": null, "type": [ "string", "null" ] }, "pt": { "example": null, "type": [ "string", "null" ] }, "ro": { "example": null, "type": [ "string", "null" ] }, "ru": { "example": null, "type": [ "string", "null" ] }, "th": { "example": null, "type": [ "string", "null" ] }, "tr": { "example": null, "type": [ "string", "null" ] }, "tw": { "example": null, "type": [ "string", "null" ] }, "vi": { "example": null, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "popup_image_url": { "description": "公会奖励链提示弹出窗口的图片。", "example": "https://image.example.com", "format": "uri", "type": [ "string", "null" ] }, "popup_instruction-two-letter-locale": { "description": "包含公会奖励链提示弹窗本地化说明的对象。两个小写字母的[语言代码](https://developers.xsolla.com/zh/doc/pay-station/features/localization/)。", "properties": { "ar": { "example": null, "type": [ "string", "null" ] }, "bg": { "example": null, "type": [ "string", "null" ] }, "cn": { "example": null, "type": [ "string", "null" ] }, "cs": { "example": null, "type": [ "string", "null" ] }, "de": { "example": "Du musst ein Clanmitglied sein, um Clananreize zu erhalten. Du trittst einem Clan bei, wenn ein Clanmitglied dich einlädt, und du die Einladung annimmst. Du kannst auch deinen eigenen Clan erstellen.", "type": [ "string", "null" ] }, "en": { "example": "You must be a clan member to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan.", "type": [ "string", "null" ] }, "es": { "example": "Debes ser miembro de un clan para obtener las recompensas del clan. Te unes a un clan cuando un miembro del clan te invita al clan y aceptas la invitación. También puedes crear tu propio clan.", "type": [ "string", "null" ] }, "fr": { "example": "Vous devez être membre d'un clan pour obtenir les récompenses du clan. Vous rejoignez un clan lorsque qu'un membre du clan vous invite au clan et que vous acceptez l'invitation. Vous pouvez également créer votre propre clan.", "type": [ "string", "null" ] }, "he": { "example": null, "type": [ "string", "null" ] }, "it": { "example": "Devi essere un membro del clan per ottenere le ricompense del clan. Ti unisci a un clan quando un membro del clan ti invita al clan e accetti l'invito. Puoi anche creare il tuo clan.", "type": [ "string", "null" ] }, "ja": { "example": "クランリワードを受け取るには、クランメンバーでなければなりません。 クランメンバーがあなたをクランに招待し、招待を受け入れると、クランに参加できます。 あなた自身のクランを作成することもできます。", "type": [ "string", "null" ] }, "ko": { "example": null, "type": [ "string", "null" ] }, "pl": { "example": null, "type": [ "string", "null" ] }, "pt": { "example": null, "type": [ "string", "null" ] }, "ro": { "example": null, "type": [ "string", "null" ] }, "ru": { "example": null, "type": [ "string", "null" ] }, "th": { "example": null, "type": [ "string", "null" ] }, "tr": { "example": null, "type": [ "string", "null" ] }, "tw": { "example": null, "type": [ "string", "null" ] }, "vi": { "example": null, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "price_conditions_bonus": { "description": "包含条件的对象数组，用于设置应用促销活动的价格范围。
促销活动仅应用于价格符合数组中所有条件的商品。如果传递此数组，请将[condition](/zh/api/shop-builder/operation/create-bonus-promotion/#!path=condition&t=request)对象的值设置为`null`。", "items": { "$ref": "#/components/schemas/price_conditions_items" }, "type": [ "array", "null" ] }, "price_conditions_discount": { "description": "具有设置促销价格范围的条件的对象数组。
促销仅适用于价格符合数组中所有条件的商品。如果传递此数组，请设置[items](/zh/api/shop-builder/operation/create-item-promotion/#!path=items&t=request)对象为`null`。", "items": { "$ref": "#/components/schemas/price_conditions_items" }, "type": [ "array", "null" ] }, "price_conditions_items": { "description": "每个对象描述一条价格应遵循的规则。", "properties": { "operator": { "description": "Comparison operator for setting the price range for applying the promotion.\n\nPossible values:\n- `ge` — Greater or equal\n- `gt` — Greater than\n- `le` — Less or equal\n- `lt` — Less than\n- `eq` — Equals\n- `ne` — Not equals", "enum": [ "ge", "gt", "le", "lt", "eq", "ne" ], "type": "string" }, "value": { "description": "用于决定应用促销活动的价格范围的值。", "pattern": "^\\d+(\\.\\d{1,4})?$", "type": "string" } }, "required": [ "operator", "value" ], "type": "object" }, "price_conditions_promocode": { "description": "包含条件的对象数组，用于设置对整个购物车应用促销活动的价格范围。
\n将用户购物车中所有商品的总价与条件中指定的价格范围进行比较。如果购物车的价格满足指定的条件，则将对购物车中的所有商品应用[奖励](/zh/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request)和[折扣](/zh/api/shop-builder/operation/create-promo-code/#!path=discount&t=request)
\n如果传递此数组，请将[discounted_items](/zh/api/shop-builder/operation/create-promo-code/#!path=discounted_items&t=request)数组的值设置为`null`。", "items": { "$ref": "#/components/schemas/price_conditions_items" }, "type": [ "array", "null" ] }, "promotion_periods": { "description": "促销活动有效期。若指定了多个时间段，则`date_from`和`date_until`均为必需。", "items": { "properties": { "date_from": { "description": "指定促销活动的开始日期。", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "nullable": false, "type": "string" }, "date_until": { "description": "促销活动的结束日期。设置为`null`时，促销活动永久有效。仅在指定单个有效期时可设置为`null`。", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "date_from" ], "type": "object" }, "nullable": false, "type": "array" }, "promotion_recurrent_schedule_response": { "description": "限制次数刷新周期。", "properties": { "per_user": { "description": "用户限制刷新周期。", "oneOf": [ { "description": "每天类型的用户限制次数刷新。", "properties": { "displayable_reset_next_date": { "description": "应重置限制次数的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "第一次限制次数刷新的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "循环刷新周期类型。", "enum": [ "daily" ], "type": "string" }, "reset_next_date": { "description": "限制次数刷新的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" }, "time": { "description": "所需时区的限制次数刷新时间（四舍五入到小时）。", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = daily", "type": "object" }, { "description": "每周类型的用户限制次数刷新。", "properties": { "day_of_week": { "description": "在一周中的哪一天刷新限制次数。其中1是星期一，7是星期日。仅针对`weekly`限制刷新周期类型不为`null`。", "maximum": 7, "minimum": 1, "type": [ "integer", "null" ] }, "displayable_reset_next_date": { "description": "应重置限制次数的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "第一次限制次数刷新的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "循环刷新周期类型。", "enum": [ "weekly" ], "type": "string" }, "reset_next_date": { "description": "限制次数刷新的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" }, "time": { "description": "所需时区的限制次数刷新时间（四舍五入到小时）。", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = weekly", "type": "object" }, { "description": "每月类型的用户限制次数刷新。", "properties": { "day_of_month": { "description": "在一个月中的哪一天刷新限制次数。如果由于较短的月没有选择具体哪一天，刷新将在该月的最后一天发生。仅针对`monthly`限制刷新周期类型不为`null`。", "maximum": 31, "minimum": 1, "type": [ "integer", "null" ] }, "displayable_reset_next_date": { "description": "应重置限制次数的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "第一次限制次数刷新的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "循环刷新周期类型。", "enum": [ "monthly" ], "type": "string" }, "reset_next_date": { "description": "限制次数刷新的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" }, "time": { "description": "所需时区的限制次数刷新时间（四舍五入到小时）。", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = monthly", "type": "object" } ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "promotion_user-attribute_conditions_model-get": { "allOf": [ { "$ref": "#/components/schemas/user-attribute_conditions_model-get" }, { "description": "用户属性验证条件。\n根据用户属性是否满足所有指定条件来确定促销活动可用性。" } ] }, "promotion_user-attribute_conditions_model-post": { "allOf": [ { "$ref": "#/components/schemas/user-attribute_conditions_model-post" }, { "description": "用户属性验证条件。\n根据用户属性是否满足所有指定条件来确定促销活动可用性。" } ] }, "recurrent_schedule_client_side": { "description": "奖励链的重置周期。", "properties": { "interval_type": { "oneOf": [ { "$ref": "#/components/schemas/interval_type_weekly", "title": "interval_type = weekly" }, { "$ref": "#/components/schemas/interval_type_monthly", "title": "interval_type = monthly" }, { "$ref": "#/components/schemas/interval_type_hourly_rc", "title": "interval_type = hourly" } ] }, "reset_next_date": { "$ref": "#/components/schemas/reset_next_date" } }, "type": [ "object", "null" ] }, "recurrent_schedule_create_update": { "description": "奖励链的重置周期。", "oneOf": [ { "description": "按周刷新奖励链。", "properties": { "day_of_week": { "$ref": "#/components/schemas/day_of_week" }, "interval_type": { "$ref": "#/components/schemas/interval_type_weekly" }, "time": { "$ref": "#/components/schemas/time" } }, "required": [ "interval_type", "time", "day_of_week" ], "title": "interval_type = weekly", "type": "object" }, { "description": "按月刷新奖励链。", "properties": { "day_of_month": { "$ref": "#/components/schemas/day_of_month" }, "interval_type": { "$ref": "#/components/schemas/interval_type_monthly" }, "time": { "$ref": "#/components/schemas/time" } }, "required": [ "interval_type", "time", "day_of_month" ], "title": "interval_type = monthly", "type": "object" }, { "description": "按指定小时间隔执行奖励链重置。", "properties": { "hours_interval": { "$ref": "#/components/schemas/reward_chain_hours_interval" }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly_rc" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = hourly", "type": "object" } ], "type": [ "object", "null" ] }, "reset_next_date": { "description": "计算的下次奖励链重置的日期和时间（Unix 时间戳）。

例如，从2024年3月1日吉隆坡时间01:00 (GMT+8)开始，奖励链每月重置一次。下一次奖励链重置的日期和时间为2024年4月1日01:00吉隆坡时间(GMT+8)，相当于2024年3月31日17:00 GMT+0 或 Unix 时间戳格式的`1711904400000`。

示例：`1711904400000`", "type": "integer" }, "reward-chain-step-reward_user-attribute_conditions_model-get": { "allOf": [ { "$ref": "#/components/schemas/user-attribute_conditions_model-get" }, { "description": "用户属性验证条件。\n根据用户属性是否满足所有指定条件来确定奖励链步骤的奖励可用性。" } ] }, "reward-chain-step-reward_user-attribute_conditions_model-post": { "allOf": [ { "$ref": "#/components/schemas/user-attribute_conditions_model-post" }, { "description": "用户属性验证条件。\n根据用户属性是否满足所有指定条件来确定奖励链步骤的奖励可用性。" } ] }, "reward_chain_hours_interval": { "description": "奖励链重置的小时间隔。

计时从date_start参数指定的时间开始。

例如，若`date_start = \"2025-11-15T18:15:00+05:00\"`且`hours_interval = 2`，则优惠链将从`\"2025-11-15T20:15:00+05:00\"`开始每2小时重置一次。", "maximum": 10000, "minimum": 1, "type": "integer" }, "reward_chain_id": { "description": "唯一奖励链ID。", "example": 9, "type": "integer" }, "reward_item_quantity": { "description": "商品数量。", "example": 2, "type": "integer" }, "reward_step_price": { "properties": { "amount": { "$ref": "#/components/schemas/step_price_amount" } }, "required": [ "amount" ], "type": "object" }, "reward_step_short": { "description": "奖励链步骤。", "properties": { "image_url": { "$ref": "#/components/schemas/image_url" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "price": { "$ref": "#/components/schemas/reward_step_price" }, "reward": { "items": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/reward-chain-step-reward_user-attribute_conditions_model-get" }, "quantity": { "$ref": "#/components/schemas/reward_item_quantity" }, "sku": { "$ref": "#/components/schemas/sku" } }, "type": "object" }, "type": "array" }, "step_id": { "$ref": "#/components/schemas/step_id" } }, "type": "object" }, "rolling-skippable-daily-chain-base": { "description": "`rolling_skippable`类型每日奖励的基础属性。", "properties": { "date_end": { "$ref": "#/components/schemas/rolling_date_end" }, "date_start": { "$ref": "#/components/schemas/daily_rolling_chain_date_start" }, "is_recurrent": { "$ref": "#/components/schemas/rolling_is_recurrent" }, "type": { "allOf": [ { "$ref": "#/components/schemas/daily_chain_type" }, { "enum": [ "rolling_skippable" ] } ] } }, "type": "object" }, "rolling-unskippable-daily-chain-base": { "description": "`rolling_unskippable`类型每日奖励的基础属性。", "properties": { "date_end": { "$ref": "#/components/schemas/rolling_date_end" }, "date_start": { "$ref": "#/components/schemas/daily_rolling_chain_date_start" }, "is_recurrent": { "$ref": "#/components/schemas/rolling_is_recurrent" }, "type": { "allOf": [ { "$ref": "#/components/schemas/daily_chain_type" }, { "enum": [ "rolling_unskippable" ] } ] } }, "type": "object" }, "rolling_date_end": { "description": "每日奖励的结束日期。", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "type": [ "string", "null" ] }, "rolling_is_recurrent": { "default": false, "description": "每日奖励是否循环。如为`true`，用户完成所有步骤后奖励将重置，可从第1步重新开始。循环仅在`date_start`和`date_end`定义的活动期间内有效。", "example": true, "type": "boolean" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "booster_mega_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "step_id": { "description": "唯一步骤ID。", "example": 10, "type": [ "integer", "null" ] }, "step_price_amount": { "description": "以奖励积分表示的步骤价格。", "example": 100, "type": "integer" }, "time": { "description": "用所需时区重置奖励链的时间（四舍五入到小时）。

例如，奖励链重置的设定时间为吉隆坡时区(GMT+8)的01:00。在这种情况下，`time`参数的值为`01:00:00+08:00`。", "example": "01:00:00+08:00", "pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])", "type": "string" }, "top_contributors": { "properties": { "contributed_amount": { "description": "用户获得的奖励积分数。", "example": 100, "type": "integer" }, "name": { "description": "在授权过程中向艾克索拉发送的用户ID。用户ID用于将用户与您的艾克索拉登录管理器项目相关联，并显示为昵称。如果使用按[用户ID](https://developers.xsolla.com/zh/solutions/web-shop/create-web-shop/set-up-authentication/?tabs=100-UserIDAuth&link=100-UserIDAuth)授权，建议在[Webhook响应](https://developers.xsolla.com/zh/webhooks/operation/user-validation-in-webshop/)中传入name参数。该参数包含将用作昵称的用户名。", "example": "Rocket", "type": "string" } }, "type": [ "object", "null" ] }, "total_promotions_count": { "description": "促销活动总数。", "type": "integer" }, "two-letter-locale": { "description": "两个小写字母的语言代码。", "properties": { "ar": { "description": "阿拉伯语", "type": [ "string", "null" ] }, "bg": { "description": "保加利亚语", "type": [ "string", "null" ] }, "cn": { "description": "中文（简体）", "type": [ "string", "null" ] }, "cs": { "description": "捷克语", "type": [ "string", "null" ] }, "de": { "description": "德语", "type": [ "string", "null" ] }, "en": { "description": "英语", "type": [ "string", "null" ] }, "es": { "description": "西班牙语（西班牙）", "type": [ "string", "null" ] }, "fr": { "description": "法语", "type": [ "string", "null" ] }, "he": { "description": "希伯来语", "type": [ "string", "null" ] }, "id": { "description": "印度尼西亚语", "type": [ "string", "null" ] }, "it": { "description": "意大利语", "type": [ "string", "null" ] }, "ja": { "description": "日语", "type": [ "string", "null" ] }, "km": { "description": "高棉语", "type": [ "string", "null" ] }, "ko": { "description": "韩语", "type": [ "string", "null" ] }, "lo": { "description": "老挝语", "type": [ "string", "null" ] }, "my": { "description": "缅甸语", "type": [ "string", "null" ] }, "ne": { "description": "尼泊尔语", "type": [ "string", "null" ] }, "ph": { "description": "菲律宾语", "type": [ "string", "null" ] }, "pl": { "description": "波兰语", "type": [ "string", "null" ] }, "pt": { "description": "葡萄牙语", "type": [ "string", "null" ] }, "ro": { "description": "罗马尼亚语", "type": [ "string", "null" ] }, "ru": { "description": "俄语", "type": [ "string", "null" ] }, "th": { "description": "泰语", "type": [ "string", "null" ] }, "tr": { "description": "土耳其语", "type": [ "string", "null" ] }, "tw": { "description": "中文（繁体）", "type": [ "string", "null" ] }, "vi": { "description": "越南语", "type": [ "string", "null" ] } }, "title": "two-letter", "type": [ "object", "null" ] }, "unit_type": { "description": "单位类型：`game`。", "example": "game", "type": "string" }, "update-calendar-hard-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/calendar-hard-daily-chain-base" }, { "description": "用于`calendar_hard`类型的每日奖励。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/daily_chain_id" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/modify-daily-chain-step-model" }, "type": "array" } }, "required": [ "name", "date_start", "steps", "is_enabled", "type" ], "type": "object" } ] }, "update-clan-reward-chain-model": { "allOf": [ { "$ref": "#/components/schemas/create-reward-chain-model" }, { "description": "公会奖励链。", "properties": { "clan_type": { "$ref": "#/components/schemas/clan_type" }, "popup_header": { "$ref": "#/components/schemas/popup_header-two-letter-locale" }, "popup_image_url": { "$ref": "#/components/schemas/popup_image_url" }, "popup_instruction": { "$ref": "#/components/schemas/popup_instruction-two-letter-locale" } }, "required": [ "name", "periods", "steps", "is_enabled", "popup_header", "popup_instruction" ], "type": "object" } ] }, "update-reward-chain-model": { "description": "一个奖励链。", "properties": { "attribute_conditions": { "$ref": "#/components/schemas/chain_user-attribute_conditions_model-post" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/image_url" }, "is_always_visible": { "$ref": "#/components/schemas/chain_is_always_visible" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "is_reset_after_end": { "$ref": "#/components/schemas/is_reset_after_end" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "periods": { "$ref": "#/components/schemas/periods" }, "recurrent_schedule": { "$ref": "#/components/schemas/recurrent_schedule_create_update" }, "steps": { "items": { "$ref": "#/components/schemas/modify_reward_step" }, "type": "array" } }, "required": [ "name", "periods", "steps", "is_enabled" ], "type": "object" }, "update-rolling-skippable-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/rolling-skippable-daily-chain-base" }, { "description": "用于`rolling_skippable`类型的每日奖励。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/daily_chain_id" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/modify-daily-chain-step-model" }, "type": "array" } }, "required": [ "name", "date_start", "steps", "is_enabled", "type" ], "type": "object" } ] }, "update-rolling-unskippable-daily-chain-model": { "allOf": [ { "$ref": "#/components/schemas/rolling-unskippable-daily-chain-base" }, { "description": "用于`rolling_unskippable`类型的每日奖励。", "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "id": { "$ref": "#/components/schemas/daily_chain_id" }, "is_enabled": { "$ref": "#/components/schemas/is_enabled" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/order" }, "steps": { "items": { "$ref": "#/components/schemas/modify-daily-chain-step-model" }, "type": "array" } }, "required": [ "name", "date_start", "steps", "is_enabled", "type" ], "type": "object" } ] }, "update_step_id": { "description": "链步骤的唯一ID。更新时指定以保留用户进度。", "example": 10, "minimum": 1, "type": [ "integer", "null" ] }, "user-attribute_condition_date_model-get": { "properties": { "attribute": { "$ref": "#/components/schemas/user-attribute_conditions_properties_attribute" }, "can_be_missing": { "$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing" }, "operator": { "$ref": "#/components/schemas/user-attribute_conditions_properties_operator_date" }, "type": { "$ref": "#/components/schemas/user-attribute_conditions_properties_type-date" }, "value": { "$ref": "#/components/schemas/user-attribute_conditions_properties_value" } }, "title": "type = date", "type": "object" }, "user-attribute_condition_date_model-post": { "properties": { "attribute": { "$ref": "#/components/schemas/user-attribute_conditions_properties_attribute" }, "can_be_missing": { "$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing" }, "operator": { "$ref": "#/components/schemas/user-attribute_conditions_properties_operator_date" }, "type": { "$ref": "#/components/schemas/user-attribute_conditions_properties_type-date" }, "value": { "$ref": "#/components/schemas/user-attribute_conditions_properties_value" } }, "required": [ "attribute", "operator", "value", "type" ], "title": "type = date", "type": "object" }, "user-attribute_condition_number_model-get": { "properties": { "attribute": { "$ref": "#/components/schemas/user-attribute_conditions_properties_attribute" }, "can_be_missing": { "$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing" }, "operator": { "$ref": "#/components/schemas/user-attribute_conditions_properties_operator_number" }, "type": { "$ref": "#/components/schemas/user-attribute_conditions_properties_type-number" }, "value": { "$ref": "#/components/schemas/user-attribute_conditions_properties_value" } }, "title": "type = number", "type": "object" }, "user-attribute_condition_number_model-post": { "properties": { "attribute": { "$ref": "#/components/schemas/user-attribute_conditions_properties_attribute" }, "can_be_missing": { "$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing" }, "operator": { "$ref": "#/components/schemas/user-attribute_conditions_properties_operator_number" }, "type": { "$ref": "#/components/schemas/user-attribute_conditions_properties_type-number" }, "value": { "$ref": "#/components/schemas/user-attribute_conditions_properties_value" } }, "required": [ "attribute", "operator", "value", "type" ], "title": "type = number", "type": "object" }, "user-attribute_condition_string_model-get": { "properties": { "attribute": { "$ref": "#/components/schemas/user-attribute_conditions_properties_attribute" }, "can_be_missing": { "$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing" }, "operator": { "$ref": "#/components/schemas/user-attribute_conditions_properties_operator_string" }, "type": { "$ref": "#/components/schemas/user-attribute_conditions_properties_type-string" }, "value": { "$ref": "#/components/schemas/user-attribute_conditions_properties_value" } }, "title": "type = string", "type": "object" }, "user-attribute_condition_string_model-post": { "properties": { "attribute": { "$ref": "#/components/schemas/user-attribute_conditions_properties_attribute" }, "can_be_missing": { "$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing" }, "operator": { "$ref": "#/components/schemas/user-attribute_conditions_properties_operator_string" }, "type": { "$ref": "#/components/schemas/user-attribute_conditions_properties_type-string" }, "value": { "$ref": "#/components/schemas/user-attribute_conditions_properties_value" } }, "required": [ "attribute", "operator", "value", "type" ], "title": "type = string", "type": "object" }, "user-attribute_conditions_model-get": { "items": { "oneOf": [ { "$ref": "#/components/schemas/user-attribute_condition_string_model-get" }, { "$ref": "#/components/schemas/user-attribute_condition_number_model-get" }, { "$ref": "#/components/schemas/user-attribute_condition_date_model-get" } ] }, "maxItems": 100, "minItems": 1, "type": "array" }, "user-attribute_conditions_model-post": { "items": { "oneOf": [ { "$ref": "#/components/schemas/user-attribute_condition_string_model-post" }, { "$ref": "#/components/schemas/user-attribute_condition_number_model-post" }, { "$ref": "#/components/schemas/user-attribute_condition_date_model-post" } ] }, "maxItems": 100, "minItems": 1, "type": "array" }, "user-attribute_conditions_properties_attribute": { "description": "用户属性代码。", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "user-attribute_conditions_properties_can_be_missing": { "description": "表示即使用户属性中缺少属性仍满足条件。传递`true`可向不具有此属性的用户显示该项目。具有该属性但值与条件中指定的值不匹配的用户将看不到该商品。传递`false`则具有该属性但值与条件中指定的值不匹配或缺少该属性的用户将看不到该商品。", "type": "boolean" }, "user-attribute_conditions_properties_operator_date": { "description": "Type of operation performed by condition. For date attribute type.\n\nPossible values:\n- `eq` — Equals\n- `ne` — Not equals\n- `lt` — Earlier\n- `gt` — Later\n- `le` — Earlier or equals\n- `ge` — Later or equals", "enum": [ "eq", "ne", "lt", "gt", "le", "ge" ], "type": "string" }, "user-attribute_conditions_properties_operator_number": { "description": "Type of operation performed by condition. For number attribute type.\n\nPossible values:\n- `eq` — Equals\n- `ne` — Not equals\n- `gt` — Greater\n- `ge` — Greater or equals\n- `lt` — Less\n- `le` — Less or equals", "enum": [ "eq", "ne", "gt", "ge", "lt", "le" ], "type": "string" }, "user-attribute_conditions_properties_operator_string": { "description": "Type of operation performed by condition. For string attribute type.\n\nPossible values:\n- `eq` — Equals\n- `ne` — Not equals", "enum": [ "eq", "ne" ], "type": "string" }, "user-attribute_conditions_properties_type-date": { "description": "用户属性类型。", "enum": [ "date" ], "type": "string" }, "user-attribute_conditions_properties_type-number": { "description": "用户属性类型。", "enum": [ "number" ], "type": "string" }, "user-attribute_conditions_properties_type-string": { "description": "用户属性类型。", "enum": [ "string" ], "type": "string" }, "user-attribute_conditions_properties_value": { "description": "与用户属性值进行比较的条件值。类型取决于属性类型。", "maxLength": 255, "type": "string" }, "user-attribute_personalized-catalog": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/personalized-catalog_user-attribute_conditions_model-get" }, "is_enabled": { "description": "如果已启用规则。", "type": "boolean" }, "is_satisfied_for_unauth": { "description": "是否向未经授权的用户显示该商品。如为`true`，无论目录显示规则如何，该商品都会向未经授权的用户显示。默认为`false`。", "type": "boolean" }, "items": { "items": { "description": "用户的属性值满足条件的情况下显示给用户的商品。", "properties": { "bundle_type": { "description": "捆绑类型。商品类型是捆绑包时返回。", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "item_id": { "description": "物品ID。", "type": "number" }, "name": { "description": "商品名称。", "type": "string" }, "sku": { "description": "物品 SKU。", "type": "string" }, "type": { "description": "商品类型。", "enum": [ "virtual_good", "virtual_currency", "bundle", "physical_good", "unit" ], "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "description": "规则的可读名称。用于在发布商帐户中显示规则。", "type": "string" }, "rule_id": { "description": "规则ID。", "type": "number" } }, "required": [ "rule_id", "name", "is_enabled", "attribute_conditions", "items" ], "type": "object" }, "user-attribute_personalized-catalog-body": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/personalized-catalog_user-attribute_conditions_model-post" }, "is_enabled": { "description": "如果已启用规则。", "type": "boolean" }, "is_satisfied_for_unauth": { "description": "是否向未经授权的用户显示该商品。如为`true`，无论目录显示规则如何，该商品都会向未经授权的用户显示。默认为`false`。", "type": "boolean" }, "items": { "items": { "oneOf": [ { "description": "属性值满足条件的情况下向用户显示的商品。", "properties": { "item_id": { "description": "物品ID。", "type": "number" } }, "required": [ "item_id" ], "type": "object" }, { "description": "属性值满足条件的情况下向用户显示的商品。", "properties": { "sku": { "description": "物品 SKU。", "type": "string" } }, "required": [ "sku" ], "type": "object" } ] }, "maxItems": 100, "minItems": 1, "type": "array" }, "name": { "description": "规则的可读名称。用于在发布商帐户中显示规则。", "maxLength": 255, "minLength": 1, "pattern": "^\\S", "type": "string" } }, "type": "object" }, "user-attribute_personalized-catalog-body-required": { "properties": { "attribute_conditions": { "$ref": "#/components/schemas/personalized-catalog_user-attribute_conditions_model-post" }, "is_enabled": { "description": "如果已启用规则。", "type": "boolean" }, "is_satisfied_for_unauth": { "description": "是否向未经授权的用户显示该商品。如为`true`，无论目录显示规则如何，该商品都会向未经授权的用户显示。默认为`false`。", "type": "boolean" }, "items": { "items": { "oneOf": [ { "description": "属性值满足条件的情况下向用户显示的商品。", "properties": { "item_id": { "description": "物品ID。", "type": "number" } }, "required": [ "item_id" ], "type": "object" }, { "description": "属性值满足条件的情况下向用户显示的商品。", "properties": { "sku": { "description": "物品 SKU。", "type": "string" } }, "required": [ "sku" ], "type": "object" } ] }, "maxItems": 100, "minItems": 1, "type": "array" }, "name": { "description": "规则的可读名称。用于在发布商帐户中显示规则。", "maxLength": 255, "minLength": 1, "pattern": "^\\S", "type": "string" } }, "required": [ "name", "is_enabled", "attribute_conditions", "items" ], "type": "object" }, "user-attribute_personalized-catalog_all": { "properties": { "is_enabled": { "description": "如果已启用规则。", "type": "boolean" }, "is_satisfied_for_unauth": { "description": "是否向未经授权的用户显示该商品。如为`true`，无论目录显示规则如何，该商品都会向未经授权的用户显示。默认为`false`。", "type": "boolean" }, "name": { "description": "规则的可读名称。用于在发布商帐户中显示规则。", "type": "string" }, "rule_id": { "description": "规则ID。", "type": "number" } }, "required": [ "rule_id", "name", "is_enabled" ], "type": "object" }, "value-external_id": { "description": "属性的唯一值ID。 `external_id`只能包含小写英文字母和数字字符、破折号和下划线。", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "value-is_free": { "default": false, "description": "该商品是否免费。", "example": false, "type": "boolean" }, "value-point-amount": { "description": "奖励积分的数量。", "type": "integer" }, "value-point-description": { "description": "奖励积分描述。", "type": [ "string", "null" ] }, "value-point-long-description": { "description": "奖励积分详细描述。", "type": [ "string", "null" ] }, "value-point-name": { "description": "奖励积分名称。", "type": "string" }, "value-point-sku": { "description": "唯一奖励积分ID。", "type": "string" } }, "securitySchemes": { "AuthForCart": { "description": "The `AuthForCart` authentication scheme is used for cart purchases and supports two modes:\n\n1. Authentication with a user's JWT. The token is passed in the Authorization header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token:`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`.\n\nAlternatively, you can use a [token for opening the payment UI](/zh/api/pay-station/token/create-token).\n\n2. Simplified mode without `Authorization` header. This mode is used only for unauthorized users and can be applied only for [selling game keys](/zh/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers:\n* `x-unauthorized-id` with a request ID\n* `x-user` with the user’s email address encoded in Base64.", "scheme": "bearer", "type": "http" }, "XsollaLoginUserJWT": { "bearerFormat": "JWT", "description": "Client-side calls use the `XsollaLoginUserJWT` authentication scheme. The request must include the user's JWT in the `Authorization` header in the following format: Bearer ``. The token identifies the user and provides access to personalized data. For details on how to create a token, refer to the [Xsolla Login API documentation](/zh/api/login/authentication-schemes#getting-user-token).\n\nYou can try this call using the following test token: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`.\n\nAlternatively, you can use a [token for opening the payment UI](/zh/api/pay-station/token/create-token).", "scheme": "bearer", "type": "http" }, "basicAuth": { "description": "Server-side calls use the `basicAuth` authentication scheme. All requests to API must\ncontain the `Authorization: Basic `\nheader, where `your_authorization_basic_key` is the `project_id:api_key`\npair encoded according to the Base64 standard.\n\nYou can use `merchant_id` instead of `project_id` if you need. It doesn't affect functionality.\n\nGo to [Publisher Account](https://publisher.xsolla.com/) to find values of the parameters:\n\n* `merchant_id` is shown:\n * In the **Company settings > Company** section\n * In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`.\n* `api_key` is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the following section:\n * [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key)\n * [Project settings > API keys](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n{% html name=\"div\" attrs={\"class\": \"notice\"} %}\n**Notice**\n\nIf a required API call doesn't include the `project_id` path parameter, use an API key that is valid across all company projects for authorization.\n{% /html %}\n\n* `project_id` is shown:\n * In Publisher Account next to the name of the project.\n * In the URL in the browser address bar when working on project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com//projects/`.\n\nFor more information about working with API keys, see the [API reference](https://developers.xsolla.com/zh/api/getting-started/#api_keys_overview).", "scheme": "basic", "type": "http" }, "basicMerchantAuth": { "description": "Server-side calls use the `basicMerchantAuth` authentication scheme. All requests to API must\ncontain the `Authorization: Basic `\nheader, where `your_authorization_basic_key` is the `merchant_id:api_key`\npair encoded according to the Base64 standard.\n\nGo to [Publisher Account](https://publisher.xsolla.com/) to find values of the parameters:\n\n* `merchant_id` is shown:\n * In the **Company settings > Company** section\n * In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`\n* `api_key` is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key) section.\n\nFor more information about working with API keys, see the [API reference](https://developers.xsolla.com/zh/api/getting-started/#api_keys_overview).", "scheme": "basic", "type": "http" } } }, "info": { "description": "# Overview\n\n* **Version:** 2.0.0\n* **Servers**: `https://store.xsolla.com/api`\n* **[Contact Us by Email](mailto:integration@xsolla.com)**\n* **Contact URL:** https://xsolla.com/\n* **Required TLS version:** 1.2\n\nLiveOps is a toolkit for driving ongoing player engagement through promotions and personalized offers.\n\nUse the API to manage the following features:\n\n* **Promotions** — create and manage coupons, promo codes, discounts, and bonus campaigns.\n* **Personalization** — specify the conditions for displaying the item catalog and applying promotions only for certain authorized users.\n* **Promotion limits** — set a limit on how many times a promotion can be used by a user and configure scheduled resets for these limits.\n* **Reward chains & Value points** — configure reward progressions tied to value point accumulation.\n* **Daily chains** — set up recurring daily rewards to motivate regular logins.\n* **Offer chains** — build sequential purchase offers with per-step pricing and free reward options.\n* **Upsell** — a sales method in which the user is offered to buy an item with additional value.\n\n## API calls\n\nThe API is divided into the **following groups**:\n\n* **Admin** — calls for creating, updating, activating, and deleting campaigns and chain configurations. Authenticated via [basic access authentication](https://developers.xsolla.com/zh/payment-ui-and-flow/payment-ui/how-to-get-payment-token/#payments_solution_get_user_auth_token_basic_auth) with your merchant or project credentials.\n* **Client** — calls for retrieving available promotions, getting active chains, redeeming codes, and claiming rewards on behalf of authenticated end users. Authenticated via user JWT.\n\n# Authentication\n\nAPI calls require authentication either on behalf of a user or on behalf of a project. The authentication scheme used is specified in the **Security** section in the description of each call.\n\n## Authentication using user's JWT\n\nUser's JWT authentication is used when a request is sent from a browser, mobile application, or game. By default, the `XsollaLoginUserJWT` scheme is applied. For details on how to create a token, see the [Xsolla Login API documentation](/zh/api/login/authentication-schemes#getting-user-token).\n\nThe token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token:\n```\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI\n```\nAlternatively, you can use a [token for opening the payment UI](/zh/api/pay-station/token/create-token).\n\n## Basic HTTP authentication\n\nBasic HTTP authentication is used for server-to-server interactions, when an API call is sent directly from your server rather than from a user's browser or mobile application. HTTP Basic authentication with an [API key](/zh/api/getting-started/#api_keys_overview) is typically used.\n\n
Note

The API key is confidential and must not be stored or used in client applications.
\n\nWith basic server-side authentication, all API requests must include the following header:\n\n- for `basicAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `project_id:api_key` pair encoded in Base64\n- for `basicMerchantAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `merchant_id:api_key` pair encoded in Base64\n\nYou can find the parameter values in [Publisher Account](https://publisher.xsolla.com/):\n\n- `merchant_id` is displayed:\n - In **Company settings > Company**.\n - In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`.\n- `project_id` is displayed:\n - Next to the project name in Publisher Account.\n - In the URL in the browser address bar when working on a project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com//projects/`.\n- `api_key` is shown in Publisher Account only at the time of creation and must be stored securely on your side. You can create an API key in the following sections:\n - [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key)\n - [Project settings > API key](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n
Notice

If a required API call doesn't include the project_id path parameter, use an API key that is valid across all company projects for authorization.
\n\nFor more information about working with API keys, see the [API references](/zh/api/getting-started/#api_keys_overview).\n\n## Authentication with guest access support\n\nThe `AuthForCart` authentication scheme is used for cart purchases and supports two modes:\n\n1. **Authentication with a user's JWT.** The token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token:\n```\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI\n```\nAlternatively, you can use a [token for opening the payment UI](/zh/api/pay-station/token/create-token).\n\n2. **Simplified mode without Authorization header.** This mode is used only for unauthorized users and can be applied only for [game key sales](/zh/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers:\n - `x-unauthorized-id` with a request ID\n - `x-user` with the user's email address encoded in Base64\n\n## Useful links\n\n- [API calls by interaction model](https://developers.xsolla.com/zh/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/zh/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/zh/api/catalog/)\n- [API keys](https://developers.xsolla.com/zh/api/catalog/)\n\n# Core entity structure\n\nItems of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.\n\n
Note

Some calls may include additional fields but they don't change the basic structure.
\n\n**Identification**\n\n- `merchant_id` — company ID in [Publisher Account](https://publisher.xsolla.com/)\n- `project_id` — project ID in Publisher Account\n- `sku` — item SKU, unique within the project\n\n**Store display**\n\n- `name` — item name\n- `description` — item description\n- `image_url` — image URL\n- `is_enabled` — item availability\n- `is_show_in_store` — whether the item is displayed in the catalog\n\nFor more information about managing item availability in the catalog, see the [documentation](/zh/items-catalog/catalog-features/items-availability/).\n\n**Organization**\n\n- `type` — item type, for example, a virtual item (`virtual_item`) or bundle (`bundle`)\n- `groups` — groups the item belongs to\n- `order` — display order in the catalog\n\n**Sale conditions**\n\n- `prices` — prices in real or virtual currency\n- `limits` — purchase limits\n- `periods` — availability periods\n- `regions` — regional restrictions\n\n**Example of core entity structure:**\n\n```json\n{\n \"attributes\": [],\n \"bundle_type\": \"virtual_currency_package\",\n \"content\": [\n {\n \"description\": {\n \"en\": \"Main in-game currency\"\n },\n \"image_url\": \"https://.../image.png\",\n \"name\": {\n \"en\": \"Crystals\",\n \"de\": \"Kristalle\"\n },\n \"quantity\": 500,\n \"sku\": \"com.xsolla.crystal_2\",\n \"type\": \"virtual_currency\"\n }\n ],\n \"description\": {\n \"en\": \"Crystals x500\"\n },\n \"groups\": [],\n \"image_url\": \"https://.../image.png\",\n \"is_enabled\": true,\n \"is_free\": false,\n \"is_show_in_store\": true,\n \"limits\": {\n \"per_item\": null,\n \"per_user\": null,\n \"recurrent_schedule\": null\n },\n \"long_description\": null,\n \"media_list\": [],\n \"name\": {\n \"en\": \"Medium crystal pack\"\n },\n \"order\": 1,\n \"periods\": [\n {\n \"date_from\": null,\n \"date_until\": \"2020-08-11T20:00:00+03:00\"\n }\n ],\n \"prices\": [\n {\n \"amount\": 20,\n \"country_iso\": \"US\",\n \"currency\": \"USD\",\n \"is_default\": true,\n \"is_enabled\": true\n }\n ],\n \"regions\": [],\n \"sku\": \"com.xsolla.crystal_pack_2\",\n \"type\": \"bundle\",\n \"vc_prices\": []\n}\n```\n\n# Basic purchase flow\n\nThe Xsolla API allows you to implement in-game store logic, including retrieving the item catalog, managing the cart, creating orders, and tracking their status. Depending on the integration scenario, API calls are divided into **Admin** and **Catalog** subsections, which use different [authentication schemes](/zh/api/catalog/section/authentication).\n\nThe following example shows a basic flow for setting up and operating a store, from item creation to purchase.\n\n## Create items and groups (Admin)\n\nCreate an item catalog for your store, such as virtual items, bundles, or virtual currency.\n\nExample API calls:\n- [Create virtual item](/zh/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/zh/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/zh/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n\n## Set up promotions, chains, and limits (Admin)\n\nConfigure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains.\n\nExample API calls:\n- [Create bonus promotion](/zh/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/zh/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/zh/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer)\n\n## Get item information (Client)\n\nConfigure item display in your application.\n\n
\n Notice

\n Do not use API calls from the Admin subsection to build a user catalog. These API calls have rate limits and aren't intended for user traffic.\n
\n
\n\nExample API calls:\n- [Get virtual items list](/zh/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/zh/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/zh/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/zh/api/catalog/common-catalog/get-sellable-items)\n\n
\n Note

\n By default, catalog API calls return items that are currently available in the store at the time of the request. To retrieve items that are not yet available or are no longer available, include the parameter \"show_inactive_time_limited_items\": 1 in the catalog request.\n
\n\n## Sell items\n\nYou can sell items using the following methods:\n- Fast purchase — sell one SKU multiple times.\n- Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order.\n\nIf an item is purchased using virtual currency instead of real money, use the [Create order with specified item purchased by virtual currency](/zh/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API call. The payment UI is not required, as the charge is processed when the API call is executed.\n\nFor free item purchase, use the [Create order with specified free item](/zh/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/zh/api/catalog/free-item/create-free-order) API call. The payment UI is not required — the order is immediately set to the done status.\n\n### Fast purchase\n\nUse the client-side API call to [create an order with a specified item](/zh/api/catalog/payment-client-side/create-order-with-item). The call returns a token used to open the payment UI.\n\n
\n Note

\n Discount information is available to the user only in the payment UI. Promo codes are not supported.\n
\n\n### Cart purchase\n\nCart setup and purchase can be performed on the client or on the server side.\n\n**Set up and purchase a cart on the client**\n\nImplement the logic of adding and removing items by yourself. Before calling the API for setting up a cart, you will not have information about which promotions will be applied to the purchase. This means that the total cost and details of the added bonus items will not be known.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/zh/api/shop-builder/operation/cart-fill/) API call. The call returns the current information about the selected items (prices before and after discounts, bonus items).\n2. Update the cart contents based on user actions:\n - To add an item or change item quantity, use the [Update cart item by cart ID](/zh/api/shop-builder/operation/put-item-by-cart-id/) API call.\n - To remove an item, use the [Delete cart item by cart ID](/zh/api/shop-builder/operation/delete-item-by-cart-id/) API call.\n\n
\n Note

\n To get the current status of the cart, use the Get current user's cart API call.\n
\n\n3. Use the [Create order with all items from current cart](/zh/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n**Set up and purchase a cart on the server**\n\nThis setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/zh/api/catalog/cart-server-side) API call. The call returns current information about the selected items (prices before and after discounts, bonus items).\n2. Use the [Create order with all items from current cart](/zh/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n## Open payment UI\n\nUse the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the [documentation](/zh/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui).\n\n| Action | Endpoint |\n|:--------------------------------|:--------------------------------------------------------------------------|\n| Open in production environment. | https://secure.xsolla.com/paystation4/?token={token} |\n| Open in sandbox mode. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |\n\n
\n Note

\n Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use test bank cards.\n\n After the first real payment is made, a strict sandbox payment policy takes effect. A payment in sandbox mode is available only to users specified in [Publisher Account > Company settings > Users](https://publisher.xsolla.com/0/settings/users).\n\n Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in [Publisher Account](https://publisher.xsolla.com/), go to **Agreements & Taxes > Agreements**, complete the agreement form, and wait for confirmation. It may take up to 3 business days to review the agreement.\n
\n\nTo enable or disable sandbox mode, change the value of the `sandbox` parameter in the request for fast purchase and cart purchase. Sandbox mode is off by default.\n\nPossible order statuses:\n- `new` — order created\n- `paid` — payment received\n- `done` — item delivered\n- `canceled` — order canceled\n- `expired` — payment expired\n\nTrack order status using one of the following methods:\n- [webhooks configured on your server](/zh/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking)\n- [short-polling](/zh/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_short_polling)\n- [WebSocket API](/zh/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_websocket_api)\n\n## Useful links\n\n- Authentication\n- [API calls by interaction model](/zh/api/catalog/section/authentication)\n- [Payment testing](/zh/dev-resources/testing/general-info/#general_overview)\n- [Set up order status tracking](/zh/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?link=200-api#payments_integration_order_tracking)\n- [Webhooks](/zh/webhooks/overview)\n- [Rate limits](/zh/api/login/rate-limits)\n- [Errors handling](/zh/api/getting-started/#api_errors_handling)\n- [API keys](/zh/api/getting-started/#api_keys_overview)\n\n# Pagination\n\nAPI calls that return large sets of records (for example, when building a catalog) return data in pages. Pagination is a mechanism that limits the number of items returned in a single API response and allows you to retrieve subsequent pages sequentially.\n\nUse the following parameters to control the number of returned items:\n\n- `limit` — number of items per page\n- `offset` — index of the first item on the page (numbering starts from 0)\n- `has_more` — indicates whether another page is available\n- `total_items_count` — total number of items\n\nExample request:\n\n```\nGET /items?limit=20&offset=40\n```\n\nResponse example:\n\n```json\n{\n \"items\": [...],\n \"has_more\": true,\n \"total_items_count\": 135\n}\n```\n\nIt is recommended to send subsequent requests until the response returns `has_more = false`.\n\n# Date and time format\n\nDates and time values are passed in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n\nThe following are supported:\n\n- UTC offset\n- `null` value when there is no time restriction for displaying an item\n- [Unix timestamp](https://www.unixtimestamp.com/) (in seconds) used in some fields\n\nFormat: `YYYY-MM-DDTHH:MM:SS±HH:MM`\n\nExample: `2026-03-16T10:00:00+03:00`\n\n# Localization\n\nXsolla supports localization of user-facing fields such as item name and description. Localized values are passed as an object where the language code is used as the key. The full list of supported languages is available in the [documentation](/zh/doc/shop-builder/references/supported-languages/).\n\n**Supported fields**\n\nLocalization can be specified for the following parameters:\n\n- `name`\n- `description`\n- `long_description`\n\n**Locale format**\n\nThe locale key can be specified in one of the following formats:\n\n- Two-letter language code: `en`, `ru`\n- Five-letter language code: `en-US`, `ru-RU`, `de-DE`\n\n**Examples**\n\nExample with a two-letter language code:\n\n```json\n{\n \"name\": {\n \"en\": \"Starter Pack\",\n \"ru\": \"Стартовый набор\"\n }\n}\n```\n\nExample with a five-letter language code:\n\n```json\n{\n \"description\": {\n \"en-US\": \"Premium bundle\",\n \"de-DE\": \"Premium-Paket\"\n }\n}\n```\n\n# Error response format\n\nIf an error occurs, the API returns an HTTP status and a JSON response body. The full list of store-related errors is available in the [documentation](/zh/dev-resources/references/errors/store-errors/).\n\n**Response example:**\n\n```json\n{\n \"errorCode\": 1102,\n \"errorMessage\": \"Validation error\",\n \"statusCode\": 422,\n \"transactionId\": \"c9e1a...\"\n}\n```\n\n- `errorCode` — error code.\n- `errorMessage` — short error description.\n- `statusCode` — HTTP response status.\n- `transactionId` — request ID. Returned only in some cases.\n- `errorMessageExtended` — additional error details, such as request parameters. Returned only in some cases.\n\n**Extended response example:**\n\n```json\n{\n \"errorCode\": 7001,\n \"errorMessage\": \"Chain not found\",\n \"errorMessageExtended\": {\n \"chain_id\": \"test_chain_id\",\n \"project_id\": \"test_project_id\",\n \"step_number\": 2\n },\n \"statusCode\": 404\n}\n```\n\n**Common HTTP status codes**\n\n- `400` — invalid request\n- `401` — authentication error\n- `403` — insufficient permissions\n- `404` — resource not found\n- `422` — validation error\n- `429` — rate limit exceeded\n\n**Recommendations**\n\n- Handle the HTTP status and the response body together.\n- Use `errorCode` to process errors related to application logic.\n- Use `transactionId` to identify requests more quickly when analyzing errors.", "title": "LiveOps API", "version": "2.0.0" }, "openapi": "3.1.0", "paths": { "/v2/project/{project_id}/admin/code/limit/coupon/external_id/{external_id}": { "get": { "description": "获取代码可以使用的剩余次数。要筛选代码，请使用`codes`查询参数。\n\n要配置代码限制本身，请前往“管理”部分：\n *[优惠券](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-coupons/)", "operationId": "get-coupon-code-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" }, { "$ref": "#/components/parameters/codes-query-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-code-coupon-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Coupon not found": { "$ref": "#/components/examples/404-coupon-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "未找到商品。" }, "422": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" } }, "type": "object" } } }, "description": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取唯一优惠券码限制", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/code/limit/promocode/external_id/{external_id}": { "get": { "description": "获取代码可以使用的剩余次数。要筛选代码，请使用`codes`查询参数。\n\n要配置代码限制本身，请前往“管理”部分：\n *[促销码](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-promo-codes/)", "operationId": "get-promo-code-code-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" }, { "$ref": "#/components/parameters/codes-query-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-code-promo-code-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Promo code not found": { "$ref": "#/components/examples/404-coupon-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "未找到商品。" }, "422": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" } }, "type": "object" } } }, "description": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取代码的促销码限制", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/coupon/{external_id}/activate": { "put": { "description": "激活优惠券促销活动。\n默认情况下创建的优惠券促销活动为禁用状态。\n激活之前，不能进行兑换。\n使用此端点启用和激活优惠券促销活动。", "operationId": "activate-coupon", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "204": { "description": "优惠券已成功激活。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" }, "422": { "$ref": "#/components/responses/Promotions_422-admin-promotion-error" } }, "security": [ { "basicAuth": [] } ], "summary": "激活优惠券促销活动", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/coupon/{external_id}/code": { "get": { "description": "获取优惠券码。", "operationId": "get-coupon-codes", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-coupon-code-list" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "获取优惠券码", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建优惠券码。", "operationId": "create-coupon-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_create-coupon-promocode-code" }, "responses": { "201": { "$ref": "#/components/responses/Promotions_201-coupon-promocode-code-created" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" }, "422": { "$ref": "#/components/responses/Promotions_422-coupon-promocode-same-code-exists" } }, "security": [ { "basicAuth": [] } ], "summary": "创建优惠券码", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/coupon/{external_id}/code/generate": { "put": { "description": "生成优惠券码。", "operationId": "generate-coupon-codes", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "count": { "$ref": "#/components/schemas/Promotions_coupon-generate-count" } }, "required": [ "count" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "count": 10 } } }, "schema": { "properties": { "count": { "$ref": "#/components/schemas/Promotions_coupon-generate-count" } }, "type": "object" } } }, "description": "代码已成功生成。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promocode" } }, "security": [ { "basicAuth": [] } ], "summary": "生成优惠券码", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/coupon/{external_id}/deactivate": { "put": { "description": "停用优惠券促销活动。\n默认情况下创建的优惠券促销活动为禁用状态。\n激活之前，不能进行兑换。\n使用此端点禁用和停用优惠券促销活动。", "operationId": "deactivate-coupon", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "204": { "description": "优惠券已成功停用。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" }, "422": { "$ref": "#/components/responses/Promotions_422-admin-promotion-error" } }, "security": [ { "basicAuth": [] } ], "summary": "停用优惠券促销活动", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/daily_chain": { "get": { "description": "获取每日奖励列表以进行管理。\n
注意

此方法返回分页的商品列表。最大值和默认值为每个响应50项。如要从列表中获取更多项，请使用`limit`和`offset`参数并获取更多页。例如，当使用`limit = 25`和`offset = 100`调用方法时，响应将从整体列表中的第101项开始返回25项。
", "operationId": "admin-get-daily-chains", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/enabled-query-param" }, { "$ref": "#/components/parameters/is_expired-daily-chain-query-param" }, { "$ref": "#/components/parameters/type-daily-chain-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-list-daily-chains" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取每日奖励列表", "tags": [ "daily-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建每日奖励。", "operationId": "admin-create-daily-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-daily-chain" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-daily-chain" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-admin-create-error-list" } }, "security": [ { "basicAuth": [] } ], "summary": "创建每日奖励", "tags": [ "daily-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}": { "delete": { "description": "删除指定每日奖励。", "operationId": "admin-delete-daily-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/daily_chain_id-path-param" } ], "responses": { "204": { "content": {}, "description": "每日奖励删除成功。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-daily-chain-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "删除每日奖励", "tags": [ "daily-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取指定每日奖励以用于管理。", "operationId": "admin-get-daily-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/daily_chain_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-daily-chain" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-daily-chain-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "获取每日奖励", "tags": [ "daily-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新指定每日奖励。", "operationId": "admin-update-daily-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/daily_chain_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-daily-chain" }, "responses": { "204": { "content": {}, "description": "每日奖励更新成功。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-daily-chain-not-found" }, "422": { "$ref": "#/components/responses/422-admin-update-error-list" } }, "security": [ { "basicAuth": [] } ], "summary": "更新每日奖励", "tags": [ "daily-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/reset": { "post": { "description": "重置所有用户的每日奖励进度。仅适用于`rolling`类型每日奖励。", "operationId": "admin-reset-daily-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/daily_chain_id-path-param" } ], "responses": { "204": { "content": {}, "description": "每日奖励已重置。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-daily-chain-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "重置每日奖励", "tags": [ "daily-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/toggle": { "put": { "description": "启用或禁用每日奖励。", "operationId": "admin-toggle-daily-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/daily_chain_id-path-param" } ], "responses": { "204": { "content": {}, "description": "每日奖励已被禁用或启用。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-daily-chain-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "切换每日奖励", "tags": [ "daily-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/upsell": { "get": { "description": "检索项目中追加销售的信息：是否启用、追加销售的类型以及属于此追加销售的商品SKU列表。", "operationId": "get-upsell-configurations-for-project-admin", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "upsell": { "summary": "项目有追加销售", "value": [ { "is_enabled": true, "items": [ { "item_id": 1, "name": { "de": "Name des Artikels", "en": "Item's name" }, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good" }, { "bundle_type": "standard", "item_id": 2, "name": { "de": "Name des Artikels", "en": "Item's name" }, "sku": "com.xsolla.booster_mega_2", "type": "bundle" }, { "item_id": 3, "name": { "en": "Mega game" }, "sku": "com.xsolla.mega_game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam_key_1", "item_id": 4, "name": { "en": "Mega game steam" }, "sku": "com.xsolla.mega_game_steam_1" } ], "unit_type": "game" } ], "type": "fixed_list" } ] } }, "schema": { "items": { "properties": { "is_enabled": { "description": "项目是否启用了追加销售。", "example": true, "type": "boolean" }, "items": { "description": "项目中追加销售包含的商品SKU列表。", "example": [ { "item_id": 1, "name": { "de": "Name des Artikels", "en": "Item's name" }, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good" } ], "items": { "properties": { "bundle_type": { "$ref": "#/components/schemas/bundle_type" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "sku": { "$ref": "#/components/schemas/sku" }, "type": { "$ref": "#/components/schemas/item_type" }, "unit_items": { "description": "用于不同DRM的游戏密钥。", "items": { "description": "游戏密钥商品。它代表某个平台（steam、gog 等）上的游戏。", "properties": { "drm_name": { "$ref": "#/components/schemas/drm_name" }, "drm_sku": { "$ref": "#/components/schemas/drm_sku" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "sku": { "$ref": "#/components/schemas/sku" }, "type": { "$ref": "#/components/schemas/item_type" } }, "type": "object" }, "type": "array" }, "unit_type": { "$ref": "#/components/schemas/unit_type" } }, "type": "object" }, "type": "array" }, "type": { "description": "追加销售的类型。", "enum": [ "fixed_list", "most_sellable", "only_promotions" ], "example": "fixed_list", "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "用于项目中追加销售的配置详细信息和商品列表。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取项目中追加销售的信息", "tags": [ "upsell-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Creates an upsell for a project.
\n Notice

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "post-upsell", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-upsell" }, "responses": { "202": { "description": "已为该项目创建了追加销售。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "404": { "$ref": "#/components/responses/Upsell-404-item-not-found" }, "422": { "$ref": "#/components/responses/Upsell-422-invalid-request" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "创建追加销售", "tags": [ "upsell-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Update an upsell for a project.
\n Notice

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "put-upsell", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-upsell" }, "responses": { "202": { "description": "该项目的追加销售已更新。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "404": { "$ref": "#/components/responses/Upsell-404-item-not-found" }, "422": { "$ref": "#/components/responses/Upsell-422-invalid-request" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "更新追加销售", "tags": [ "upsell-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/upsell/{toggle}": { "put": { "description": "Changes an upsell’s status in a project to be either active or inactive.
\n Notice

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "put-upsell-toggle-active-inactive", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "激活状态。", "in": "path", "name": "toggle", "required": true, "schema": { "example": "activate", "type": "string" } } ], "responses": { "202": { "description": "项目中的追加销售已激活或停用。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "激活/停用项目的追加销售", "tags": [ "upsell-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/value_points": { "get": { "description": "获取项目内的奖励积分列表以用于管理。", "operationId": "admin-get-value-points-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-value-points" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取奖励积分列表", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建一个奖励积分。", "operationId": "admin-create-value-points", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-value-point" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-value-point" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "创建奖励积分", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/value_points/sku/{item_sku}": { "delete": { "description": "按SKU删除奖励积分。", "operationId": "admin-delete-value-point", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "content": {}, "description": "已成功删除奖励积分。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "删除奖励积分", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "根据项目中的SKU获取奖励积分以进行管理。", "operationId": "admin-get-value-point", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-value-point" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取奖励积分", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "按SKU更新奖励积分。", "operationId": "admin-update-value-point", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-value-point" }, "responses": { "204": { "content": {}, "description": "已成功更新奖励积分。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "更新奖励积分", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards": { "delete": { "description": "删除所有商品的奖励积分奖励。", "operationId": "admin-delete-items-value-point-reward", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/value_point_sku-path-param" } ], "responses": { "204": { "content": {}, "description": "已成功删除商品的奖励积分。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "删除商品的奖励积分", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取项目内有奖励积分的商品列表以用于管理。", "operationId": "admin-get-items-value-point-reward", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/value_point_sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-list-value-point-rewards" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取有奖励积分的商品列表", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "patch": { "description": "按照商品SKU来部分更新一个或多个商品的奖励积分数量。用户在购买指定商品后可获得这些奖励积分。\n\n更新奖励积分的原则：\n * 如果某个商品尚无奖励积分，则在`amount`字段中发送非零值将创建奖励积分。\n * 如果某个商品已有奖励积分，则在`amount`字段中发送非零值将更新原有值。\n * 如果`amount`设置为0，则会删除该商品的现有奖励积分。\n\n与`PUT`方法（[设置商品的奖励积分](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-set-items-value-point-reward/)）不同，此`PATCH`方法不会覆盖项目中所有商品的现有奖励积分，它只会更新指定的商品。\n\n单个请求最多可以更新100个商品。同一请求中不能包含重复的商品SKU。", "operationId": "admin-patch-items-value-point-reward", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/value_point_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/set-item-value-point-reward-for-patch" }, "responses": { "204": { "content": {}, "description": "已成功更新商品的奖励积分。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/sellable-item-by-sku_404" } }, "security": [ { "basicAuth": [] } ], "summary": "部分更新商品的奖励积分", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "按SKU将奖励积分分配给一件或多件商品。用户购买这些商品后将获得奖励积分。\n\n请注意，此PUT请求将覆盖项目中商品所有先前设置的奖励积分。\n\n为了避免无意中删除奖励积分，请在每个PUT请求中包含所有商品及其各自的奖励积分。\n\n如果只想更新特定商品的奖励积分，同时保留其他商品的奖励积分，则应使用GET请求检索当前的奖励积分集，修改所需商品的奖励积分，然后返回包含特定商品更新后奖励积分的奖励积分集。", "operationId": "admin-set-items-value-point-reward", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/value_point_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/set-item-value-point-reward" }, "responses": { "204": { "content": {}, "description": "已成功更新商品的奖励积分。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/sellable-item-by-sku_404" } }, "security": [ { "basicAuth": [] } ], "summary": "设置商品的奖励积分", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/offer_chain": { "get": { "description": "获取优惠链列表以用于管理。\n
注意

所有项目的单次响应中返回的商品数量都有上限。默认值和最大值为每次响应10个商品。如需更多数据，可通过limit与offset参数分页获取。
", "operationId": "admin-get-offer-chains", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/enabled-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-list-offer-chains" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取优惠链列表", "tags": [ "offer-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建优惠链。", "operationId": "admin-create-offer-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-offer-chain" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-offer-chain" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-create-error-list" } }, "security": [ { "basicAuth": [] } ], "summary": "创建优惠链", "tags": [ "offer-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}": { "delete": { "description": "删除指定优惠链。\n\n删除后：
  • 用户已收到的奖励保留。
  • 未完成步骤不再可用，不可再获取奖励。
\n\n与通过启停优惠链禁用优惠链不同，删除不可恢复，用户进度不保留。", "operationId": "admin-delete-offer-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/offer_chain_id-path-param" } ], "responses": { "204": { "content": {}, "description": "已成功删除优惠链。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-offer-chain-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "删除优惠链", "tags": [ "offer-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取指定优惠链以用于管理。", "operationId": "admin-get-offer-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/offer_chain_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-offer-chain" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-offer-chain-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "获取优惠链", "tags": [ "offer-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新指定优惠链。", "operationId": "admin-update-offer-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/offer_chain_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-offer-chain" }, "responses": { "204": { "content": {}, "description": "已成功更新优惠链。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-offer-chain-not-found" }, "422": { "$ref": "#/components/responses/422-update-error-list" } }, "security": [ { "basicAuth": [] } ], "summary": "更新优惠链", "tags": [ "offer-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}/toggle": { "put": { "description": "启用/禁用优惠链。\n\n禁用后，用户暂时无法访问，但进度保留。\n\n重新启用后，用户可从上次步骤的进度继续。", "operationId": "admin-toggle-offer-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/offer_chain_id-path-param" } ], "responses": { "204": { "content": {}, "description": "已禁用/启用优惠链。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-offer-chain-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "启停优惠链", "tags": [ "offer-chain-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/promocode/{external_id}/activate": { "put": { "description": "激活促销码活动。\n\n默认情况下创建的促销码活动为禁用状态。\n激活之前，不能进行兑换。\n使用此端点启用和激活促销码活动。", "operationId": "activate-promo-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "204": { "description": "促销码已成功激活。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promocode" }, "422": { "$ref": "#/components/responses/Promotions_422-admin-promotion-error" } }, "security": [ { "basicAuth": [] } ], "summary": "激活促销码活动", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/promocode/{external_id}/code": { "get": { "description": "获取促销码活动的促销码。", "operationId": "get-promocode-codes", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-promocode-code-list" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promocode" } }, "security": [ { "basicAuth": [] } ], "summary": "获取促销码活动的促销码", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "为促销码活动创建促销码。", "operationId": "create-promo-code-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_create-coupon-promocode-code" }, "responses": { "201": { "$ref": "#/components/responses/Promotions_201-coupon-promocode-code-created" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promocode" }, "422": { "$ref": "#/components/responses/Promotions_422-coupon-promocode-same-code-exists" } }, "security": [ { "basicAuth": [] } ], "summary": "创建促销码活动的促销码", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/promocode/{external_id}/code/generate": { "put": { "description": "生成促销码活动的促销码。", "operationId": "generate-promo-code-codes", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "count": { "$ref": "#/components/schemas/Promotions_coupon-generate-count" } }, "required": [ "count" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "count": 10 } } }, "schema": { "properties": { "count": { "$ref": "#/components/schemas/Promotions_coupon-generate-count" } }, "type": "object" } } }, "description": "代码已成功生成。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promocode" } }, "security": [ { "basicAuth": [] } ], "summary": "生成促销码活动的促销码", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/promocode/{external_id}/deactivate": { "put": { "description": "停用促销码活动。\n\n默认情况下创建的促销码活动为禁用状态。\n激活之前，不能进行兑换。\n使用此端点禁用和停用促销码活动。", "operationId": "deactivate-promo-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "204": { "description": "优惠券已成功停用。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promocode" }, "422": { "$ref": "#/components/responses/Promotions_422-admin-promotion-error" } }, "security": [ { "basicAuth": [] } ], "summary": "停用促销码活动", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/promotion/{promotion_id}/activate": { "put": { "description": "激活促销活动。", "operationId": "activate-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "responses": { "204": { "description": "促销活动已成功激活。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Promotions_422-activate-deactivate-promotion" } }, "security": [ { "basicAuth": [] } ], "summary": "激活促销活动", "tags": [ "promotions-common" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/promotion/{promotion_id}/deactivate": { "put": { "description": "停用促销活动。", "operationId": "deactivate-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "responses": { "204": { "description": "促销活动已成功停用。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Promotions_422-activate-deactivate-promotion" } }, "security": [ { "basicAuth": [] } ], "summary": "停用促销活动", "tags": [ "promotions-common" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/activate": { "put": { "description": "激活特别目录优惠促销活动。\n默认情况下创建的特别目录促销活动为禁用状态。\n激活之前，不能进行兑换。\n使用此端点启用和激活优惠券促销活动。", "operationId": "activate-unique-catalog-offer", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "204": { "description": "已成功激活特别目录优惠。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" }, "422": { "$ref": "#/components/responses/Promotions_422-admin-promotion-error" } }, "security": [ { "basicAuth": [] } ], "summary": "激活特别目录优惠促销活动", "tags": [ "promotions-unique-catalog-offers" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code": { "get": { "description": "获取特别目录优惠代码。", "operationId": "get-unique-catalog-offer-codes", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-unique-catalog-offer-code-list" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "获取特别目录优惠代码", "tags": [ "promotions-unique-catalog-offers" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建特别目录优惠代码。", "operationId": "create-unique-catalog-offer-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_create-coupon-promocode-code" }, "responses": { "201": { "$ref": "#/components/responses/Promotions_201-coupon-promocode-code-created" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" }, "422": { "$ref": "#/components/responses/Promotions_422-coupon-promocode-same-code-exists" } }, "security": [ { "basicAuth": [] } ], "summary": "创建特别目录优惠代码", "tags": [ "promotions-unique-catalog-offers" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code/generate": { "put": { "description": "生成特别目录优惠代码。", "operationId": "generate-unique-catalog-offer-codes", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "count": { "$ref": "#/components/schemas/Promotions_coupon-generate-count" } }, "required": [ "count" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "count": 10 } } }, "schema": { "properties": { "count": { "$ref": "#/components/schemas/Promotions_coupon-generate-count" } }, "type": "object" } } }, "description": "代码已成功生成。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promocode" } }, "security": [ { "basicAuth": [] } ], "summary": "生成特别目录优惠代码", "tags": [ "promotions-unique-catalog-offers" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/deactivate": { "put": { "description": "停用特别目录优惠促销活动。\n默认情况下创建的特别目录促销活动为禁用状态。\n激活之前，不能进行兑换。\n使用此端点禁用和停用优惠券促销活动。", "operationId": "deactivate-unique-catalog-offer", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "204": { "description": "特别目录优惠已成功停用。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" }, "422": { "$ref": "#/components/responses/Promotions_422-admin-promotion-error" } }, "security": [ { "basicAuth": [] } ], "summary": "停用特别目录优惠促销活动", "tags": [ "promotions-unique-catalog-offers" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/attribute/rule": { "get": { "description": "获取应用于用户属性的所有规则。", "operationId": "get-filter-rules", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/is_enabled-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "ork" } ], "is_enabled": true, "is_satisfied_for_unauth": false, "items": [ { "item_id": 1, "name": "Ork Armor", "sku": "com.xsolla.ork_armor_1", "type": "virtual_good" }, { "bundle_type": "standard", "item_id": 2, "name": "Potion pack", "sku": "com.xsolla.potion_pack_1", "type": "bundle" } ], "name": "Ork race armor rule", "rule_id": 1 } ], "total_items_count": 20 } } }, "schema": { "properties": { "has_more": { "description": "如果存在其他带规则的页面。", "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/user-attribute_personalized-catalog" }, "type": "array" }, "total_items_count": { "description": "规则总数。", "type": "number" } }, "type": "object" } } }, "description": "规则已成功接收。" }, "401": { "$ref": "#/components/responses/Common_401-complex" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" } }, "security": [ { "basicAuth": [] } ], "summary": "获取目录筛选规则列表", "tags": [ "personalized-catalog" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建用户属性的规则。", "operationId": "create-filter-rule", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/personalized-catalog_create-update-body" }, "responses": { "201": { "content": { "application/json": { "examples": { "response": { "value": { "rule_id": 1 } } }, "schema": { "properties": { "rule_id": { "description": "规则ID。", "type": "number" } }, "type": "object" } } }, "description": "规则已成功创建。" }, "401": { "$ref": "#/components/responses/Common_401-complex" }, "422": { "$ref": "#/components/responses/Common_422-body-validation" } }, "security": [ { "basicAuth": [] } ], "summary": "创建目录筛选规则", "tags": [ "personalized-catalog" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/attribute/rule/all": { "get": { "description": "获取所有目录规则列表以供在客户端搜索。\n
注意：

仅返回规则ID、名称和is_enabled
", "operationId": "get-all-filter-rules", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "is_enabled": true, "is_satisfied_for_unauth": false, "name": "Ork race armor rule", "rule_id": 1 }, { "is_enabled": false, "is_satisfied_for_unauth": false, "name": "Age", "rule_id": 2 } ] } } }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/user-attribute_personalized-catalog_all" }, "type": "array" } }, "type": "object" } } }, "description": "规则已成功接收。" }, "401": { "$ref": "#/components/responses/Common_401-complex" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" } }, "security": [ { "basicAuth": [] } ], "summary": "获取所有目录规则以供在客户端搜索", "tags": [ "personalized-catalog" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/attribute/rule/{rule_id}": { "delete": { "description": "删除指定规则。", "operationId": "delete-filter-rule-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/personalized-catalog-rule_id-path-param" } ], "responses": { "204": { "description": "删除成功。" }, "401": { "$ref": "#/components/responses/Common_401-complex" } }, "security": [ { "basicAuth": [] } ], "summary": "删除目录筛选规则", "tags": [ "personalized-catalog" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取应用于用户属性的指定规则。", "operationId": "get-filter-rule-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/personalized-catalog-rule_id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "attribute_conditions": [ { "attribute": "race", "can_be_missing": false, "operator": "eq", "type": "string", "value": "ork" } ], "is_enabled": true, "is_satisfied_for_unauth": true, "items": [ { "item_id": 1, "name": "Ork Armor", "sku": "com.xsolla.ork_armor_1" } ], "name": "Ork race armor rule", "rule_id": 1 } } }, "schema": { "$ref": "#/components/schemas/user-attribute_personalized-catalog" } } }, "description": "规则已成功接收。" }, "401": { "$ref": "#/components/responses/Common_401-complex" } }, "security": [ { "basicAuth": [] } ], "summary": "获取目录筛选规则", "tags": [ "personalized-catalog" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "patch": { "description": "更新应用于用户属性的指定规则。当前值将用于未指定的属性。", "operationId": "patch-filter-rule-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/personalized-catalog-rule_id-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "is_enabled": false }, "schema": { "$ref": "#/components/schemas/user-attribute_personalized-catalog-body" } } } }, "responses": { "204": { "description": "更新成功。" }, "401": { "$ref": "#/components/responses/Common_401-complex" }, "422": { "$ref": "#/components/responses/Common_422-body-validation" } }, "security": [ { "basicAuth": [] } ], "summary": "补丁目录筛选规则", "tags": [ "personalized-catalog" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新应用于用户属性的指定规则。默认值将用于未指定的属性（如果属性非必需）。", "operationId": "update-filter-rule-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/personalized-catalog-rule_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/personalized-catalog_create-update-body" }, "responses": { "204": { "description": "更新成功。" }, "401": { "$ref": "#/components/responses/Common_401-complex" }, "422": { "$ref": "#/components/responses/Common_422-body-validation" } }, "security": [ { "basicAuth": [] } ], "summary": "更新目录筛选规则", "tags": [ "personalized-catalog" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}": { "get": { "description": "获取指定用户可以使用优惠券的剩余次数。\n\n用户限制API允许您限制用户可以使用优惠券的次数。要配置用户限制数本身，请前往“管理”部分：\n* [优惠券](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-coupons/)", "operationId": "get-coupon-user-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" }, { "$ref": "#/components/parameters/user_external_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-coupon-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Coupon not found": { "$ref": "#/components/examples/404-coupon-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "未找到商品。" }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/Promotions_422-invalid-coupon" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取指定用户的优惠券限制", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/promocode/external_id/{external_id}": { "get": { "description": "获取指定用户可以使用促销码的剩余次数。\n\n用户限制API允许您限制用户可以使用促销码的次数。要配置用户限制数本身，请前往“管理”部分：\n* [促销码](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-promo-codes/)", "operationId": "get-promo-code-user-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" }, { "$ref": "#/components/parameters/user_external_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-promo-code-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Promo code not found": { "$ref": "#/components/examples/404-coupon-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "未找到商品。" }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/Promotions_422-invalid-coupon" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取指定用户的促销码限制", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/promotion/all": { "delete": { "description": "刷新指定用户所有促销活动的所有限制，以便其可以再次使用这些促销活动。\n\n用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分：\n* [折扣促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-discounts/)\n* [奖励促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-bonuses/)", "operationId": "reset-all-user-promotions-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/reset-user-limits" }, "responses": { "200": { "description": "已成功刷新促销活动限制。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "未找到商品。" }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "刷新指定用户的所有促销活动限制", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}": { "delete": { "description": "减少指定用户在应用的限制内可以使用促销活动的剩余次数。\n\n用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分：\n* [折扣促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-discounts/)\n* [奖励促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-bonuses/)", "operationId": "remove-user-promotion-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-strict" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-promotion-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-promotion-by-id-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "未找到商品。" }, "422": { "content": { "application/json": { "examples": { "Available promotion limit is out of range": { "$ref": "#/components/examples/422-promotion-out-of-range-available-user-limit" }, "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Promotion does not have configured user limits": { "$ref": "#/components/examples/422-promotion-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "无效请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "减少指定用户的促销活动限制", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取指定用户在应用的限制内可以使用促销活动的剩余次数。\n\n用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分：\n* [折扣促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-discounts/)\n* [奖励促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-bonuses/)", "operationId": "get-user-promotion-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" }, { "$ref": "#/components/parameters/user_external_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-promotion-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-promotion-by-id-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "未找到商品。" }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Promotion does not have configured user limits": { "$ref": "#/components/examples/422-promotion-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "无效请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取指定用户的促销活动限制", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "增加指定用户在应用的限制内可以使用促销活动的剩余次数。\n\n用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分：\n* [折扣促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-discounts/)\n* [奖励促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-bonuses/)", "operationId": "add-user-promotion-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-strict" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-promotion-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-promotion-by-id-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "未找到商品。" }, "422": { "content": { "application/json": { "examples": { "Available promotion limit is out of range": { "$ref": "#/components/examples/422-promotion-out-of-range-available-user-limit" }, "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Promotion does not have configured user limits": { "$ref": "#/components/examples/422-promotion-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "无效请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "增加指定用户的促销活动限制", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "在增加或减少次数后设置指定用户在应用的限制内可以使用促销活动的次数。\n\n用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分：\n* [折扣促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-discounts/)\n* [奖励促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-bonuses/)", "operationId": "set-user-promotion-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-flexible" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-promotion-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-promotion-by-id-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "未找到商品。" }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Promotion does not have configured user limits": { "$ref": "#/components/examples/422-promotion-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "无效请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "设置指定用户的促销活动限制", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}/all": { "delete": { "description": "刷新促销活动限制以便用户可以再次使用该促销活动。如果*user*参数为`null`，此调用将刷新所有用户的此限制。\n\n用户限制API允许您限制用户可以使用促销的次数。要自行配置用户限制，请前往所需促销活动类型的“管理”部分：\n* [折扣促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-discounts/)\n* [奖励促销活动](https://developers.xsolla.com/zh/api/shop-builder/tag/promotions-bonuses/)", "operationId": "reset-user-promotion-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/reset-user-limits-flexible" }, "responses": { "200": { "description": "已成功刷新促销活动限制。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-promotion-by-id-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "未找到商品。" }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Promotion does not have configured user limits": { "$ref": "#/components/examples/422-promotion-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "刷新用户的促销活动限制", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/coupon/code/{coupon_code}/rewards": { "get": { "description": "Gets coupons rewards by its code.\nCan be used to allow users to choose one of many items as a bonus.\nThe usual case is choosing a DRM if the coupon contains a game as a bonus (`type=unit`).
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "get-coupon-rewards-by-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/coupon_code-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-coupon-rewards" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "403": { "$ref": "#/components/responses/Promotions_403-auth-header" }, "404": { "$ref": "#/components/responses/Promotions_404-coupon" }, "422": { "$ref": "#/components/responses/Promotions_422-rewards" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取优惠券奖励", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/coupon/redeem": { "post": { "description": "Redeems a coupon code. The user gets a bonus after a coupon is redeemed.
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "redeem-coupon", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_redeem-coupon-model" }, "responses": { "200": { "$ref": "#/components/responses/Promotions_200-coupon-redeemed" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "403": { "$ref": "#/components/responses/Promotions_403-auth-header" }, "404": { "$ref": "#/components/responses/Promotions_404-coupon" }, "422": { "$ref": "#/components/responses/Promotions_422-redeem-coupon" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "兑换优惠券码", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/upsell": { "get": { "description": "Gets a list of upsell items in a project if they have already been set up.
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "get-upsell-for-project-client", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Upsell-200-get-client-list" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取项目中追加销售商品的列表", "tags": [ "upsell-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/promocode/code/{promocode_code}/rewards": { "get": { "description": "Gets promo code rewards by its code.\nCan be used to allow users to choose one of many items as a bonus.\nThe usual case is choosing a DRM if the promo code contains a game as a bonus (`type=unit`).
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "get-promo-code-rewards-by-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promocode_code-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-promocode-rewards" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "403": { "$ref": "#/components/responses/Promotions_403-auth-header" }, "404": { "$ref": "#/components/responses/Promotions_404-promo-code" }, "422": { "$ref": "#/components/responses/Promotions_422-rewards" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取促销码奖励", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/promocode/redeem": { "post": { "description": "兑换促销码活动的促销码。\n兑换促销码后，用户将获得免费商品和/或购物车和/或特定商品的价格折扣。", "operationId": "redeem-promo-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_redeem-promo-code-model" }, "responses": { "200": { "$ref": "#/components/responses/Promotions_200-promo-code-redeemed" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "403": { "$ref": "#/components/responses/Promotions_403-auth-header" }, "404": { "$ref": "#/components/responses/Promotions_404-promo-code" }, "422": { "$ref": "#/components/responses/Promotions_422-redeem-coupon" } }, "security": [ { "AuthForCart": [] } ], "summary": "兑换促销码", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/promocode/remove": { "put": { "description": "移除购物车的促销码。\n删除促销码后，将重新计算购物车中所有商品的总价，去掉促销码提供的奖励和折扣。", "operationId": "remove-cart-promo-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_cancel-promo-code-model" }, "responses": { "200": { "$ref": "#/components/responses/Promotions_200-promo-code-canceled" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "403": { "$ref": "#/components/responses/Promotions_403-auth-header" }, "422": { "$ref": "#/components/responses/Promotions_422-cancel-promo-code" } }, "security": [ { "AuthForCart": [] } ], "summary": "移除购物车的促销码", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/promotion/code/{code}/verify": { "get": { "description": "Determines if the code is a promo code or coupon code and if the user can apply it.
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "verify-promotion-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/code-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-verify-promo-code" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "403": { "$ref": "#/components/responses/Promotions_403-auth-header" }, "404": { "$ref": "#/components/responses/Promotions_404-verify-promo-code" }, "422": { "$ref": "#/components/responses/Promotions_422-verify-promo-code" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "验证促销码", "tags": [ "promotions-common" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/clan/contributors/{reward_chain_id}/top": { "get": { "description": "Retrieves the list of top 10 contributors to the specific reward chain under the current user's clan. If a user doesn't belong to a clan, the call returns an empty array.
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "get-user-clan-top-contributors", "parameters": [ { "description": "项目ID。", "in": "path", "name": "project_id", "required": true, "schema": { "example": 44056, "type": "integer" } }, { "description": "奖励链ID。", "in": "path", "name": "reward_chain_id", "required": true, "schema": { "example": 101, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "clan": { "summary": "用户有一个公会", "value": [ { "contributed_amount": 555, "name": "winner" }, { "contributed_amount": 398, "name": "Rocket" }, { "contributed_amount": 201, "name": "MrJoe" }, { "contributed_amount": 1, "name": "beginner" } ] }, "without-clan": { "summary": "用户不属于任何公会", "value": [] } }, "schema": { "items": { "properties": { "contributed_amount": { "description": "用户贡献的奖励积分数。", "example": 100, "type": "integer" }, "name": { "description": "用户ID。这是授权过程中发送给艾克索拉的ID，用于将用户关联到您的艾克索拉登录管理器项目。", "example": "Rocket", "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "公会奖励链贡献者前10名列表。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取公会名下奖励链的前10名贡献者列表", "tags": [ "clan-reward-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/clan/update": { "put": { "description": "Updates a current user's clan via user attributes. Claims all rewards from reward chains that were not claimed for a previous clan and returns them in the response. If the user was in a clan and now is not — their inclusion in the clan will be revoked. If the user changed the clan — the clan will be changed.
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "user-clan-update", "parameters": [ { "description": "项目ID。", "in": "path", "name": "project_id", "required": true, "schema": { "default": 44056, "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/200-client-update-user-clan" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "更新当前用户的公会", "tags": [ "clan-reward-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/daily_chain": { "get": { "description": "Client endpoint. Gets the current user's daily rewards.\n
Notice

A method returns a paginated list of items. The maximum and default value is 50 items per response. To get more items from the list, use the limit and offset parameters and fetch more pages. For example, when calling a method with limit = 25 and offset = 100, the response returns 25 items starting from the 101st item in the overall list.

\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "get-daily-chains-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-client-get-daily-chains-list" }, "401": { "$ref": "#/components/responses/401-client-auth-error" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取当前用户的每日奖励", "tags": [ "daily-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/daily_chain/{daily_chain_id}": { "get": { "description": "Client endpoint. Gets the current user’s daily reward by its ID.
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "get-user-daily-chain-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/daily_chain_id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-client-daily-chain" } }, "schema": { "$ref": "#/components/schemas/client-daily-chain-model" } } }, "description": "用户每日奖励检索成功。" }, "404": { "$ref": "#/components/responses/404-daily-chain-not-found" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "通过ID获取当前用户的每日奖励", "tags": [ "daily-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/daily_chain/{daily_chain_id}/step/number/{step_number}/claim": { "post": { "description": "Client endpoint. Claims the current user's step reward from a daily reward. All steps can only be claimed in sequential order. The reward for a missed step cannot be obtained for virtual or real currency, or by watching an ad
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "claim-user-daily-chain-step-reward", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/daily_chain_id-path-param" }, { "$ref": "#/components/parameters/daily_chain_step_number-path-param" } ], "responses": { "204": { "description": "成功领取当前用户每日奖励步骤的奖励。" }, "401": { "$ref": "#/components/responses/401-client-auth-error" }, "404": { "$ref": "#/components/responses/404-daily-chain-step-not-found" }, "422": { "content": { "application/json": { "examples": { "invalid-step": { "$ref": "#/components/examples/422-daily-chain-claim-error-invalid-step" } }, "schema": { "$ref": "#/components/schemas/daily-chain-error-model" } } }, "description": "该步骤无法领取。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "领取每日奖励步骤", "tags": [ "daily-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/offer_chain": { "get": { "description": "Gets the current user’s offer chains.\n
Notice

All projects have a limit on the number of items that can be returned in a single response. The default and maximum value is 30 items per response. To get more data, use the limit and offset query parameters for pagination.

\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "get-offer-chains-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-client-get-offer-chains-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取当前用户的优惠链", "tags": [ "offer-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/offer_chain/{offer_chain_id}": { "get": { "description": "Gets the current user’s offer chain by the offer chain's ID.
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "get-user-offer-chain-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/offer_chain_id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-client-offer-chain" } }, "schema": { "$ref": "#/components/schemas/client-offer-chain-model" } } }, "description": "成功获取用户的优惠链。" }, "404": { "$ref": "#/components/responses/404-offer-chain-not-found" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "根据ID获取当前用户的优惠链", "tags": [ "offer-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/claim": { "post": { "description": "Completes the current user’s progression through the offer chain step and grants the associated reward.\n
\n Notice

\n Use this call only for free steps in the offer chain.\n For steps that require payment in real currency, use the Create order for paid offer chain step call instead.\n

\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "claim-user-offer-chain-step-reward", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/offer_chain_id-path-param" }, { "$ref": "#/components/parameters/offer_chain_step_number-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641 } } }, "schema": { "properties": { "order_id": { "description": "订单ID。", "type": "integer" } }, "type": "object" } } }, "description": "成功领取了免费步骤且奖励发放成功。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "404": { "$ref": "#/components/responses/404-offer-chain-step-not-found" }, "422": { "content": { "application/json": { "examples": { "invalid-step": { "$ref": "#/components/examples/422-offer-chain-claim-error-invalid-step" } }, "schema": { "$ref": "#/components/schemas/offer-chain-error-model" } } }, "description": "该步骤不可领取。请确保前置步骤已完成且该步骤标记为免费。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "领取免费优惠链步骤奖励", "tags": [ "offer-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/order": { "post": { "description": "Creates an order for the item associated with the specified paid offer chain step. The created order gets the `new` order status.\n\nTo open the payment UI in a new window, use the following link: `https://secure.xsolla.com/paystation4/?token={token}`, where `{token}` is the received token.\n\nFor testing purposes, use this URL: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\n
\n Notice

\n This method must be used on the client side. The user's IP address is used to determine the country, which affects the currency and available payment methods. Using this method from the server side may result in incorrect currency detection and affect payment methods in Pay Station.\n

\n\n
\n Notice

\n Use this call only for paid offer chain steps.\n For free steps, use the Claim free offer chain step call instead.\n
\n
\n
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "order-user-offer-chain-step-reward", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/offer_chain_id-path-param" }, { "$ref": "#/components/parameters/offer_chain_step_number-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-order-created" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "404": { "$ref": "#/components/responses/404-offer-chain-step-not-found" }, "422": { "content": { "application/json": { "examples": { "invalid-step": { "$ref": "#/components/examples/422-offer-chain-claim-error-invalid-step" } }, "schema": { "$ref": "#/components/schemas/offer-chain-error-model" } } }, "description": "该步骤不可购买。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "为付费优惠链步骤创建订单", "tags": [ "offer-chain-client", "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/reward_chain": { "get": { "description": "Client endpoint. Gets the current user’s reward chains.\n
\n Attention

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

\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "get-reward-chains-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-client-get-reward-chains-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取当前用户的奖励链", "tags": [ "reward-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/reward_chain/{reward_chain_id}/balance": { "get": { "description": "Client endpoint. Gets the current user’s value point balance.
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "get-user-reward-chain-balance", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/reward_chain_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-client-get-user-reward-chain-balance" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取当前用户的奖励积分余额", "tags": [ "reward-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/user/reward_chain/{reward_chain_id}/step/{step_id}/claim": { "post": { "description": "Client endpoint. Claims the current user’s step reward from a reward chain.
\n Note

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "claim-user-reward-chain-step-reward", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/reward_chain_id-path-param" }, { "$ref": "#/components/parameters/reward_chain_step_id-path-param" } ], "responses": { "204": { "description": "成功从奖励链中领取当前用户的步骤奖励。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-client-auth" }, "404": { "$ref": "#/components/responses/404-reward-chain-step-not-found" }, "422": { "$ref": "#/components/responses/422-reward-chain-step-reward-can-not-claimed" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "领取步骤奖励", "tags": [ "reward-chain-client" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v3/project/{project_id}/admin/coupon": { "get": { "description": "获取项目的优惠券促销活动列表。", "operationId": "get-coupons", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-get-coupons" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取优惠券促销活动列表", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建优惠券促销活动。", "operationId": "admin-create-coupon", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_coupon-create" }, "responses": { "201": { "content": { "application/json": { "examples": { "response": { "value": { "external_id": "coupon_external_id" } } }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/Promotions_coupon-external_id" } }, "type": "object" } } }, "description": "优惠券已成功创建。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Promotions_422-invalid-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "创建优惠券促销活动", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/coupon/{external_id}": { "delete": { "description": "删除[优惠券促销活动](https://developers.xsolla.com/zh/doc/shop-builder/features/coupons/)。删除的促销活动将：\n * 从您项目中设置的促销活动列表中消失。\n* 不再适用于商品目录。用户无法通过该促销活动获得奖励商品。\n\n删除后，该促销活动无法恢复。\n已删除促销活动的优惠券代码可以[添加到](https://developers.xsolla.com/zh/api/shop-builder/operation/create-coupon-code/)现有的促销活动。", "operationId": "delete-coupon-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "204": { "description": "优惠券促销活动成功删除。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "删除优惠券促销活动", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取指定的优惠券促销活动。", "operationId": "get-coupon", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "bonus": [ { "quantity": 100, "sku": "com.xsolla.diamonds_1" } ], "external_id": "summer20221", "is_enabled": true, "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ], "redeem_code_limit": null, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } } } }, "schema": { "$ref": "#/components/schemas/admin-promotions_200-get-coupon-promotion-model" } } }, "description": "优惠券已成功收到。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "获取优惠券促销活动", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新优惠券促销活动。", "operationId": "update-coupon-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_coupon-update" }, "responses": { "204": { "description": "优惠券已成功更新。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" }, "422": { "$ref": "#/components/responses/Promotions_422-invalid-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "更新优惠券促销活动", "tags": [ "promotions-coupons" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/promocode": { "get": { "description": "获取项目的促销码列表。", "operationId": "get-promo-codes", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-get-promocodes" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取促销码活动列表", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建促销码活动。", "operationId": "create-promo-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_promocode-create" }, "responses": { "201": { "content": { "application/json": { "examples": { "response": { "value": { "external_id": "coupon_external_id" } } }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/Promotions_coupon-external_id" } }, "type": "object" } } }, "description": "促销码已成功创建。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Promotions_422-invalid-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "创建促销码活动", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/promocode/{external_id}": { "delete": { "description": "删除[促销码活动](https://developers.xsolla.com/zh/doc/shop-builder/features/promo-codes/)。删除的促销活动将：\n * 从您项目中设置的促销活动列表中消失。\n* 不再适用于商品目录和购物车。用户无法通过该促销活动获得奖励商品或购买商品。\n\n删除后，该促销活动无法恢复。\n已删除促销活动的促销码可以[添加到](https://developers.xsolla.com/zh/api/shop-builder/operation/create-promo-code-code/)现有的促销活动。", "operationId": "delete-promo-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "204": { "description": "成功删除促销码活动。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promocode" } }, "security": [ { "basicAuth": [] } ], "summary": "删除促销码活动", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取指定的促销码活动。", "operationId": "get-promo-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "simple": { "value": { "bonus": [ { "quantity": 100, "sku": "com.xsolla.diamonds_1" } ], "discount": { "percent": "10.99" }, "discounted_items": null, "excluded_promotions": [ 23, 45 ], "external_id": "summer20221", "is_enabled": true, "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } } }, "with item price conditions": { "value": { "bonus": [ { "quantity": 100, "sku": "com.xsolla.diamonds_3" } ], "discount": { "percent": "10.99" }, "discounted_items": null, "excluded_promotions": [ 23, 45 ], "external_id": "summer20221", "is_enabled": true, "item_price_conditions": [ { "operator": "gt", "value": "10.0000" }, { "operator": "lt", "value": "50.0000" } ], "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } } }, "with price conditions": { "value": { "bonus": [ { "quantity": 100, "sku": "com.xsolla.diamonds_2" } ], "discount": { "percent": "10.99" }, "discounted_items": null, "external_id": "summer20221", "is_enabled": true, "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "price_conditions": [ { "operator": "gt", "value": "10.0000" }, { "operator": "lt", "value": "50.0000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } } } }, "schema": { "$ref": "#/components/schemas/Promotions_200-get-promocode-promotion-model" } } }, "description": "已成功收到促销码。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promocode" } }, "security": [ { "basicAuth": [] } ], "summary": "获取促销码活动", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新促销码活动。", "operationId": "update-promo-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_promocode-update" }, "responses": { "204": { "description": "促销码已成功更新。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promocode" }, "422": { "$ref": "#/components/responses/Promotions_422-invalid-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "更新促销码活动", "tags": [ "promotions-promo-codes" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/promotion": { "get": { "description": "获取项目的促销活动列表。", "operationId": "get-promotion-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/enabled-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-get-promotions" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取所有促销活动列表", "tags": [ "promotions-common" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/promotion/bonus": { "get": { "description": "获取项目的奖励促销活动列表。\n\n促销活动对进行购买的用户给予免费的奖励商品。\n促销活动可以应用于项目中的任何购买或包含特定商品的购买。", "operationId": "get-bonus-promotion-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-get-bonus-promotions" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取奖励促销活动列表", "tags": [ "promotions-bonuses" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建奖励促销活动。\n\n促销活动对进行购买的用户给予免费的奖励商品。\n促销活动可以应用于项目中的任何购买或包含特定商品的购买。", "operationId": "create-bonus-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_create-update-bonus-promotion" }, "responses": { "201": { "$ref": "#/components/responses/Promotions_201-create-promotion" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Promotions_422-admin-promotion-missed-bonus-property" } }, "security": [ { "basicAuth": [] } ], "summary": "创建奖励促销活动", "tags": [ "promotions-bonuses" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/promotion/item": { "get": { "description": "获取项目的商品促销列表。\n\n促销活动提供商品折扣(%)。\n折扣应用于指定商品的所有价格。", "operationId": "get-item-promotion-list", "parameters": [ { "description": "项目ID。", "in": "path", "name": "project_id", "required": true, "schema": { "default": 59080, "type": "integer" } }, { "description": "页面上元素数量的限制。", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "元素编号，从该元素开始生成列表（从0开始数）。", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-get-item-promotions" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取商品促销活动列表", "tags": [ "promotions-discounts" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "为商品创建折扣促销活动。\n\n促销活动提供商品折扣(%)。\n折扣将应用于指定商品的所有价格。", "operationId": "create-item-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_create-update-item-promotion" }, "responses": { "201": { "$ref": "#/components/responses/Promotions_201-create-promotion" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Promotions_422-admin-promotion-missed-items-property" } }, "security": [ { "basicAuth": [] } ], "summary": "为商品创建折扣促销活动", "tags": [ "promotions-discounts" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/promotion/redeemable/code/{code}": { "get": { "description": "通过促销码或优惠券码获取促销活动。", "operationId": "get-redeemable-promotion-by-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/code-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-redeemable-by-code" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-code-not-found" }, "405": { "$ref": "#/components/responses/405-method-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "通过代码获取兑换型促销活动", "tags": [ "promotions-common" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus": { "delete": { "description": "删除[奖励促销活动](https://developers.xsolla.com/zh/doc/shop-builder/features/bonuses/)。删除的促销活动将：\n * 从您项目中设置的促销活动列表中消。失\n* 不再适用于商品目录和购物车。用户无法通过该促销活动获得奖励商品。\n\n删除后，该促销活动无法恢复。", "operationId": "delete-bonus-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "responses": { "204": { "description": "成功删除促销活动。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promotion" } }, "security": [ { "basicAuth": [] } ], "summary": "删除奖励促销活动", "tags": [ "promotions-bonuses" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取奖励促销活动。\n\n促销活动对进行购买的用户给予免费的奖励商品。\n促销活动可以应用于项目中的任何购买或包含特定商品的购买。", "operationId": "get-bonus-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-admin-get-bonus-promotion" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promotion" } }, "security": [ { "basicAuth": [] } ], "summary": "获取奖励促销活动", "tags": [ "promotions-bonuses" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新促销活动。\n\n
注意

如果只想更新促销活动的一部分，也应在请求中传输所有必需数据。
\n\n促销活动对进行购买的用户给予免费的奖励商品。\n促销活动可以应用于项目中的任何购买或包含特定商品的购买。", "operationId": "update-bonus-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_create-update-bonus-promotion" }, "responses": { "204": { "description": "促销活动已成功更新。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Promotions_422-admin-promotion-missed-bonus-property" } }, "security": [ { "basicAuth": [] } ], "summary": "更新奖励促销活动", "tags": [ "promotions-bonuses" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/promotion/{promotion_id}/item": { "delete": { "description": "删除[折扣促销活动](https://developers.xsolla.com/zh/doc/shop-builder/features/discounts/)。删除的促销活动将：\n * 从您项目中设置的促销活动列表中消失。\n* 不再适用于商品目录和购物车。用户无法通过该促销活动购买商品。\n\n删除后，该促销活动无法恢复。", "operationId": "delete-item-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "responses": { "204": { "description": "成功删除促销活动。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promotion" } }, "security": [ { "basicAuth": [] } ], "summary": "删除商品促销活动", "tags": [ "promotions-discounts" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取应用于特定商品的促销活动。\n\n促销提供商品折扣 (%)。\n折扣将应用于指定商品的所有价格。", "operationId": "get-item-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "discount": { "percent": "20.00" }, "excluded_promotions": [ 23, 45 ], "id": 1, "is_enabled": true, "items": [ { "sku": "com.xsolla.elven_helmet_1" }, { "sku": "com.xsolla.elven_armor_1" } ], "limits": { "per_item": null, "per_user": { "total": 10 }, "recurrent_schedule": { "per_user": { "day_of_month": null, "day_of_week": null, "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "name": { "en-US": "Promotion", "ru-RU": "Акция" }, "price_conditions": [ { "operator": "ge", "value": "10.0000" }, { "operator": "le", "value": "50.0000" } ], "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] } } }, "schema": { "example": { "discount": { "percent": "15.00" }, "id": 1, "is_enabled": true, "items": [ { "sku": "com.xsolla.elven_sword_1" }, { "sku": "com.xsolla.elven_helmet_1" }, { "sku": "com.xsolla.elven_armor_1" } ], "name": { "en-US": "Promotion", "ru-RU": "Акция" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" } ] }, "properties": { "attribute_conditions": { "$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get" }, "discount": { "properties": { "percent": { "default": "10.00", "description": "百分比折扣。\n商品价格使用此百分比计算打折价格。", "type": [ "string", "null" ] } }, "type": "object" }, "excluded_promotions": { "$ref": "#/components/schemas/excluded_promotions" }, "id": { "description": "促销活动ID。项目内的唯一促销活动标识符。", "type": "integer" }, "is_enabled": { "$ref": "#/components/schemas/Promotions_is_enabled" }, "items": { "items": { "description": "适用折扣的商品列表。", "properties": { "sku": { "default": "elven_sword", "description": "商品SKU。", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "limits": { "$ref": "#/components/schemas/Promotions_promotion_limits_response" }, "name": { "additionalProperties": { "example": { "en-US": "Promotion", "ru-RU": "Акция" }, "type": "string" }, "description": "促销活动名称。应包含键/值对，\n其中键是格式为\"^[a-z]{2}-[A-Z]{2}$\"的区域设置，值是字符串。", "type": "object" }, "price_conditions": { "$ref": "#/components/schemas/price_conditions_discount" }, "promotion_periods": { "$ref": "#/components/schemas/promotion_periods" } }, "type": "object" } } }, "description": "已成功收到商品促销活动。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9502, "errorMessage": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 9502, "type": "integer" }, "errorMessage": { "example": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "未找到促销活动。请确保`promotion_id`正确无误。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取商品促销活动", "tags": [ "promotions-discounts" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新促销活动。\n\n
注意

新数据将替换旧数据。如果只想更新促销活动的一部分，也应在请求中传输所有必需数据。
\n\n促销提供商品折扣(%)。\n折扣将应用于指定商品的所有价格。", "operationId": "update-item-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/promotion_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_create-update-item-promotion" }, "responses": { "204": { "description": "促销活动已成功更新。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-promotion" }, "422": { "$ref": "#/components/responses/Promotions_422-admin-promotion-missed-items-property" } }, "security": [ { "basicAuth": [] } ], "summary": "更新商品促销活动", "tags": [ "promotions-discounts" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/reward_chain": { "get": { "description": "获取奖励链列表。\n\n
注意：

所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应10项。要逐页获取更多数据，请使用limit和offset字段。
", "operationId": "admin-get-reward-chains", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/enabled-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-list-reward-chains" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取奖励链列表", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建奖励链。", "operationId": "admin-create-reward-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-reward-chain" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-reward-chain" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "创建奖励链", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}": { "delete": { "description": "删除特定奖励链。", "operationId": "admin-delete-reward-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/reward_chain_id-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/204-admin-delete-reward-chain" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "删除奖励链", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取特定奖励链。", "operationId": "admin-get-reward-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/reward_chain_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-reward-chain" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-admin-reward-chain-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "获取奖励链", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新特定奖励链。", "operationId": "admin-update-reward-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/reward_chain_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-reward-chain" }, "responses": { "204": { "$ref": "#/components/responses/204-admin-update-reward-chain" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-admin-reward-chain-not-found" }, "422": { "$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "更新奖励链", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/reset": { "post": { "description": "Resets the value points balance and progress of all users in the reward chain.
The balance is tied to the value points type, not to a specific reward chain. If these value points are used in other chains, the balance will be reset in all chains that use these value points.
After the reset, you can update the reward chain’s validity period, and users will be able to progress through it again.
The clan balance is calculated as the sum of its members’ balances. Therefore, after the reset, the clan balance is also reset.
This request is irreversible and applies to all users of the project.\n\n
Notice\n

\n You should not reset the reward chain during its validity period. In this case, users may lose earned value points before they claim their reward.\n
", "operationId": "admin-reset-reward-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/reward_chain_id-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/204-admin-reset-reward-chain" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "重置奖励链", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/toggle": { "put": { "description": "启用/禁用奖励链。", "operationId": "admin-toggle-reward-chain", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/reward_chain_id-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/204-admin-toggle-reward-chain" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "开关奖励链", "tags": [ "reward-chain-value-points-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/unique_catalog_offer": { "get": { "description": "获取项目的特别目录优惠促销活动的列表。", "operationId": "get-unique-catalog-offers", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Promotions_200-get-unique-catalog-offers" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "获取特别目录优惠促销活动列表", "tags": [ "promotions-unique-catalog-offers" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建一个特别目录优惠促销活动。", "operationId": "admin-create-unique-catalog-offer", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_unique_catalog_offer-create" }, "responses": { "201": { "content": { "application/json": { "examples": { "response": { "value": { "external_id": "coupon_external_id" } } }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/Promotions_coupon-external_id" } }, "type": "object" } } }, "description": "已成功创建特别目录优惠。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Promotions_422-invalid-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "创建特别目录优惠促销活动", "tags": [ "promotions-unique-catalog-offers" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}": { "delete": { "description": "删除[特别目录优惠促销活动](https://developers.xsolla.com/zh/doc/shop-builder/features/unique-offer/)。删除的促销活动将：\n * 从您项目中设置的促销活动列表中消失。\n* 不再适用于商品目录和购物车。用户无法通过该促销活动购买商品。\n\n删除后，该促销活动无法恢复。", "operationId": "delete-unique-catalog-offer-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "204": { "description": "成功删除特别目录优惠。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "删除特别目录优惠促销活动", "tags": [ "promotions-unique-catalog-offers" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取指定的特别目录优惠促销活动。", "operationId": "get-unique-catalog-offer", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "external_id": "secret_shop", "is_enabled": true, "items": [ "helmet", "sword", "shield" ], "name": { "en-US": "Secret shop", "ru-RU": "Секретный магазин" }, "promotion_periods": [ { "date_from": "2020-04-15T18:16:00+05:00", "date_until": "2020-04-25T18:16:00+05:00" }, { "date_from": "2020-05-15T18:16:00+05:00", "date_until": "2020-05-25T18:16:00+05:00" } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } } } }, "schema": { "$ref": "#/components/schemas/Promotions_200-get-unique-catalog-offer-promotion-model" } } }, "description": "已成功收到特别目录优惠。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "获取特别目录优惠促销活动", "tags": [ "promotions-unique-catalog-offers" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新特别目录优惠促销活动。", "operationId": "update-unique-catalog-offer-promotion", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-promotion-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Promotions_unique_catalog_offer-update" }, "responses": { "204": { "description": "特别目录优惠已成功更新。" }, "401": { "$ref": "#/components/responses/Promotions_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Promotions_404-admin-coupon" }, "422": { "$ref": "#/components/responses/Promotions_422-invalid-coupon" } }, "security": [ { "basicAuth": [] } ], "summary": "更新特别目录优惠促销活动", "tags": [ "promotions-unique-catalog-offers" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } } }, "servers": [ { "url": "https://store.xsolla.com/api" } ], "tags": [ { "description": "Promotions are marketing tools designed to attract new users and increase sales. Using Xsolla API, you can configure the following promotions:\n\n* Discounts — reduced prices on selected items.\n* Bonuses — items granted to users along with their purchase.\n* Coupons — codes that allow users to receive one or more bonus items when redeeming.\n* Promo codes — codes that allow users to receive bonus items, a discount on a specific item, or a discount on the entire cart. Unlike coupons that are redeemed after the user enters them, promo codes are redeemed during a purchase (at checkout).\n* Unique offers — hidden items displayed in the catalog to users who have entered a unique offer code. If the code is not entered, the items are not displayed.\n\nExample flow for configuring a discount promotion:\n1. Create items using the calls from the **Admin** subsection of the [Virtual items and currency](/zh/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list/), [Bundles](/zh/api/catalog/bundles-admin/admin-create-bundle), or [Game keys](/zh/api/catalog/game-keys-admin) groups.\n2. Create a promotion using the [Create discount promotion for item](/zh/api/liveops/promotions-discounts/create-item-promotion/) call. In the `items` array, pass the necessary item SKUs.\n3. Set up promotion validity periods. To do this, call the [Create discount promotion for item](/zh/api/liveops/promotions-discounts/create-item-promotion/) or [Update item promotion](/zh/api/liveops/promotions-discounts/update-item-promotion/) methods, and pass the `promotion_periods` field as an array of objects where `date_from` defines the start, and `date_until` defines the end date of the validity period.\n4. Activate a promotion using the [Update item promotion](/zh/api/liveops/promotions-discounts/update-item-promotion/) call. Pass the `\"is_enabled\": true` parameter.\n5. To get information about item prices, including discounted prices, call the client API methods for getting an item catalog from the [Common > Catalog](/zh/api/catalog/tag/common-catalog/), [Virtual Items and Currency > Catalog](/zh/api/catalog/virtual-items-currency-catalog/get-virtual-items/), and [Bundles > Catalog](/zh/api/catalog/bundles-catalog/get-bundle-list/) subsections.\n\n![Promotion configuration example](https://cdn.xsolla.net/developers/current/images/api_docs/promo-overview.svg)\n\nRefer to our documentation for detailed information about configuring promotions:\n* [Discounts](https://developers.xsolla.com/zh/liveops/promotion-tools/discounts/)\n* [Bonuses](https://developers.xsolla.com/zh/liveops/promotion-tools/bonuses/)\n* [Coupons](https://developers.xsolla.com/zh/liveops/promotion-tools/coupons/)\n* [Promo codes](https://developers.xsolla.com/zh/liveops/promotion-tools/promo-codes/)\n* [Unique catalog offers](https://developers.xsolla.com/zh/liveops/promotion-tools/unique-offer/)", "name": "promotions-overview", "x-displayName": "Overview" }, { "description": "You can call API methods from this subsection to manage different types of promotions.", "name": "promotions-common", "x-displayName": "Common API calls" }, { "description": "Call API methods from this subsection to configure and manage coupon promotions.\n\n
\n

Note

\n

Refer to our documentation for detailed information about coupons.

\n
", "name": "promotions-coupons", "x-displayName": "优惠券" }, { "description": "Call API methods from this subsection to configure and manage promo code promotions.\n\n
\n

Note

\n

Refer to our documentation for detailed information about promo codes.

\n
", "name": "promotions-promo-codes", "x-displayName": "促销码" }, { "description": "Call API methods from this subsection to configure and manage unique catalog offers.\n\n
\n

Note

\n

Refer to our documentation for detailed information about unique offers.

\n
", "name": "promotions-unique-catalog-offers", "x-displayName": "特别目录优惠" }, { "description": "Call API methods from this subsection to configure and manage discount promotions.\n\n
\n

Note

\n

Refer to our documentation for detailed information about discounts.

\n
", "name": "promotions-discounts", "x-displayName": "折扣" }, { "description": "Call API methods from this subsection to configure and manage bonus promotions.\n\n
\n

Note

\n

Refer to our documentation for detailed information about bonuses.

\n
", "name": "promotions-bonuses", "x-displayName": "奖励" }, { "description": "Personalization allows you to specify the conditions for displaying the item catalog and applying promotions only for specific authorized users. Conditions are defined based on user attributes and allow you to offer items and promotions that are most relevant to particular users.\n\nThe following personalization types are available:\n\n\n* [Xsolla-side personalization](/zh/liveops/promotion-tools/personalization/#guides_personalization_on_xsolla_side). Personalization rules and logic are configured and stored on the Xsolla side. You pass user attributes, and Xsolla uses them to generate a personalized catalog.\n* [Partner-side personalization](/zh/liveops/promotion-tools/personalization/#guides_personalization_on_partner_side). You configure personalization rules and logic on your side and send a final catalog payload for a specific user to Xsolla.\n\n
\n Note

\n You can use only one personalization type. To change it, follow the\n instructions.\n
\n\n\nTo configure personalization on the Xsolla side using the Xsolla API:\n\n1. Create items using the API calls from the **Admin** subsection of the [Virtual items and currency](/zh/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list/), [Bundles](/zh/api/catalog/bundles-admin/admin-create-bundle) or [Game keys](/zh/api/catalog/game-keys-admin) groups.\n2. [Set up user attributes using the Xsolla Login API](/zh/liveops/promotion-tools/personalization/#web_shop_guide_personalization_setting_attributes) and keep them synchronized by updating data in Xsolla whenever changes occur in your game.\n3. Configure personalization for items or promotions:\n * To personalize the item catalog, define catalog display rules using the [Create catalog filter rule](/zh/api/liveops/personalized-catalog/create-filter-rule) API call:\n * In the [attribute_conditions](/zh/api/liveops/personalized-catalog/create-filter-rule#personalized-catalog/create-filter-rule/t=request&path=attribute_conditions) array, specify the conditions that determine item availability based on user attributes.\n * In the [items](/zh/api/liveops/personalized-catalog/create-filter-rule#personalized-catalog/create-filter-rule/t=request&path=items) array, provide the list of items that should be visible to the user if their attributes match the specified conditions.\n * To configure personalized promotions, use the [create and update API calls for the required promotion type](/zh/api/liveops/promotions-discounts/create-item-promotion). In the [attribute_conditions](/zh/api/liveops/promotions-discounts/create-item-promotion) array, specify the conditions that determine promotion availability based on user attributes.\n\n4. Pass the [user JWT](/zh/api/login/getting-user-token#getting-user-token) with user attributes to the [catalog retrieval API calls](https://developers.xsolla.com/zh/api/catalog/virtual-items-currency-catalog/get-virtual-items) to receive a personalized catalog.\n\n**Sequence for configuring and applying Xsolla-side personalization for item catalog:**\n\n![Personalization for item catalog](https://cdn.xsolla.net/developers/current/images/api_docs/personalization-catalog.png)\n\n**Sequence for configuring and applying Xsolla-side personalization for promotions:**\n\n![Personalization for promotions](https://cdn.xsolla.net/developers/current/images/api_docs/personalization-liveops.png)\n\n
\nNote

\nDetailed information is provided:\n\n
", "name": "personalized-catalog", "x-displayName": "个性化目录" }, { "name": "user-limits-admin", "x-displayName": "管理" }, { "name": "reward-chain-value-points-admin", "x-displayName": "管理" }, { "name": "reward-chain-client", "x-displayName": "客户端" }, { "name": "clan-reward-chain-client", "x-displayName": "公会客户端" }, { "name": "daily-chain-admin", "x-displayName": "管理" }, { "name": "daily-chain-client", "x-displayName": "客户端" }, { "name": "offer-chain-admin", "x-displayName": "管理" }, { "name": "offer-chain-client", "x-displayName": "客户端" }, { "name": "upsell-admin", "x-displayName": "管理" }, { "name": "upsell-client", "x-displayName": "客户端" } ], "x-tagGroups": [ { "name": "促销活动", "tags": [ "promotions-overview", "promotions-common", "promotions-coupons", "promotions-promo-codes", "promotions-unique-catalog-offers", "promotions-discounts", "promotions-bonuses" ] }, { "name": "个性化", "tags": [ "personalized-catalog" ] }, { "name": "限制", "tags": [ "user-limits-admin" ] }, { "name": "奖励链和奖励积分", "tags": [ "reward-chain-value-points-admin", "reward-chain-client", "clan-reward-chain-client" ] }, { "name": "每日奖励链", "tags": [ "daily-chain-admin", "daily-chain-client" ] }, { "name": "优惠链", "tags": [ "offer-chain-admin", "offer-chain-client" ] }, { "name": "追加销售", "tags": [ "upsell-admin", "upsell-client" ] } ] }