# 获取商品目录中的游戏

获取用于商品目录的游戏。


  注：
    未经授权使用此API调用时，会返回通用商品目录数据。如需获取
    个性化
    用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在Authorization请求头中传递用户JWT。
    有关用户JWT的更多信息，请参阅此调用的Security部分。

Endpoint: GET /v2/project/{project_id}/items/game/sku/{item_sku}
Version: 2.0.0
Security: XsollaLoginUserJWT

## Path parameters:

  - `project_id` (integer, required)
    项目ID。您可以在发布商帐户的项目名称旁找到此参数；使用项目时，也可以在浏览器地址栏中找到此参数。URL格式如下：https://publisher.xsolla.com//projects/。
    Example: 44056

  - `item_sku` (string, required)
    商品SKU。

## Query parameters:

  - `locale` (string)
    响应语言。符合ISO 639-1标准的两位小写语言代码（例如en）。name和description等本地化字段支持五字符区域代码（例如en-US），但在响应中会标准化为两位代码。支持的语言完整列表请参阅文档。

  - `additional_fields[]` (array)
    响应中需额外返回的字段。默认不返回这些字段。如需返回，请传入对应的字段值。
    Enum: "media_list", "order", "long_description", "custom_attributes", "item_order_in_group"

  - `country` (string)
    符合ISO 3166-1 alpha-2标准的两位大写国家/地区代码。关于艾克索拉支持的国家/地区和国家/地区判定流程的详细信息，请参阅文档。
    Example: "US"

  - `promo_code` (string)
    区分大小写的唯一兑换码。包含字母和数字。
    Example: "WINTER2021"

  - `show_inactive_time_limited_items` (integer)
    显示对用户不可用的时效性商品。这类商品的有效期尚未开始或已经结束。
    Example: 1

## Response 200 fields (application/json):

  - `sku` (string)
    唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。
    Example: "game_01"

  - `name` (string)
    商品名称。
    Example: "Game name"

  - `groups` (array)
    商品所属分组。

  - `groups.external_id` (string)
    创建商品组时指定的[外部商品组ID](/zh/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id)。
    Example: "exclusive"

  - `groups.name` (string)
    组名称。
    Example: "Exclusive"

  - `groups.item_order_in_group` (integer)
    商品在组内的位置，用于决定其显示顺序。
仅在通过additional_fields[]查询参数请求时返回。
    Example: 1

  - `attributes` (array)
    与商品对应的属性及其值的列表。可用于商品目录筛选。

  - `attributes.external_id` (string)
    唯一属性ID。 external_id只能包含大小写英文字母、数字、短横线和下划线。

  - `attributes.name` (string)
    属性名称。
    Example: "Genre"

  - `attributes.values` (array)

  - `attributes.values.external_id` (string)
    属性的唯一值ID。 external_id只能包含小写英文字母、数字、短横线和下划线。

  - `attributes.values.value` (string)
    属性值。
    Example: "Strategy"

  - `type` (string)
    商品类型：virtual_good/virtual_currency/bundle/physical_good/unit。
    Example: "unit"

  - `unit_type` (string)
    单元类型：game。
    Example: "game"

  - `description` (string)
    商品描述。
    Example: "Game description"

  - `image_url` (string)
    图片URL。
    Example: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"

  - `promotions` (array)
    应用于购物车中指定商品的促销活动。仅在以下情况下返回该数组：

* 为某商品配置了折扣促销活动。

* 应用了具有对所选商品提供折扣设置的兑换码。

