EC-CUBE 4.3 フロントAPI (4.3.0)

Download OpenAPI specification:

URL: https://www.ec-cube.net License: GPL-2.0-only

EC-CUBE 4.3 顧客向けフロントエンドAPI。 Symfony 6.4 ベースの日本語ECオープンプラットフォームのフロント操作を定義する。本仕様は ALPS アプリケーションプロファイル (alps.json) から生成された。

top

トップページ

トップページを見る

ショップのトップページ。ニュース一覧、新着商品、カテゴリナビゲーション等を表示

Responses

Response samples

200
500

Content type

application/json

{"shopMessage": "string"
}

catalog

商品カタログ（商品一覧・詳細・カテゴリ）

商品一覧を見る

商品一覧ページ。検索条件やカテゴリで絞り込み可能

query Parameters

categoryId	integer カテゴリIDで絞り込み
name	string 商品名で検索
pageno	integer ページ番号
disp_number	integer 1ページあたりの表示件数
orderby	integer ソート順

Responses

Response samples

200
500

Content type

application/json

{"products": [{"productName": "string",
"descriptionList": "string",
"descriptionDetail": "string",
"searchWord": "string",
"freeArea": "string",
"productStatus": 0,
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z",
"productClasses": [{"productCode": "string",
"stock": 0,
"stockUnlimited": true,
"saleLimit": 0,
"price01": 0,
"price02": 0,
"deliveryFee": 0,
"productClassVisible": true,
"currencyCode": "string",
"pointRate": 0,
"classCategoryName": "string",
"classCategoryBackendName": "string"
}
],
"productImages": [{"fileName": "string",
"sortNo": 0
}
],
"productCategories": [{"categoryName": "string",
"hierarchy": 0
}
],
"productTags": [{"tagName": "string"
}
]
}
]
}

商品詳細を見る

商品詳細ページ。規格・画像・カテゴリ・タグ情報を含む

path Parameters

productId

required

integer

商品ID

Responses

Response samples

200
404
500

Content type

application/json

{"productName": "string",
"descriptionList": "string",
"descriptionDetail": "string",
"searchWord": "string",
"freeArea": "string",
"productStatus": 0,
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z",
"productClasses": [{"productCode": "string",
"stock": 0,
"stockUnlimited": true,
"saleLimit": 0,
"price01": 0,
"price02": 0,
"deliveryFee": 0,
"productClassVisible": true,
"currencyCode": "string",
"pointRate": 0,
"classCategoryName": "string",
"classCategoryBackendName": "string"
}
],
"productImages": [{"fileName": "string",
"sortNo": 0
}
],
"productCategories": [{"categoryName": "string",
"hierarchy": 0
}
],
"productTags": [{"tagName": "string"
}
]
}

カテゴリ一覧を見る

カテゴリ一覧。階層構造を持つカテゴリツリーを返す

Responses

Response samples

200
500

Content type

application/json

{"categories": [{"categoryName": "string",
"hierarchy": 0,
"sortNo": 0,
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z"
}
]
}

カテゴリ詳細を見る

指定カテゴリの詳細情報

path Parameters

categoryId

required

integer

カテゴリID

Responses

Response samples

200
404
500

Content type

application/json

{"categoryName": "string",
"hierarchy": 0,
"sortNo": 0,
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z"
}

cart

カート操作

カートを見る

カート内容の表示。販売種別ごとに分離されたカートを返す

Responses

Response samples

200
500

Content type

application/json

{"cartKey": "string",
"preOrderId": "string",
"totalPrice": 0,
"deliveryFeeTotal": 0,
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z",
"cartItems": [{"cartItemPrice": 0,
"quantity": 0,
"productName": "string",
"productCode": "string"
}
]
}

カートに追加する

在庫・販売制限・配送設定をチェックし、制限超過時は数量を自動調整

Request Body schema: application/json
required

productCode required	string 商品コード（SKU/品番）
quantity required	integer 数量

Responses

Request samples

Payload

Content type

application/json

{"productCode": "string",
"quantity": 0
}

Response samples

201
400
500

Content type

application/json

{"cartKey": "string",
"preOrderId": "string",
"totalPrice": 0,
"deliveryFeeTotal": 0,
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z",
"cartItems": [{"cartItemPrice": 0,
"quantity": 0,
"productName": "string",
"productCode": "string"
}
]
}

