Xsolla-logo

指定されたグループの販売可能なアイテムリストを取得Client-side

get/v2/project/{project_id}/items/group/{external_id}

カタログを作成するために、指定されたグループから販売可能なアイテムリストを取得します。

注意

すべてのプロジェクトには、回答で得られるアイテムの数に制限があります。初期値および最大値は、1回答あたり50件です。ページごとに多くのデータを取得するには、制限オフセットフィールドを使用します。

注意事項

一般的に、アイテムのカタログは無許可で利用することができます。
パーソナライズされたドカタログを取得できるのは、認証されたユーザーだけです。
SecurityXsollaLoginUserJWT
Request
path Parameters
project_id
required
integer

プロジェクトID。このパラメータは、ドメインページのプロジェクト名の横にあります。

Example: 59080
external_id
required
string
Default: "armour"

グループexternal ID。

query Parameters
limit
integer

Limit for the number of elements on the page.

Example: limit=50
offset
integer

リストが生成される要素番号(カウントは0から始まります)。

Example: offset=0
locale
string
Default: "en"

応答言語。ISO 639-1に基づく小文字の2文字言語コード。

additional_fields[]
Array of strings

追加フィールドのリスト。これらのフィールドは、リクエストの中で送信すると、応答に含まれます。

Items Enum: "media_list" "order" "long_description" "custom_attributes"
country
string

ISO 3166-1 alpha-2に従った2文字の大文字の国名コード。エクソーラがサポートする国国を決定するプロセスの詳細情報については、ドキュメンテーションを確認してください。

Example: country=US
promo_code
string [ 1 .. 128 ] characters

大文字と小文字を区別する一意のコードです。文字と数字が含まれます。

Example: promo_code=WINTER2021
show_inactive_time_limited_items
integer
Default: 0

ユーザーに利用可能でない、期限付きアイテムを表示します。このようなアイテムの有効期間はまだ開始されていないか、すでに期限切れです。

Example: show_inactive_time_limited_items=1
Responses
200

指定されたグループの販売可能なアイテムのリストは正常に受信されました。

404

グループが見つかりませんでした。external_idが正しく、グループがオフになったり削除されたりしていないことを確認してください。

Request samples
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/{project_id}/items/group/{external_id}?limit=50&offset=0&locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{}