如果未应用任何商品级促销活动，则返回空数组。

  - `promotions.name` (string)

  - `promotions.date_start` (string,null)

  - `promotions.date_end` (string,null)

  - `promotions.discount` (object,null)

  - `promotions.discount.percent` (string,null)

  - `promotions.discount.value` (string,null)

  - `promotions.bonus` (array)

  - `promotions.bonus.sku` (string)

  - `promotions.bonus.quantity` (integer)

  - `promotions.bonus.type` (string)
    赠品类型。
    Enum: "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft"

  - `promotions.bonus.name` (string)
    赠品名称。不适用于physical_good赠品类型。

  - `promotions.bonus.image_url` (string)
    赠品图片URL。不适用于physical_good赠品类型。

  - `promotions.bonus.bundle_type` (string)
    赠品捆绑包商品类型。仅适用于bundle赠品类型。
    Enum: "standard", "virtual_currency_package"

  - `promotions.limits` (object)

  - `promotions.limits.per_user` (object)

  - `promotions.limits.per_user.available` (integer)

  - `promotions.limits.per_user.total` (integer)

  - `unit_items` (array)

  - `unit_items.sku` (string)
    唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。
    Example: "game_01"

  - `unit_items.type` (string)
    商品类型：game_key。
    Example: "game_key"

  - `unit_items.is_free` (boolean)
    该商品是否免费。

  - `unit_items.price` (object)
    商品价格。

  - `unit_items.price.amount` (string)
    商品折后价格。
    Example: "2.9900"

  - `unit_items.price.amount_without_discount` (string)
    商品价格。
    Example: "2.9900"

  - `unit_items.price.currency` (string)
    商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。
    Example: "USD"

  - `unit_items.virtual_prices` (array)
    虚拟价格。

  - `unit_items.virtual_prices.amount` (integer)
    以虚拟货币表示的商品价格。
    Example: 100

  - `unit_items.virtual_prices.amount_without_discount` (integer)
    商品折扣前的虚拟货币价格。由于折扣不适用于虚拟货币价格，因此该值始终等于amount。
    Example: 200

  - `unit_items.virtual_prices.sku` (string)
    虚拟货币SKU。
    Example: "vc_gold"

  - `unit_items.virtual_prices.is_default` (boolean)
    是否为默认虚拟货币价格。
    Example: true

  - `unit_items.virtual_prices.image_url` (string,null)
    虚拟货币图片URL。
    Example: "http://image.png"

  - `unit_items.virtual_prices.name` (string)
    虚拟货币名称。
    Example: "Gold"

  - `unit_items.virtual_prices.type` (string)
    商品类型。对于虚拟货币，该值为virtual_currency。
    Example: "virtual_currency"

  - `unit_items.virtual_prices.description` (string,null)
    虚拟货币说明。
    Example: "In-game currency used to purchase weapons and upgrades"

  - `unit_items.can_be_bought` (boolean)
    如为true，则用户可以购买商品。

  - `unit_items.drm_name` (string)
    DRM名称。
    Example: "Steam"

  - `unit_items.drm_sku` (string)
    唯一DRM ID。 SKU只能包含大小写英文字母、数字、句点、短横线和下划线。
    Example: "steam"

  - `unit_items.has_keys` (boolean)
    如果为true，则该游戏Key有供销售的Key。

  - `unit_items.is_pre_order` (boolean)
    如果为true，则该游戏Key为预售，且尚未到发布日期。
    Example: true

  - `unit_items.release_date` (string,null)
    游戏Key发布日期，采用ISO 8601格式。
    Example: "2020-08-11T10:00:00+03:00"

  - `unit_items.promotions` (array)
    应用于购物车中指定商品的促销活动。仅在以下情况下返回该数组：

* 为某商品配置了折扣促销活动。

* 应用了具有对所选商品提供折扣设置的兑换码。

如果未应用任何商品级促销活动，则返回空数组。

  - `unit_items.promotions.name` (string)

  - `unit_items.promotions.date_start` (string,null)

  - `unit_items.promotions.date_end` (string,null)

  - `unit_items.promotions.discount` (object,null)

  - `unit_items.promotions.discount.percent` (string,null)

  - `unit_items.promotions.discount.value` (string,null)

  - `unit_items.promotions.bonus` (array)

  - `unit_items.promotions.bonus.sku` (string)

  - `unit_items.promotions.bonus.quantity` (integer)

  - `unit_items.promotions.bonus.type` (string)
    赠品类型。
    Enum: "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft"

  - `unit_items.promotions.bonus.name` (string)
    赠品名称。不适用于physical_good赠品类型。

  - `unit_items.promotions.bonus.image_url` (string)
    赠品图片URL。不适用于physical_good赠品类型。

  - `unit_items.promotions.bonus.bundle_type` (string)
    赠品捆绑包商品类型。仅适用于bundle赠品类型。
    Enum: "standard", "virtual_currency_package"

  - `unit_items.promotions.limits` (object)

  - `unit_items.promotions.limits.per_user` (object)

  - `unit_items.promotions.limits.per_user.available` (integer)

  - `unit_items.promotions.limits.per_user.total` (integer)

  - `unit_items.limits` (object,null)
    商品限制数。

  - `unit_items.limits.per_user` (object,null)
    单个用户的商品购买数量限制。

  - `unit_items.limits.per_user.total` (integer)
    单个用户可购买的最大商品数量。
    Example: 5

  - `unit_items.limits.per_user.available` (integer)
    当前用户可购买的剩余商品数量。
    Example: 3

  - `unit_items.limits.per_user.recurrent_schedule` (any)

  - `unit_items.limits.per_user.limit_exceeded_visibility` (string)
    设定商品在达到购买限制后、下次限制重置前在商品目录中的可见性。