カート数量を変更する

カート内の指定商品の数量を更新

path Parameters

productCode

required

string

商品コード

Request Body schema: application/json
required

quantity

required

integer

変更後の数量

Responses

Request samples

Payload

Content type

application/json

{"quantity": 0
}

Response samples

200
400
404
500

Content type

application/json

{"cartKey": "string",
"preOrderId": "string",
"totalPrice": 0,
"deliveryFeeTotal": 0,
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z",
"cartItems": [{"cartItemPrice": 0,
"quantity": 0,
"productName": "string",
"productCode": "string"
}
]
}

カートから削除する

カート内の指定商品を削除

path Parameters

productCode

required

string

商品コード

Responses

Response samples

200
404
500

Content type

application/json

{"cartKey": "string",
"preOrderId": "string",
"totalPrice": 0,
"deliveryFeeTotal": 0,
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z",
"cartItems": [{"cartItemPrice": 0,
"quantity": 0,
"productName": "string",
"productCode": "string"
}
]
}

checkout

購入手続き（注文確定まで）

注文手続きへ進む

カートから注文手続きへ遷移。未ログイン時はShoppingLoginへリダイレクト

Responses

Response samples

200
500

Content type

application/json

{"paymentMethod": "string",
"deliveryName": "string",
"deliveryTime": "string",
"deliveryDate": "2019-08-24",
"message": "string",
"point": 0
}

購入ログインを見る

購入手続き時のログイン画面。会員ログインまたはゲスト購入を選択

Responses

Response samples

200
500

Content type

application/json

{"email": "user@example.com"
}

非会員購入情報入力へ進む

非会員（ゲスト）が注文者情報を入力する画面

Responses

Response samples

200
500

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string"
}

非会員情報を送信する

ゲスト購入用の注文者情報を送信

Request Body schema: application/json
required

name01 required	string 姓
name02 required	string 名
kana01	string セイ
kana02	string メイ
companyName	string 会社名
email required	string <email> メールアドレス
phoneNumber required	string 電話番号
postalCode required	string 郵便番号
pref required	integer 都道府県（1〜47）
addr01 required	string 市区町村
addr02 required	string 番地・建物名

Responses

Request samples

Payload

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string"
}

Response samples

200
400
500

Content type

application/json

{"paymentMethod": "string",
"deliveryName": "string",
"deliveryTime": "string",
"deliveryDate": "2019-08-24",
"message": "string",
"point": 0
}

お届け先を選択する画面を見る

会員の登録済みお届け先から配送先を選択する画面

Responses

Response samples

200
500

Content type

application/json

{"addresses": [{"name01": "string",
"name02": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"phoneNumber": "string"
}
]
}

お届け先を選択する

登録済みのお届け先を選択して配送先に設定

Request Body schema: application/json
required

customerAddressId

integer

配送先住所ID

Responses

Request samples

Payload

Content type

application/json

{"customerAddressId": 0
}

Response samples

200
400
500

Content type

application/json

{"paymentMethod": "string",
"deliveryName": "string",
"deliveryTime": "string",
"deliveryDate": "2019-08-24",
"message": "string",
"point": 0
}

お届け先変更画面を見る

新しいお届け先を入力する、または非会員のお届け先を編集する画面

Responses

Response samples

200
500

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"phoneNumber": "string"
}

お届け先を更新する

新しいお届け先の登録または既存お届け先の更新

Request Body schema: application/json
required

name01 required	string 姓
name02 required	string 名
kana01	string セイ
kana02	string メイ
companyName	string 会社名
postalCode required	string 郵便番号
pref required	integer 都道府県（1〜47）
addr01 required	string 市区町村
addr02 required	string 番地・建物名
phoneNumber required	string 電話番号

Responses

Request samples

Payload

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"phoneNumber": "string"
}

Response samples

200
400
500

Content type

application/json

{"paymentMethod": "string",
"deliveryName": "string",
"deliveryTime": "string",
"deliveryDate": "2019-08-24",
"message": "string",
"point": 0
}

複数配送先設定画面を見る

複数のお届け先に商品を振り分ける画面

Responses

Response samples

200
500

Content type

application/json

{"paymentMethod": "string",
"deliveryName": "string",
"deliveryTime": "string",
"deliveryDate": "2019-08-24",
"message": "string",
"point": 0
}

注文内容を確認する

PaymentMethod::verifyによる決済検証を実行

