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

商品IDです。通常SKUを登録します。参考: https://support.google.com/merchants/answer/6324405?hl=ja&ref_topic=6324338

groupId
string

バリエーションのある商品をグループ化している際のIDです。参考: https://support.google.com/merchants/answer/6324507?hl=ja&ref_topic=6324338

name
required
string

商品名です。

imageURL
required
string

メイン画像のURLです。

linkURL
required
string

商品ページのURLです。

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

バリエーションのある商品をグループ化している際のIDです。参考: https://support.google.com/merchants/answer/6324507?hl=ja&ref_topic=6324338

name
string

商品名です。

imageURL
string

メイン画像のURLです。

linkURL
string

商品ページのURLです。

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}

商品の一括登録のための商品ファイルをアップロードします

商品ファイルをアップロードします。アップロードされたファイルは定期的に商品登録されます

Authorizations:
Request Body schema: multipart/form-data
file
string <binary>

JSONファイルかgzipで圧縮されたJSONを指定してください。JSONの内容は商品情報を登録する際に送信するオブジェクトの配列です。

Responses

200

ファイルは正常にアップロードされました。

404

予期しないリクエストです。フォームに指定する名前かファイルの形式を確認してください。

422

アップロードに失敗しました。

500

ファイルの保存に失敗しています。時間を置いて試してください。

post /products.json

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

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

本番サーバ

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

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "qC3P7wVllPjk"
}

商品一括登録のステータスを確認します

商品一括登録のステータスを確認します

Authorizations:
path Parameters
id
required
string

アップロード時に返却されたidを指定します。

Responses

200

正常に処理されました

404

指定したidでアップロードされたファイルがありません。idを確認してください。

get /upload_items/{id}

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

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

本番サーバ

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

Response samples

application/json
Copy
Expand all Collapse all
{
  • "status": "pending",
  • "last_updated": "2019-08-29T03:56:33.599677Z"
}