适用于在recurrent_schedule数组中配置了周期性重置数量限制的商品。

如果未配置重置限制，则达到购买限制后，无论limit_exceeded_visibility的值如何，该商品都不会显示在商品目录中。

可能值：
- show — 达到购买限制后，商品目录检索API调用仍会返回该商品。在客户端侧
商品目录检索API调用中，达到限制后返回的商品会带有can_be_bought: false 标志。下一次重置日期
将在reset_next_date中返回。
- hide — 达到购买限制后，在限制
重置之前，商品目录检索API调用不会返回该商品。
    Enum: "show", "hide"

  - `unit_items.limits.per_item` (object,null)
    单个商品的购买数量限制。

  - `unit_items.limits.per_item.total` (integer)
    所有用户可购买的最大商品数量。
    Example: 5

  - `unit_items.limits.per_item.available` (integer)
    所有用户还可购买的剩余商品数量。
    Example: 3

  - `unit_items.periods` (array,null)
    商品销售期。

  - `unit_items.periods.date_from` (string)
    指定商品开始可购的日期。
    Example: "2020-08-11T10:00:00+03:00"

  - `unit_items.periods.date_until` (string,null)
    指定商品停止可购的日期。可为null。
    Example: "2020-08-11T20:00:00+03:00"

  - `unit_items.vp_rewards` (array)
    该商品的累充积分奖励列表。

  - `unit_items.vp_rewards.item_id` (integer)
    内部唯一商品ID。

  - `unit_items.vp_rewards.sku` (string)
    唯一累充积分ID。

  - `unit_items.vp_rewards.amount` (integer)
    累充积分数量。

  - `unit_items.vp_rewards.name` (string)
    累充积分名称。

  - `unit_items.vp_rewards.image_url` (string)
    图片URL。

  - `unit_items.vp_rewards.is_clan` (boolean)
    累充积分是否用于公会累充奖励链。

  - `unit_items.loyalty_rewards` (array)
    用户购买商品后获得的忠诚积分奖励。

  - `unit_items.loyalty_rewards.name` (string)
    忠诚积分名称。

  - `unit_items.loyalty_rewards.sku` (string)
    忠诚积分SKU。调用其他API时，请将该值作为loyalty_point_sku参数传入，例如创建使用忠诚积分支付的订单时。

  - `unit_items.loyalty_rewards.description` (string)
    忠诚积分描述。

  - `unit_items.loyalty_rewards.image_url` (string,null)
    图片URL。

  - `unit_items.loyalty_rewards.amount` (integer)
    用户购买商品后获得的忠诚积分数量。

  - `unit_items.loyalty_prices` (array)
    可用于购买该商品的忠诚积分。

  - `unit_items.loyalty_prices.name` (string)
    忠诚积分名称。

  - `unit_items.loyalty_prices.sku` (string)
    忠诚积分SKU。调用其他API时，请将该值作为loyalty_point_sku参数传入，例如创建使用忠诚积分支付的订单时。

  - `unit_items.loyalty_prices.description` (string)
    忠诚积分描述。

  - `unit_items.loyalty_prices.image_url` (string,null)
    图片URL。

  - `unit_items.loyalty_prices.amount` (integer)
    以指定忠诚积分计价的商品价格。

## Response 404 fields (application/json):

  - `statusCode` (integer)
    Example: 404

  - `errorCode` (integer)
    Example: 4001

  - `errorMessage` (string)
    Example: "[0401-4001]: Item with sku = 'game_1' not found"