Request Body schema: application/json
required

paymentMethod	string 支払方法
message	string 注文メッセージ
point	integer 使用ポイント
deliveryTime	string 配送時間帯
deliveryDate	string <date> 配送希望日

Responses

Request samples

Payload

Content type

application/json

{"paymentMethod": "string",
"message": "string",
"point": 0,
"deliveryTime": "string",
"deliveryDate": "2019-08-24"
}

Response samples

200
400
500

Content type

application/json

{"paymentMethod": "string",
"subtotal": 0,
"deliveryFeeTotal": 0,
"charge": 0,
"discount": 0,
"tax": 0,
"total": 0,
"paymentTotal": 0
}

注文を確定する

税計算、送料計算、在庫引当、ポイント減算を実行。決済処理後に注文確認メールを送信しカートをクリア

Request Body schema: application/json
required

paymentMethod

string

支払方法

Responses

Request samples

Payload

Content type

application/json

{"paymentMethod": "string"
}

Response samples

200
400
500

Content type

application/json

{"orderNo": "string"
}

購入エラー画面を表示する

在庫不足、決済失敗、セッション切れなどのエラー発生時にリダイレクトされる

Responses

Response samples

200
500

Content type

application/json

{"message": "string"
}

account

会員アカウント（登録・ログイン・マイページ）

ログイン画面を見る

顧客用ログイン画面

Responses

Response samples

200
500

Content type

application/json

{"email": "user@example.com"
}

ログインする

メールアドレスとパスワードで認証

Request Body schema: application/json
required

email required	string <email> メールアドレス
password required	string <password> パスワード

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"password": "pa$$word"
}

Response samples

200
401
500

Content type

application/json

{"orders": [{"orderNo": "string",
"orderDate": "2019-08-24T14:15:22Z",
"orderStatus": 0,
"paymentMethod": "string",
"total": 0
}
]
}

ログアウトする

セッションを破棄してログアウト

Responses

Response samples

200
500

Content type

application/json

{"shopMessage": "string"
}

会員登録フォームを見る

会員登録フォーム画面

Responses

Response samples

200
500

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"birth": "2019-08-24",
"sex": 0,
"job": 0
}

会員登録する

会員メール認証オプション有効時は仮会員として登録し認証メールを送信。無効時は即座に本会員

Request Body schema: application/json
required

name01 required	string 姓
name02 required	string 名
kana01	string セイ
kana02	string メイ
companyName	string 会社名
email required	string <email> メールアドレス
phoneNumber	string 電話番号
postalCode	string 郵便番号
pref	integer 都道府県（1〜47）
addr01	string 市区町村
addr02	string 番地・建物名
password required	string <password> パスワード
birth	string <date> 生年月日
sex	integer 性別（1=男性, 2=女性, 3=その他, 4=回答しない）
job	integer 職業（1〜18）

Responses

Request samples

Payload

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"password": "pa$$word",
"birth": "2019-08-24",
"sex": 0,
"job": 0
}

Response samples

201
400
500

Content type

application/json

{ }

会員を有効化する

メール認証リンクのsecretKeyを検証し仮会員から本会員に変更

path Parameters

secretKey

required

string

認証キー

Responses

Response samples

200
400
500

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"birth": "2019-08-24",
"sex": 0,
"job": 0,
"customerStatus": 0,
"point": 0,
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z"
}

パスワードリセットを依頼する

パスワードリセット用のメールを送信

Request Body schema: application/json
required

email

required

string <email>

メールアドレス

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com"
}

Response samples

400
500

Content type

application/json

{"message": "string",
"code": 0,
"errors": [{"field": "string",
"message": "string"
}
]
}

パスワードをリセットする

リセットキーを検証し新しいパスワードを設定

path Parameters

resetKey

required

string

リセットキー

Request Body schema: application/json
required

password

required

string <password>

新しいパスワード

Responses

Request samples

Payload

Content type

application/json

{"password": "pa$$word"
}

Response samples

200
400
500

Content type

application/json

{"email": "user@example.com"
}

マイページを見る

マイページトップ。注文履歴一覧を表示

Responses

Response samples

200
401
500

Content type

application/json

{"orders": [{"orderNo": "string",
"orderDate": "2019-08-24T14:15:22Z",
"orderStatus": 0,
"paymentMethod": "string",
"total": 0
}
]
}

