API docs by Redocly

Furupura Shop API (1.0.0)

Download OpenAPI specification:

Furupura API Team: api@furupura.jp

ふるぷらショップ向けAPI

← API Portal に戻る

auth

認証

ショップオーナー登録

新しいショップオーナーアカウントを作成します。ショップ名、メールアドレス、パスワードが必要です。

Request Body schema: application/json
required
shop_name
required
string <= 100 characters

ショップ名

email
required
string <email>

ショップのメールアドレス

password
required
string <password> >= 8 characters

パスワード（8文字以上）

Responses

Request samples

Content type
application/json
{
  • "shop_name": "string",
  • "email": "user@example.com",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "shop": {
    }
}

ショップログイン

ショップのメールアドレスとパスワードでログインします。

Request Body schema: application/json
required
email
required
string <email>

ショップのメールアドレス

password
required
string <password>

パスワード

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "shop": {
    }
}

ログアウト

現在のセッションからログアウトします。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "ログアウトしました"
}

products

商品管理

商品一覧取得

ショップの商品一覧を取得します。カテゴリやステータスでフィルタリング可能です。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1

ページ番号

pageSize
integer [ 1 .. 100 ]
Default: 20

1ページあたりの件数

q
string

検索キーワード

categoryId
integer <int64>
status
string
Enum: "active" "inactive" "draft"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

商品登録

新しい商品を登録します。画像URLや在庫数も同時に設定できます。

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string <= 200 characters
description
string
price
required
integer >= 0
tax_rate
number <float>
Default: 0.1
category_id
string
images
Array of strings <uri> [ items <uri > ]
stock_quantity
integer >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "price": 0,
  • "tax_rate": 0.1,
  • "category_id": "string",
  • "images": [],
  • "stock_quantity": 0
}

Response samples

Content type
application/json
{
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "name": "string",
  • "description": "string",
  • "price": 0,
  • "tax_rate": 0.1,
  • "category_id": "string",
  • "images": [],
  • "status": "active",
  • "stock_quantity": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

商品詳細取得

指定した商品の詳細情報を取得します。

Authorizations:
bearerAuth
path Parameters
productId
required
string

Responses

Response samples

Content type
application/json
{
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "name": "string",
  • "description": "string",
  • "price": 0,
  • "tax_rate": 0.1,
  • "category_id": "string",
  • "images": [],
  • "status": "active",
  • "stock_quantity": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

orders

注文管理

注文一覧取得

ショップの注文一覧を取得します。ステータスでフィルタリング可能です。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1

ページ番号

pageSize
integer [ 1 .. 100 ]
Default: 20

1ページあたりの件数

status
string
Enum: "pending" "processing" "shipped" "delivered" "cancelled"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

配送先情報取得

注文の配送先情報とユーザー情報を取得

Authorizations:
bearerAuth
path Parameters
orderId
required
integer

注文ID

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "shippingAddress": {
    },
  • "status": "string"
}

配達完了マーク

注文商品を配達済みとしてマーク

Authorizations:
bearerAuth
path Parameters
orderId
required
integer

注文ID

Request Body schema: application/json
required
purchaseItemIds
Array of integers

配達済みにする購入アイテムID

rentalItemIds
Array of integers

配達済みにするレンタルアイテムID

Responses

Request samples

Content type
application/json
{
  • "purchaseItemIds": [
    ],
  • "rentalItemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}

レンタル商品返却

レンタル商品を返却済みとしてマーク

Authorizations:
bearerAuth
path Parameters
orderId
required
integer

レンタルアイテムID

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

注文キャンセル

注文商品をキャンセル

Authorizations:
bearerAuth
path Parameters
orderId
required
integer

注文ID

Request Body schema: application/json
required
purchaseItemIds
Array of integers

キャンセルする購入アイテムID

rentalItemIds
Array of integers

キャンセルするレンタルアイテムID

cancellationReason
required
string

キャンセル理由

Responses

Request samples

Content type
application/json
{
  • "purchaseItemIds": [
    ],
  • "rentalItemIds": [
    ],
  • "cancellationReason": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "order": {
    }
}

inventory

在庫管理

shop

ショップ情報