LOKA Public API (1.0.0)

Download OpenAPI specification:Download

LOKA APIサポート: system@loka.co.jp Terms of Service

LOKAが公開しているAPIです。文字コードはUTF-8を使用しています。認証にはHTTPヘッダのAuthorizationにBearer トークンを含めるかクエリパラメータのtokenにトークンが必要となります。

Authentication

bearerAuth

Security scheme type: HTTP
HTTP Authorization Scheme bearer

apiKey

Security scheme type: API Key
Query parameter name: token

products

商品情報へアクセスします

商品情報を登録します

商品情報を登録します。idは重複できません。

Authorizations:
Request Body schema: application/json

商品情報

id
required
string
groupId
string
name
required
string
imageURL
required
string
linkURL
required
string
price
integer <int32>
quantity
integer <int32>

Responses

201

正常に作成されました。

400

必須項目がありません。あるいは数値型の項目に数値以外の値が入っています。

422

正しく作成できませんでした。例として既に同じidの商品が登録されている場合に発生します。

post /products

ステージングサーバ(テスト用)

https://staging-story-api.lokaplatform.com/public/v1/products

本番サーバ

https://story-api.lokaplatform.com/public/v1/products

Request samples

application/json
Copy
Expand all Collapse all
{}

商品情報を更新します

商品情報を更新します。更新する箇所の項目だけデータに含めた場合も処理されます。

Authorizations:
path Parameters
id
required
string

商品ID

Request Body schema: application/json
groupId
string
name
string
imageURL
string
linkURL
string
price
integer <int32>
quantity
integer <int32>

Responses

200

正常に更新されました。

400

数値型の項目に数値以外の値が入っています。

404

指定されたidの商品情報がありません。

422

正しく更新できませんでした。

patch /products/{id}

ステージングサーバ(テスト用)

https://staging-story-api.lokaplatform.com/public/v1/products/{id}

本番サーバ

https://story-api.lokaplatform.com/public/v1/products/{id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "name": "フラワーギンガムシャツ"
}

商品情報を削除します

商品情報を削除します。

Authorizations:
path Parameters
id
required
string

商品ID

Responses

200

正常に削除されました。

404

指定されたidの商品情報がありません。

delete /products/{id}

ステージングサーバ(テスト用)

https://staging-story-api.lokaplatform.com/public/v1/products/{id}

本番サーバ

https://story-api.lokaplatform.com/public/v1/products/{id}