注文履歴詳細を見る

個別の注文履歴詳細画面

path Parameters

orderNo

required

string

注文番号

Responses

Response samples

200
401
404
500

Content type

application/json

{"orderNo": "string",
"orderDate": "2019-08-24T14:15:22Z",
"orderStatus": 0,
"paymentMethod": "string",
"subtotal": 0,
"deliveryFeeTotal": 0,
"charge": 0,
"discount": 0,
"total": 0,
"paymentTotal": 0,
"orderItems": [{"orderItemProductName": "string",
"orderItemProductCode": "string",
"orderItemClassName1": "string",
"orderItemClassName2": "string",
"orderItemClassCategoryName1": "string",
"orderItemClassCategoryName2": "string",
"orderItemPrice": 0,
"orderItemQuantity": 0,
"orderItemTax": 0,
"taxRate": 0,
"taxAdjust": 0,
"orderItemType": 0
}
],
"shippings": [{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"phoneNumber": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"deliveryName": "string",
"deliveryTime": "string",
"deliveryDate": "2019-08-24",
"shippingDate": "2019-08-24T14:15:22Z",
"trackingNumber": "string",
"mailSendDate": "2019-08-24T14:15:22Z"
}
]
}

会員情報変更画面を見る

会員情報の変更画面

Responses

Response samples

200
401
500

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"birth": "2019-08-24",
"sex": 0,
"job": 0
}

会員情報を更新する

会員情報を変更・保存

Request Body schema: application/json
required

name01	string 姓
name02	string 名
kana01	string セイ
kana02	string メイ
companyName	string 会社名
email required	string <email> メールアドレス
phoneNumber	string 電話番号
postalCode	string 郵便番号
pref	integer 都道府県（1〜47）
addr01	string 市区町村
addr02	string 番地・建物名
password	string <password> パスワード
birth	string <date> 生年月日
sex	integer 性別（1=男性, 2=女性, 3=その他, 4=回答しない）
job	integer 職業（1〜18）

Responses

Request samples

Payload

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"password": "pa$$word",
"birth": "2019-08-24",
"sex": 0,
"job": 0
}

Response samples

200
400
401
500

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"birth": "2019-08-24",
"sex": 0,
"job": 0
}

退会画面を見る

退会確認・退会処理画面

Responses

Response samples

401
500

Content type

application/json

{"message": "string",
"code": 0,
"errors": [{"field": "string",
"message": "string"
}
]
}

退会する

メールアドレスをダミー値に置換しカートとセッションをクリア。退会確認メール送信後にログアウト

Responses

Response samples

200
401
500

Content type

application/json

{"shopMessage": "string"
}

配送先一覧を見る

会員の登録済み配送先住所一覧

Responses

Response samples

200
401
500

Content type

application/json

{"addresses": [{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"phoneNumber": "string",
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z"
}
]
}

配送先を追加する

最大20件まで登録可能

Request Body schema: application/json
required

name01 required	string 姓
name02 required	string 名
kana01	string セイ
kana02	string メイ
companyName	string 会社名
postalCode required	string 郵便番号
pref required	integer 都道府県（1〜47）
addr01 required	string 市区町村
addr02 required	string 番地・建物名
phoneNumber required	string 電話番号

Responses

Request samples

Payload

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"phoneNumber": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"phoneNumber": "string",
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z"
}

配送先を更新する

配送先住所情報を更新

path Parameters

addressId

required

integer

配送先住所ID

Request Body schema: application/json
required

name01	string 姓
name02	string 名
kana01	string セイ
kana02	string メイ
companyName	string 会社名
postalCode	string 郵便番号
pref	integer 都道府県（1〜47）
addr01	string 市区町村
addr02	string 番地・建物名
phoneNumber	string 電話番号

Responses

Request samples

Payload

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"phoneNumber": "string"
}

Response samples

200
400
401
404
500

Content type

application/json

{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"phoneNumber": "string",
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z"
}

配送先を削除する

登録済み配送先住所を削除

path Parameters

addressId

required

integer

配送先住所ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"addresses": [{"name01": "string",
"name02": "string",
"kana01": "string",
"kana02": "string",
"companyName": "string",
"postalCode": "string",
"pref": 0,
"addr01": "string",
"addr02": "string",
"phoneNumber": "string",
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z"
}
]
}

再注文する

過去の注文内容をカートに再投入

