Skip to main content

GET /v1/gachas

List gachas

Overview​

デフォルトではユーザのログイン方法とビーコンのログイン状況に基づいてガチャの一覧を取得できます。

Sample​

note

ユーザ認証についてはこちら。この API はユーザ認証認証なしでのアクセスも可能です。

curl -X GET http://localhost/api/v1/gachas

ResponseJson​

{
  "data": [
    {
      "id": "dd7ca1e0-b746-4b1b-9f46-e0a6997cc672",
      "name": "スーパーガチャ",
      "description": "このガチャはテストようです\n良い商品が当たります。",
      "price": 100,
      "maximum": 0,
      "has_limit": false,
      "status": "selling",
      "thumbnail_image_url": "https://dev-507-assets.s3.ap-northeast-1.amazonaws.com/01FZW5TWRRHPSJFG5JFKGKDRTZ.jpeg",
      "lineup_image_url": "https://dev-507-assets.s3.ap-northeast-1.amazonaws.com/01FZW5V1P8DRZM47EB38GNJDQ7.jpeg",
      "redeem_limit_date": null,
      "start_at": "2022-04-05T06:24:45.000Z",
      "end_at": "2022-04-05T06:24:45.000Z",
      "created_at": "2022-04-05T06:24:45.364Z",
      "updated_at": "2022-04-05T06:24:45.370Z",
      "is_checkin": true,
      "delivery_type": "self",
      "tags": ["example", "test"]
    },
    {
      "id": "0219add6-dcfd-42eb-aceb-a0836cd08441",
      "name": "ノーマルガチャ",
      "description": "このガチャはテストようです\n良い商品が当たります。",
      "price": 100,
      "maximum": 0,
      "has_limit": false,
      "status": "selling",
      "thumbnail_image_url": "https://dev-507-assets.s3.ap-northeast-1.amazonaws.com/01FZW5TWRRHPSJFG5JFKGKDRTZ.jpeg",
      "lineup_image_url": "https://dev-507-assets.s3.ap-northeast-1.amazonaws.com/01FZW5V1P8DRZM47EB38GNJDQ7.jpeg",
      "redeem_limit_date": null,
      "start_at": "2022-04-05T06:24:45.000Z",
      "end_at": "2022-04-05T06:24:45.000Z",
      "created_at": "2022-04-05T06:24:45.364Z",
      "updated_at": "2022-04-05T06:24:45.370Z",
      "is_checkin": false,
      "delivery_type": "self",
      "tags": ["example"]
    }
  ]
}

Querystring​

カラム名必須データ型説明
filterNostring未受け取りの注文の存在するガチャのみを取得する場合は「nopickuped」

Gacha オブジェクト​

カラム名データ型詳細
idstringガチャの ID
namestringガチャの名前
descriptionstringガチャの詳細文
pricenumberガチャ一回分の値段(円)
maximumnumberユーザの購入回数制限
has_limitbooleanユーザの購入制限の有無
statusstringガチャの状態。購入可能なら「saling」 購入不可能の場合は「closing」 売り切れの場合は「soldout」
thumbnail_image_urlstringガチャのサムネイル
lineup_image_urlstringガチャの商品一覧画像
start_atdatetimeガチャの販売開始時間。
end_atdatetimeガチャの販売終了時間。
is_checkinbooleanガチャの購入可能状態。
delivery_typestringQR コードによる受け取りの場合self、郵送の場合はmail
tagsstring[]ガチャ管理者が任意で文字列の配列を設定します