path Parameters

orderNo

required

string

注文番号

Responses

Response samples

200
401
404
500

Content type

application/json

{"cartKey": "string",
"preOrderId": "string",
"totalPrice": 0,
"deliveryFeeTotal": 0,
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z",
"cartItems": [{"cartItemPrice": 0,
"quantity": 0,
"productName": "string",
"productCode": "string"
}
]
}

favorite

お気に入り商品

お気に入り一覧を見る

お気に入り商品の一覧を表示

Responses

Response samples

200
401
500

Content type

application/json

{"favoriteProducts": [{"productName": "string",
"price02": 0,
"createDate": "2019-08-24T14:15:22Z"
}
]
}

お気に入りに追加する

指定商品をお気に入りに追加

path Parameters

productId

required

integer

商品ID

Responses

Response samples

201
401
404
500

Content type

application/json

{"productName": "string",
"price02": 0,
"createDate": "2019-08-24T14:15:22Z"
}

お気に入りから削除する

指定商品をお気に入りから削除

path Parameters

productId

required

integer

商品ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"favoriteProducts": [{"productName": "string",
"price02": 0,
"createDate": "2019-08-24T14:15:22Z"
}
]
}

contact

お問い合わせ

お問い合わせフォームを見る

お問い合わせフォーム画面

Responses

Response samples

200
500

Content type

application/json

{"contactName01": "string",
"contactName02": "string",
"contactKana01": "string",
"contactKana02": "string",
"contactEmail": "user@example.com",
"phoneNumber": "string",
"contactContents": "string"
}

お問い合わせを送信する

お問い合わせ内容を送信

Request Body schema: application/json
required

contactName01 required	string お問い合わせ姓
contactName02 required	string お問い合わせ名
contactKana01	string お問い合わせセイ
contactKana02	string お問い合わせメイ
contactEmail required	string <email> お問い合わせメールアドレス
phoneNumber	string 電話番号
contactContents required	string お問い合わせ内容

Responses

Request samples

Payload

Content type

application/json

{"contactName01": "string",
"contactName02": "string",
"contactKana01": "string",
"contactKana02": "string",
"contactEmail": "user@example.com",
"phoneNumber": "string",
"contactContents": "string"
}

Response samples

200
400
500

Content type

application/json

{ }

help

ヘルプ・利用規約・特定商取引法

当サイトについてを見る

当サイトについてのページ

Responses

Response samples

500

Content type

application/json

{"message": "string",
"code": 0,
"errors": [{"field": "string",
"message": "string"
}
]
}

ご利用ガイドを見る

ご利用ガイドページ

Responses

Response samples

500

Content type

application/json

{"message": "string",
"code": 0,
"errors": [{"field": "string",
"message": "string"
}
]
}

ご利用規約を見る

利用規約ページ

Responses

Response samples

500

Content type

application/json

{"message": "string",
"code": 0,
"errors": [{"field": "string",
"message": "string"
}
]
}

プライバシーポリシーを見る

プライバシーポリシーページ

Responses

Response samples

500

Content type

application/json

{"message": "string",
"code": 0,
"errors": [{"field": "string",
"message": "string"
}
]
}

特定商取引法を見る

特定商取引法に基づく表記のフロント表示ページ

Responses

Response samples

200
500

Content type

application/json

{"items": [{"tradeLawName": "string",
"tradeLawDescription": "string"
}
]
}

EC-CUBE 4.3 フロントAPI (4.3.0)

top

トップページを見る

Responses

Response samples

catalog

商品一覧を見る

query Parameters

Responses

Response samples

商品詳細を見る

path Parameters

Responses

Response samples

カテゴリ一覧を見る

Responses

Response samples

カテゴリ詳細を見る

path Parameters

Responses

Response samples

cart

カートを見る

Responses

Response samples

カートに追加する

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

カート数量を変更する

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

カートから削除する

path Parameters

Responses

Response samples

checkout

注文手続きへ進む

Responses

Response samples

購入ログインを見る

Responses

Response samples

非会員購入情報入力へ進む

Responses

Response samples

非会員情報を送信する

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

お届け先を選択する画面を見る

Responses

Response samples

お届け先を選択する

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

お届け先変更画面を見る

Responses

Response samples

お届け先を更新する

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

複数配送先設定画面を見る

Responses

Response samples

注文内容を確認する

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

注文を確定する

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required