BeMart Page Resource API Doc

BeMart page resources generated from BEAR.Sunday source, ALPS vocabulary, and available fake data fixtures.

Endpoints

Path Method Params Type Description Meta Response
/action-redirect GET returnTo string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 2048 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: /products
GET /action-redirect response
POST returnTo string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 2048 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: /products
POST /action-redirect response
/cart GET
ALPS `goCart` に対応する GET 操作。
sessionPrefix string セッション接頭辞(入力) - 購入フローのカートキーを構成するセッションスコープの接頭辞。saleTypeId と組み合わせて販売種別ごとのカートを分離する。 Fake観察文字長 16〜23; 観察値 'session-prefix-1', 'session-checkout-pilot5'。
minLength: 0 maxLength: 128 default: session-prefix-1 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: session-prefix-1
GET /cart response
/contact GET
EC-CUBE goContactForm — show the contact form scaffolding.
Pure form-info endpoint: no Be Framework involved, no domain logic. Anonymous-accessible (returns 200 regardless of session state). `csrfToken` carries the trusted reference {@see \CsrfToken::$token} issues — the HTML port renders it into the form's hidden `_token` input so the subsequent POST passes CSRF validation.
GET /contact response
POST
ALPS `doSubmitContact` に対応する POST 操作。
contactName01 string お問い合わせ姓(入力) - お問い合わせフォームの姓。内部的にはNameTypeのname01と同じ仕組み
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /contact response
contactName02 string お問い合わせ名(入力) - お問い合わせフォームの名。内部的にはNameTypeのname02と同じ仕組み
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
contactEmail string お問い合わせメール(入力) - お問い合わせフォームのメールアドレス
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: alice@example.com
contactContents string お問い合わせ内容(入力) - お問い合わせフォームの本文
minLength: 0 maxLength: 2000 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
mode string フォーム操作モード
minLength: 0 maxLength: 32 $comment: EC-CUBE compatible HTML form submit mode.
/entry GET
EC-CUBE goCustomerRegistration — show the customer registration form scaffolding.
Pure form-info endpoint: no Be Framework involved, no domain logic. Anonymous-accessible (returns 200 regardless of session state). Fields mirror RegisterCustomerInput: 4 required + 11 optional. In the dev/html fake-CSRF environment we expose the fake token into the hidden `_token` input so a real browser form submit can exercise the POST path instead of failing at the boundary.
GET /entry response
POST
Phase B Slice 9: every form field is user-controlled input. Declared as taint sources so Psalm can trace them. Semantic value objects format-validate but do not universally escape — sinks downstream still need their own defense (bound params, HTML escape on render).
email string メールアドレス(入力) - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: alice@example.com
POST /entry response
password string パスワード(入力) - 書き込み専用(ハッシュ化して保存) Fake観察文字長 50〜63; 観察値 '$2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi', '$2y$10$deputyplaceholder.hash.never.verified.0123456789abcdef', '$2y$10$zyxwvutsrqponmlkjihgfedcbaZYXWVUTSRQPONMLKJIHGFEDCBA9876', '$2y$12$lbpzHVyv.ytzJju.4xk9Au5tPePdQe1WFH6sLWeWwcvIKbn0vMnE.', '$2y$10$shopownerplaceholder.hash.never.verified.0123456789ab', '$2y$10$abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123', '$2y$10$0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRS', '$2y$12$placeholder.hash.never.verified.never.0123456789abcde'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: $2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi
name01 string 姓(入力) - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
name02 string 名(入力) - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
kana01 string セイ(入力) - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマダ
kana02 string メイ(入力) - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
companyName string 会社名(入力) - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Acme Corp.
phoneNumber string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
postalCode string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref string 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01 string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02 string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
birth string 生年月日(入力) - 会員の生年月日 Fake観察文字長 10〜10; 観察値 '1990-04-01', '1985-12-15'; null 18/28。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1990-04-01
sex string 性別(入力) - 1=男性, 2=女性, 3=その他, 4=回答しない Fake観察数値 2〜2; 観察値 '2'; null 3/5。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2
job string 職業(入力) - 1=公務員〜18=その他の18区分 Fake観察数値 7〜18; 観察値 '7', '18'; null 3/5。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 7
email_confirm string メールアドレス確認(入力) - HTML会員登録フォームの確認用メールアドレス。Resource境界でemailと照合する。
minLength: 0 maxLength: 254 $comment: Browser-form boundary field; not persisted.
password_confirm string パスワード確認(入力) - HTML会員登録フォームの確認用パスワード。Resource境界でpasswordと照合し、失敗時も再表示しない。
minLength: 0 maxLength: 128 $comment: Browser-form boundary field; not persisted.
birth_year string 生年月日 年(入力)
minLength: 0 maxLength: 4 $comment: Browser-form boundary field; combined into birth.
birth_month string 生年月日 月(入力)
minLength: 0 maxLength: 2 $comment: Browser-form boundary field; combined into birth.
birth_day string 生年月日 日(入力)
minLength: 0 maxLength: 2 $comment: Browser-form boundary field; combined into birth.
user_policy_check string 利用規約同意(入力)
minLength: 0 maxLength: 16 $comment: Browser-form boundary field; required only for HTML registration submissions.
mode string フォーム操作モード
minLength: 0 maxLength: 32 $comment: EC-CUBE compatible HTML form submit mode.
/forgot-complete GET
EC-CUBE goForgotComplete — render the reset-mail-sent confirmation page scaffolding.
GET /forgot-complete response
/forgot-password GET
EC-CUBE goRequestPasswordReset — show the password-reset-request form scaffolding.
Pure form-info endpoint: no Be Framework, no domain logic. Anonymous-accessible (returns 200 regardless of session state).
GET /forgot-password response
POST
ALPS `doRequestPasswordReset` に対応する POST 操作。
email* string メールアドレス(入力) - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: alice@example.com
POST /forgot-password response
/index GET
EC-CUBE goTop — render the top page scaffolding.
GET /index response
/login GET
EC-CUBE goLogin — show the login form scaffolding.
Pure form-info endpoint: no Be Framework involved, no domain logic. Anonymous-accessible (returns 200 regardless of session state). The `csrfToken` body field carries the trusted reference {@see \CsrfToken::$token} issues, which the HTML port renders into the form's hidden `_csrf_token` input so the subsequent POST passes CSRF validation.
GET /login response
POST
Phase B Slice 9: every form field is user-controlled input.
email string メールアドレス(入力) - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: alice@example.com
POST /login response
password string パスワード(入力) - 書き込み専用(ハッシュ化して保存) Fake観察文字長 50〜63; 観察値 '$2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi', '$2y$10$deputyplaceholder.hash.never.verified.0123456789abcdef', '$2y$10$zyxwvutsrqponmlkjihgfedcbaZYXWVUTSRQPONMLKJIHGFEDCBA9876', '$2y$12$lbpzHVyv.ytzJju.4xk9Au5tPePdQe1WFH6sLWeWwcvIKbn0vMnE.', '$2y$10$shopownerplaceholder.hash.never.verified.0123456789ab', '$2y$10$abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123', '$2y$10$0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRS', '$2y$12$placeholder.hash.never.verified.never.0123456789abcde'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: $2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi
mode string フォーム送信モード - HTMLフォーム送信をResource/JSON境界と区別するための任意パラメータ。ログイン画面では browser form re-render 判定にだけ使う。
minLength: 0 maxLength: 32 example: login
/logout POST
Phase B Slice 9: the CSRF token is user-controlled input.
POST /logout response
/mypage GET
ALPS `goMypage` に対応する GET 操作。
orderLimit int 一覧制御項目(入力) - /mypage のレスポンスで返す一覧制御項目。一覧、集計、CSV処理結果の規模を表す非負の数値。
default: 5 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
GET /mypage response
/product GET
Phase B Slice 9: `$productCode` is user input (URI / query param); declared explicitly so Psalm taint analysis can trace it through Becoming into any downstream sink. The Be Semantic\ProductCode constructor format-validates but does not escape — sinks downstream still need to defend (e.g. bound parameters for SQL).
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
GET /product response
/products GET
EC-CUBE goProductList — render the product-list page.
`name` is the EC-CUBE header search field. `nameKeyword` is accepted as a BeMart/API-friendly alias.
name string 商品名 - /products で表示する商品名。検索・一覧・詳細でユーザーに見せる販売名。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: テスト管理者
GET /products response
nameKeyword string 名前検索キーワード - /products の検索条件。商品名・会員名・管理者名など、この一覧画面で名前として扱う表示名を部分一致検索する。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
limit int 表示件数(入力) - /products の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 50 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
offset int 開始位置(入力) - /products の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
category_id string カテゴリID(検索入力) - /products のカテゴリ絞り込みでHTML query stringとして送られるカテゴリID。Resource境界では文字列で受け取り、カテゴリ名解決に使う。
pattern: ^[0-9]+$ minLength: 1 maxLength: 10 $comment: HTTP query parameterは文字列として届くためtransport schemaではstring|nullを許容する。数値性はpatternで表し、存在しないカテゴリはResource側で未絞り込みまたは0件として扱う。
pageno string ページ番号(入力) - /products の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
minLength: 0 maxLength: 64 $comment: EC-CUBE互換のフォーム/一覧境界で数値と文字列の両方が観察される。業務解釈はResource/Semantic層で行う。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
disp_number string 表示件数指定(入力) - /products の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
minLength: 0 maxLength: 64 $comment: EC-CUBE互換のフォーム/一覧境界で数値と文字列の両方が観察される。業務解釈はResource/Semantic層で行う。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
orderby string 並び順(入力) - /products の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/reset GET
EC-CUBE goResetPassword — show the new-password form scaffolding (EC-CUBE `Forgot/reset.twig`).
Pure form-info endpoint: no Be Framework, no domain logic. Anonymous-accessible (the reset-key check is the POST's job). The `resetKey` arrives as a query param on the emailed reset link and is carried into a hidden form field for the subsequent POST.
resetKey string パスワードリセットキー(入力) - パスワードリセット用のワンタイムトークン。リセット要求時に生成、使用後にクリア Fake観察文字長 32〜34; 観察値 'valid-reset-key-pilot15-aaaa1111', 'expired-token-key-pilot15-aaaa1111'。
minLength: 0 maxLength: 128 $comment: キー/追跡番号は照合用の不透明文字列で、数値演算対象ではない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: valid-reset-key-pilot15-aaaa1111
GET /reset response
POST
ALPS `doResetPassword` に対応する POST 操作。
resetKey* string パスワードリセットキー(入力) - パスワードリセット用のワンタイムトークン。リセット要求時に生成、使用後にクリア Fake観察文字長 32〜34; 観察値 'valid-reset-key-pilot15-aaaa1111', 'expired-token-key-pilot15-aaaa1111'。
minLength: 0 maxLength: 128 $comment: キー/追跡番号は照合用の不透明文字列で、数値演算対象ではない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: valid-reset-key-pilot15-aaaa1111
POST /reset response
password* string パスワード(入力) - 書き込み専用(ハッシュ化して保存) Fake観察文字長 50〜63; 観察値 '$2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi', '$2y$10$deputyplaceholder.hash.never.verified.0123456789abcdef', '$2y$10$zyxwvutsrqponmlkjihgfedcbaZYXWVUTSRQPONMLKJIHGFEDCBA9876', '$2y$12$lbpzHVyv.ytzJju.4xk9Au5tPePdQe1WFH6sLWeWwcvIKbn0vMnE.', '$2y$10$shopownerplaceholder.hash.never.verified.0123456789ab', '$2y$10$abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123', '$2y$10$0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRS', '$2y$12$placeholder.hash.never.verified.never.0123456789abcde'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: $2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi
/shopping GET
ALPS `goCheckoutEntry` / `goShopping` に対応する GET 操作。
sessionPrefix string セッション接頭辞(入力) - 購入フローのカートキーを構成するセッションスコープの接頭辞。saleTypeId と組み合わせて販売種別ごとのカートを分離する。 Fake観察文字長 16〜23; 観察値 'session-prefix-1', 'session-checkout-pilot5'。
minLength: 0 maxLength: 128 default: session-prefix-1 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: session-prefix-1
GET /shopping response
/unsupported-route GET routeName string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 255 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
GET /unsupported-route response
POST routeName string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 255 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /unsupported-route response
returnTo string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 2048 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: /products
/admin/action-redirect GET returnTo string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 2048 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: /products
GET /admin/action-redirect response
POST returnTo string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 2048 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: /products
POST /admin/action-redirect response
/admin/authority-role GET
Phase 3 admin HTML Tier-2: render the authority-rule management screen. The ALPS transition covers `doUpdateAuthorityRole`; EC-CUBE uses the same resource to edit URL-deny rules stored in `dtb_authority_role`.
GET /admin/authority-role response
POST
Wave 8: browser form input for URL deny rules. The primary HTML shape carries CSRF at the request boundary plus `AuthorityRoles[*][Authority]` / `AuthorityRoles[*][deny_url]`.
The legacy member role-flip shape (`loginId`, `authority`) remains supported for member workflow.
loginId string ログインID(入力) - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: test-admin
POST /admin/authority-role response
authority int 権限(入力) - 管理者権限レベル。0=システム管理者(最高権限、全機能アクセス可能), 1=店舗オーナー(制限あり、denyUrlで制限されたURLにアクセス不可)。数値が小さいほど権限が高い。AuthorityRoleのURL拒否パターンでアクセス制御 Fake観察数値 0〜1; 観察値 '1', '0'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
AuthorityRoles array 権限ルール入力一覧 - 権限管理画面のURL拒否ルール行。HTML form の AuthorityRoles[*][Authority] / deny_url を受け取る。
minItems: 0
/admin/base-info GET
Wave 9ι: goBaseInfo — admin views the shop base info form data.
Setting/Shop Tier-2 also renders `shop_master.twig` from this body; the `form` key carries an {@see \AdminShopMasterForm} pre-filled with the dtb_base_info row for the HTML editor.
GET /admin/base-info response
POST
Wave 8: every shop-info field is admin-form input.
shopName* string ショップ名(入力) - ショップの表示名。フロント画面のヘッダやメールに表示 Fake観察文字長 12〜12; 観察値 'EC-CUBE SHOP'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: EC-CUBE SHOP
POST /admin/base-info response
shopKana string ショップ名フリガナ(入力) - ショップ名のカタカナ読み Fake観察文字長 12〜12; 観察値 'イーシーキューブショップ'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: イーシーキューブショップ
shopNameEng string ショップ名英語(入力) - ショップの英語名。多言語対応やメール署名等で使用 Fake観察文字長 12〜12; 観察値 'EC-CUBE SHOP'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: EC-CUBE SHOP
companyName string 会社名(入力) - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Acme Corp.
postalCode string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref int 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01 string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02 string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
phoneNumber string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
businessHour string 営業時間(入力) - ショップの営業時間。フリーフォーマット Fake観察文字長 11〜11; 観察値 '10:00-19:00'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 10:00-19:00
shopEmail01 string 送信元/BCC メールアドレス(入力) - ほぼ全メール種別の送信元(From)兼ショップ控え(BCC)アドレス。注文確認・会員登録・パスワードリセット等で使用 Fake観察文字長 16〜16; 観察値 'shop@example.com'。
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: shop@example.com
shopMessage string ショップメッセージ(入力) - 「当サイトについて」ページ(Help/about.twig)に表示する店舗からのメッセージ Fake観察文字長 20〜20; 観察値 'ようこそ、EC-CUBE SHOP へ。'。
minLength: 0 maxLength: 2000 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ようこそ、EC-CUBE SHOP へ。
/admin/calendar GET
ALPS `goCalendar` に対応する GET 操作。
GET /admin/calendar response
POST
EC-CUBE doUpdateCalendar / doCreateCalendarHoliday.
operation string 操作種別(入力) - /admin/calendar のunsafe操作結果を表す操作種別。成功時の差分、処理件数、冪等状態をクライアントに返す。
minLength: 0 maxLength: 64 default: update $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/calendar response
title string 処理タイトル(入力) - /admin/calendar のレスポンスで表示またはテンプレート描画に使う処理タイトル。同名propertyでも親文脈 `root` によって意味を分ける。
minLength: 0 maxLength: 255 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
holiday string 休日指定(入力) - /admin/calendar の処理文脈から派生した休日指定。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
default: minLength: 0 maxLength: 64 $comment: EC-CUBE互換のフォーム/一覧境界で数値と文字列の両方が観察される。業務解釈はResource/Semantic層で行う。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
calendarId string カレンダーID(入力) - /admin/calendar のレスポンスで対象を識別するカレンダーID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 $comment: カレンダーID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
DELETE
EC-CUBE doDeleteCalendarHoliday.
calendarId string カレンダーID(入力) - /admin/calendar のレスポンスで対象を識別するカレンダーID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 $comment: カレンダーID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
DELETE /admin/calendar response
/admin/change-password GET
Renders the admin password-change form.
Admin-only: returns 403 for an anonymous request — the same firewall contract as the other admin pages, enforced at the resource layer (there is no Be Final to raise `UnauthorizedAdminAccessException`).
GET /admin/change-password response
POST
Applies the admin's own password change (doChangePassword).
Failure mapping: - Invalid CSRF → 403 (interceptor) - SemanticVariableException → 400 - InvalidCurrentPasswordException → 400 - PasswordConfirmationMismatchException→ 400 - PasswordPolicyViolationException → 400 - UnauthorizedAdminAccessException → 403 (no admin session) - AdminNotFoundException → 404 (stale session)
currentPassword* string フォーム文脈項目(入力) - /admin/change-password のフォーム文脈で使うフォーム文脈項目。入力保持、初期値、再表示に必要な補助値。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/change-password response
changePasswordFirst* string フォーム文脈項目(入力) - /admin/change-password のフォーム文脈で使うフォーム文脈項目。入力保持、初期値、再表示に必要な補助値。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
changePasswordSecond* string フォーム文脈項目(入力) - /admin/change-password のフォーム文脈で使うフォーム文脈項目。入力保持、初期値、再表示に必要な補助値。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/create-customer POST
Wave 5: every form field is user-controlled input — same taint discipline as the front-end entry. The admin AUTHZ check lives inside the first Being (AdminCustomerCreating), so this method can stay free of session lookups; we just map the exception.
email* string メールアドレス(入力) - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: alice@example.com
POST /admin/create-customer response
password* string パスワード(入力) - 書き込み専用(ハッシュ化して保存) Fake観察文字長 50〜63; 観察値 '$2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi', '$2y$10$deputyplaceholder.hash.never.verified.0123456789abcdef', '$2y$10$zyxwvutsrqponmlkjihgfedcbaZYXWVUTSRQPONMLKJIHGFEDCBA9876', '$2y$12$lbpzHVyv.ytzJju.4xk9Au5tPePdQe1WFH6sLWeWwcvIKbn0vMnE.', '$2y$10$shopownerplaceholder.hash.never.verified.0123456789ab', '$2y$10$abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123', '$2y$10$0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRS', '$2y$12$placeholder.hash.never.verified.never.0123456789abcde'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: $2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi
name01* string 姓(入力) - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
name02* string 名(入力) - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
kana01 string セイ(入力) - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマダ
kana02 string メイ(入力) - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
companyName string 会社名(入力) - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Acme Corp.
phoneNumber string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
postalCode string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref int 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01 string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02 string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
birth string 生年月日(入力) - 会員の生年月日 Fake観察文字長 10〜10; 観察値 '1990-04-01', '1985-12-15'; null 18/28。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1990-04-01
sex int 性別(入力) - 1=男性, 2=女性, 3=その他, 4=回答しない Fake観察数値 2〜2; 観察値 '2'; null 3/5。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2
job int 職業(入力) - 1=公務員〜18=その他の18区分 Fake観察数値 7〜18; 観察値 '7', '18'; null 3/5。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 7
/admin/csv-config GET
EC-CUBE CSV出力項目設定 — Setting/Shop Tier-2.
Thin GET renderer for `Setting/Shop/csv.twig`. The existing POST persists a submitted vector; this GET serves the editor body.
csvType int CSV種別(入力) - CSV出力項目設定で編集対象にするCSV種別。1=商品CSV, 2=会員CSV, 3=受注CSV, 4=配送CSV。HTTP queryでは文字列として届く場合があるためtransport schemaではstring|integer|nullを許容し、意味検証はResource/Semantic層へ委ねる。
default: 3 enum: [1,2,3,4,"1","2","3","4",null] $comment: GET query transport boundary: browser selection values arrive as strings; Resource signature casts/validates csvType semantics.
GET /admin/csv-config response
POST
Wave 9: admin-form input. The columns list is sanitized by Be / Semantic; the column entries themselves carry user-supplied column names so the taint mark applies to the whole payload.
csvType* int CSV種別(入力) - dtb_csv.csv_type_id — mtb_csv_type への FK(1=商品CSV, 2=会員CSV, 3=受注CSV, 4=出荷CSV)。1つの csvType が複数の列設定行(dtb_csv 行)を所有する。doUpdateCsv は1つの csvType の列ベクタ全体を一括 POST し、SqlCsvColumnConfigStorage::replaceType がその csvType の行集合をアトミックに置換する。mtb_csv_type は structure-only ダンプで空のため SQL テストは seedCsvTypes でシード(seedAdminMasters と同じ空マスタ FK シード規約)
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/csv-config response
columns array CSV列定義 - /admin/csv-config のCSV列設定。各要素は出力対象フィールドと表示名を表す。
minItems: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
csvOutput string CSV出力対象列(HTML入力) - CSV設定画面の multi-select `csvOutput[]` が送る出力対象列。JavaScript が生成する columns[n] と同じ列ベクタへ Resource 境界で正規化される。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
csvNotOutput string CSV非出力対象列(HTML入力) - CSV設定画面の multi-select `csvNotOutput[]` が送る非出力対象列。JavaScript が生成する columns[n] と同じ列ベクタへ Resource 境界で正規化される。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/customer GET
Wave 5: the email comes from the admin UI (typed input or query string), so it is user-controlled — same taint discipline as the customer-side LoginResource.
email string メールアドレス(入力) - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: alice@example.com
GET /admin/customer response
customerId string 会員ID(入力) - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: customer-001
id string ID(入力) - Fake観察文字長 13〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000003', 'fedcba9876543210fedcba9876543210', '10000000aaaa1111bbbb2222cccc3333', 'ad000000000000000000000000000002', '0123456789abcdef0123456789abcdef', 'aaaaaaaa00000000bbbbbbbb11111111', '20000000dddd2222eeee3333ffff4444'。
minLength: 0 maxLength: 128 $comment: ID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ad000000000000000000000000000001
POST
EC-CUBE doUpdateCustomerProfile — 会員情報を更新する(管理画面).
Admin-side edit of an EXISTING customer. The `customerId` comes from the form (the admin_customer_edit `{id}`) — a foreign id — so the admin AUTHZ check lives inside the first Being (AdminCustomerUpdating, which throws before the load). This method stays free of session lookups and just maps the exceptions. Failure mapping (matching the onGet ladder + the create sibling): - SemanticVariableException → 400 (email/name format) - UnauthorizedAdminAccessException → 403 (no admin session) - CustomerNotFoundException → 404 (unknown customerId) - EmailAlreadyRegisteredException → 409 (email already taken) On success: 200 with a `Location` header pointing back at the admin Customer detail URL keyed by the opaque customerId (POST-redirect-GET) — never by email, so no PII enters the URL.
customerId* string 会員ID(入力) - 編集対象会員の不透明な文字列ハンドル(admin_customer_edit の {id})。管理画面のフォームから供給され、管理ファイアウォール越しにのみ使用される。
minLength: 1 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]+$ $comment: Admin-supplied target id; gated by the admin firewall in the downstream Being. example: 0123456789abcdef0123456789abcdef
POST /admin/customer response
email* string メールアドレス(入力) - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: alice@example.com
name01* string 姓(入力) - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
name02* string 名(入力) - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
kana01 string セイ(入力) - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマダ
kana02 string メイ(入力) - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
companyName string 会社名(入力) - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Acme Corp.
phoneNumber string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
postalCode string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref int 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01 string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02 string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
birth string 生年月日(入力) - 会員の生年月日 Fake観察文字長 10〜10; 観察値 '1990-04-01', '1985-12-15'; null 18/28。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1990-04-01
sex int 性別(入力) - 1=男性, 2=女性, 3=その他, 4=回答しない Fake観察数値 2〜2; 観察値 '2'; null 3/5。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2
job int 職業(入力) - 1=公務員〜18=その他の18区分 Fake観察数値 7〜18; 観察値 '7', '18'; null 3/5。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 7
password string パスワード(入力) - 書き込み専用(ハッシュ化して保存) Fake観察文字長 50〜63; 観察値 '$2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi', '$2y$10$deputyplaceholder.hash.never.verified.0123456789abcdef', '$2y$10$zyxwvutsrqponmlkjihgfedcbaZYXWVUTSRQPONMLKJIHGFEDCBA9876', '$2y$12$lbpzHVyv.ytzJju.4xk9Au5tPePdQe1WFH6sLWeWwcvIKbn0vMnE.', '$2y$10$shopownerplaceholder.hash.never.verified.0123456789ab', '$2y$10$abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123', '$2y$10$0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRS', '$2y$12$placeholder.hash.never.verified.never.0123456789abcde'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: $2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi
/admin/customer-csv GET
ALPS `goExportCustomer` に対応する GET 操作。
GET /admin/customer-csv response
/admin/customer-delivery-edit GET
The customer id comes from the admin UI (route param), so it is user-controlled — same taint discipline as the sibling {@see Customer} resource.
customerId string 会員ID(入力) - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
default: minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: customer-001
GET /admin/customer-delivery-edit response
id string ID(入力) - Fake観察文字長 13〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000003', 'fedcba9876543210fedcba9876543210', '10000000aaaa1111bbbb2222cccc3333', 'ad000000000000000000000000000002', '0123456789abcdef0123456789abcdef', 'aaaaaaaa00000000bbbbbbbb11111111', '20000000dddd2222eeee3333ffff4444'。
default: minLength: 0 maxLength: 128 $comment: ID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ad000000000000000000000000000001
POST
Persist a customer delivery address. Empty `addressId` creates a new row (doCreateCustomerDeliveryAddress); a present `addressId` updates the existing row in place (doUpdateCustomerDeliveryAddress). The Be Final guards the AdminSession (403 first) then verifies the target customer / address ownership before writing.
customerId* string 会員ID - 対象会員の不透明ID(route param)。
minLength: 1 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]+$ $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0123456789abcdef0123456789abcdef
POST /admin/customer-delivery-edit response
name01* string 姓 - 配送先の姓。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 山田
name02* string 名 - 配送先の名。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 太郎
postalCode* string 郵便番号 - 日本の郵便番号。
minLength: 0 maxLength: 8 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref* int 都道府県ID - 1=北海道〜47=沖縄県。未選択初期値の0も許容。
minimum: 0 maximum: 47 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01* string 市区町村 - 市区町村名。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02* string 番地・建物名 - 番地・建物名。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
phoneNumber* string 電話番号 - 配送先の電話番号。
minLength: 0 maxLength: 13 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
addressId string 配送先ID - 更新対象の配送先ID。空文字なら新規作成。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: addr00000000000000000000000000a1
kana01 string セイ - 姓のカナ。null 許容。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマダ
kana02 string メイ - 名のカナ。null 許容。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: タロウ
companyName string 会社名 - 会社名。null 許容。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Acme Corp.
DELETE
Remove one customer delivery address. The Be Final guards the AdminSession (403 first) then verifies the address is owned by the route-param customer before deleting.
customerId* string 会員ID - 対象会員の不透明ID(route param)。
minLength: 1 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]+$ $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0123456789abcdef0123456789abcdef
DELETE /admin/customer-delivery-edit response
addressId* string 配送先ID - 削除対象の配送先ID。
minLength: 1 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]+$ $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: addr00000000000000000000000000a1
/admin/customer-list GET
Wave 5: filter fields are admin-form input — taint discipline mirrors the Wave 4 admin login.
nameKeyword string 名前検索キーワード - /admin/customer-list の検索条件。商品名・会員名・管理者名など、この一覧画面で名前として扱う表示名を部分一致検索する。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
GET /admin/customer-list response
emailKeyword string メール検索キーワード - /admin/customer-list の検索条件。会員または管理者のメールアドレス/ログイン識別子を部分一致検索する。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: carol
limit int 表示件数(入力) - /admin/customer-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 50 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/delete-customer POST
Wave 6: customerId is user-controlled input from the admin UI (admin clicks a customer-list row, the row's customerId feeds this form). Same taint discipline as goCustomer's email.
customerId* string 会員ID(入力) - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: customer-001
POST /admin/delete-customer response
/admin/empty-page GET
Renders the empty admin extension-slot page.
Admin-only: returns 403 for an anonymous request — the same firewall contract as the other admin pages.
GET /admin/empty-page response
/admin/index GET
Renders the admin dashboard scaffolding.
Admin-only: returns 403 for an anonymous (not-logged-in-as-admin) request — the same firewall contract as the News / Customer admin pages, enforced here at the resource layer because there is no Be Final to raise `UnauthorizedAdminAccessException`.
GET /admin/index response
/admin/log GET
ALPS `goLog` に対応する GET 操作。
GET /admin/log response
/admin/login GET
Show the admin login form scaffolding.
Pure form-info endpoint: no Be Framework involved, no domain logic. Anonymous-accessible (returns 200 regardless of session state) — the admin firewall guard is on the POST. The `csrfToken` body field carries the trusted reference {@see \CsrfToken::$token} issues, which the HTML port renders into the form's hidden `_csrf_token` input so the subsequent POST passes CSRF validation.
GET /admin/login response
POST
Wave 4 / Phase B Slice 9: every form field is user-controlled input — same taint discipline as the customer login.
loginId string ログインID(入力) - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: test-admin
POST /admin/login response
password string パスワード(入力) - 書き込み専用(ハッシュ化して保存) Fake観察文字長 50〜63; 観察値 '$2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi', '$2y$10$deputyplaceholder.hash.never.verified.0123456789abcdef', '$2y$10$zyxwvutsrqponmlkjihgfedcbaZYXWVUTSRQPONMLKJIHGFEDCBA9876', '$2y$12$lbpzHVyv.ytzJju.4xk9Au5tPePdQe1WFH6sLWeWwcvIKbn0vMnE.', '$2y$10$shopownerplaceholder.hash.never.verified.0123456789ab', '$2y$10$abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123', '$2y$10$0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRS', '$2y$12$placeholder.hash.never.verified.never.0123456789abcde'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: $2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi
mode string フォーム送信モード - HTMLフォーム送信をResource/JSON境界と区別するための任意パラメータ。管理ログイン画面では browser form re-render 判定にだけ使う。
minLength: 0 maxLength: 32 example: login
/admin/login-history GET
ALPS `goLoginHistoryList` に対応する GET 操作。
limit int 表示件数(入力) - /admin/login-history の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 50 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
GET /admin/login-history response
/admin/logout POST
Wave 4 / Phase B Slice 9: the CSRF token is user-controlled input — same taint discipline as the customer logout.
POST /admin/logout response
/admin/mail-template GET
Wave 9ι: goMailTemplateList — admin lists every mail template.
mailTemplateId int メールテンプレートID
GET /admin/mail-template response
POST
ALPS `doUpdateMailTemplate` に対応する POST 操作。
mailTemplateId* int メールテンプレートID(入力) - dtb_mail_template.id(int unsigned AUTO_INCREMENT)の正の整数主キー。doUpdateMailTemplate の必須入力で、既存行を指す必要がある。SqlMailTemplateStorage は findById / update をこの id で引き、未知 id は MailTemplateNotFoundException(404)。新規テンプレート作成フローは file_name 設定と Twig ファイル書き出しを伴うため Phase 2 scope であり、ID 生成器は存在しない(更新専用契約) Fake観察数値 1〜2; 観察値 '1', '2'。
$comment: メールテンプレートID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. minLength: 0 maxLength: 128 example: 1
POST /admin/mail-template response
mailSubject string メール件名(入力) - メールの件名。テンプレート変数を含む場合あり Fake観察文字長 13〜13; 観察値 'ご注文ありがとうございます'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ご注文ありがとうございます
mail_subject string メール件名(HTMLフォーム入力) - 管理画面HTMLフォームの `mail_subject` field。Resourceでは `mailSubject` と同じ doUpdateMailTemplate の件名入力として扱う。
minLength: 0 maxLength: 32 $comment: HTTP form boundary uses snake_case field names; Resource normalizes this to the ALPS mailSubject input. example: ご注文ありがとうございます
DELETE
EC-CUBE doDeleteMailTemplate.
The mail-template master still needs a full file-backed delete in a later adapter pass; this surface is intentionally narrow and concrete so the legacy route reaches a Resource with CSRF/AUTHZ semantics instead of generic ActionRedirect.
mailTemplateId* int メールテンプレートID(入力) - dtb_mail_template.id(int unsigned AUTO_INCREMENT)の正の整数主キー。doUpdateMailTemplate の必須入力で、既存行を指す必要がある。SqlMailTemplateStorage は findById / update をこの id で引き、未知 id は MailTemplateNotFoundException(404)。新規テンプレート作成フローは file_name 設定と Twig ファイル書き出しを伴うため Phase 2 scope であり、ID 生成器は存在しない(更新専用契約) Fake観察数値 1〜2; 観察値 '1', '2'。
$comment: メールテンプレートID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. minLength: 0 maxLength: 128 example: 1
DELETE /admin/mail-template response
/admin/master-data GET
ALPS `goMasterData` に対応する GET 操作。
masterType string マスタ種別(入力) - /admin/master-data の処理文脈から派生したマスタ種別。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minLength: 0 maxLength: 255 default: tag $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
GET /admin/master-data response
PUT
Selects which master to view (doSelectMasterData). ALPS marks it `idempotent` → PUT; returns the chosen master's rows.
masterType string マスタ種別(入力) - /admin/master-data の処理文脈から派生したマスタ種別。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minLength: 0 maxLength: 255 default: tag $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
PUT /admin/master-data response
/admin/master-data-edit PUT
ALPS `doUpdateMasterData` に対応する PUT 操作。
masterType* string マスタ種別(入力) - /admin/master-data-edit の処理文脈から派生したマスタ種別。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
PUT /admin/master-data-edit response
rows array 行データ - /admin/master-data-edit のマスタ/CSV行データ。列集合は対象マスタにより変わるため、既知列を優先して契約する。
minItems: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/member GET
Wave 8: the loginId comes from the admin UI (typed input or query string) — user-controlled.
loginId string ログインID(入力) - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: test-admin
GET /admin/member response
POST
Wave 8: all form fields are user-controlled. The admin AUTHZ check lives inside the first Being (MemberCreating), so this method just maps the exceptions.
loginId* string ログインID(入力) - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._-]+$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: test-admin
POST /admin/member response
password* string パスワード(入力) - 書き込み専用(ハッシュ化して保存) Fake観察文字長 50〜63; 観察値 '$2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi', '$2y$10$deputyplaceholder.hash.never.verified.0123456789abcdef', '$2y$10$zyxwvutsrqponmlkjihgfedcbaZYXWVUTSRQPONMLKJIHGFEDCBA9876', '$2y$12$lbpzHVyv.ytzJju.4xk9Au5tPePdQe1WFH6sLWeWwcvIKbn0vMnE.', '$2y$10$shopownerplaceholder.hash.never.verified.0123456789ab', '$2y$10$abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123', '$2y$10$0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRS', '$2y$12$placeholder.hash.never.verified.never.0123456789abcde'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: $2y$12$stXeC3GBw5uMLkgK/6Vb0.R7XLnwERRqWM/Hl7rtAhp4IcHoK8eWi
name* string 処理表示名(入力) - Fake観察文字長 1〜7; 観察値 'テスト管理者', '副管理者', '店舗オーナー', '削除済み管理者', 'Red', 'Blue', 'S', 'Color'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: テスト管理者
authority* int 権限(入力) - 管理者権限レベル。0=システム管理者(最高権限、全機能アクセス可能), 1=店舗オーナー(制限あり、denyUrlで制限されたURLにアクセス不可)。数値が小さいほど権限が高い。AuthorityRoleのURL拒否パターンでアクセス制御 Fake観察数値 0〜1; 観察値 '1', '0'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
passwordConfirm string パスワード確認(入力)
minLength: 0 maxLength: 128 $comment: Browser-form boundary field; compared with password before CreateMemberInput.
mode string フォーム送信モード
minLength: 0 maxLength: 32 $comment: HTML form submit marker; Resource workflow calls omit it.
PUT
Wave 8: doUpdateMember — edits `name` only. The other admin fields (authority, work, passwordHash) have their own dedicated transitions / are out of scope for Phase 1. EC-CUBE 4.3 dtb_member has no email column, so no mailAddress field is accepted.
loginId* string ログインID(入力) - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: test-admin
PUT /admin/member response
name string 処理表示名(入力) - Fake観察文字長 1〜7; 観察値 'テスト管理者', '副管理者', '店舗オーナー', '削除済み管理者', 'Red', 'Blue', 'S', 'Color'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: テスト管理者
mode string フォーム送信モード
minLength: 0 maxLength: 32 $comment: HTML form submit marker; Resource workflow calls omit it.
DELETE
Wave 8: doDeleteMember — soft-delete (work=0). Idempotent replay returns 200 with `alreadyDeleted=true`. The caller's own account, and any target that outranks the caller, raise {@see InsufficientAuthorityException} → 403.
loginId* string ログインID(入力) - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: test-admin
DELETE /admin/member response
mode string フォーム送信モード
minLength: 0 maxLength: 32 $comment: HTML form submit marker; Resource workflow calls omit it.
/admin/member-list GET
Wave 8: filter / paging knobs are admin-form input. Same taint discipline as the customer-list and order-list variants.
nameKeyword string 名前検索キーワード - /admin/member-list の検索条件。商品名・会員名・管理者名など、この一覧画面で名前として扱う表示名を部分一致検索する。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
GET /admin/member-list response
limit int 表示件数(入力) - /admin/member-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 50 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
offset int 開始位置(入力) - /admin/member-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/order GET
Wave 7: orderNo comes from the admin UI (click on an order-list row, or pasted into the URL).
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
GET /admin/order response
PUT
Wave 7: every editable field is admin-form input. The orderNo selector is also admin-controlled. Same taint discipline as the Wave 5 / Wave 6 admin resources.
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
PUT /admin/order response
discount int 値引き額(入力) - 受注全体の値引き合計額。クーポン等による値引き Fake観察数値 0〜0; 観察値 '0'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0
charge int 手数料(入力) - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
$comment: 手数料(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0
usePoint int 使用ポイント(入力) - 注文で使用するポイント数。実際の値引き額は usePoint x pointConversionRate(切り捨て)で計算され、不課税のポイント値引き明細として受注に追加 Fake観察数値 0〜0; 観察値 '0'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0
/admin/order-list GET
Wave 7: pagination knobs are admin-form input. Same taint discipline as Wave 5 / Wave 6 admin resources.
limit int 表示件数(入力) - /admin/order-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 50 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
GET /admin/order-list response
offset int 開始位置(入力) - /admin/order-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/order-status GET
EC-CUBE 受注対応状況設定 — Setting/Shop Tier-2.
Thin GET renderer for `Setting/Shop/order_status.twig`. BeMart has a per-order status-change transition on POST, but not yet a master-data transition for editing status labels/colors.
GET /admin/order-status response
PUT
EC-CUBE doUpdateOrderStatusList — settings-side status list update.
This is intentionally separate from {@see \onPost()}, which updates one order's workflow status. The settings screen submits the master-list shape; this wave exposes a concrete CSRF/AUTHZ surface and returns the accepted payload count without claiming full EC-CUBE master-data persistence yet.
orderStatuses array 注文ステータス一覧(入力) - /admin/order-status のレスポンスで扱う注文ステータス一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
PUT /admin/order-status response
orderStatusRows string 受注ステータス(入力) - 1=新規受付, 3=注文取消, 4=対応中, 5=発送済み, 6=入金済み, 7=決済処理中, 8=購入処理中, 9=返品。Symfony Workflowステートマシンで遷移を制御。許可される遷移: pay(1->6), packing(1,6->4), cancel(1,4,6->3), back_to_in_progress(3->4), ship(1,6,4->5), return(5->9), cancel_return(9->5)。7と8はPurchaseFlow内で直接セットされステートマシン遷移の対象外
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST
Wave 7: both `orderNo` and `orderStatus` are admin-form input (orderNo selected from the order-list row, orderStatus picked from a dropdown of dtb_order_status values).
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
POST /admin/order-status response
orderStatus* int 受注ステータス(入力) - 1=新規受付, 3=注文取消, 4=対応中, 5=発送済み, 6=入金済み, 7=決済処理中, 8=購入処理中, 9=返品。Symfony Workflowステートマシンで遷移を制御。許可される遷移: pay(1->6), packing(1,6->4), cancel(1,4,6->3), back_to_in_progress(3->4), ship(1,6,4->5), return(5->9), cancel_return(9->5)。7と8はPurchaseFlow内で直接セットされステートマシン遷移の対象外 Fake観察数値 1〜1; 観察値 '1'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
/admin/plugin DELETE
Wave 8: pluginCode is admin-form input (selected from the grid).
pluginCode* string プラグインコード(入力) - プラグインの一意識別子。dtb_plugin.code に格納する自然キー — 列名は `code` であって `plugin_code` ではない(dtb_plugin は EC-CUBE 後発の dtb_*_code 命名規約より古い)。findByCode / install / uninstall / setEnabled の全ライフサイクルメソッドがこの列をプローブする。dtb_plugin は FK 制約を持たないが structure-only ダンプでは空のため、SQL ハイパーメディアテストは seedPlugins で2つのデモプラグイン(Sample/SamplePlugin, Sample/DisabledPlugin)をシードする Fake観察文字長 19〜21; 観察値 'Sample/SamplePlugin', 'Sample/DisabledPlugin'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Sample/SamplePlugin
DELETE /admin/plugin response
/admin/plugin-disable POST
ALPS `doDisablePlugin` に対応する POST 操作。
pluginCode* string プラグインコード(入力) - プラグインの一意識別子。dtb_plugin.code に格納する自然キー — 列名は `code` であって `plugin_code` ではない(dtb_plugin は EC-CUBE 後発の dtb_*_code 命名規約より古い)。findByCode / install / uninstall / setEnabled の全ライフサイクルメソッドがこの列をプローブする。dtb_plugin は FK 制約を持たないが structure-only ダンプでは空のため、SQL ハイパーメディアテストは seedPlugins で2つのデモプラグイン(Sample/SamplePlugin, Sample/DisabledPlugin)をシードする Fake観察文字長 19〜21; 観察値 'Sample/SamplePlugin', 'Sample/DisabledPlugin'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Sample/SamplePlugin
POST /admin/plugin-disable response
/admin/plugin-enable POST
ALPS `doEnablePlugin` に対応する POST 操作。
pluginCode* string プラグインコード(入力) - プラグインの一意識別子。dtb_plugin.code に格納する自然キー — 列名は `code` であって `plugin_code` ではない(dtb_plugin は EC-CUBE 後発の dtb_*_code 命名規約より古い)。findByCode / install / uninstall / setEnabled の全ライフサイクルメソッドがこの列をプローブする。dtb_plugin は FK 制約を持たないが structure-only ダンプでは空のため、SQL ハイパーメディアテストは seedPlugins で2つのデモプラグイン(Sample/SamplePlugin, Sample/DisabledPlugin)をシードする Fake観察文字長 19〜21; 観察値 'Sample/SamplePlugin', 'Sample/DisabledPlugin'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Sample/SamplePlugin
POST /admin/plugin-enable response
/admin/plugin-list GET
ALPS `goPluginList` に対応する GET 操作。
GET /admin/plugin-list response
POST
Wave 8: every form field is admin-form input.
pluginCode* string プラグインコード(入力) - プラグインの一意識別子。dtb_plugin.code に格納する自然キー — 列名は `code` であって `plugin_code` ではない(dtb_plugin は EC-CUBE 後発の dtb_*_code 命名規約より古い)。findByCode / install / uninstall / setEnabled の全ライフサイクルメソッドがこの列をプローブする。dtb_plugin は FK 制約を持たないが structure-only ダンプでは空のため、SQL ハイパーメディアテストは seedPlugins で2つのデモプラグイン(Sample/SamplePlugin, Sample/DisabledPlugin)をシードする Fake観察文字長 19〜21; 観察値 'Sample/SamplePlugin', 'Sample/DisabledPlugin'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Sample/SamplePlugin
POST /admin/plugin-list response
pluginName* string プラグイン名(入力) - プラグインの表示名。dtb_plugin.name に格納。PluginEntity の pluginName に対応 Fake観察文字長 13〜22; 観察値 'Sample Plugin', 'Disabled Sample Plugin'。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Sample Plugin
pluginVersion* string プラグインバージョン(入力) - プラグインのバージョン文字列。dtb_plugin.version に格納。PluginEntity の version に対応
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/product GET
goProduct (admin variant) — fetch full product detail.
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
GET /admin/product response
POST
doCreateProduct — create a new product.
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
POST /admin/product response
productName* string 商品名(入力) - 商品の表示名 Fake観察文字長 6〜17。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: サンプル商品 A
price02* int 販売価格(入力) - 実際の販売価格(税抜)。税計算・小計計算のベース Fake観察数値 800〜28000。
$comment: 販売価格(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 3500
stock int 在庫数(入力) - 物理在庫数。stockUnlimited=trueの場合は無視される。注文確定時に引き当てが行われる Fake観察数値 0〜100; 観察値 '0', '10', '20', '50', '5', '7', '100', '3'; null 9/73。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0
productStatus int 商品ステータス(入力) - 1=公開(フロント表示), 2=非公開(フロント非表示), 3=廃止(論理削除、管理画面でもデフォルト非表示) Fake観察数値 1〜3; 観察値 '1', '2', '3'。
$comment: 商品ステータス(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
description string 詳細説明文(入力) - 商品詳細ページに表示する説明文 Fake観察文字長 12〜32; 観察値 'Stock-unlimited fixture', 'Wave 8 admin grid: visible row', 'Wave 8 admin grid: hidden row', 'Wave 8 admin grid: withdrawn row', '管理画面から名称変更した、彩り豊かなジェラートセットです。', '管理画面から作成した商品'; null 1/7。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Stock-unlimited fixture
searchWord string 検索ワード(入力) - フロント検索でヒットさせるためのキーワード。画面には表示されない検索補助データ Fake観察文字長 9〜15; 観察値 '管理 active', '管理 withdrawn', '管理 hidden', 'ジェラート ギフト 彩 api', 'ui create'; null 10/42。
minLength: 0 maxLength: 1000 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 管理 active
note string 商品備考(入力) - 管理者のみが参照する内部メモ。フロントには表示されない Fake観察文字長 11〜25; 観察値 'internal note A', 'internal note C', 'internal note B', '管理画面名称変更 smoke 2026-05-23', 'Codex smoke'; null 10/42。
minLength: 0 maxLength: 1000 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: internal note A
PUT
doUpdateProduct — edit an existing product (partial overwrite).
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
PUT /admin/product response
productName string 商品名(入力) - 商品の表示名 Fake観察文字長 6〜17。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: サンプル商品 A
price02 int 販売価格(入力) - 実際の販売価格(税抜)。税計算・小計計算のベース Fake観察数値 800〜28000。
$comment: 販売価格(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 3500
stock int 在庫数(入力) - 物理在庫数。stockUnlimited=trueの場合は無視される。注文確定時に引き当てが行われる Fake観察数値 0〜100; 観察値 '0', '10', '20', '50', '5', '7', '100', '3'; null 9/73。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0
productStatus int 商品ステータス(入力) - 1=公開(フロント表示), 2=非公開(フロント非表示), 3=廃止(論理削除、管理画面でもデフォルト非表示) Fake観察数値 1〜3; 観察値 '1', '2', '3'。
$comment: 商品ステータス(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
description string 詳細説明文(入力) - 商品詳細ページに表示する説明文 Fake観察文字長 12〜32; 観察値 'Stock-unlimited fixture', 'Wave 8 admin grid: visible row', 'Wave 8 admin grid: hidden row', 'Wave 8 admin grid: withdrawn row', '管理画面から名称変更した、彩り豊かなジェラートセットです。', '管理画面から作成した商品'; null 1/7。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Stock-unlimited fixture
searchWord string 検索ワード(入力) - フロント検索でヒットさせるためのキーワード。画面には表示されない検索補助データ Fake観察文字長 9〜15; 観察値 '管理 active', '管理 withdrawn', '管理 hidden', 'ジェラート ギフト 彩 api', 'ui create'; null 10/42。
minLength: 0 maxLength: 1000 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 管理 active
note string 商品備考(入力) - 管理者のみが参照する内部メモ。フロントには表示されない Fake観察文字長 11〜25; 観察値 'internal note A', 'internal note C', 'internal note B', '管理画面名称変更 smoke 2026-05-23', 'Codex smoke'; null 10/42。
minLength: 0 maxLength: 1000 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: internal note A
DELETE
doDeleteProduct — soft-delete (status=3). Idempotent replay surfaces `alreadyDeleted=true`.
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
DELETE /admin/product response
/admin/product-bulk-status POST
ALPS `doBulkUpdateProductStatus` に対応する POST 操作。
productCodes* array 取込商品コード一覧 - 商品CSV取込で処理対象になったSKU一覧。各要素は商品コード制約に従う。
minItems: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/product-bulk-status response
productStatus* int 商品ステータス(入力) - 1=公開(フロント表示), 2=非公開(フロント非表示), 3=廃止(論理削除、管理画面でもデフォルト非表示) Fake観察数値 1〜3; 観察値 '1', '2', '3'。
$comment: 商品ステータス(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
/admin/product-copy POST
ALPS `doCopyProduct` に対応する POST 操作。
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
POST /admin/product-copy response
newProductCode* string 処理識別子(入力) - /admin/product-copy のレスポンスで扱う処理識別子。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
/admin/product-csv GET
ALPS `goExportProduct` に対応する GET 操作。
GET /admin/product-csv response
POST
ALPS `doCreateProduct` に対応する POST 操作。
csv* string 輸送ペイロード(入力) - CSVインポート/エクスポート本文。列構造の詳細はCSV互換サービス境界で検査する。
minLength: 0 maxLength: 5000000 $comment: CSV列の業務妥当性はCSV互換サービスで検査する。ここではJSON境界上の文字列サイズを契約する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/product-csv response
/admin/product-list GET
ALPS `goProductList` に対応する GET 操作。
nameKeyword string 名前検索キーワード - /admin/product-list の検索条件。商品名・会員名・管理者名など、この一覧画面で名前として扱う表示名を部分一致検索する。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
GET /admin/product-list response
limit int 表示件数(入力) - /admin/product-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 50 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
offset int 開始位置(入力) - /admin/product-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/product-new GET
ALPS `doCreateProduct` に対応する GET 操作。
GET /admin/product-new response
/admin/security GET
ALPS `doUpdateSecurity` に対応する GET 操作。
GET /admin/security response
PUT
Updates the security settings (doUpdateSecurity). ALPS marks this `idempotent` → PUT.
Failure mapping: - Invalid CSRF → 403 (interceptor) - SemanticVariableException → 400 - UnauthorizedAdminAccessException → 403 (no admin session)
adminAllowHosts string 処理一覧(入力) - /admin/security のレスポンスで扱う処理一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minLength: 0 maxLength: 255 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
PUT /admin/security response
adminDenyHosts string 処理一覧(入力) - /admin/security のレスポンスで扱う処理一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minLength: 0 maxLength: 255 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
frontAllowHosts string 処理一覧(入力) - /admin/security のレスポンスで扱う処理一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minLength: 0 maxLength: 255 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
frontDenyHosts string 処理一覧(入力) - /admin/security のレスポンスで扱う処理一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minLength: 0 maxLength: 255 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
trustedHosts string 処理一覧(入力) - /admin/security のレスポンスで扱う処理一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minLength: 0 maxLength: 255 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/sort-no-move PUT
ALPS `doSortNoMove` に対応する PUT 操作。
masterType* string マスタ種別(入力) - /admin/sort-no-move の処理文脈から派生したマスタ種別。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
PUT /admin/sort-no-move response
rowId* string 行ID(入力) - /admin/sort-no-move のレスポンスで対象を識別する行ID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 $comment: 行ID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
sortNo* int 表示順(入力) - 一覧における並び順 Fake観察数値 1〜20; 観察値 '1', '3', '2', '4', '10', '20'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
/admin/system GET
ALPS `goSystemInfo` に対応する GET 操作。
GET /admin/system response
/admin/toggle-visible PUT
ALPS `doToggleVisible` に対応する PUT 操作。
masterType* string マスタ種別(入力) - /admin/toggle-visible の処理文脈から派生したマスタ種別。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
PUT /admin/toggle-visible response
rowId* string 行ID(入力) - /admin/toggle-visible のレスポンスで対象を識別する行ID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 $comment: 行ID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
visible* bool 処理状態フラグ(入力) - 観察値 'true'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: true
/admin/trade-law GET
Wave 9ι: goTradeLawList — admin views the current TradeLaw body.
GET /admin/trade-law response
POST
ALPS `doUpdateTradeLaw` に対応する POST 操作。
tradeLawBody string 特定商取引法本文(入力) - 特定商取引法ページ本文の単一ブロブ投影。項目別行ではなく、ページ全体を1本の本文として扱う。
minLength: 0 maxLength: 65535 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/trade-law response
mode string HTMLフォーム送信時のPRG mode。
enum: ["trade_law_form",null]
trade_law_1_name string
trade_law_1_description string
trade_law_1_displayOrderScreen string
trade_law_2_name string
trade_law_2_description string
trade_law_2_displayOrderScreen string
trade_law_3_name string
trade_law_3_description string
trade_law_3_displayOrderScreen string
trade_law_4_name string
trade_law_4_description string
trade_law_4_displayOrderScreen string
trade_law_5_name string
trade_law_5_description string
trade_law_5_displayOrderScreen string
trade_law_6_name string
trade_law_6_description string
trade_law_6_displayOrderScreen string
/admin/two-factor-auth GET
Renders the admin 2FA challenge form.
Anonymous-accessible (login-context): returns 200 regardless of session state — the admin firewall guard is downstream of a successful challenge.
GET /admin/two-factor-auth response
POST
Verifies the submitted TOTP code (doVerifyTwoFactorAuth).
Login-context: no admin-firewall guard. The trusted `loginId` is read from the password-verified session challenge and the admin session is elevated only after the token succeeds. Legacy client-supplied `loginId` is ignored. Failure mapping: - Invalid CSRF → 403 (interceptor) - Missing pending challenge → 403 - SemanticVariableException → 400 (malformed code) - TwoFactorAuthFailedException → 400 (code mismatch) - LoginAttemptsExceededException → 429 (too many codes burned; the pending challenge is dropped here, so the admin has to come back through the password stage — which is throttled on the same counter, i.e. only after the window has passed)
deviceToken* string 二要素認証デバイストークン(入力) - /admin/two-factor-auth のレスポンスで扱う二要素認証デバイストークン。数値演算対象ではなく、照合・URL・配送追跡などに使う不透明な文字列識別子。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/two-factor-auth response
loginId string ログインID(入力) - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。 この値は2FAログインチャレンジでは互換入力としてのみ受け取り、信頼しない。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: test-admin
mode string フォーム送信モード - HTMLフォーム送信をResource/JSON境界と区別するための任意パラメータ。2FAチャレンジ画面では browser の 303 リダイレクト判定にだけ使う。
minLength: 0 maxLength: 32 example: verify
/admin/two-factor-auth-edit GET
ALPS `goAdminTwoFactorAuthEdit` に対応する GET 操作。
GET /admin/two-factor-auth-edit response
/admin/two-factor-auth-set GET
Renders the admin 2FA device-setup form.
Anonymous-accessible (login-context): returns 200 regardless of session state.
GET /admin/two-factor-auth-set response
PUT
Registers the TOTP device after confirming the first code (doSetTwoFactorAuth). ALPS marks this `idempotent` → PUT.
The pending login identity and server-generated candidate secret are read from {@see \HtmlAdminLoginChallengeAdapter}. Legacy client fields (`loginId`, `authKey`) may still arrive from old forms/tests, but are deliberately ignored and never forwarded to the Be transition. Failure mapping: - Invalid CSRF → 403 (interceptor) - Missing pending setup → 403 - SemanticVariableException → 400 (malformed code) - TwoFactorAuthFailedException → 400 (first code mismatch)
deviceToken* string 二要素認証デバイストークン(入力) - /admin/two-factor-auth-set のレスポンスで扱う二要素認証デバイストークン。数値演算対象ではなく、照合・URL・配送追跡などに使う不透明な文字列識別子。
minLength: 0 maxLength: 128 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
PUT /admin/two-factor-auth-set response
loginId string ログインID(入力) - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。 この値は2FAログインチャレンジでは互換入力としてのみ受け取り、信頼しない。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: test-admin
authKey string 二要素認証キー(入力) - /admin/two-factor-auth-set のレスポンスで扱う二要素認証キー。数値演算対象ではなく、照合・URL・配送追跡などに使う不透明な文字列識別子。 この値は2FA設定では互換入力としてのみ受け取り、信頼しない。
minLength: 0 maxLength: 128 $comment: キー/追跡番号は照合用の不透明文字列で、数値演算対象ではない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
mode string フォーム送信モード - HTMLフォーム送信をResource/JSON境界と区別するための任意パラメータ。2FAデバイス登録画面では browser の 303 リダイレクト判定にだけ使う。
minLength: 0 maxLength: 32 example: set
/admin/unsupported-route GET routeName string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 255 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
GET /admin/unsupported-route response
POST routeName string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 255 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/unsupported-route response
returnTo string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 2048 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: /products
/cart/item POST
Phase B Slice 9: all three params arrive from the HTTP request body and are user-controlled. Declared as taint sources so Psalm can trace them through Becoming into any downstream sink (Phase 2 will surface real flows once Fake Reasons are swapped for DB-backed implementations).
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
POST /cart/item response
quantity int 数量(入力) - 購入数量。カート明細と受注明細で共通使用 Fake観察数値 1〜3; 観察値 '1', '2', '3'。
$comment: 数量(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
sessionPrefix string セッション接頭辞(入力) - 購入フローのカートキーを構成するセッションスコープの接頭辞。saleTypeId と組み合わせて販売種別ごとのカートを分離する。 Fake観察文字長 16〜23; 観察値 'session-prefix-1', 'session-checkout-pilot5'。
minLength: 0 maxLength: 128 default: session-prefix-1 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: session-prefix-1
operation string 操作種別(入力) - /cart/item のunsafe操作結果を表す操作種別。成功時の差分、処理件数、冪等状態をクライアントに返す。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
PUT
EC-CUBE doUpdateCartItemQuantity — replace an item's quantity (Pilot 10). Idempotent (PUT semantics), CSRF-guarded.
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
PUT /cart/item response
quantity* int 数量(入力) - 購入数量。カート明細と受注明細で共通使用 Fake観察数値 1〜3; 観察値 '1', '2', '3'。
$comment: 数量(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
sessionPrefix string セッション接頭辞(入力) - 購入フローのカートキーを構成するセッションスコープの接頭辞。saleTypeId と組み合わせて販売種別ごとのカートを分離する。 Fake観察文字長 16〜23; 観察値 'session-prefix-1', 'session-checkout-pilot5'。
minLength: 0 maxLength: 128 default: session-prefix-1 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: session-prefix-1
DELETE
EC-CUBE doRemoveCartItem — remove an item from the cart (Pilot 11).
Idempotent (DELETE), CSRF-guarded.
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
DELETE /cart/item response
sessionPrefix string セッション接頭辞(入力) - 購入フローのカートキーを構成するセッションスコープの接頭辞。saleTypeId と組み合わせて販売種別ごとのカートを分離する。 Fake観察文字長 16〜23; 観察値 'session-prefix-1', 'session-checkout-pilot5'。
minLength: 0 maxLength: 128 default: session-prefix-1 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: session-prefix-1
/contact/complete GET
ALPS `goContactComplete` に対応する GET 操作。
ticketId string 受付番号(入力) - 問い合わせ送信後に発行される公開受付番号。問い合わせ本文の readback resource ではなく、完了状態の成立証拠として使う。
default: minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
GET /contact/complete response
/contact/confirm GET
ALPS `goContactForm` に対応する GET 操作。
GET /contact/confirm response
/entry/activate GET
EC-CUBE doActivateCustomer landing — the email-verification-complete screen. Pure renderer: the body surfaces only the screen shape + the outbound `goTop` transition (ALPS `#CustomerActivationComplete`).
GET /entry/activate response
POST
ALPS `doActivateCustomer` に対応する POST 操作。
secretKey* string メール認証キー(入力) - 会員アカウントのメール認証トークン。/entry/activate/{secret_key}形式のURLに使用。暗号鍵やAPIシークレットではない。会員登録時にランダム生成 Fake観察文字長 34〜34; 観察値 'pending-secret-key-pilot7-2026abcd'; null 19/25。
minLength: 0 maxLength: 128 $comment: キー/追跡番号は照合用の不透明文字列で、数値演算対象ではない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: pending-secret-key-pilot7-2026abcd
POST /entry/activate response
/entry/complete GET
ALPS `goCustomerRegistrationComplete` に対応する GET 操作。
GET /entry/complete response
/entry/confirm GET
ALPS `goCustomerRegistrationConfirm` に対応する GET 操作。
GET /entry/confirm response
/help/about GET
ALPS `goodTraded` に対応する GET 操作。
GET /help/about response
/help/agreement GET
ALPS `goHelpAgreement` に対応する GET 操作。
GET /help/agreement response
/help/guide GET
ALPS `goHelpGuide` に対応する GET 操作。
GET /help/guide response
/help/privacy GET
ALPS `goHelpPrivacy` に対応する GET 操作。
GET /help/privacy response
/help/trade-law GET
ALPS `goHelpTradeLaw` に対応する GET 操作。
GET /help/trade-law response
/mypage/address GET
EC-CUBE お届け先情報編集 — show the address add/edit form.
Pure form-info endpoint: no Be Framework, no domain logic. Maps EC-CUBE's `mypage_delivery_new` (no `addressId`) and `mypage_delivery_edit` (`addressId` given) screens. AUTHN + ownership AUTHZ are enforced here directly (mirrors Withdraw::onGet — a Resource-level guard on a no-domain form page): - no session → 401 - addressId of an unknown row → 404 - addressId owned by another → 403 Phase 3 — HTML FORM page. The resource builds an {@see \AddressForm} (Ray.WebFormModule AbstractForm) and exposes it as `body['form']`. For the edit screen the form is pre-populated from the stored address; for the new screen it is empty. VALIDATION AUTHORITY STAYS WITH the Be Framework Becoming chain (onPost). The JSON contexts ignore `body['form']`.
addressId string 配送先住所ID(入力) - dtb_customer_address.id の不透明な文字列ハンドル。BeMart の AddressEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_customer_address.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。所有者は customerId、AUTHZ 検査は CustomerAddressUpdated / CustomerAddressDeleted で getById → customerId 一致確認の順で実施 Fake観察文字長 32〜32; 観察値 'addr00000000000000000000000000a1'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: addr00000000000000000000000000a1
GET /mypage/address response
PUT
ALPS `doUpdateCustomerAddress` に対応する PUT 操作。
addressId* string 配送先住所ID(入力) - dtb_customer_address.id の不透明な文字列ハンドル。BeMart の AddressEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_customer_address.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。所有者は customerId、AUTHZ 検査は CustomerAddressUpdated / CustomerAddressDeleted で getById → customerId 一致確認の順で実施 Fake観察文字長 32〜32; 観察値 'addr00000000000000000000000000a1'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: addr00000000000000000000000000a1
PUT /mypage/address response
name01 string 姓(入力) - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
name02 string 名(入力) - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
kana01 string セイ(入力) - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマダ
kana02 string メイ(入力) - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
companyName string 会社名(入力) - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Acme Corp.
postalCode string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref int 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01 string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02 string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
phoneNumber string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
DELETE
ALPS `doUpdateCustomerAddress` に対応する DELETE 操作。
addressId* string 配送先住所ID(入力) - dtb_customer_address.id の不透明な文字列ハンドル。BeMart の AddressEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_customer_address.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。所有者は customerId、AUTHZ 検査は CustomerAddressUpdated / CustomerAddressDeleted で getById → customerId 一致確認の順で実施 Fake観察文字長 32〜32; 観察値 'addr00000000000000000000000000a1'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: addr00000000000000000000000000a1
DELETE /mypage/address response
/mypage/address-list GET
ALPS `goCustomerAddressList` に対応する GET 操作。
GET /mypage/address-list response
POST
ALPS `doCreateCustomerAddress` に対応する POST 操作。
name01* string 姓(入力) - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
POST /mypage/address-list response
name02* string 名(入力) - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
postalCode* string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref* int 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01* string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02* string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
phoneNumber* string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
kana01 string セイ(入力) - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマダ
kana02 string メイ(入力) - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
companyName string 会社名(入力) - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Acme Corp.
/mypage/change GET
goMypageChange — show the change-customer-info form pre-populated with the logged-in customer's current values.
Safe read. No CSRF (read-only). AUTHN in the Be layer maps null session → 401. Phase 3 — HTML FORM page. The resource builds a {@see \ChangeForm} (Ray.WebFormModule AbstractForm), pre-populates it with the fetched profile, and exposes it as `body['form']` so the HTML port renders real `<input>`s via `{{ form.input(...) }}`. VALIDATION AUTHORITY STAYS WITH the Be Framework Becoming chain (onPost). The JSON contexts ignore `body['form']`; the flat profile keys stay on `body` for the JSON-context tests.
GET /mypage/change response
POST
ALPS `doUpdateCustomer` に対応する POST 操作。
email* string メールアドレス(入力) - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: alice@example.com
POST /mypage/change response
name01 string 姓(入力) - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
name02 string 名(入力) - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
kana01 string セイ(入力) - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマダ
kana02 string メイ(入力) - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
companyName string 会社名(入力) - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Acme Corp.
phoneNumber string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
postalCode string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref int 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01 string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02 string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
/mypage/change-complete GET
ALPS `goMypageChangeComplete` に対応する GET 操作。
GET /mypage/change-complete response
/mypage/favorite POST
ALPS `doAddFavorite` に対応する POST 操作。
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
POST /mypage/favorite response
DELETE
EC-CUBE doRemoveFavorite — お気に入りから削除 (idempotent inverse of Pilot 13). DELETE is idempotent (ALPS type=idempotent): re-removing an already-absent item returns 200 with alreadyAbsent=true rather than 404. The flag lets the UI distinguish first-remove from re-remove without leaking the underlying state.
Unlike onPost, we do NOT validate that productCode resolves to a real product — DELETE removes a stored row, not a product.
productCode* string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
DELETE /mypage/favorite response
/mypage/favorite-list GET
ALPS `goFavoriteList` に対応する GET 操作。
GET /mypage/favorite-list response
/mypage/history GET
ALPS `goMypageHistory` に対応する GET 操作。
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
GET /mypage/history response
/mypage/order-history GET
ALPS `goOrderHistory` に対応する GET 操作。
historyLimit int 一覧制御項目(入力) - /mypage/order-history のレスポンスで返す一覧制御項目。一覧、集計、CSV処理結果の規模を表す非負の数値。
default: 50 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
GET /mypage/order-history response
offset int 開始位置(入力) - /mypage/order-history の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
default: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/mypage/reorder POST
ALPS `doReorder` に対応する POST 操作。
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
POST /mypage/reorder response
/mypage/withdraw GET
EC-CUBE goMypageWithdraw — show the withdrawal confirmation page.
Pure form-info endpoint: no Be Framework involved, no domain logic. Authenticated (mirrors Pilot 8 behavior): returns 401 directly from the Resource when no session is present. Surfaces the current customer's email + name01/name02 so the confirm page can render "退会されるアカウント: name01 name02 (email)".
GET /mypage/withdraw response
POST
ALPS `doWithdrawCustomer` に対応する POST 操作。
POST /mypage/withdraw response
/mypage/withdraw-complete GET
ALPS `goMypageWithdrawComplete` に対応する GET 操作。
GET /mypage/withdraw-complete response
/mypage/withdraw-confirm GET
ALPS `goMypageWithdrawConfirm` に対応する GET 操作。
GET /mypage/withdraw-confirm response
/shopping/checkout POST
Phase B Slice 9: the domain parameter arrives from the HTTP request body.
`$preOrderId` is a 40-hex-char id that PreOrderId Semantic format-validates. The CSRF boundary token is enforced declaratively by the BEAR.Csrf CsrfToken attribute.
preOrderId* string 仮注文ID(入力) - 購入フローの一時セッショントークン(SHA1ハッシュ)。カートと受注を紐づける。予約注文(pre-order)IDではない。チェックアウト開始時に生成、注文確定またはカート破棄で消去 Fake観察文字長 40〜40; 観察値 'deadbeefcafe1234567890abcdef01234567890a', 'deadbeefcafe1234567890abcdef01234567890b', 'aaaa00000000000000000000000000000000aaaa', 'past00000000000000000000000000000000past', 'deadbeefcafe1234567890abcdef01234567890c', 'bbbb00000000000000000000000000000000bbbb', 'cccc00000000000000000000000000000000cccc', 'aceface0000000000000000000000000000a11ce'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: deadbeefcafe1234567890abcdef01234567890a
POST /shopping/checkout response
/shopping/complete GET
ALPS `goShoppingComplete` に対応する GET 操作。
orderNo string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
GET /shopping/complete response
/shopping/confirm GET
ALPS `goShopping` に対応する GET 操作。
preOrderId string 仮注文ID(入力) - 購入フローの一時セッショントークン(SHA1ハッシュ)。カートと受注を紐づける。予約注文(pre-order)IDではない。チェックアウト開始時に生成、注文確定またはカート破棄で消去 Fake観察文字長 40〜40; 観察値 'deadbeefcafe1234567890abcdef01234567890a', 'deadbeefcafe1234567890abcdef01234567890b', 'aaaa00000000000000000000000000000000aaaa', 'past00000000000000000000000000000000past', 'deadbeefcafe1234567890abcdef01234567890c', 'bbbb00000000000000000000000000000000bbbb', 'cccc00000000000000000000000000000000cccc', 'aceface0000000000000000000000000000a11ce'。
default: aceface0000000000000000000000000000a11ce minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: deadbeefcafe1234567890abcdef01234567890a
GET /shopping/confirm response
paymentMethodId int 支払方法ID - 受注に紐づく支払方法マスタID。Fake/EC-CUBE境界ではDB採番値として扱う。
default: 2 minLength: 0 maxLength: 128 $comment: 支払方法IDは業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2
POST
HTML checkout form posts the selected payment field as `payment`.
Keep GET query compatibility while accepting the real browser form.
preOrderId* string 仮注文ID(入力) - 購入フローの一時セッショントークン(SHA1ハッシュ)。カートと受注を紐づける。予約注文(pre-order)IDではない。チェックアウト開始時に生成、注文確定またはカート破棄で消去 Fake観察文字長 40〜40; 観察値 'deadbeefcafe1234567890abcdef01234567890a', 'deadbeefcafe1234567890abcdef01234567890b', 'aaaa00000000000000000000000000000000aaaa', 'past00000000000000000000000000000000past', 'deadbeefcafe1234567890abcdef01234567890c', 'bbbb00000000000000000000000000000000bbbb', 'cccc00000000000000000000000000000000cccc', 'aceface0000000000000000000000000000a11ce'。
default: aceface0000000000000000000000000000a11ce minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: deadbeefcafe1234567890abcdef01234567890a
GET /shopping/confirm response
payment int 支払方法ID(確認フォーム入力) - /shopping の確認フォームで選択された支払方法ID。HTML formでは `payment` 名で送信され、Resourceで ConfirmOrderInput.paymentMethodId に渡す。
default: 2 minLength: 0 maxLength: 128 $comment: 支払方法IDは業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2
/shopping/error GET
ALPS `goShoppingError` に対応する GET 操作。
GET /shopping/error response
/shopping/login GET
ALPS `goShoppingLogin` に対応する GET 操作。
GET /shopping/login response
/shopping/non-member GET
EC-CUBE goShoppingNonMember — show the guest-info entry form.
Pure form-info endpoint: no Be Framework involved, no domain logic. Anonymous-accessible (returns 200 regardless of session state). Fields mirror SubmitNonMemberInput. `csrfToken` carries the trusted reference token so the HTML form can pass the subsequent POST's CSRF boundary.
GET /shopping/non-member response
POST
EC-CUBE doSubmitNonMember — accept guest shipping info and return the synthesised preOrderId.
Phase B Slice 9: every guest form field is user-controlled input. Declared as taint sources so Psalm can trace them downstream. Semantic value objects format-validate but do not universally escape — sinks downstream remain responsible for their own defence (bound params, HTML escape on render).
name01 string 姓(入力) - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
POST /shopping/non-member response
name02 string 名(入力) - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
kana01 string セイ(入力) - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマダ
kana02 string メイ(入力) - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
email string メールアドレス(入力) - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: alice@example.com
phoneNumber string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
postalCode string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref string 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
minLength: 0 maxLength: 2 pattern: ^\d*$ $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01 string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02 string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
sessionPrefix string セッション接頭辞(入力) - 購入フローのカートキーを構成するセッションスコープの接頭辞。saleTypeId と組み合わせて販売種別ごとのカートを分離する。 Fake観察文字長 16〜23; 観察値 'session-prefix-1', 'session-checkout-pilot5'。
minLength: 0 maxLength: 128 default: session-prefix-1 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: session-prefix-1
/shopping/shipping GET
ALPS `goShoppingShipping` に対応する GET 操作。
GET /shopping/shipping response
POST
EC-CUBE doSelectShippingAddress — accept the selected address-book row.
This closes the former ActionRedirect gap for the customer checkout route. The current shopping renderer does not yet hydrate the address radio list, so the resource records the selected id in the response surface and returns to the shopping page. The full pre-order shipping persistence is intentionally left to the existing checkout enrichment backlog; this method makes the route executable without a placeholder.
shippingAddressId string 配送先ID(入力) - /shopping/shipping のレスポンスで対象を識別する配送先ID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
$comment: 配送先ID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. minLength: 0 maxLength: 128
POST /shopping/shipping response
/shopping/shipping-edit GET
ALPS `goShoppingShippingEdit` に対応する GET 操作。
GET /shopping/shipping-edit response
POST
EC-CUBE doUpdateShippingAddress — accept the edited shipping address.
The BeMart checkout page still keeps the richer pre-order shipping persistence as a later enrichment. This method removes the former ActionRedirect placeholder and gives the submitted address a concrete Resource surface while returning the user to the main shopping page.
name01 string 姓(入力) - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
POST /shopping/shipping-edit response
name02 string 名(入力) - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
kana01 string セイ(入力) - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマダ
kana02 string メイ(入力) - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
companyName string 会社名(入力) - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Acme Corp.
postalCode string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref int 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
default: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01 string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02 string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
phoneNumber string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
/shopping/shipping-multiple GET
ALPS `goShoppingShippingMultiple` に対応する GET 操作。
GET /shopping/shipping-multiple response
POST
EC-CUBE doSelectShippingAddress — accept the multi-shipping allocation.
The current page exposes the allocation form shape but has no cart-item rows yet. The POST endpoint is still concrete: CSRF is enforced, the transition is acknowledged, and the user returns to the shopping page.
allocations array 配送割当一覧(入力) - /shopping/shipping-multiple のレスポンスで扱う配送割当一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /shopping/shipping-multiple response
/shopping/shipping-multiple-edit GET
ALPS `goShoppingShippingMultipleEdit` に対応する GET 操作。
GET /shopping/shipping-multiple-edit response
POST
EC-CUBE doUpdateShippingAddress — add/update an address for the multi-destination checkout branch.
This mirrors {@see \ShippingEdit::onPost()} but returns to the multi-shipping screen instead of the main shopping screen.
name01 string 姓(入力) - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
POST /shopping/shipping-multiple-edit response
name02 string 名(入力) - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
kana01 string セイ(入力) - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマダ
kana02 string メイ(入力) - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
companyName string 会社名(入力) - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Acme Corp.
postalCode string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref int 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
default: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01 string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02 string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
phoneNumber string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
/admin/block/block GET
Renders the block edit form.
The JSON contexts (`app`, `prod`, `test`) ignore `body['form']`.
blockId string ブロックID(入力) - dtb_block.id の不透明な文字列ハンドル。SQL 実装では dtb_block.id を文字列化して使用し、Fake 実装では bk-* seed handle を使用する。
minLength: 0 maxLength: 128 example: 1
GET /admin/block/block response
PUT
ALPS `doUpdateBlock` に対応する PUT 操作。
blockId* string ブロックID(入力) - dtb_block.id の不透明な文字列ハンドル。BeMart の BlockEntity 層は数値ではなく文字列として保持する。Fake 実装は `bk-` プレフィックス付きの英数字を生成し(シード `bk-header` を含む)、SQL 実装は dtb_block.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlBlockStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (BlockUpdated / BlockDeleted) を踏むため、シードハンドル `bk-header` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 7〜9; 観察値 'bk-header', 'bk-user'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: bk-header
PUT /admin/block/block response
blockName string ブロック名(入力) - ブロックの表示名 Fake観察文字長 4〜8; 観察値 'ヘッダー', 'ユーザーブロック'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヘッダー
blockFileName string ブロックファイル名(入力) - ブロックのテンプレートファイル名 Fake観察文字長 6〜10; 観察値 'header', 'user_block'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: header
DELETE
ALPS `doDeleteBlock` に対応する DELETE 操作。
blockId* string ブロックID(入力) - dtb_block.id の不透明な文字列ハンドル。BeMart の BlockEntity 層は数値ではなく文字列として保持する。Fake 実装は `bk-` プレフィックス付きの英数字を生成し(シード `bk-header` を含む)、SQL 実装は dtb_block.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlBlockStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (BlockUpdated / BlockDeleted) を踏むため、シードハンドル `bk-header` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 7〜9; 観察値 'bk-header', 'bk-user'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: bk-header
DELETE /admin/block/block response
/admin/block/block-list GET
ALPS `goBlockList` に対応する GET 操作。
GET /admin/block/block-list response
POST
ALPS `doCreateBlock` に対応する POST 操作。
blockName* string ブロック名(入力) - ブロックの表示名 Fake観察文字長 4〜8; 観察値 'ヘッダー', 'ユーザーブロック'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヘッダー
POST /admin/block/block-list response
blockFileName* string ブロックファイル名(入力) - ブロックのテンプレートファイル名 Fake観察文字長 6〜10; 観察値 'header', 'user_block'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: header
/admin/category/category GET
ALPS `goCategory` に対応する GET 操作。
categoryId* string カテゴリID(入力) - dtb_category.id の不透明な文字列ハンドル。BeMart の CategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (CategoryUpdated / CategoryDeleted / CategoryCreated の親解決) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。parentId(自己参照 FK parent_category_id)も同じ文字列ハンドルで表現され、非数値 parentId は SQL では NULL(ルート)に倒れる。blockId / pageId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 8〜10; 観察値 'cat-food', 'cat-drinks'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cat-food
GET /admin/category/category response
PUT
ALPS `doUpdateCategory` に対応する PUT 操作。
categoryId* string カテゴリID(入力) - dtb_category.id の不透明な文字列ハンドル。BeMart の CategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (CategoryUpdated / CategoryDeleted / CategoryCreated の親解決) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。parentId(自己参照 FK parent_category_id)も同じ文字列ハンドルで表現され、非数値 parentId は SQL では NULL(ルート)に倒れる。blockId / pageId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 8〜10; 観察値 'cat-food', 'cat-drinks'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cat-food
PUT /admin/category/category response
categoryName string カテゴリ名(入力) - カテゴリの表示名 Fake観察文字長 4〜6; 観察値 'Food', 'Drinks'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Food
sortNo int 表示順(入力) - 一覧における並び順 Fake観察数値 1〜20; 観察値 '1', '3', '2', '4', '10', '20'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
parentId string 親カテゴリID(入力) - /admin/category/category のレスポンスで対象を識別する親カテゴリID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
DELETE
ALPS `doDeleteCategory` に対応する DELETE 操作。
categoryId* string カテゴリID(入力) - dtb_category.id の不透明な文字列ハンドル。BeMart の CategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (CategoryUpdated / CategoryDeleted / CategoryCreated の親解決) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。parentId(自己参照 FK parent_category_id)も同じ文字列ハンドルで表現され、非数値 parentId は SQL では NULL(ルート)に倒れる。blockId / pageId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 8〜10; 観察値 'cat-food', 'cat-drinks'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cat-food
DELETE /admin/category/category response
/admin/category/category-list GET
ALPS `goCategoryList` に対応する GET 操作。
GET /admin/category/category-list response
POST
ALPS `doCreateCategory` に対応する POST 操作。
categoryName* string カテゴリ名(入力) - カテゴリの表示名 Fake観察文字長 4〜6; 観察値 'Food', 'Drinks'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: Food
POST /admin/category/category-list response
sortNo* int 表示順(入力) - 一覧における並び順 Fake観察数値 1〜20; 観察値 '1', '3', '2', '4', '10', '20'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
parentId string 親カテゴリID(入力) - /admin/category/category-list のレスポンスで対象を識別する親カテゴリID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/category/csv GET
ALPS `goExportCategory` に対応する GET 操作。
GET /admin/category/csv response
POST
ALPS `doImportCategoryCsv` に対応する POST 操作。
csv* string 輸送ペイロード(入力) - CSVインポート/エクスポート本文。列構造の詳細はCSV互換サービス境界で検査する。
minLength: 0 maxLength: 5000000 $comment: CSV列の業務妥当性はCSV互換サービスで検査する。ここではJSON境界上の文字列サイズを契約する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/category/csv response
/admin/category/edit GET
ALPS `goCategory` に対応する GET 操作。
categoryId string カテゴリID(入力) - dtb_category.id の不透明な文字列ハンドル。BeMart の CategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (CategoryUpdated / CategoryDeleted / CategoryCreated の親解決) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。parentId(自己参照 FK parent_category_id)も同じ文字列ハンドルで表現され、非数値 parentId は SQL では NULL(ルート)に倒れる。blockId / pageId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 8〜10; 観察値 'cat-food', 'cat-drinks'。
default: minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cat-food
GET /admin/category/edit response
/admin/class-category/class-category PUT
ALPS `doUpdateClassCategory` に対応する PUT 操作。
classCategoryId* string 規格分類ID(入力) - dtb_class_category.id の不透明な文字列ハンドル。BeMart の ClassCategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格分類の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。classNameId / categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 6〜8; 観察値 'cc-red', 'cc-blue', 'cc-small'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cc-red
PUT /admin/class-category/class-category response
classCategoryName string 規格分類名(入力) - 商品バリエーション軸の具体的な値(例: 赤、Lサイズ)。EC-CUBEの"classCategory"はOOPのカテゴリではなく規格値を意味する
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
DELETE
ALPS `doDeleteClassCategory` に対応する DELETE 操作。
classCategoryId* string 規格分類ID(入力) - dtb_class_category.id の不透明な文字列ハンドル。BeMart の ClassCategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格分類の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。classNameId / categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 6〜8; 観察値 'cc-red', 'cc-blue', 'cc-small'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cc-red
DELETE /admin/class-category/class-category response
/admin/class-category/class-category-export GET
ALPS `goExportClassCategory` に対応する GET 操作。
classNameId string 規格名ID(入力) - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cn-color
GET /admin/class-category/class-category-export response
/admin/class-category/class-category-list GET
ALPS `goClassCategoryList` に対応する GET 操作。
classNameId string 規格名ID(入力) - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cn-color
GET /admin/class-category/class-category-list response
POST
ALPS `doCreateClassCategory` に対応する POST 操作。
classNameId* string 規格名ID(入力) - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cn-color
POST /admin/class-category/class-category-list response
classCategoryName* string 規格分類名(入力) - 商品バリエーション軸の具体的な値(例: 赤、Lサイズ)。EC-CUBEの"classCategory"はOOPのカテゴリではなく規格値を意味する
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/class-name/class-name PUT
ALPS `doUpdateClassName` に対応する PUT 操作。
classNameId* string 規格名ID(入力) - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cn-color
PUT /admin/class-name/class-name response
classNameLabel string 規格名(入力) - 商品バリエーション軸の名前(例: カラー、サイズ)。EC-CUBEの"class"はOOPのクラスではなく商品規格を意味する
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
DELETE
ALPS `doDeleteClassName` に対応する DELETE 操作。
classNameId* string 規格名ID(入力) - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: cn-color
DELETE /admin/class-name/class-name response
/admin/class-name/class-name-export GET
ALPS `goExportClassName` に対応する GET 操作。
GET /admin/class-name/class-name-export response
/admin/class-name/class-name-list GET
ALPS `goClassNameList` に対応する GET 操作。
GET /admin/class-name/class-name-list response
POST
ALPS `doCreateClassName` に対応する POST 操作。
classNameLabel* string 規格名(入力) - 商品バリエーション軸の名前(例: カラー、サイズ)。EC-CUBEの"class"はOOPのクラスではなく商品規格を意味する
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/class-name/class-name-list response
/admin/content/cache GET
ALPS `doClearCache` に対応する GET 操作。
GET /admin/content/cache response
PUT
Clears the application cache (doClearCache).
mode string フォーム送信モード
minLength: 0 maxLength: 32 $comment: HTML form submit marker; Resource workflow calls omit it.
PUT /admin/content/cache response
/admin/content/css GET
ALPS `goContentCss` に対応する GET 操作。
GET /admin/content/css response
PUT
Saves the customize CSS (doUpdateContentCss). ALPS idempotent → PUT.
css string 処理一覧(入力) - /admin/content/css のレスポンスで運ぶ処理一覧。CSV/PDF/ログ等の内部形式は専用境界で扱い、JSON Schemaでは輸送上の型とサイズを契約する。
minLength: 0 maxLength: 1000000 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
PUT /admin/content/css response
mode string フォーム送信モード
minLength: 0 maxLength: 32 $comment: HTML form submit marker; Resource workflow calls omit it.
/admin/content/file-manager GET
ALPS `goAdminContentFileManager` に対応する GET 操作。
GET /admin/content/file-manager response
/admin/content/js GET
ALPS `goContentJs` に対応する GET 操作。
GET /admin/content/js response
PUT
Saves the customize JS (doUpdateContentJs). ALPS idempotent → PUT.
js string 処理一覧(入力) - /admin/content/js のレスポンスで運ぶ処理一覧。CSV/PDF/ログ等の内部形式は専用境界で扱い、JSON Schemaでは輸送上の型とサイズを契約する。
minLength: 0 maxLength: 1000000 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
PUT /admin/content/js response
mode string フォーム送信モード
minLength: 0 maxLength: 32 $comment: HTML form submit marker; Resource workflow calls omit it.
/admin/content/maintenance GET
ALPS `goMaintenance` に対応する GET 操作。
GET /admin/content/maintenance response
PUT
Toggles maintenance mode to an explicit state (doToggleMaintenance).
ALPS marks it `idempotent` → PUT.
enabled* bool 処理状態フラグ(入力) - 観察値 'true', 'false'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: true
PUT /admin/content/maintenance response
mode string フォーム送信モード
minLength: 0 maxLength: 32 $comment: HTML form submit marker; Resource workflow calls omit it.
/admin/customer/resend-activation-mail POST
ALPS `doResendActivationMail` に対応する POST 操作。
email* string メールアドレス(入力) - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
minLength: 0 maxLength: 254 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: alice@example.com
POST /admin/customer/resend-activation-mail response
/admin/delivery/delivery GET
EC-CUBE 配送方法設定(編集) — Setting/Shop Tier-2.
Thin GET renderer for `Setting/Shop/delivery_edit.twig`. An empty `$deliveryId` renders a blank "new delivery" form; a known id pre-fills the editor; an unknown id is 404. The delivery-master list doubles as the AUTHZ gate — no admin session → 403.
deliveryId string 配送方法ID(入力) - dtb_delivery.id の不透明な文字列ハンドル。BeMart の DeliveryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_delivery.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlDeliveryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (DeliveryUpdated / DeliveryDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。blockId / pageId / categoryId と同じ Fake↔SQL 二重性 Fake観察文字長 10〜10; 観察値 'del-yamato', 'del-yupack'。
default: minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: del-yamato
GET /admin/delivery/delivery response
PUT
ALPS `doUpdateDelivery` に対応する PUT 操作。
deliveryId* string 配送方法ID(入力) - dtb_delivery.id の不透明な文字列ハンドル。BeMart の DeliveryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_delivery.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlDeliveryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (DeliveryUpdated / DeliveryDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。blockId / pageId / categoryId と同じ Fake↔SQL 二重性 Fake観察文字長 10〜10; 観察値 'del-yamato', 'del-yupack'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: del-yamato
PUT /admin/delivery/delivery response
deliveryName string 配送方法名 - 管理画面で登録・更新する配送方法の表示名。実運用では店舗独自の長い名称を許容する。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマト宅急便
visible bool 処理状態フラグ(入力) - 観察値 'true'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: true
DELETE
ALPS `doDeleteDelivery` に対応する DELETE 操作。
deliveryId* string 配送方法ID(入力) - dtb_delivery.id の不透明な文字列ハンドル。BeMart の DeliveryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_delivery.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlDeliveryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (DeliveryUpdated / DeliveryDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。blockId / pageId / categoryId と同じ Fake↔SQL 二重性 Fake観察文字長 10〜10; 観察値 'del-yamato', 'del-yupack'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: del-yamato
DELETE /admin/delivery/delivery response
/admin/delivery/delivery-list GET
ALPS `goDeliveryList` に対応する GET 操作。
GET /admin/delivery/delivery-list response
POST
ALPS `doCreateDelivery` に対応する POST 操作。
deliveryName* string 配送方法名 - 管理画面で登録・更新する配送方法の表示名。実運用では店舗独自の長い名称を許容する。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ヤマト宅急便
POST /admin/delivery/delivery-list response
visible bool 処理状態フラグ(入力) - 観察値 'true'。
default: 1 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: true
/admin/layout/layout GET
Renders the layout editor form (new-layout case).
The JSON contexts (`app`, `prod`, `test`) ignore `body['form']`.
layoutId string レイアウトID(入力) - dtb_layout.id の不透明な文字列ハンドル。SQL 実装では dtb_layout.id を文字列化して使用し、Fake 実装では seed handle を使用する。
minLength: 0 maxLength: 128 example: 1
GET /admin/layout/layout response
PUT
ALPS `doUpdateLayout` に対応する PUT 操作。
layoutId* string レイアウトID(入力) - CMSレイアウトを識別する不透明な文字列ハンドル。seed 済みレイアウトを Fake/SQL 同型に扱う。 Fake観察文字長 13〜13; 観察値 'lo-pc-default', 'lo-sp-default'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: lo-pc-default
PUT /admin/layout/layout response
layoutName string レイアウト名(入力) - レイアウトの表示名 Fake観察文字長 4〜5; 観察値 'PC標準', 'スマホ標準'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: PC標準
name string レイアウト名(HTMLフォーム入力) - EC-CUBE由来の HTML form field name。Resource では layoutName と同じ意味として扱う。
minLength: 0 maxLength: 255 $comment: HTML form compatibility field. API clients should prefer layoutName. example: PC標準
/admin/layout/layout-list GET
ALPS `goLayoutList` に対応する GET 操作。
GET /admin/layout/layout-list response
/admin/mail-template/create POST
Creates an admin mail template database row for workflow verification.
mailTemplateName* string Admin-visible mail template name.
minLength: 1 maxLength: 255
POST /admin/mail-template/create response
fileName* string Twig template file path stored in dtb_mail_template.file_name.
minLength: 1 maxLength: 255
mailSubject* string Mail subject stored with the template row.
minLength: 1 maxLength: 255
/admin/news/news GET
ALPS `goNews` に対応する GET 操作。
newsId string ニュースID(入力) - dtb_news.id の不透明な文字列ハンドル。BeMart の NewsEntity 層は数値ではなく文字列として保持する。Fake 実装は `nw-` プレフィックス付きの英数字を生成し(シード `nw-welcome` を含む)、SQL 実装は dtb_news.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlNewsStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminNewsFetched / NewsUpdated / NewsDeleted) を踏むため、シードハンドル `nw-welcome` や `nonexistent` は Fake / SQL 双方で 404 が同形 Fake観察文字長 10〜10; 観察値 'nw-welcome'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: nw-welcome
GET /admin/news/news response
PUT
ALPS `doUpdateNews` に対応する PUT 操作。
newsId* string ニュースID(入力) - dtb_news.id の不透明な文字列ハンドル。BeMart の NewsEntity 層は数値ではなく文字列として保持する。Fake 実装は `nw-` プレフィックス付きの英数字を生成し(シード `nw-welcome` を含む)、SQL 実装は dtb_news.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlNewsStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminNewsFetched / NewsUpdated / NewsDeleted) を踏むため、シードハンドル `nw-welcome` や `nonexistent` は Fake / SQL 双方で 404 が同形 Fake観察文字長 10〜10; 観察値 'nw-welcome'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: nw-welcome
PUT /admin/news/news response
newsTitle string ニュースタイトル(入力) - ニュース記事の見出し Fake観察文字長 4〜4; 観察値 'ようこそ'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ようこそ
newsDescription string ニュース本文(入力) - ニュース記事の本文。HTML入力可能でHTMLPurifierによる浄化あり Fake観察文字長 14〜14; 観察値 'EC-CUBE へようこそ。'。
minLength: 0 maxLength: 2000 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: EC-CUBE へようこそ。
newsUrl string 外部URL(入力) - 外部リンクURL。設定時はニュース本文の代わりにこのURLへ遷移
minLength: 0 maxLength: 2048 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: /products
publishDate string 公開日(入力) - ニュースの公開日時。フロントの表示順を制御 Fake観察文字長 25〜25; 観察値 '2026-01-01T00:00:00+09:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2026-01-01T00:00:00+09:00
linkMethod bool 新規ウィンドウで開く(入力) - 外部URLのリンク開き方(boolean)。false=同一ウィンドウ, true=新規ウィンドウ(target="_blank")。テンプレートでtarget属性の出力制御に使用 観察値 'false'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: false
DELETE
ALPS `doDeleteNews` に対応する DELETE 操作。
newsId* string ニュースID(入力) - dtb_news.id の不透明な文字列ハンドル。BeMart の NewsEntity 層は数値ではなく文字列として保持する。Fake 実装は `nw-` プレフィックス付きの英数字を生成し(シード `nw-welcome` を含む)、SQL 実装は dtb_news.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlNewsStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminNewsFetched / NewsUpdated / NewsDeleted) を踏むため、シードハンドル `nw-welcome` や `nonexistent` は Fake / SQL 双方で 404 が同形 Fake観察文字長 10〜10; 観察値 'nw-welcome'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: nw-welcome
DELETE /admin/news/news response
/admin/news/news-list GET
ALPS `goNewsList` に対応する GET 操作。
GET /admin/news/news-list response
POST
ALPS `doCreateNews` に対応する POST 操作。
newsTitle* string ニュースタイトル(入力) - ニュース記事の見出し Fake観察文字長 4〜4; 観察値 'ようこそ'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ようこそ
POST /admin/news/news-list response
publishDate* string 公開日(入力) - ニュースの公開日時。フロントの表示順を制御 Fake観察文字長 25〜25; 観察値 '2026-01-01T00:00:00+09:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2026-01-01T00:00:00+09:00
newsDescription string ニュース本文(入力) - ニュース記事の本文。HTML入力可能でHTMLPurifierによる浄化あり Fake観察文字長 14〜14; 観察値 'EC-CUBE へようこそ。'。
minLength: 0 maxLength: 2000 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: EC-CUBE へようこそ。
newsUrl string 外部URL(入力) - 外部リンクURL。設定時はニュース本文の代わりにこのURLへ遷移
minLength: 0 maxLength: 2048 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: /products
linkMethod bool 新規ウィンドウで開く(入力) - 外部URLのリンク開き方(boolean)。false=同一ウィンドウ, true=新規ウィンドウ(target="_blank")。テンプレートでtarget属性の出力制御に使用 観察値 'false'。
default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: false
/admin/order/bulk-delete POST
ALPS `doBulkDeleteOrder` に対応する POST 操作。
orderNos array 注文番号一覧(入力) - /admin/order/bulk-delete のレスポンスで扱う注文番号一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minItems: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/order/bulk-delete response
ids array 注文番号一覧(HTML form alias) - EC-CUBE互換の受注一覧一括フォームが `ids[]` として送る注文番号一覧。Resource境界では `orderNos` に正規化する。
minItems: 0 $comment: Transport alias only; business contract remains orderNos.
mode string フォームモード - HTML form submit からのPOSTを識別し、PRG応答にするためのフォーム境界値。
enum: ["order_bulk_delete_form",null]
/admin/order/create POST
ALPS `doCreateOrder` に対応する POST 操作。
customerId* string 会員ID(入力) - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: customer-001
POST /admin/order/create response
paymentMethodId* string 支払方法ID - 受注に紐づく支払方法マスタID。Fake/EC-CUBE境界ではDB採番値として扱う。
minLength: 0 maxLength: 128 $comment: 支払方法IDは業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2
orderItems* array 受注明細一覧(入力) - /admin/order/create のレスポンスで扱う受注明細一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
deliveryFeeTotal string 送料合計(入力) - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
default: 0 $comment: 送料合計(入力)は本来数値の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 600
charge string 手数料(入力) - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
default: 0 $comment: 手数料(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0
discount string 値引き額(入力) - 受注全体の値引き合計額。クーポン等による値引き Fake観察数値 0〜0; 観察値 '0'。
default: 0 $comment: 値引き額(入力)は本来数値の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0
/admin/order/edit GET
ALPS `goOrder` に対応する GET 操作。
orderNo string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
GET /admin/order/edit response
/admin/order/export-order GET
ALPS `goExportOrder` に対応する GET 操作。
GET /admin/order/export-order response
/admin/order/export-order-pdf GET
ALPS `goExportOrderPdf` に対応する GET 操作。
orderNos string 注文番号一覧(入力) - /admin/order/export-order-pdf のレスポンスで扱う注文番号一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minItems: 0 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
GET /admin/order/export-order-pdf response
orderNo string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
POST
EC-CUBE admin_order_pdf_download (POST) — the order_pdf.twig options form submits POST /admin/order/export-order-pdf. Same export pipeline as onGet.
orderNos string
GET /admin/order/export-order-pdf response
orderNo string 注文番号
/admin/order/export-shipping GET
ALPS `goExportShipping` に対応する GET 操作。
GET /admin/order/export-shipping response
/admin/order/import-shipping GET
EC-CUBE 出荷CSV登録 — Order Tier-2.
Thin GET renderer for `admin/Order/csv_shipping.twig` — the shipping-CSV upload form. The POST below accepts the uploaded CSV; this GET serves the upload-form shell. AUTHZ is a direct admin-session check (Pattern B — no Be transition is invoked on the GET path); a non-admin firewall is refused with 403.
GET /admin/order/import-shipping response
POST
ALPS `doImportShippingCsv` に対応する POST 操作。
csv* string 輸送ペイロード(入力) - CSVインポート/エクスポート本文。列構造の詳細はCSV互換サービス境界で検査する。
minLength: 0 maxLength: 5000000 $comment: CSV列の業務妥当性はCSV互換サービスで検査する。ここではJSON境界上の文字列サイズを契約する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/order/import-shipping response
/admin/order/mail-confirm GET
ALPS `goOrderMailConfirm` に対応する GET 操作。
orderNo string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
GET /admin/order/mail-confirm response
/admin/order/order-pdf GET
ALPS `goOrderPdf` に対応する GET 操作。
orderNo string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
GET /admin/order/order-pdf response
/admin/order/send-mail GET
EC-CUBE 受注メール送信 — Order Tier-2.
Thin GET renderer for `admin/Order/mail.twig` — the order-mail composition screen. The POST below re-sends the confirmation mail; this GET serves the composition form keyed by the order. AUTHZ is a direct admin-session check (Pattern B — no Be transition is invoked on the GET path). The composition fields render blank so the page is faithful with empty JSON-backed fake storage.
orderNo string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
GET /admin/order/send-mail response
POST
ALPS `doSendOrderMail` に対応する POST 操作。
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
POST /admin/order/send-mail response
/admin/order/shipping-address GET
EC-CUBE 出荷登録 / 配送先編集 — Order Tier-2.
Thin GET renderer for `admin/Order/shipping.twig` (~709 lines). The POST / PUT methods below carry the address-book-pick and the explicit-overwrite transitions; this GET serves the editor shell keyed by the order being shipped. BeMart has no Be transition to READ an order's current shipping target, so the editor renders a blank shipping form — the render-smoke test exercises this with empty JSON-backed fake storage. AUTHZ is a direct admin-session check (Pattern B — no Be transition is invoked on the GET path).
orderNo string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
GET /admin/order/shipping-address response
POST
doSelectShippingAddress — pick an address-book row for the order.
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
POST /admin/order/shipping-address response
addressId* string 配送先住所ID(入力) - dtb_customer_address.id の不透明な文字列ハンドル。BeMart の AddressEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_customer_address.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。所有者は customerId、AUTHZ 検査は CustomerAddressUpdated / CustomerAddressDeleted で getById → customerId 一致確認の順で実施 Fake観察文字長 32〜32; 観察値 'addr00000000000000000000000000a1'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: addr00000000000000000000000000a1
PUT
doUpdateShippingAddress — overwrite the order's shipping fields.
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
PUT /admin/order/shipping-address response
name01* string 姓(入力) - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 鈴木
name02* string 名(入力) - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: アリス
postalCode* string 郵便番号(入力) - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1500001
pref* int 都道府県(入力) - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 13
addr01* string 市区町村(入力) - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 渋谷区
addr02* string 番地・建物名(入力) - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 神宮前1-1-1
phoneNumber* string 電話番号(入力) - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
minLength: 0 maxLength: 13 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0312345678
/admin/order/shipping-notify-mail GET
Displays the shipping-notification confirmation form.
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. default: example: past0000000000000000000000000001
GET /admin/order/shipping-notify-mail response
POST
ALPS `doSendShippingNotifyMail` に対応する POST 操作。
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
POST /admin/order/shipping-notify-mail response
/admin/order/tracking-number PUT
ALPS `doUpdateTrackingNumber` に対応する PUT 操作。
orderNo* string 注文番号(入力) - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: past0000000000000000000000000001
PUT /admin/order/tracking-number response
trackingNumber* string 荷物追跡番号(入力) - 配送業者の荷物追跡番号。confirmUrlと組み合わせて追跡URLを構成
minLength: 0 maxLength: 128 $comment: キー/追跡番号は照合用の不透明文字列で、数値演算対象ではない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
/admin/page/page GET
ALPS `goPage` に対応する GET 操作。
pageId string ページID(入力) - dtb_page.id の不透明な文字列ハンドル。BeMart の PageEntity 層は数値ではなく文字列として保持する。Fake 実装は `pg-` プレフィックス付きの英数字を生成し(シード `pg-homepage` を含む)、SQL 実装は dtb_page.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPageStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminPageFetched / PageUpdated / PageDeleted) を踏むため、シードハンドル `pg-homepage` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 6〜11; 観察値 'pg-homepage', 'pg-company', 'pg-foo'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: pg-homepage
GET /admin/page/page response
PUT
ALPS `doUpdatePage` に対応する PUT 操作。
pageId* string ページID(入力) - dtb_page.id の不透明な文字列ハンドル。BeMart の PageEntity 層は数値ではなく文字列として保持する。Fake 実装は `pg-` プレフィックス付きの英数字を生成し(シード `pg-homepage` を含む)、SQL 実装は dtb_page.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPageStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminPageFetched / PageUpdated / PageDeleted) を踏むため、シードハンドル `pg-homepage` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 6〜11; 観察値 'pg-homepage', 'pg-company', 'pg-foo'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: pg-homepage
PUT /admin/page/page response
pageName string ページ名(入力) - 管理画面でのページ表示名 Fake観察文字長 3〜6; 観察値 'ホームページ', '会社案内', 'Foo'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ホームページ
pageUrl string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list) Fake観察文字長 3〜8; 観察値 'homepage', 'company', 'foo'。
minLength: 0 maxLength: 2048 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: homepage
pageFileName string テンプレートファイル名(入力) - ページのテンプレートファイル名 Fake観察文字長 3〜7; 観察値 'index', 'company', 'foo'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: index
DELETE
ALPS `doDeletePage` に対応する DELETE 操作。
pageId* string ページID(入力) - dtb_page.id の不透明な文字列ハンドル。BeMart の PageEntity 層は数値ではなく文字列として保持する。Fake 実装は `pg-` プレフィックス付きの英数字を生成し(シード `pg-homepage` を含む)、SQL 実装は dtb_page.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPageStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminPageFetched / PageUpdated / PageDeleted) を踏むため、シードハンドル `pg-homepage` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 6〜11; 観察値 'pg-homepage', 'pg-company', 'pg-foo'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: pg-homepage
DELETE /admin/page/page response
/admin/page/page-list GET
ALPS `goPageList` に対応する GET 操作。
GET /admin/page/page-list response
POST
ALPS `doCreatePage` に対応する POST 操作。
pageName* string ページ名(入力) - 管理画面でのページ表示名 Fake観察文字長 3〜6; 観察値 'ホームページ', '会社案内', 'Foo'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: ホームページ
POST /admin/page/page-list response
pageUrl* string ページURL(入力) - ページのURLパス(Symfonyルート名。例: homepage, product_list) Fake観察文字長 3〜8; 観察値 'homepage', 'company', 'foo'。
minLength: 0 maxLength: 2048 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: homepage
pageFileName* string テンプレートファイル名(入力) - ページのテンプレートファイル名 Fake観察文字長 3〜7; 観察値 'index', 'company', 'foo'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: index
/admin/payment/payment GET
EC-CUBE 支払方法設定(編集) — Setting/Shop Tier-2.
Thin GET renderer for `Setting/Shop/payment_edit.twig`. An empty `$paymentId` renders a blank "new payment" form; a known id pre-fills the editor; an unknown id is 404. The payment-master list doubles as the AUTHZ gate — no admin session → 403.
paymentId string 支払方法ID(入力) - dtb_payment.id の不透明な文字列ハンドル。BeMart の PaymentMethodAdminEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_payment.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPaymentMethodAdminStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (PaymentMethodAdminUpdated / PaymentMethodAdminDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜10; Fake観察数値 1〜9; 観察値 '2', 'pay-cod', 'pay-credit', '1', '9'。
default: minLength: 0 maxLength: 128 $comment: 支払方法ID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2
GET /admin/payment/payment response
PUT
ALPS `doUpdatePayment` に対応する PUT 操作。
paymentId* string 支払方法ID(入力) - dtb_payment.id の不透明な文字列ハンドル。BeMart の PaymentMethodAdminEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_payment.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPaymentMethodAdminStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (PaymentMethodAdminUpdated / PaymentMethodAdminDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜10; Fake観察数値 1〜9; 観察値 '2', 'pay-cod', 'pay-credit', '1', '9'。
minLength: 0 maxLength: 128 $comment: 支払方法ID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2
PUT /admin/payment/payment response
paymentMethodName string 支払方法名(入力) - 支払方法の表示名 Fake観察文字長 4〜8; 観察値 '代金引換', 'クレジットカード', '検証失敗'。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 代金引換
charge int 手数料(入力) - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
$comment: 手数料(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0
ruleMin int 下限金額(入力) - /admin/payment/payment のフォーム文脈で使う下限金額。入力保持、初期値、再表示に必要な補助値。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
ruleMax int 上限金額(入力) - /admin/payment/payment のフォーム文脈で使う上限金額。入力保持、初期値、再表示に必要な補助値。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
visible bool 処理状態フラグ(入力) - 観察値 'true'。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: true
DELETE
ALPS `doDeletePayment` に対応する DELETE 操作。
paymentId* string 支払方法ID(入力) - dtb_payment.id の不透明な文字列ハンドル。BeMart の PaymentMethodAdminEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_payment.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPaymentMethodAdminStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (PaymentMethodAdminUpdated / PaymentMethodAdminDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜10; Fake観察数値 1〜9; 観察値 '2', 'pay-cod', 'pay-credit', '1', '9'。
minLength: 0 maxLength: 128 $comment: 支払方法ID(入力)は業務上IDだが、HTTPフォームでは文字列として届く。Resource/Semantic層の検証を通すためtransport schemaではstring|integerを許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2
DELETE /admin/payment/payment response
/admin/payment/payment-list GET
ALPS `goPaymentList` に対応する GET 操作。
GET /admin/payment/payment-list response
POST
ALPS `doCreatePayment` に対応する POST 操作。
paymentMethodName* string 支払方法名(入力) - 支払方法の表示名 Fake観察文字長 4〜8; 観察値 '代金引換', 'クレジットカード', '検証失敗'。
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 代金引換
POST /admin/payment/payment-list response
charge int 手数料(入力) - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
default: 0 $comment: 手数料(入力)は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 0
ruleMin int 下限金額(入力) - /admin/payment/payment-list のフォーム文脈で使う下限金額。入力保持、初期値、再表示に必要な補助値。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
ruleMax int 上限金額(入力) - /admin/payment/payment-list のフォーム文脈で使う上限金額。入力保持、初期値、再表示に必要な補助値。
$comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
visible bool 処理状態フラグ(入力) - 観察値 'true'。
default: 1 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: true
/admin/product/csv-category GET
ALPS `goExportCategory` に対応する GET 操作。
GET /admin/product/csv-category response
/admin/product/csv-class-category GET
ALPS `goExportClassCategory` に対応する GET 操作。
GET /admin/product/csv-class-category response
POST
Imports the 規格分類 CSV (doImportClassCategoryCsv).
csv string 輸送ペイロード(入力) - CSVインポート/エクスポート本文。列構造の詳細はCSV互換サービス境界で検査する。
minLength: 0 maxLength: 5000000 $comment: CSV列の業務妥当性はCSV互換サービスで検査する。ここではJSON境界上の文字列サイズを契約する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. default:
POST /admin/product/csv-class-category response
/admin/product/csv-class-name GET
ALPS `goExportClassName` に対応する GET 操作。
GET /admin/product/csv-class-name response
POST
Imports the 規格名 CSV (doImportClassNameCsv).
csv string 輸送ペイロード(入力) - CSVインポート/エクスポート本文。列構造の詳細はCSV互換サービス境界で検査する。
minLength: 0 maxLength: 5000000 $comment: CSV列の業務妥当性はCSV互換サービスで検査する。ここではJSON境界上の文字列サイズを契約する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. default:
POST /admin/product/csv-class-name response
/admin/product/csv-product GET
ALPS `goExportProduct` に対応する GET 操作。
GET /admin/product/csv-product response
/admin/product/edit GET
ALPS `goProduct` に対応する GET 操作。
productCode string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
GET /admin/product/edit response
/admin/product/product-class GET
ALPS `goProductClass` に対応する GET 操作。
productCode string 商品コード(入力) - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 default: $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: sample-001
GET /admin/product/product-class response
POST
ALPS `doRegisterProductClass` に対応する POST 操作。
A real browser submits the EC-CUBE 新規規格 matrix row, whose Aura fields are the snake_case leaf names of {@see \AdminProductClassForm}: `product_code` (leaf SKU), `price02`, `stock`, `stock_unlimited` (scalar checkbox — present only when checked) and `delivery_fee`. The parent product is carried by the hidden camelCase `productCode`. Blank money/stock fields arrive as empty strings (`price02=&stock=`), which a non-nullable `int` boundary would reject with a 400, so the transport empties are normalised to int here (EC-CUBE IntegerType semantics). The authoritative SKU is the parent `productCode`; the per-cell `product_code` leaf is accepted but not used for the write.
productCode* string 商品コード - 登録対象の親商品を識別するSKU/品番。フォームの hidden camelCase フィールドから供給される。在庫・カート・受注明細の結合キー。
minLength: 1 maxLength: 64 example: sample-001
POST /admin/product/product-class response
price02 string 販売価格 - 登録する規格(SKU)の販売価格(税抜)。日本円の整数金額。ブラウザは text input を文字列として送信し、空欄は空文字列で届くため、transport では string/null も受け入れて Resource 境界で int に正規化する。
$comment: Request schema is transport-level; a browser posts text inputs as strings and blank fields as empty strings. Business invalid values are allowed through to Resource/Semantic validation. example: 1200
stock string 在庫数 - 登録する規格(SKU)の物理在庫数。stockUnlimited=true の場合は無視される。ブラウザは文字列として送信し、空欄は空文字列で届く。
default: 0 example: 10
stock_unlimited string 在庫無制限(規格セル) - EC-CUBE 商品規格マトリクスの checkbox。チェック時のみ送信される。単一行ポートでは camelCase stockUnlimited を権威とする。
example: 1
delivery_fee string 商品別送料(規格セル) - EC-CUBE 商品規格マトリクスの送料入力。単一行ポートでは camelCase deliveryFee を権威とする。
minLength: 0 maxLength: 12 example: 0
product_code string 商品コード(規格セル) - EC-CUBE 商品規格マトリクスの 新規規格 セルが送信する SKU コード入力。単一行ポートでは登録には用いず、親 productCode を権威とする。
minLength: 0 maxLength: 64 example: sample-001
/admin/tag/tag DELETE
ALPS `doDeleteTag` に対応する DELETE 操作。
tagId* string タグID(入力) - dtb_tag.id の不透明な文字列ハンドル。BeMart の TagEntity 層は数値ではなく文字列として保持する。Fake 実装は `tg-` プレフィックス付きの英数字を生成し、SQL 実装は dtb_tag.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlTagStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (TagDeleted) を踏むため、シードハンドル `tg-new` / `tg-sale` は Fake 専用 Fake観察文字長 6〜7; 観察値 'tg-new', 'tg-sale'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: tg-new
DELETE /admin/tag/tag response
/admin/tag/tag-list GET
ALPS `goTagList` に対応する GET 操作。
GET /admin/tag/tag-list response
POST
ALPS `doCreateTag` に対応する POST 操作。
tagName* string タグ名(入力) - 商品に付与するタグの表示名 Fake観察文字長 3〜3; 観察値 '新商品', 'セール'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 新商品
POST /admin/tag/tag-list response
/admin/tax-rule/tax-rule DELETE
ALPS `doDeleteTaxRule` に対応する DELETE 操作。
taxRuleId* string 税率ルールID(入力) - dtb_tax_rule.id の不透明な文字列ハンドル。BeMart の TaxRuleEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_tax_rule.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlTaxRuleStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (TaxRuleDeleted) を踏むため、シードハンドル(`nonexistent-zzz` 等)は Fake / SQL 双方で 404 が同形 Fake観察文字長 5〜6; 観察値 'tax-10', 'tax-8'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: tax-10
DELETE /admin/tax-rule/tax-rule response
/admin/tax-rule/tax-rule-list GET
ALPS `goTaxRuleList` に対応する GET 操作。
GET /admin/tax-rule/tax-rule-list response
POST
ALPS `doCreateTaxRule` に対応する POST 操作。
taxRate* float 税率 - 税ルールに適用する税率。8.0や10.0のような小数表現を含む百分率。
$comment: 税率は本来数値/列挙の業務値だが、HTTPフォームでは文字列として届く。Resource/Semantic層の400応答を奪わないためtransport schemaでは文字列入力を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 10.0
POST /admin/tax-rule/tax-rule-list response
applyDate* string 適用日(入力) - この税率ルールが有効になる日時。適用日以降の注文にこの税率が適用される。複数の税率ルールがある場合、注文日時点で最も新しい適用日のルールが使用される。過去の受注には影響しない Fake観察文字長 25〜25; 観察値 '2024-04-01T00:00:00+09:00', '2023-10-01T00:00:00+09:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 2024-04-01T00:00:00+09:00
roundingType int 端数処理(入力) - 1=四捨五入, 2=切り捨て, 3=切り上げ。受注明細の税額計算時の端数処理方式。TaxRuleで設定 Fake観察数値 1〜1; 観察値 '1'。
default: 1 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: 1
/admin/template/template-add GET
ALPS `goTemplateInstall` に対応する GET 操作。
GET /admin/template/template-add response
POST
Installs an uploaded design template (doInstallTemplate). ALPS marks it `unsafe` → POST.
templateCode* string テンプレートコード(入力) - テンプレートの一意識別コード。標準テンプレートは'default'
minLength: 0 maxLength: 255 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation.
POST /admin/template/template-add response
templateName* string テンプレート名(入力) - テンプレートの表示名 Fake観察文字長 10〜11; 観察値 'デフォルト (PC)', 'デフォルト (スマホ)'。
minLength: 0 maxLength: 32 $comment: Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: デフォルト (PC)
file string テンプレートファイル - multipart/form-data の `file` または Resource テストで渡される FileUpload オブジェクト。詳細検証は `#[InputFile]` が担う。
$comment: Koriym\FileUpload\FileUpload / ErrorFileUpload は schema では不透明オブジェクトとして扱う。
/admin/template/template-list GET
ALPS `goTemplateList` に対応する GET 操作。
GET /admin/template/template-list response
PUT
Activates a template (doSelectTemplate). ALPS idempotent → PUT.
ALPS `doSelectTemplate` に対応する PUT 操作。
templateId* string テンプレートID(入力) - dtb_template.id の不透明な文字列ハンドル。BeMart の TemplateEntity 層は数値ではなく文字列として保持する。Fake 実装は `tp-` プレフィックス付きのシードハンドル(tp-default-pc / tp-default-sp)を持ち、SQL 実装は dtb_template.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。Template には list アフォーダンスのみ(goTemplateList)で作成・更新・削除が無いため ID ジェネレータは存在せず、テンプレートはインストーラ/fixture が seed した行から読み出すのみ。layoutId / blockId / categoryId と同じ Fake↔SQL 二重性。templateCode(一意の install-time コード)とは別物 — TemplateEntity の投影は id ハンドルを用い templateCode は投影外 Fake観察文字長 13〜13; 観察値 'tp-default-pc', 'tp-default-sp'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: tp-default-pc
PUT /admin/template/template-list response
DELETE
Deletes a template (doDeleteTemplate). ALPS idempotent → DELETE.
ALPS `doDeleteTemplate` に対応する DELETE 操作。
templateId* string テンプレートID(入力) - dtb_template.id の不透明な文字列ハンドル。BeMart の TemplateEntity 層は数値ではなく文字列として保持する。Fake 実装は `tp-` プレフィックス付きのシードハンドル(tp-default-pc / tp-default-sp)を持ち、SQL 実装は dtb_template.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。Template には list アフォーダンスのみ(goTemplateList)で作成・更新・削除が無いため ID ジェネレータは存在せず、テンプレートはインストーラ/fixture が seed した行から読み出すのみ。layoutId / blockId / categoryId と同じ Fake↔SQL 二重性。templateCode(一意の install-time コード)とは別物 — TemplateEntity の投影は id ハンドルを用い templateCode は投影外 Fake観察文字長 13〜13; 観察値 'tp-default-pc', 'tp-default-sp'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: tp-default-pc
DELETE /admin/template/template-list response
POST
Downloads a template zip (doDownloadTemplate). ALPS unsafe → POST.
ALPS `doDownloadTemplate` に対応する POST 操作。
templateId* string テンプレートID(入力) - dtb_template.id の不透明な文字列ハンドル。BeMart の TemplateEntity 層は数値ではなく文字列として保持する。Fake 実装は `tp-` プレフィックス付きのシードハンドル(tp-default-pc / tp-default-sp)を持ち、SQL 実装は dtb_template.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。Template には list アフォーダンスのみ(goTemplateList)で作成・更新・削除が無いため ID ジェネレータは存在せず、テンプレートはインストーラ/fixture が seed した行から読み出すのみ。layoutId / blockId / categoryId と同じ Fake↔SQL 二重性。templateCode(一意の install-time コード)とは別物 — TemplateEntity の投影は id ハンドルを用い templateCode は投影外 Fake観察文字長 13〜13; 観察値 'tp-default-pc', 'tp-default-sp'。
minLength: 0 maxLength: 128 $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 Request schema is transport-level; business invalid values are allowed through to Resource/Semantic validation. example: tp-default-pc
POST /admin/template/template-list response

Objects

📄GET /action-redirect response

NameTypeDescriptionMeta
message string|null リダイレクトメッセージ - /action-redirect のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。

📄POST /action-redirect response

NameTypeDescriptionMeta
message string|null リダイレクトメッセージ - /action-redirect のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。

📄GET /cart response

NameTypeDescriptionMeta
carts array|null カート一覧 - /cart のレスポンスで扱うカート一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
cartCount int|null カート件数 - /cart のレスポンスで返すカート件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
totalPrice int カート合計金額 - カート内の税込合計金額。PurchaseFlow.calculateTotal()で毎回再計算されるキャッシュ値。受注のtotalとは別プロパティ Fake観察数値 0〜3600; 観察値 '0', '1500', '3600'。
minimum: 0 maximum: 999999999 example: 0
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
deliveryFeeTotal int|null 送料合計 - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
minimum: 0 maximum: 999999999 example: 600

📄GET /contact response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /contact でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /contact のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["rel","href","method"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /contact response

NameTypeDescriptionMeta
contactEmail string|null お問い合わせメール - お問い合わせフォームのメールアドレス
format: email minLength: 3 maxLength: 254 example: alice@example.com
contactName02 string|null お問い合わせ名 - お問い合わせフォームの名。内部的にはNameTypeのname02と同じ仕組み
minLength: 0 maxLength: 255
contactName01 string|null お問い合わせ姓 - お問い合わせフォームの姓。内部的にはNameTypeのname01と同じ仕組み
minLength: 0 maxLength: 255
ticketId string|null 受付番号 - 問い合わせ送信後に発行される公開受付番号。問い合わせ本文の readback resource ではなく、完了状態の成立証拠として使う。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。

📄GET /entry response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /entry でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /entry のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /entry response

NameTypeDescriptionMeta
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
customerStatus int 会員ステータス - 1=仮会員(メール未認証), 2=本会員(認証済み), 3=退会。退会時はメールアドレスが無効化される Fake観察数値 1〜2; 観察値 '2', '1'。
enum: [1,2,3] example: 2
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
initialPoint int|null 初期ポイント - Fake観察数値 100〜100; 観察値 '100'。
minimum: 0 maximum: 2147483647 example: 100
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス

📄GET /forgot-complete response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /forgot-complete でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /forgot-complete のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /forgot-password response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /forgot-password でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /forgot-password のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /forgot-password response

NameTypeDescriptionMeta
message string|null パスワード再設定メッセージ - /forgot-password のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。

📄GET /index response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /index でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /index のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent string|null 静的コンテンツ - /index で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
minLength: 0 maxLength: 255
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /login response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /login でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /login のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /login response

NameTypeDescriptionMeta
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
customerStatus int 会員ステータス - 1=仮会員(メール未認証), 2=本会員(認証済み), 3=退会。退会時はメールアドレスが無効化される Fake観察数値 1〜2; 観察値 '2', '1'。
enum: [1,2,3] example: 2
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス

📄POST /logout response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /logout のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
wasLoggedIn boolean|null ログイン済み結果 - /logout の処理状態を示すログイン済み結果。画面表示や冪等処理結果の分岐に使う真偽値。
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001

📄GET /mypage response

NameTypeDescriptionMeta
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
recentOrders array|null 最近の注文一覧 - /mypage のレスポンスで扱う最近の注文一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
favoriteCount int|null お気に入り件数 - /mypage のレスポンスで返すお気に入り件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
recentOrderCount int|null 最近の注文件数 - /mypage のレスポンスで返す最近の注文件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス

📄GET /product response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
stock int|null 在庫数 - 物理在庫数。stockUnlimited=trueの場合は無視される。注文確定時に引き当てが行われる Fake観察数値 0〜100; 観察値 '0', '10', '20', '50', '5', '7', '100', '3'; null 9/73。
minimum: 0 maximum: 2147483647 example: 0
productName string|null 商品名 - 商品の表示名 Fake観察文字長 6〜17。
minLength: 0 maxLength: 128 example: サンプル商品 A
description string|null 詳細説明文 - 商品詳細ページに表示する説明文 Fake観察文字長 12〜32; 観察値 'Stock-unlimited fixture', 'Wave 8 admin grid: visible row', 'Wave 8 admin grid: hidden row', 'Wave 8 admin grid: withdrawn row', '管理画面から名称変更した、彩り豊かなジェラートセットです。', '管理画面から作成した商品'; null 1/7。
minLength: 0 maxLength: 128 example: Stock-unlimited fixture
classNames array|null 規格名一覧 - Fake観察数値 0〜1。
minItems: 0
price02 int|null 販売価格 - 実際の販売価格(税抜)。税計算・小計計算のベース Fake観察数値 800〜28000。
minimum: 0 maximum: 999999999 example: 3500
mainImage string|null メイン画像URI - /product の画面表示に使うメイン画像URI。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
format: uri-reference minLength: 1 maxLength: 2048 example: /products
tagNames array|null タグ名一覧 - Fake観察数値 0〜2。
minItems: 0
categoryNames array|null カテゴリ名一覧 - Fake観察数値 0〜4。
minItems: 0
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
stockFind boolean|null 在庫検索フラグ - /product の処理文脈から派生した在庫検索フラグ。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /products response

NameTypeDescriptionMeta
filters object|null 検索条件 - /products の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
additionalProperties: required: ["disp_number","nameKeyword","name","pageno","orderby","categoryName","category_id"]
pager object|null ページャ - /products の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
additionalProperties: required: ["pages","pageCount","current"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
totalItemCount int|null 総件数 - /products のレスポンスで返す総件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
products array|null 商品一覧 - /products のレスポンスで扱う商品一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
productSource embed
src: app://self/products{?nameKeyword,name}

📄GET /reset response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /reset でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
resetKey string|null パスワードリセットキー - パスワードリセット用のワンタイムトークン。リセット要求時に生成、使用後にクリア Fake観察文字長 32〜34; 観察値 'valid-reset-key-pilot15-aaaa1111', 'expired-token-key-pilot15-aaaa1111'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@-]+$ $comment: キー/追跡番号は照合用の不透明文字列で、数値演算対象ではない。 example: valid-reset-key-pilot15-aaaa1111
submitTo object|null フォーム送信先リンク - /reset のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /reset response

NameTypeDescriptionMeta
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001

📄GET /shopping response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
cartCount int|null カート件数 - /shopping のレスポンスで返すカート件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
totalPrice int カート合計金額 - カート内の税込合計金額。PurchaseFlow.calculateTotal()で毎回再計算されるキャッシュ値。受注のtotalとは別プロパティ Fake観察数値 0〜3600; 観察値 '0', '1500', '3600'。
minimum: 0 maximum: 999999999 example: 0
canCheckout boolean|null 処理状態フラグ - /shopping の処理状態を示す処理状態フラグ。画面表示や冪等処理結果の分岐に使う真偽値。
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
deliveryFeeTotal int|null 送料合計 - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
minimum: 0 maximum: 999999999 example: 600
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
carts array|null カート一覧 - /shopping のレスポンスで扱うカート一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
paymentMethods array|null 処理一覧 - /shopping のレスポンスで扱う処理一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minItems: 0
defaultShippingAddress object|null 処理一覧 - /shopping のレスポンスで扱う処理一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
additionalProperties: required: ["addr01"]
preOrderId string|null 仮注文ID - 購入フローの一時セッショントークン。カートと注文確認/注文確定を接続する40文字の小文字16進ID。HTML確認フォームではhidden inputとして送信される。
minLength: 0 maxLength: 128 pattern: ^[0-9a-f]*$ $comment: 実DBではカート作成時に生成され、/shopping → /shopping/confirm → /shopping/checkout の境界契約として使う。 example: deadbeefcafe1234567890abcdef01234567890a
csrfToken string 購入確認CSRFトークン - /shopping で表示する購入確認フォームの送信元検証トークン。/shopping/confirm へ進むPOSTで hidden input として送信され、Ray.Csrf CsrfToken属性によりセッション上の信頼済みトークンと照合される。実HTTPでは64桁hex、test/fake文脈では deterministic token を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ $comment: 実HTTPではEccubeSharedCsrfTokenAdapter/BeMartTwigExtensionがPHPセッションに保存した64桁hexを返す。test/fake contextではFakeCsrfToken::TOKENを返すため、schemaはCSRF値の文字種・最小長のみ契約し、真正性はCsrfForbiddenInterceptorで検証する。 example: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef

📄GET /unsupported-route response

NameTypeDescriptionMeta
message string|null 未対応ルートメッセージ - /unsupported-route のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
routeName string|null ページURL - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 255

📄POST /unsupported-route response

NameTypeDescriptionMeta
message string|null 未対応ルートメッセージ - /unsupported-route のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
routeName string|null ページURL - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 255

📄GET /admin/action-redirect response

NameTypeDescriptionMeta
message string|null リダイレクトメッセージ - /admin/action-redirect のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。

📄POST /admin/action-redirect response

NameTypeDescriptionMeta
message string|null リダイレクトメッセージ - /admin/action-redirect のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。

📄GET /admin/authority-role response

NameTypeDescriptionMeta
authorityOptions array|null 権限選択肢一覧 - 管理者権限レベル。0=システム管理者(最高権限、全機能アクセス可能), 1=店舗オーナー(制限あり、denyUrlで制限されたURLにアクセス不可)。数値が小さいほど権限が高い。AuthorityRoleのURL拒否パターンでアクセス制御
minItems: 0
rules array|null 権限ルール一覧 - /admin/authority-role のレスポンスで扱う権限ルール一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
csrfToken string

📄POST /admin/authority-role response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/authority-role のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
adminId string|null 管理者ID - 管理者メンバーを識別する不透明な文字列ハンドル。Fake と SQL の ID 形状差を隠す。 Fake観察文字長 32〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000002', 'ad000000000000000000000000000003', 'ad000000000000000000000000000004'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: ad000000000000000000000000000001
loginId string|null ログインID - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: test-admin
previousAuthority int|null 処理派生項目 - /admin/authority-role の処理文脈から派生した処理派生項目。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minimum: 0
authority int|null 権限 - 管理者権限レベル。0=システム管理者(最高権限、全機能アクセス可能), 1=店舗オーナー(制限あり、denyUrlで制限されたURLにアクセス不可)。数値が小さいほど権限が高い。AuthorityRoleのURL拒否パターンでアクセス制御 Fake観察数値 0〜1; 観察値 '1', '0'。
minimum: 0 maximum: 9 example: 1
changed bool 処理状態フラグ - Fake観察数値 1〜1; 観察値 '1'。
example: 1
transitionId string
count int
rules array|null 権限ルール一覧 - 更新後の権限URL拒否ルール一覧。
minItems: 0

📄GET /admin/base-info response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
phoneNumber string|null 電話番号 - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
pattern: ^0\d{1,4}-?\d{1,4}-?\d{3,4}$ minLength: 10 maxLength: 13 example: 0312345678
shopKana string|null ショップ名フリガナ - ショップ名のカタカナ読み Fake観察文字長 12〜12; 観察値 'イーシーキューブショップ'。
minLength: 0 maxLength: 32 example: イーシーキューブショップ
businessHour string|null 営業時間 - ショップの営業時間。フリーフォーマット Fake観察文字長 11〜11; 観察値 '10:00-19:00'。
minLength: 0 maxLength: 32 example: 10:00-19:00
addr02 string|null 番地・建物名 - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 example: 神宮前1-1-1
postalCode string|null 郵便番号 - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
pattern: ^\d{3}-?\d{4}$ example: 1500001
pref int|null 都道府県 - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
minimum: 0 maximum: 47 example: 13
addr01 string|null 市区町村 - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 example: 渋谷区
shopEmail01 string|null 送信元/BCC メールアドレス - ほぼ全メール種別の送信元(From)兼ショップ控え(BCC)アドレス。注文確認・会員登録・パスワードリセット等で使用 Fake観察文字長 16〜16; 観察値 'shop@example.com'。
format: email minLength: 3 maxLength: 254 example: shop@example.com
shopName string|null ショップ名 - ショップの表示名。フロント画面のヘッダやメールに表示 Fake観察文字長 12〜12; 観察値 'EC-CUBE SHOP'。
minLength: 0 maxLength: 32 example: EC-CUBE SHOP
companyName string|null 会社名 - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 example: Acme Corp.
shopMessage string|null ショップメッセージ - 「当サイトについて」ページ(Help/about.twig)に表示する店舗からのメッセージ Fake観察文字長 20〜20; 観察値 'ようこそ、EC-CUBE SHOP へ。'。
minLength: 0 maxLength: 2000 example: ようこそ、EC-CUBE SHOP へ。
shopNameEng string|null ショップ名英語 - ショップの英語名。多言語対応やメール署名等で使用 Fake観察文字長 12〜12; 観察値 'EC-CUBE SHOP'。
minLength: 0 maxLength: 32 example: EC-CUBE SHOP
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/base-info response

NameTypeDescriptionMeta
phoneNumber string|null 電話番号 - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
pattern: ^0\d{1,4}-?\d{1,4}-?\d{3,4}$ minLength: 10 maxLength: 13 example: 0312345678
shopKana string|null ショップ名フリガナ - ショップ名のカタカナ読み Fake観察文字長 12〜12; 観察値 'イーシーキューブショップ'。
minLength: 0 maxLength: 32 example: イーシーキューブショップ
changed boolean|null 処理状態フラグ - Fake観察数値 1〜1; 観察値 '1'。
example: 1
businessHour string|null 営業時間 - ショップの営業時間。フリーフォーマット Fake観察文字長 11〜11; 観察値 '10:00-19:00'。
minLength: 0 maxLength: 32 example: 10:00-19:00
addr02 string|null 番地・建物名 - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 example: 神宮前1-1-1
postalCode string|null 郵便番号 - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
pattern: ^\d{3}-?\d{4}$ example: 1500001
pref int|null 都道府県 - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
minimum: 0 maximum: 47 example: 13
addr01 string|null 市区町村 - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 example: 渋谷区
shopEmail01 string|null 送信元/BCC メールアドレス - ほぼ全メール種別の送信元(From)兼ショップ控え(BCC)アドレス。注文確認・会員登録・パスワードリセット等で使用 Fake観察文字長 16〜16; 観察値 'shop@example.com'。
format: email minLength: 3 maxLength: 254 example: shop@example.com
shopName string|null ショップ名 - ショップの表示名。フロント画面のヘッダやメールに表示 Fake観察文字長 12〜12; 観察値 'EC-CUBE SHOP'。
minLength: 0 maxLength: 32 example: EC-CUBE SHOP
companyName string|null 会社名 - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 example: Acme Corp.
shopMessage string|null ショップメッセージ - 「当サイトについて」ページ(Help/about.twig)に表示する店舗からのメッセージ Fake観察文字長 20〜20; 観察値 'ようこそ、EC-CUBE SHOP へ。'。
minLength: 0 maxLength: 2000 example: ようこそ、EC-CUBE SHOP へ。
shopNameEng string|null ショップ名英語 - ショップの英語名。多言語対応やメール署名等で使用 Fake観察文字長 12〜12; 観察値 'EC-CUBE SHOP'。
minLength: 0 maxLength: 32 example: EC-CUBE SHOP

📄GET /admin/calendar response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
calendars array|null カレンダー一覧 - /admin/calendar のレスポンスで扱うカレンダー一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
errors array|null 検証エラー - /admin/calendar のレスポンスで扱う検証エラー。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
csrfToken string

📄POST /admin/calendar response

NameTypeDescriptionMeta
title string|null 処理タイトル - /admin/calendar のレスポンスで表示またはテンプレート描画に使う処理タイトル。同名propertyでも親文脈 `root` によって意味を分ける。
minLength: 0 maxLength: 255
message string|null 処理メッセージ - /admin/calendar のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
calendarId string|int|null カレンダーID - /admin/calendar のレスポンスで対象を識別するカレンダーID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 $comment: Fake文字列IDとEC-CUBE整数IDの両方が観察されるため、この境界だけmixedBoundaryIdとして扱う。
holiday string|int|null 休日指定 - /admin/calendar の処理文脈から派生した休日指定。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
maximum: 2147483647 minLength: 0 maxLength: 64 $comment: EC-CUBE互換のフォーム/一覧境界で数値と文字列の両方が観察される。業務解釈はResource/Semantic層で行う。

📄DELETE /admin/calendar response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/calendar のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
calendarId string|int|null カレンダーID - /admin/calendar のレスポンスで対象を識別するカレンダーID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 $comment: Fake文字列IDとEC-CUBE整数IDの両方が観察されるため、この境界だけmixedBoundaryIdとして扱う。

📄GET /admin/change-password response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
fields array|null 静的表示フィールド - /admin/change-password でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/change-password response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/change-password のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
loginId string|null ログインID - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: test-admin
adminId string|null 管理者ID - 管理者メンバーを識別する不透明な文字列ハンドル。Fake と SQL の ID 形状差を隠す。 Fake観察文字長 32〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000002', 'ad000000000000000000000000000003', 'ad000000000000000000000000000004'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: ad000000000000000000000000000001

📄POST /admin/create-customer response

NameTypeDescriptionMeta
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
customerStatus int 会員ステータス - 1=仮会員(メール未認証), 2=本会員(認証済み), 3=退会。退会時はメールアドレスが無効化される Fake観察数値 1〜2; 観察値 '2', '1'。
enum: [1,2,3] example: 2
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
initialPoint int|null 初期ポイント - Fake観察数値 100〜100; 観察値 '100'。
minimum: 0 maximum: 2147483647 example: 100
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス

📄GET /admin/csv-config response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
notOutputColumns object|null 非出力CSV列 - /admin/csv-config のレスポンスで扱う非出力CSV列。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
additionalProperties: required: ["paymentMethod","trackingNumber","deliveryName"]
outputColumns object|null 出力CSV列 - /admin/csv-config のレスポンスで扱う出力CSV列。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
additionalProperties: required: ["orderDate","paymentTotal","customerName","orderNo"]
csvType int CSV種別 - CSV出力項目設定で現在選択しているCSV種別。1=商品CSV, 2=会員CSV, 3=受注CSV, 4=配送CSV。画面の選択状態とPOST対象の列設定コンテキストを示す。
enum: [1,2,3,4] example: 1
csrfToken string

📄POST /admin/csv-config response

NameTypeDescriptionMeta
message string|null CSVメッセージ - /admin/csv-config のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
csvType int|null CSV種別 - dtb_csv.csv_type_id — mtb_csv_type への FK(1=商品CSV, 2=会員CSV, 3=受注CSV, 4=出荷CSV)。1つの csvType が複数の列設定行(dtb_csv 行)を所有する。doUpdateCsv は1つの csvType の列ベクタ全体を一括 POST し、SqlCsvColumnConfigStorage::replaceType がその csvType の行集合をアトミックに置換する。mtb_csv_type は structure-only ダンプで空のため SQL テストは seedCsvTypes でシード(seedAdminMasters と同じ空マスタ FK シード規約)
minimum: 0
columns array CSV列定義 - /admin/csv-config のCSV列設定。各要素は出力対象フィールドと表示名を表す。
minItems: 0
count int|null 件数 - /admin/csv-config のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647

📄GET /admin/customer response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
sex int|null 性別 - 1=男性, 2=女性, 3=その他, 4=回答しない Fake観察数値 2〜2; 観察値 '2'; null 3/5。
minimum: 0 example: 2
kana02 string|null メイ - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: アリス
phoneNumber string|null 電話番号 - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
pattern: ^0\d{1,4}-?\d{1,4}-?\d{3,4}$ minLength: 10 maxLength: 13 example: 0312345678
initialPoint int|null 初期ポイント - Fake観察数値 100〜100; 観察値 '100'。
minimum: 0 maximum: 2147483647 example: 100
totalSpent int 累計購入金額 - /admin/customer のレスポンスで返す累計購入金額。一覧、集計、CSV処理結果の規模を表す非負の数値。
minimum: 0 maximum: 999999999 example: 1200
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス
kana01 string|null セイ - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: ヤマダ
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
favorites array|null お気に入り商品一覧 - /admin/customer のレスポンスで扱うお気に入り商品一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
postalCode string|null 郵便番号 - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
pattern: ^\d{3}-?\d{4}$ example: 1500001
addr01 string|null 市区町村 - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 example: 渋谷区
birth string|null 生年月日 - 会員の生年月日 Fake観察文字長 10〜10; 観察値 '1990-04-01', '1985-12-15'; null 18/28。
format: date example: 1990-04-01
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
addr02 string|null 番地・建物名 - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 example: 神宮前1-1-1
customerStatus int 会員ステータス - 1=仮会員(メール未認証), 2=本会員(認証済み), 3=退会。退会時はメールアドレスが無効化される Fake観察数値 1〜2; 観察値 '2', '1'。
enum: [1,2,3] example: 2
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
pref int|null 都道府県 - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
minimum: 0 maximum: 47 example: 13
favoriteCount int|null お気に入り件数 - /admin/customer のレスポンスで返すお気に入り件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
companyName string|null 会社名 - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 example: Acme Corp.
job int|null 職業 - 1=公務員〜18=その他の18区分 Fake観察数値 7〜18; 観察値 '7', '18'; null 3/5。
minimum: 0 example: 7
orders array|null 注文一覧 - /admin/customer のレスポンスで扱う注文一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
orderCount int|null 注文件数 - /admin/customer のレスポンスで返す注文件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/customer response

NameTypeDescriptionMeta
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス

📄GET /admin/customer-csv response

NameTypeDescriptionMeta
rowCount int|null 行数 - /admin/customer-csv のレスポンスで返す行数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csv string|null 輸送ペイロード - CSVインポート/エクスポート本文。列構造の詳細はCSV互換サービス境界で検査する。
minLength: 0 maxLength: 5000000 $comment: CSV列の業務妥当性はCSV互換サービスで検査する。ここではJSON境界上の文字列サイズを契約する。

📄GET /admin/customer-delivery-edit response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/customer-delivery-edit response

NameTypeDescriptionMeta
addressId string|null 配送先ID - dtb_customer_address.id の不透明な文字列ハンドル。サーバ採番。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ example: addr00000000000000000000000000a1
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。管理画面では route param 由来。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ example: 0123456789abcdef0123456789abcdef
name01 string|null 姓 - 配送先の姓。
minLength: 0 maxLength: 255 example: 山田
name02 string|null 名 - 配送先の名。
minLength: 0 maxLength: 255 example: 太郎
kana01 string|null セイ - 姓のカタカナ読み。null 許容。
minLength: 0 maxLength: 255 example: ヤマダ
kana02 string|null メイ - 名のカタカナ読み。null 許容。
minLength: 0 maxLength: 255 example: タロウ
companyName string|null 会社名 - 配送先の会社名。null 許容。
minLength: 0 maxLength: 255 example: Acme Corp.
phoneNumber string|null 電話番号 - 配送先の電話番号。
minLength: 0 maxLength: 13 example: 0312345678
postalCode string|null 郵便番号 - 日本の郵便番号。
minLength: 0 maxLength: 8 example: 1500001
pref int|null 都道府県ID - 1=北海道〜47=沖縄県。
minimum: 0 maximum: 47 example: 13
addr01 string|null 市区町村 - 市区町村名。
minLength: 0 maxLength: 255 example: 渋谷区
addr02 string|null 番地・建物名 - 番地・ビル名・部屋番号等。
minLength: 0 maxLength: 255 example: 神宮前1-1-1

📄DELETE /admin/customer-delivery-edit response

NameTypeDescriptionMeta
addressId string|null 配送先ID - dtb_customer_address.id の不透明な文字列ハンドル。サーバ採番。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ example: addr00000000000000000000000000a1
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。管理画面では route param 由来。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ example: 0123456789abcdef0123456789abcdef

📄GET /admin/customer-list response

NameTypeDescriptionMeta
filters object|null 検索条件 - /admin/customer-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
additionalProperties: required: ["nameKeyword","emailKeyword"]
count int|null 件数 - /admin/customer-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。管理者向け一覧ページでの絞り込みフォームに使用。
minLength: 1 maxLength: 160
searchForm object|array|null 検索フォーム - /admin/customer-list のレスポンスで保持するフォーム文脈。Aura/WebForm由来の内部構造は別境界の責務で、ここではResource上の役割を示す。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
customers array|null 会員一覧 - /admin/customer-list のレスポンスで扱う会員一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0

📄POST /admin/delete-customer response

NameTypeDescriptionMeta
alreadyDeleted boolean|null 既削除フラグ - /admin/delete-customer の処理状態を示す既削除フラグ。画面表示や冪等処理結果の分岐に使う真偽値。
originalEmail string フォーム文脈項目 - /admin/delete-customer のフォーム文脈で使うフォーム文脈項目。入力保持、初期値、再表示に必要な補助値。
format: email minLength: 3 maxLength: 254 example: alice@example.com
message string|null 会員メッセージ - /admin/delete-customer のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001

📄GET /admin/empty-page response

NameTypeDescriptionMeta

📄GET /admin/index response

NameTypeDescriptionMeta
countNonStockProducts int|null 在庫切れ商品数 - /admin/index のレスポンスで返す在庫切れ商品数。一覧、集計、CSV処理結果の規模を表す非負の数値。
minimum: 0 maximum: 2147483647
salesToday int|null 本日売上 - /admin/index のレスポンスで返す本日売上。一覧、集計、CSV処理結果の規模を表す非負の数値。
minimum: 0 maximum: 999999999 example: 1200
recommendedPlugins array|null 推奨プラグイン一覧 - /admin/index のレスポンスで扱う推奨プラグイン一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
orders array|null 注文一覧 - /admin/index のレスポンスで扱う注文一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
salesThisMonth int|null 当月売上 - /admin/index のレスポンスで返す当月売上。一覧、集計、CSV処理結果の規模を表す非負の数値。
minimum: 0 maximum: 999999999 example: 1200
orderStatuses array|null 注文ステータス一覧 - /admin/index のレスポンスで扱う注文ステータス一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
countCustomers int|null 会員数 - /admin/index のレスポンスで返す会員数。一覧、集計、CSV処理結果の規模を表す非負の数値。
minimum: 0 maximum: 2147483647
countProducts int|null 商品数 - /admin/index のレスポンスで返す商品数。一覧、集計、CSV処理結果の規模を表す非負の数値。
minimum: 0 maximum: 2147483647
salesYesterday int|null 昨日売上 - /admin/index のレスポンスで返す昨日売上。一覧、集計、CSV処理結果の規模を表す非負の数値。
minimum: 0 maximum: 999999999 example: 1200
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /admin/log response

NameTypeDescriptionMeta
log array|null ログ行一覧 - /admin/log のレスポンスで扱うログ行一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。

📄GET /admin/login response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /admin/login でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /admin/login のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/login response

NameTypeDescriptionMeta
name string|null 処理表示名 - Fake観察文字長 1〜7; 観察値 'テスト管理者', '副管理者', '店舗オーナー', '削除済み管理者', 'Red', 'Blue', 'S', 'Color'。
minLength: 0 maxLength: 32 example: テスト管理者
loginId string|null ログインID - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: test-admin
authority int|null 権限 - 管理者権限レベル。0=システム管理者(最高権限、全機能アクセス可能), 1=店舗オーナー(制限あり、denyUrlで制限されたURLにアクセス不可)。数値が小さいほど権限が高い。AuthorityRoleのURL拒否パターンでアクセス制御 Fake観察数値 0〜1; 観察値 '1', '0'。
minimum: 0 maximum: 9 example: 1
adminId string|null 管理者ID - 管理者メンバーを識別する不透明な文字列ハンドル。Fake と SQL の ID 形状差を隠す。 Fake観察文字長 32〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000002', 'ad000000000000000000000000000003', 'ad000000000000000000000000000004'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: ad000000000000000000000000000001

📄GET /admin/login-history response

NameTypeDescriptionMeta
entries array|null ログイン履歴一覧 - /admin/login-history のレスポンスで扱うログイン履歴一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
count int|null 件数 - /admin/login-history のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647

📄POST /admin/logout response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/logout のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
wasLoggedIn boolean|null ログイン済み結果 - /admin/logout の処理状態を示すログイン済み結果。画面表示や冪等処理結果の分岐に使う真偽値。
adminId string|null 管理者ID - 管理者メンバーを識別する不透明な文字列ハンドル。Fake と SQL の ID 形状差を隠す。 Fake観察文字長 32〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000002', 'ad000000000000000000000000000003', 'ad000000000000000000000000000004'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: ad000000000000000000000000000001

📄GET /admin/mail-template response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
mailTemplates array|null メールテンプレート一覧 - /admin/mail-template のレスポンスで扱うメールテンプレート一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minItems: 0
id string|int|null ID - Fake観察文字長 13〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000003', 'fedcba9876543210fedcba9876543210', '10000000aaaa1111bbbb2222cccc3333', 'ad000000000000000000000000000002', '0123456789abcdef0123456789abcdef', 'aaaaaaaa00000000bbbbbbbb11111111', '20000000dddd2222eeee3333ffff4444'。
minLength: 0 maxLength: 128 $comment: Fake文字列IDとEC-CUBE整数IDの両方が観察されるため、この境界だけmixedBoundaryIdとして扱う。 example: ad000000000000000000000000000001
count int|null 件数 - /admin/mail-template のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csrfToken string
Mail object|null メールテンプレート詳細 - /admin/mail-template のレスポンスで扱うメールテンプレート詳細。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
additionalProperties: required: ["id","isDeletable","file_name"]

📄POST /admin/mail-template response

NameTypeDescriptionMeta
mailTemplateId int|null メールテンプレートID - dtb_mail_template.id(int unsigned AUTO_INCREMENT)の正の整数主キー。doUpdateMailTemplate の必須入力で、既存行を指す必要がある。SqlMailTemplateStorage は findById / update をこの id で引き、未知 id は MailTemplateNotFoundException(404)。新規テンプレート作成フローは file_name 設定と Twig ファイル書き出しを伴うため Phase 2 scope であり、ID 生成器は存在しない(更新専用契約) Fake観察数値 1〜2; 観察値 '1', '2'。
minimum: 0 maximum: 2147483647 $comment: EC-CUBE側の採番IDとして扱う。 example: 1
mailTemplateName string|null テンプレート名 - メールテンプレートの表示名 Fake観察文字長 7〜9; 観察値 '注文完了メール', '会員登録完了メール'。
minLength: 0 maxLength: 32 example: 注文完了メール
fileName string|null ファイル名 - 商品画像のファイル名 Fake観察文字長 12〜15; 観察値 'Mail/order.twig', 'Mail/entry.twig', 'sample-a.jpg', 'sample-b.jpg'。
minLength: 1 maxLength: 255 example: Mail/order.twig
changed boolean|null 処理状態フラグ - Fake観察数値 1〜1; 観察値 '1'。
example: 1
mailSubject string|null メール件名 - メールの件名。テンプレート変数を含む場合あり Fake観察文字長 13〜13; 観察値 'ご注文ありがとうございます'。
minLength: 0 maxLength: 32 example: ご注文ありがとうございます

📄DELETE /admin/mail-template response

NameTypeDescriptionMeta
mailTemplateId int|null メールテンプレートID - dtb_mail_template.id(int unsigned AUTO_INCREMENT)の正の整数主キー。doUpdateMailTemplate の必須入力で、既存行を指す必要がある。SqlMailTemplateStorage は findById / update をこの id で引き、未知 id は MailTemplateNotFoundException(404)。新規テンプレート作成フローは file_name 設定と Twig ファイル書き出しを伴うため Phase 2 scope であり、ID 生成器は存在しない(更新専用契約) Fake観察数値 1〜2; 観察値 '1', '2'。
minimum: 0 maximum: 2147483647 $comment: EC-CUBE側の採番IDとして扱う。 example: 1
mailTemplateName string|null テンプレート名 - メールテンプレートの表示名 Fake観察文字長 7〜9; 観察値 '注文完了メール', '会員登録完了メール'。
minLength: 0 maxLength: 32 example: 注文完了メール
fileName string|null ファイル名 - 商品画像のファイル名 Fake観察文字長 12〜15; 観察値 'Mail/order.twig', 'Mail/entry.twig', 'sample-a.jpg', 'sample-b.jpg'。
minLength: 1 maxLength: 255 example: Mail/order.twig
message string|null 処理メッセージ - /admin/mail-template のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /admin/master-data response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。管理者向けマスタデータ選択フォームに使用。
minLength: 1 maxLength: 160
submitTo object|null 送信先 - /admin/master-data のフォーム送信先。unsafe 操作はこの action から辿る。
additionalProperties: required: ["rel","method","href"]
masterTypes array|null マスタ種別一覧 - /admin/master-data のレスポンスで扱うマスタ種別一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
selectedMaster string|null 選択中マスタ - /admin/master-data の処理文脈から派生した選択中マスタ。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minLength: 0 maxLength: 255
rows array|null 行データ - /admin/master-data のマスタ/CSV行データ。列集合は対象マスタにより変わるため、既知列を優先して契約する。
minItems: 0

📄PUT /admin/master-data response

NameTypeDescriptionMeta
message string|null マスタデータメッセージ - /admin/master-data のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。管理者向けマスタデータ編集フォームに使用。
minLength: 1 maxLength: 160
submitTo object|null 送信先 - /admin/master-data の選択後に編集内容を送信するフォーム action。
additionalProperties: required: ["rel","method","href"]
masterTypes array|null マスタ種別一覧 - /admin/master-data のレスポンスで扱うマスタ種別一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
selectedMaster string|null 選択中マスタ - /admin/master-data の処理文脈から派生した選択中マスタ。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minLength: 0 maxLength: 255
rows array|null 行データ - /admin/master-data のマスタ/CSV行データ。列集合は対象マスタにより変わるため、既知列を優先して契約する。
minItems: 0

📄PUT /admin/master-data-edit response

NameTypeDescriptionMeta
message string|null マスタデータメッセージ - /admin/master-data-edit のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
masterType string マスタ種別 - /admin/master-data-edit の処理文脈から派生したマスタ種別。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minLength: 1 maxLength: 255
count int|null 件数 - /admin/master-data-edit のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647

📄GET /admin/member response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
name string|null 処理表示名 - Fake観察文字長 1〜7; 観察値 'テスト管理者', '副管理者', '店舗オーナー', '削除済み管理者', 'Red', 'Blue', 'S', 'Color'。
minLength: 0 maxLength: 32 example: テスト管理者
loginId string|null ログインID - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: test-admin
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
sortNo int|null 表示順 - 一覧における並び順 Fake観察数値 1〜20; 観察値 '1', '3', '2', '4', '10', '20'。
minimum: 0 maximum: 2147483647 example: 1
authority int|null 権限 - 管理者権限レベル。0=システム管理者(最高権限、全機能アクセス可能), 1=店舗オーナー(制限あり、denyUrlで制限されたURLにアクセス不可)。数値が小さいほど権限が高い。AuthorityRoleのURL拒否パターンでアクセス制御 Fake観察数値 0〜1; 観察値 '1', '0'。
minimum: 0 maximum: 9 example: 1
work int|null 稼働状態 - Work Masterの定数で定義: 0=NON_ACTIVE(非稼働、ログイン不可), 1=ACTIVE(稼働、ログイン可能)。管理者メンバーの有効/無効を制御
minimum: 0
adminId string|null 管理者ID - 管理者メンバーを識別する不透明な文字列ハンドル。Fake と SQL の ID 形状差を隠す。 Fake観察文字長 32〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000002', 'ad000000000000000000000000000003', 'ad000000000000000000000000000004'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: ad000000000000000000000000000001

📄POST /admin/member response

NameTypeDescriptionMeta
name string|null 処理表示名 - Fake観察文字長 1〜7; 観察値 'テスト管理者', '副管理者', '店舗オーナー', '削除済み管理者', 'Red', 'Blue', 'S', 'Color'。
minLength: 0 maxLength: 32 example: テスト管理者
sortNo int|null 表示順 - 一覧における並び順 Fake観察数値 1〜20; 観察値 '1', '3', '2', '4', '10', '20'。
minimum: 0 maximum: 2147483647 example: 1
loginId string|null ログインID - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: test-admin
authority int|null 権限 - 管理者権限レベル。0=システム管理者(最高権限、全機能アクセス可能), 1=店舗オーナー(制限あり、denyUrlで制限されたURLにアクセス不可)。数値が小さいほど権限が高い。AuthorityRoleのURL拒否パターンでアクセス制御 Fake観察数値 0〜1; 観察値 '1', '0'。
minimum: 0 maximum: 9 example: 1
work int|null 稼働状態 - Work Masterの定数で定義: 0=NON_ACTIVE(非稼働、ログイン不可), 1=ACTIVE(稼働、ログイン可能)。管理者メンバーの有効/無効を制御
minimum: 0
adminId string|null 管理者ID - 管理者メンバーを識別する不透明な文字列ハンドル。Fake と SQL の ID 形状差を隠す。 Fake観察文字長 32〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000002', 'ad000000000000000000000000000003', 'ad000000000000000000000000000004'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: ad000000000000000000000000000001

📄PUT /admin/member response

NameTypeDescriptionMeta
name string|null 処理表示名 - Fake観察文字長 1〜7; 観察値 'テスト管理者', '副管理者', '店舗オーナー', '削除済み管理者', 'Red', 'Blue', 'S', 'Color'。
minLength: 0 maxLength: 32 example: テスト管理者
sortNo int|null 表示順 - 一覧における並び順 Fake観察数値 1〜20; 観察値 '1', '3', '2', '4', '10', '20'。
minimum: 0 maximum: 2147483647 example: 1
loginId string|null ログインID - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: test-admin
authority int|null 権限 - 管理者権限レベル。0=システム管理者(最高権限、全機能アクセス可能), 1=店舗オーナー(制限あり、denyUrlで制限されたURLにアクセス不可)。数値が小さいほど権限が高い。AuthorityRoleのURL拒否パターンでアクセス制御 Fake観察数値 0〜1; 観察値 '1', '0'。
minimum: 0 maximum: 9 example: 1
work int|null 稼働状態 - Work Masterの定数で定義: 0=NON_ACTIVE(非稼働、ログイン不可), 1=ACTIVE(稼働、ログイン可能)。管理者メンバーの有効/無効を制御
minimum: 0
adminId string|null 管理者ID - 管理者メンバーを識別する不透明な文字列ハンドル。Fake と SQL の ID 形状差を隠す。 Fake観察文字長 32〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000002', 'ad000000000000000000000000000003', 'ad000000000000000000000000000004'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: ad000000000000000000000000000001

📄DELETE /admin/member response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/member のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
adminId string|null 管理者ID - 管理者メンバーを識別する不透明な文字列ハンドル。Fake と SQL の ID 形状差を隠す。 Fake観察文字長 32〜32; 観察値 'ad000000000000000000000000000001', 'ad000000000000000000000000000002', 'ad000000000000000000000000000003', 'ad000000000000000000000000000004'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: ad000000000000000000000000000001
loginId string|null ログインID - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: test-admin
alreadyDeleted bool 既削除フラグ - /admin/member の処理状態を示す既削除フラグ。画面表示や冪等処理結果の分岐に使う真偽値。
example: false

📄GET /admin/member-list response

NameTypeDescriptionMeta
filters object|null 検索条件 - /admin/member-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
additionalProperties: required: ["nameKeyword","offset","limit"]
count int|null 件数 - /admin/member-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csrfToken string|null CSRFトークン - 一覧画面から送信する削除フォーム用のCSRFトークン。
minLength: 0 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]*$
members array|null 管理メンバー一覧 - /admin/member-list のレスポンスで扱う管理メンバー一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0

📄GET /admin/order response

NameTypeDescriptionMeta
paymentDate string 入金日 - 入金確認日時。入金済みステータスへの変更時に記録 Fake観察文字長 19〜19; 観察値 '2026-04-01 10:00:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 pattern: ^$|\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-04-01 10:00:00
paymentMethodId int|null 支払方法ID - 受注に紐づく支払方法マスタID。Fake/EC-CUBE境界ではDB採番値として扱う。
minimum: 0 maximum: 2147483647 example: 2
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
orderStatus int 受注ステータス - 1=新規受付, 3=注文取消, 4=対応中, 5=発送済み, 6=入金済み, 7=決済処理中, 8=購入処理中, 9=返品。Symfony Workflowステートマシンで遷移を制御。許可される遷移: pay(1->6), packing(1,6->4), cancel(1,4,6->3), back_to_in_progress(3->4), ship(1,6,4->5), return(5->9), cancel_return(9->5)。7と8はPurchaseFlow内で直接セットされステートマシン遷移の対象外 Fake観察数値 1〜1; 観察値 '1'。
minimum: 1 maximum: 9 example: 1
orderDate string 注文日 - 注文確定日時 Fake観察文字長 19〜19; 観察値 '2026-04-01 10:00:00'。
pattern: ^\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-04-01 10:00:00
preOrderId string|null 仮注文ID - 購入フローの一時セッショントークン(SHA1ハッシュ)。カートと受注を紐づける。予約注文(pre-order)IDではない。チェックアウト開始時に生成、注文確定またはカート破棄で消去 Fake観察文字長 40〜40; 観察値 'deadbeefcafe1234567890abcdef01234567890a', 'deadbeefcafe1234567890abcdef01234567890b', 'aaaa00000000000000000000000000000000aaaa', 'past00000000000000000000000000000000past', 'deadbeefcafe1234567890abcdef01234567890c', 'bbbb00000000000000000000000000000000bbbb', 'cccc00000000000000000000000000000000cccc', 'aceface0000000000000000000000000000a11ce'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: deadbeefcafe1234567890abcdef01234567890a
itemCount int|null 明細件数 - /admin/order のレスポンスで返す明細件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 10000 example: 1
discount int|null 値引き額 - 受注全体の値引き合計額。クーポン等による値引き Fake観察数値 0〜0; 観察値 '0'。
minimum: 0 maximum: 999999999 example: 0
addPoint int|null 付与ポイント - 注文により付与されるポイント数。商品単価(税抜) x pointRate x 数量で明細ごとに計算し合算。利用ポイント分を控除。発送済み(DELIVERED)遷移時に会員のpointに加算 Fake観察数値 0〜127; 観察値 '127', '0'。
minimum: 0 maximum: 2147483647 example: 127
items array|null 明細一覧 - /admin/order の親オブジェクト `` に含まれる明細配列。商品・カート・受注明細の文脈で解釈する。
minItems: 0
customer array|null|object 会員詳細 - /admin/order のレスポンスで扱う会員詳細。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0 $comment: 単一詳細画面では未選択/初期表示に空配列、取得済み状態にobjectが現れる。不透明な詳細構造は既知propertyを優先し、追加キーは互換境界として許容する。
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
deliveryFeeTotal int|null 送料合計 - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
minimum: 0 maximum: 999999999 example: 600
usePoint int|null 使用ポイント - 注文で使用するポイント数。実際の値引き額は usePoint x pointConversionRate(切り捨て)で計算され、不課税のポイント値引き明細として受注に追加 Fake観察数値 0〜0; 観察値 '0'。
minimum: 0 maximum: 2147483647 example: 0
charge int|null 手数料 - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
minimum: 0 maximum: 999999999 example: 0
paymentTotal int|null 支払合計 - 実際の支払金額。初期値はtotalと同値で、PointProcessorがポイント値引きのOrderItem(type=POINT_DISCOUNT、不課税)を追加後にPurchaseFlow.calculateTotal()で再計算される。計算式: total - (利用ポイント x pointConversionRate) Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700
tax int|null 税額 - 受注全体の税額合計(非推奨)。明細ごとの税額集計と差異が生じる場合があるため、正確な税額はOrderItem明細ごとのtaxを集計すべき Fake観察数値 1100〜1100; 観察値 '1100'。
minimum: 0 maximum: 999999999 example: 1100
orderStatusOptions object 受注ステータス - 1=新規受付, 3=注文取消, 4=対応中, 5=発送済み, 6=入金済み, 7=決済処理中, 8=購入処理中, 9=返品。Symfony Workflowステートマシンで遷移を制御。許可される遷移: pay(1->6), packing(1,6->4), cancel(1,4,6->3), back_to_in_progress(3->4), ship(1,6,4->5), return(5->9), cancel_return(9->5)。7と8はPurchaseFlow内で直接セットされステートマシン遷移の対象外
$comment: フレームワーク由来または動的mapのため、JSON境界ではobjectであることと意味を契約し、内部キーは別境界で扱う。追加キーは不透明構造として許容する。
subtotal int|null 商品小計 - 商品合計金額(税込)。送料・手数料・値引き適用前の商品明細(orderItemType=1)のみの合計。PurchaseFlow.calculateSubTotal()で計算。送料無料条件の判定基準にも使用(お届け先ごとに判定) Fake観察数値 11000〜11000; 観察値 '11000'。
minimum: 0 maximum: 999999999 example: 11000
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
total int|null 受注合計 - 受注合計金額。計算式: subtotal(商品税込合計) + deliveryFeeTotal(送料) + charge(手数料) - discount(値引き)。カートのtotalPriceとは別プロパティ Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700

📄PUT /admin/order response

NameTypeDescriptionMeta
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
orderStatus int 受注ステータス - 1=新規受付, 3=注文取消, 4=対応中, 5=発送済み, 6=入金済み, 7=決済処理中, 8=購入処理中, 9=返品。Symfony Workflowステートマシンで遷移を制御。許可される遷移: pay(1->6), packing(1,6->4), cancel(1,4,6->3), back_to_in_progress(3->4), ship(1,6,4->5), return(5->9), cancel_return(9->5)。7と8はPurchaseFlow内で直接セットされステートマシン遷移の対象外 Fake観察数値 1〜1; 観察値 '1'。
minimum: 1 maximum: 9 example: 1
deliveryFeeTotal int|null 送料合計 - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
minimum: 0 maximum: 999999999 example: 600
usePoint int|null 使用ポイント - 注文で使用するポイント数。実際の値引き額は usePoint x pointConversionRate(切り捨て)で計算され、不課税のポイント値引き明細として受注に追加 Fake観察数値 0〜0; 観察値 '0'。
minimum: 0 maximum: 2147483647 example: 0
charge int|null 手数料 - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
minimum: 0 maximum: 999999999 example: 0
paymentTotal int|null 支払合計 - 実際の支払金額。初期値はtotalと同値で、PointProcessorがポイント値引きのOrderItem(type=POINT_DISCOUNT、不課税)を追加後にPurchaseFlow.calculateTotal()で再計算される。計算式: total - (利用ポイント x pointConversionRate) Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700
tax int|null 税額 - 受注全体の税額合計(非推奨)。明細ごとの税額集計と差異が生じる場合があるため、正確な税額はOrderItem明細ごとのtaxを集計すべき Fake観察数値 1100〜1100; 観察値 '1100'。
minimum: 0 maximum: 999999999 example: 1100
subtotal int|null 商品小計 - 商品合計金額(税込)。送料・手数料・値引き適用前の商品明細(orderItemType=1)のみの合計。PurchaseFlow.calculateSubTotal()で計算。送料無料条件の判定基準にも使用(お届け先ごとに判定) Fake観察数値 11000〜11000; 観察値 '11000'。
minimum: 0 maximum: 999999999 example: 11000
discount int|null 値引き額 - 受注全体の値引き合計額。クーポン等による値引き Fake観察数値 0〜0; 観察値 '0'。
minimum: 0 maximum: 999999999 example: 0
total int|null 受注合計 - 受注合計金額。計算式: subtotal(商品税込合計) + deliveryFeeTotal(送料) + charge(手数料) - discount(値引き)。カートのtotalPriceとは別プロパティ Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700

📄GET /admin/order-list response

NameTypeDescriptionMeta
offset int|null 開始位置 - /admin/order-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
minimum: 0 maximum: 2147483647
limit int|null 表示件数 - /admin/order-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
minimum: 0 maximum: 2147483647
orders array|null 注文一覧 - /admin/order-list のレスポンスで扱う注文一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
count int|null 件数 - /admin/order-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
searchForm object|array|null 検索フォーム - /admin/order-list のレスポンスで保持するフォーム文脈。Aura/WebForm由来の内部構造は別境界の責務で、ここではResource上の役割を示す。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csrfToken string CSRFトークン - 一括削除フォームの送信元を検証するトークン。管理者向け受注一覧の一括操作フォームに使用。
minLength: 1 maxLength: 160

📄GET /admin/order-status response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
orderStatuses array|null 注文ステータス一覧 - /admin/order-status のレスポンスで扱う注文ステータス一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
csrfToken string|null CSRFトークン - POST /admin/order-status のhidden inputで送るCSRFトークン。
minLength: 0 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]*$

📄PUT /admin/order-status response

NameTypeDescriptionMeta
orderStatusRows string|null 受注ステータス - 1=新規受付, 3=注文取消, 4=対応中, 5=発送済み, 6=入金済み, 7=決済処理中, 8=購入処理中, 9=返品。Symfony Workflowステートマシンで遷移を制御。許可される遷移: pay(1->6), packing(1,6->4), cancel(1,4,6->3), back_to_in_progress(3->4), ship(1,6,4->5), return(5->9), cancel_return(9->5)。7と8はPurchaseFlow内で直接セットされステートマシン遷移の対象外
minLength: 0 maxLength: 255
message string|null 注文メッセージ - /admin/order-status のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
count int|null 件数 - /admin/order-status のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄POST /admin/order-status response

NameTypeDescriptionMeta
changed boolean|null 処理状態フラグ - Fake観察数値 1〜1; 観察値 '1'。
example: 1
previousStatus int 処理一覧 - /admin/order-status のレスポンスで扱う処理一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minimum: 1 maximum: 9 example: 1
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
orderStatus int 受注ステータス - 1=新規受付, 3=注文取消, 4=対応中, 5=発送済み, 6=入金済み, 7=決済処理中, 8=購入処理中, 9=返品。Symfony Workflowステートマシンで遷移を制御。許可される遷移: pay(1->6), packing(1,6->4), cancel(1,4,6->3), back_to_in_progress(3->4), ship(1,6,4->5), return(5->9), cancel_return(9->5)。7と8はPurchaseFlow内で直接セットされステートマシン遷移の対象外 Fake観察数値 1〜1; 観察値 '1'。
minimum: 1 maximum: 9 example: 1

📄DELETE /admin/plugin response

NameTypeDescriptionMeta
pluginCode string|null プラグインコード - プラグインの一意識別子。dtb_plugin.code に格納する自然キー — 列名は `code` であって `plugin_code` ではない(dtb_plugin は EC-CUBE 後発の dtb_*_code 命名規約より古い)。findByCode / install / uninstall / setEnabled の全ライフサイクルメソッドがこの列をプローブする。dtb_plugin は FK 制約を持たないが structure-only ダンプでは空のため、SQL ハイパーメディアテストは seedPlugins で2つのデモプラグイン(Sample/SamplePlugin, Sample/DisabledPlugin)をシードする Fake観察文字長 19〜21; 観察値 'Sample/SamplePlugin', 'Sample/DisabledPlugin'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/+-]*$ example: Sample/SamplePlugin
wasInstalled boolean|null インストール済み結果 - /admin/plugin の処理状態を示すインストール済み結果。画面表示や冪等処理結果の分岐に使う真偽値。

📄POST /admin/plugin-disable response

NameTypeDescriptionMeta
changed boolean|null 処理状態フラグ - Fake観察数値 1〜1; 観察値 '1'。
example: 1
pluginCode string|null プラグインコード - プラグインの一意識別子。dtb_plugin.code に格納する自然キー — 列名は `code` であって `plugin_code` ではない(dtb_plugin は EC-CUBE 後発の dtb_*_code 命名規約より古い)。findByCode / install / uninstall / setEnabled の全ライフサイクルメソッドがこの列をプローブする。dtb_plugin は FK 制約を持たないが structure-only ダンプでは空のため、SQL ハイパーメディアテストは seedPlugins で2つのデモプラグイン(Sample/SamplePlugin, Sample/DisabledPlugin)をシードする Fake観察文字長 19〜21; 観察値 'Sample/SamplePlugin', 'Sample/DisabledPlugin'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/+-]*$ example: Sample/SamplePlugin
enabled boolean|null 処理状態フラグ - 観察値 'true', 'false'。
example: true

📄POST /admin/plugin-enable response

NameTypeDescriptionMeta
changed boolean|null 処理状態フラグ - Fake観察数値 1〜1; 観察値 '1'。
example: 1
pluginCode string|null プラグインコード - プラグインの一意識別子。dtb_plugin.code に格納する自然キー — 列名は `code` であって `plugin_code` ではない(dtb_plugin は EC-CUBE 後発の dtb_*_code 命名規約より古い)。findByCode / install / uninstall / setEnabled の全ライフサイクルメソッドがこの列をプローブする。dtb_plugin は FK 制約を持たないが structure-only ダンプでは空のため、SQL ハイパーメディアテストは seedPlugins で2つのデモプラグイン(Sample/SamplePlugin, Sample/DisabledPlugin)をシードする Fake観察文字長 19〜21; 観察値 'Sample/SamplePlugin', 'Sample/DisabledPlugin'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/+-]*$ example: Sample/SamplePlugin
enabled boolean|null 処理状態フラグ - 観察値 'true', 'false'。
example: true

📄GET /admin/plugin-list response

NameTypeDescriptionMeta
plugins array|null プラグイン一覧 - /admin/plugin-list のレスポンスで扱うプラグイン一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
count int|null 件数 - /admin/plugin-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647

📄POST /admin/plugin-list response

NameTypeDescriptionMeta
pluginCode string|null プラグインコード - プラグインの一意識別子。dtb_plugin.code に格納する自然キー — 列名は `code` であって `plugin_code` ではない(dtb_plugin は EC-CUBE 後発の dtb_*_code 命名規約より古い)。findByCode / install / uninstall / setEnabled の全ライフサイクルメソッドがこの列をプローブする。dtb_plugin は FK 制約を持たないが structure-only ダンプでは空のため、SQL ハイパーメディアテストは seedPlugins で2つのデモプラグイン(Sample/SamplePlugin, Sample/DisabledPlugin)をシードする Fake観察文字長 19〜21; 観察値 'Sample/SamplePlugin', 'Sample/DisabledPlugin'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/+-]*$ example: Sample/SamplePlugin
alreadyInstalled boolean|null 既インストールフラグ - /admin/plugin-list の処理状態を示す既インストールフラグ。画面表示や冪等処理結果の分岐に使う真偽値。
installed boolean|null 処理状態フラグ - Fake観察数値 1〜1; 観察値 'true', '1'。
example: true
pluginName string|null プラグイン名 - プラグインの表示名。dtb_plugin.name に格納。PluginEntity の pluginName に対応 Fake観察文字長 13〜22; 観察値 'Sample Plugin', 'Disabled Sample Plugin'。
minLength: 0 maxLength: 128 example: Sample Plugin
enabled boolean|null 処理状態フラグ - 観察値 'true', 'false'。
example: true
pluginVersion string|null プラグインバージョン - プラグインのバージョン文字列。dtb_plugin.version に格納。PluginEntity の version に対応
minLength: 0 maxLength: 255

📄GET /admin/product response

NameTypeDescriptionMeta
stock int|null 在庫数 - 物理在庫数。stockUnlimited=trueの場合は無視される。注文確定時に引き当てが行われる Fake観察数値 0〜100; 観察値 '0', '10', '20', '50', '5', '7', '100', '3'; null 9/73。
minimum: 0 maximum: 2147483647 example: 0
productName string|null 商品名 - 商品の表示名 Fake観察文字長 6〜17。
minLength: 0 maxLength: 128 example: サンプル商品 A
description string|null 詳細説明文 - 商品詳細ページに表示する説明文 Fake観察文字長 12〜32; 観察値 'Stock-unlimited fixture', 'Wave 8 admin grid: visible row', 'Wave 8 admin grid: hidden row', 'Wave 8 admin grid: withdrawn row', '管理画面から名称変更した、彩り豊かなジェラートセットです。', '管理画面から作成した商品'; null 1/7。
minLength: 0 maxLength: 128 example: Stock-unlimited fixture
classNames array|null 規格名一覧 - Fake観察数値 0〜1。
minItems: 0
price02 int|null 販売価格 - 実際の販売価格(税抜)。税計算・小計計算のベース Fake観察数値 800〜28000。
minimum: 0 maximum: 999999999 example: 3500
mainImage string|null メイン画像URI - /admin/product の画面表示に使うメイン画像URI。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
format: uri-reference minLength: 1 maxLength: 2048 example: /products
tagNames array|null タグ名一覧 - Fake観察数値 0〜2。
minItems: 0
categoryNames array|null カテゴリ名一覧 - Fake観察数値 0〜4。
minItems: 0
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
note string|null 商品備考 - 管理者のみが参照する内部メモ。フロントには表示されない Fake観察文字長 11〜25; 観察値 'internal note A', 'internal note C', 'internal note B', '管理画面名称変更 smoke 2026-05-23', 'Codex smoke'; null 10/42。
minLength: 0 maxLength: 1000 example: internal note A
productStatusOptions object 商品ステータス - 1=公開(フロント表示), 2=非公開(フロント非表示), 3=廃止(論理削除、管理画面でもデフォルト非表示)
$comment: フレームワーク由来または動的mapのため、JSON境界ではobjectであることと意味を契約し、内部キーは別境界で扱う。追加キーは不透明構造として許容する。
productStatus int|null 商品ステータス - 1=公開(フロント表示), 2=非公開(フロント非表示), 3=廃止(論理削除、管理画面でもデフォルト非表示) Fake観察数値 1〜3; 観察値 '1', '2', '3'。
enum: [1,2,3] example: 1
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
searchWord string|null 検索ワード - フロント検索でヒットさせるためのキーワード。画面には表示されない検索補助データ Fake観察文字長 9〜15; 観察値 '管理 active', '管理 withdrawn', '管理 hidden', 'ジェラート ギフト 彩 api', 'ui create'; null 10/42。
minLength: 0 maxLength: 1000 example: 管理 active

📄POST /admin/product response

NameTypeDescriptionMeta
stock int|null 在庫数 - 物理在庫数。stockUnlimited=trueの場合は無視される。注文確定時に引き当てが行われる Fake観察数値 0〜100; 観察値 '0', '10', '20', '50', '5', '7', '100', '3'; null 9/73。
minimum: 0 maximum: 2147483647 example: 0
productName string|null 商品名 - 商品の表示名 Fake観察文字長 6〜17。
minLength: 0 maxLength: 128 example: サンプル商品 A
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
description string|null 詳細説明文 - 商品詳細ページに表示する説明文 Fake観察文字長 12〜32; 観察値 'Stock-unlimited fixture', 'Wave 8 admin grid: visible row', 'Wave 8 admin grid: hidden row', 'Wave 8 admin grid: withdrawn row', '管理画面から名称変更した、彩り豊かなジェラートセットです。', '管理画面から作成した商品'; null 1/7。
minLength: 0 maxLength: 128 example: Stock-unlimited fixture
productStatus int|null 商品ステータス - 1=公開(フロント表示), 2=非公開(フロント非表示), 3=廃止(論理削除、管理画面でもデフォルト非表示) Fake観察数値 1〜3; 観察値 '1', '2', '3'。
enum: [1,2,3] example: 1
price02 int|null 販売価格 - 実際の販売価格(税抜)。税計算・小計計算のベース Fake観察数値 800〜28000。
minimum: 0 maximum: 999999999 example: 3500

📄PUT /admin/product response

NameTypeDescriptionMeta
stock int|null 在庫数 - 物理在庫数。stockUnlimited=trueの場合は無視される。注文確定時に引き当てが行われる Fake観察数値 0〜100; 観察値 '0', '10', '20', '50', '5', '7', '100', '3'; null 9/73。
minimum: 0 maximum: 2147483647 example: 0
productName string|null 商品名 - 商品の表示名 Fake観察文字長 6〜17。
minLength: 0 maxLength: 128 example: サンプル商品 A
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
description string|null 詳細説明文 - 商品詳細ページに表示する説明文 Fake観察文字長 12〜32; 観察値 'Stock-unlimited fixture', 'Wave 8 admin grid: visible row', 'Wave 8 admin grid: hidden row', 'Wave 8 admin grid: withdrawn row', '管理画面から名称変更した、彩り豊かなジェラートセットです。', '管理画面から作成した商品'; null 1/7。
minLength: 0 maxLength: 128 example: Stock-unlimited fixture
productStatus int|null 商品ステータス - 1=公開(フロント表示), 2=非公開(フロント非表示), 3=廃止(論理削除、管理画面でもデフォルト非表示) Fake観察数値 1〜3; 観察値 '1', '2', '3'。
enum: [1,2,3] example: 1
price02 int|null 販売価格 - 実際の販売価格(税抜)。税計算・小計計算のベース Fake観察数値 800〜28000。
minimum: 0 maximum: 999999999 example: 3500

📄DELETE /admin/product response

NameTypeDescriptionMeta
alreadyDeleted boolean|null 既削除フラグ - /admin/product の処理状態を示す既削除フラグ。画面表示や冪等処理結果の分岐に使う真偽値。
productName string|null 商品名 - 商品の表示名 Fake観察文字長 6〜17。
minLength: 0 maxLength: 128 example: サンプル商品 A
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
message string|null 商品メッセージ - /admin/product のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。

📄POST /admin/product-bulk-status response

NameTypeDescriptionMeta
requestedCount int|null 件数 - /admin/product-bulk-status のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
changedCount int|null 件数 - /admin/product-bulk-status のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
productCodes array 取込商品コード一覧 - 商品CSV取込で処理対象になったSKU一覧。各要素は商品コード制約に従う。
minItems: 0
productStatus int|null 商品ステータス - 1=公開(フロント表示), 2=非公開(フロント非表示), 3=廃止(論理削除、管理画面でもデフォルト非表示) Fake観察数値 1〜3; 観察値 '1', '2', '3'。
enum: [1,2,3] example: 1

📄POST /admin/product-copy response

NameTypeDescriptionMeta
productCode string|null 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
newProductCode string|null 処理識別子 - /admin/product-copy のレスポンスで扱う処理識別子。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minLength: 0 maxLength: 64 example: sample-001
newProductName string 表示項目 - /admin/product-copy の画面表示に使う表示項目。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 1 maxLength: 255
price02 int|null 販売価格 - 実際の販売価格(税抜)。税計算・小計計算のベース Fake観察数値 800〜28000。
minimum: 0 maximum: 999999999 example: 3500
stock int|null 在庫数 - 物理在庫数。stockUnlimited=trueの場合は無視される。注文確定時に引き当てが行われる Fake観察数値 0〜100; 観察値 '0', '10', '20', '50', '5', '7', '100', '3'; null 9/73。
minimum: 0 maximum: 2147483647 example: 0

📄GET /admin/product-csv response

NameTypeDescriptionMeta
count int|null 件数 - /admin/product-csv のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csv string|null 輸送ペイロード - CSVインポート/エクスポート本文。列構造の詳細はCSV互換サービス境界で検査する。
minLength: 0 maxLength: 5000000 $comment: CSV列の業務妥当性はCSV互換サービスで検査する。ここではJSON境界上の文字列サイズを契約する。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/product-csv response

NameTypeDescriptionMeta
message string|null CSVメッセージ - /admin/product-csv のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
count int|null 件数 - /admin/product-csv のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
productCodes array 取込商品コード一覧 - 商品CSV取込で処理対象になったSKU一覧。各要素は商品コード制約に従う。
minItems: 0

📄GET /admin/product-list response

NameTypeDescriptionMeta
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
filters object|null 検索条件 - /admin/product-list の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
additionalProperties: required: ["nameKeyword","offset","limit"]
count int|null 件数 - /admin/product-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
searchForm object|array|null 検索フォーム - /admin/product-list のレスポンスで保持するフォーム文脈。Aura/WebForm由来の内部構造は別境界の責務で、ここではResource上の役割を示す。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
products array|null 商品一覧 - /admin/product-list のレスポンスで扱う商品一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0

📄GET /admin/product-new response

NameTypeDescriptionMeta
productStatusOptions object 商品ステータス - 1=公開(フロント表示), 2=非公開(フロント非表示), 3=廃止(論理削除、管理画面でもデフォルト非表示)
$comment: フレームワーク由来または動的mapのため、JSON境界ではobjectであることと意味を契約し、内部キーは別境界で扱う。追加キーは不透明構造として許容する。
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /admin/security response

NameTypeDescriptionMeta
isSecureRequest boolean|null セキュアリクエスト判定 - /admin/security の処理状態を示すセキュアリクエスト判定。画面表示や冪等処理結果の分岐に使う真偽値。
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csrfToken string

📄PUT /admin/security response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/security のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
trustedHosts string|null 処理一覧 - /admin/security のレスポンスで扱う処理一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minLength: 0 maxLength: 255

📄PUT /admin/sort-no-move response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/sort-no-move のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
masterType string マスタ種別 - /admin/sort-no-move の処理文脈から派生したマスタ種別。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minLength: 1 maxLength: 255
rowId string|int|null 行ID - /admin/sort-no-move のレスポンスで対象を識別する行ID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 $comment: Fake文字列IDとEC-CUBE整数IDの両方が観察されるため、この境界だけmixedBoundaryIdとして扱う。
sortNo int|null 表示順 - 一覧における並び順 Fake観察数値 1〜20; 観察値 '1', '3', '2', '4', '10', '20'。
minimum: 0 maximum: 2147483647 example: 1

📄GET /admin/system response

NameTypeDescriptionMeta
info array|null システム情報一覧 - /admin/system のレスポンスで扱うシステム情報一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
phpinfoEnabled boolean|null PHP情報表示可否 - /admin/system の処理状態を示すPHP情報表示可否。画面表示や冪等処理結果の分岐に使う真偽値。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄PUT /admin/toggle-visible response

NameTypeDescriptionMeta
masterType string 表示切替マスタ種別 - /admin/toggle-visible で表示状態を変更する管理マスタの種別。delivery や payment など、表示フラグを持つ管理一覧の対象を識別する。
minLength: 1 maxLength: 64 pattern: ^[A-Za-z][A-Za-z0-9_-]{0,63}$ example: delivery
rowId string 表示切替対象行ID - /admin/toggle-visible で表示状態を変更する管理マスタ行のID。masterType と組み合わせて対象行を一意に指す。
minLength: 1 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]+$ example: del-yamato
visible bool 表示状態 - 対象マスタ行を表示状態にするかどうかを表す真偽値。PUT はこの値へ冪等に設定する。
example: false

📄GET /admin/trade-law response

NameTypeDescriptionMeta
tradeLawBody string|null 特定商取引法本文 - 特定商取引法ページ本文の単一ブロブ投影。項目別行ではなく、ページ全体を1本の本文として扱う。
minLength: 0 maxLength: 65535
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
tradeLawRows array|null 特定商取引法表示行 - /admin/trade-law のレスポンスで扱う特定商取引法表示行。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0

📄POST /admin/trade-law response

NameTypeDescriptionMeta
tradeLawBody string|null 特定商取引法本文 - 特定商取引法ページ本文の単一ブロブ投影。項目別行ではなく、ページ全体を1本の本文として扱う。
minLength: 0 maxLength: 65535
changed boolean|null 処理状態フラグ - Fake観察数値 1〜1; 観察値 '1'。
example: 1

📄GET /admin/two-factor-auth response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
fields array|null 静的表示フィールド - /admin/two-factor-auth でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
csrfToken string

📄POST /admin/two-factor-auth response

NameTypeDescriptionMeta
message string|null 二要素認証メッセージ - /admin/two-factor-auth のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
loginId string|null ログインID - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: test-admin

📄GET /admin/two-factor-auth-edit response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
memberName string|null 管理者名 - 管理者メンバーの表示名
minLength: 0 maxLength: 255
shopName string|null ショップ名 - ショップの表示名。フロント画面のヘッダやメールに表示 Fake観察文字長 12〜12; 観察値 'EC-CUBE SHOP'。
minLength: 0 maxLength: 32 example: EC-CUBE SHOP
authKey string|null 二要素認証キー - /admin/two-factor-auth-edit のレスポンスで扱う二要素認証キー。数値演算対象ではなく、照合・URL・配送追跡などに使う不透明な文字列識別子。
minLength: 0 maxLength: 128 $comment: キー/追跡番号は照合用の不透明文字列で、数値演算対象ではない。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /admin/two-factor-auth-set response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /admin/two-factor-auth-set でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
memberName string|null 管理者名 - 管理者メンバーの表示名
minLength: 0 maxLength: 255
shopName string|null ショップ名 - ショップの表示名。フロント画面のヘッダやメールに表示 Fake観察文字長 12〜12; 観察値 'EC-CUBE SHOP'。
minLength: 0 maxLength: 32 example: EC-CUBE SHOP
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
authKey string|null 二要素認証キー - /admin/two-factor-auth-set のレスポンスで扱う二要素認証キー。数値演算対象ではなく、照合・URL・配送追跡などに使う不透明な文字列識別子。
minLength: 0 maxLength: 128 $comment: キー/追跡番号は照合用の不透明文字列で、数値演算対象ではない。
csrfToken string

📄PUT /admin/two-factor-auth-set response

NameTypeDescriptionMeta
message string|null 二要素認証メッセージ - /admin/two-factor-auth-set のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
loginId string|null ログインID - 管理画面ログイン用のID。一意 Fake観察文字長 6〜13; 観察値 'test-admin', 'shop-owner', 'deputy', 'deleted-admin', 'unknown-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: test-admin

📄GET /admin/unsupported-route response

NameTypeDescriptionMeta
message string|null 未対応ルートメッセージ - /admin/unsupported-route のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
routeName string|null ページURL - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 255

📄POST /admin/unsupported-route response

NameTypeDescriptionMeta
message string|null 未対応ルートメッセージ - /admin/unsupported-route のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
routeName string|null ページURL - ページのURLパス(Symfonyルート名。例: homepage, product_list)
minLength: 0 maxLength: 255

📄POST /cart/item response

NameTypeDescriptionMeta
cartKey string カートキー - カート分離キー。形式: {セッションプレフィックス}_{販売種別ID}。EC-CUBEは販売種別ごとにカートを分離するため、異なる販売種別の商品は別カートになる 販売種別ごとにカートを分離するキー。ALPSのcartKeyはセッション接頭辞と販売種別IDから構成される。 Fake観察文字長 18〜23; 観察値 'session-prefix-1_1', 'session-prefix-1_2', 'session-checkout-pilot5'。
minLength: 3 maxLength: 128 pattern: ^.+_[0-9]+$ example: session-prefix-1_1
requestedQuantity int 要求数量 - /cart/item の処理文脈から派生した要求数量。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minimum: 0 maximum: 2147483647 example: 1
saleTypeName string|null 販売種別 - 販売種別の名称。カート分離の基準となる。異なる販売種別の商品は別カート(cartKey)に分離される Fake観察文字長 4〜8; 観察値 '通常販売', '予約販売', 'ダウンロード販売'。
minLength: 0 maxLength: 32 example: 通常販売
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
totalPrice int カート合計金額 - カート内の税込合計金額。PurchaseFlow.calculateTotal()で毎回再計算されるキャッシュ値。受注のtotalとは別プロパティ Fake観察数値 0〜3600; 観察値 '0', '1500', '3600'。
minimum: 0 maximum: 999999999 example: 0
unitPrice int 単価(表示/計算用) - 明細1件あたりの単価。受注/カート明細・お気に入りスナップショットでは追加時点の price02 をスナップショットして保持する(後の値引きやマスタ改定に影響されない)。BeMart 側では `int` 円整数 Fake観察数値 1200〜9800; 観察値 '1200', '9800'。
minimum: 0 maximum: 999999999 example: 1200
adjustedQuantity int 調整後数量 - /cart/item の処理文脈から派生した調整後数量。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minimum: 0 maximum: 2147483647 example: 1
deliveryFeeTotal int|null 送料合計 - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
minimum: 0 maximum: 999999999 example: 600

📄PUT /cart/item response

NameTypeDescriptionMeta
cartKey string カートキー - カート分離キー。形式: {セッションプレフィックス}_{販売種別ID}。EC-CUBEは販売種別ごとにカートを分離するため、異なる販売種別の商品は別カートになる 販売種別ごとにカートを分離するキー。ALPSのcartKeyはセッション接頭辞と販売種別IDから構成される。 Fake観察文字長 18〜23; 観察値 'session-prefix-1_1', 'session-prefix-1_2', 'session-checkout-pilot5'。
minLength: 3 maxLength: 128 pattern: ^.+_[0-9]+$ example: session-prefix-1_1
requestedQuantity int 要求数量 - /cart/item の処理文脈から派生した要求数量。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minimum: 0 maximum: 2147483647 example: 1
saleTypeName string|null 販売種別 - 販売種別の名称。カート分離の基準となる。異なる販売種別の商品は別カート(cartKey)に分離される Fake観察文字長 4〜8; 観察値 '通常販売', '予約販売', 'ダウンロード販売'。
minLength: 0 maxLength: 32 example: 通常販売
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
totalPrice int カート合計金額 - カート内の税込合計金額。PurchaseFlow.calculateTotal()で毎回再計算されるキャッシュ値。受注のtotalとは別プロパティ Fake観察数値 0〜3600; 観察値 '0', '1500', '3600'。
minimum: 0 maximum: 999999999 example: 0
unitPrice int 単価(表示/計算用) - 明細1件あたりの単価。受注/カート明細・お気に入りスナップショットでは追加時点の price02 をスナップショットして保持する(後の値引きやマスタ改定に影響されない)。BeMart 側では `int` 円整数 Fake観察数値 1200〜9800; 観察値 '1200', '9800'。
minimum: 0 maximum: 999999999 example: 1200
adjustedQuantity int 調整後数量 - /cart/item の処理文脈から派生した調整後数量。ALPS基礎語だけでは単位や用途が不足するため、このResource上の意味を明示する。
minimum: 0 maximum: 2147483647 example: 1
deliveryFeeTotal int|null 送料合計 - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
minimum: 0 maximum: 999999999 example: 600

📄DELETE /cart/item response

NameTypeDescriptionMeta
cartKey string カートキー - カート分離キー。形式: {セッションプレフィックス}_{販売種別ID}。EC-CUBEは販売種別ごとにカートを分離するため、異なる販売種別の商品は別カートになる 販売種別ごとにカートを分離するキー。ALPSのcartKeyはセッション接頭辞と販売種別IDから構成される。 Fake観察文字長 18〜23; 観察値 'session-prefix-1_1', 'session-prefix-1_2', 'session-checkout-pilot5'。
minLength: 3 maxLength: 128 pattern: ^.+_[0-9]+$ example: session-prefix-1_1
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
totalPrice int カート合計金額 - カート内の税込合計金額。PurchaseFlow.calculateTotal()で毎回再計算されるキャッシュ値。受注のtotalとは別プロパティ Fake観察数値 0〜3600; 観察値 '0', '1500', '3600'。
minimum: 0 maximum: 999999999 example: 0
deliveryFeeTotal int|null 送料合計 - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
minimum: 0 maximum: 999999999 example: 600

📄GET /contact/complete response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /contact/complete でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /contact/complete のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /contact/complete で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["title","page"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
ticketId string|null 受付番号 - 問い合わせ送信後に発行される公開受付番号。問い合わせ本文の readback resource ではなく、完了状態の成立証拠として使う。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。

📄GET /contact/confirm response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /contact/confirm でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /contact/confirm のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
staticContent object|null 静的コンテンツ - /contact/confirm で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["title","page"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /entry/activate response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /entry/activate でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /entry/activate のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /entry/activate で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["title","page"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄POST /entry/activate response

NameTypeDescriptionMeta
message string|null 会員メッセージ - /entry/activate のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。

📄GET /entry/complete response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /entry/complete でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /entry/complete のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /entry/complete で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["title","page"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /entry/confirm response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /entry/confirm でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /entry/confirm のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
staticContent object|null 静的コンテンツ - /entry/confirm で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["title","page"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /help/about response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /help/about でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /help/about のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /help/about で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["page","sections","title"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /help/agreement response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /help/agreement でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /help/agreement のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /help/agreement で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["page","sections","title"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /help/guide response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /help/guide でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /help/guide のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /help/guide で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["page","sections","title"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /help/privacy response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /help/privacy でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /help/privacy のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /help/privacy で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["page","sections","title"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /help/trade-law response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /help/trade-law でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /help/trade-law のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /help/trade-law で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["page","sections","title"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /mypage/address response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
submitTo object|null フォーム送信先リンク - /mypage/address のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
addressId string|null 配送先住所ID - dtb_customer_address.id の不透明な文字列ハンドル。BeMart の AddressEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_customer_address.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。所有者は customerId、AUTHZ 検査は CustomerAddressUpdated / CustomerAddressDeleted で getById → customerId 一致確認の順で実施 Fake観察文字長 32〜32; 観察値 'addr00000000000000000000000000a1'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: addr00000000000000000000000000a1

📄PUT /mypage/address response

NameTypeDescriptionMeta
kana02 string|null メイ - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: アリス
phoneNumber string|null 電話番号 - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
pattern: ^0\d{1,4}-?\d{1,4}-?\d{3,4}$ minLength: 10 maxLength: 13 example: 0312345678
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
kana01 string|null セイ - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: ヤマダ
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
addr02 string|null 番地・建物名 - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 example: 神宮前1-1-1
postalCode string|null 郵便番号 - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
pattern: ^\d{3}-?\d{4}$ example: 1500001
pref int|null 都道府県 - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
minimum: 0 maximum: 47 example: 13
addr01 string|null 市区町村 - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 example: 渋谷区
companyName string|null 会社名 - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 example: Acme Corp.
addressId string|null 配送先住所ID - dtb_customer_address.id の不透明な文字列ハンドル。BeMart の AddressEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_customer_address.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。所有者は customerId、AUTHZ 検査は CustomerAddressUpdated / CustomerAddressDeleted で getById → customerId 一致確認の順で実施 Fake観察文字長 32〜32; 観察値 'addr00000000000000000000000000a1'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: addr00000000000000000000000000a1

📄DELETE /mypage/address response

NameTypeDescriptionMeta
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
addressId string|null 配送先住所ID - dtb_customer_address.id の不透明な文字列ハンドル。BeMart の AddressEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_customer_address.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。所有者は customerId、AUTHZ 検査は CustomerAddressUpdated / CustomerAddressDeleted で getById → customerId 一致確認の順で実施 Fake観察文字長 32〜32; 観察値 'addr00000000000000000000000000a1'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: addr00000000000000000000000000a1

📄GET /mypage/address-list response

NameTypeDescriptionMeta
count int|null 件数 - /mypage/address-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
addresses array|null 住所一覧 - /mypage/address-list のレスポンスで扱う住所一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001

📄POST /mypage/address-list response

NameTypeDescriptionMeta
kana02 string|null メイ - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: アリス
phoneNumber string|null 電話番号 - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
pattern: ^0\d{1,4}-?\d{1,4}-?\d{3,4}$ minLength: 10 maxLength: 13 example: 0312345678
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
kana01 string|null セイ - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: ヤマダ
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
addr02 string|null 番地・建物名 - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 example: 神宮前1-1-1
postalCode string|null 郵便番号 - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
pattern: ^\d{3}-?\d{4}$ example: 1500001
pref int|null 都道府県 - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
minimum: 0 maximum: 47 example: 13
addr01 string|null 市区町村 - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 example: 渋谷区
companyName string|null 会社名 - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 example: Acme Corp.
addressId string|null 配送先住所ID - dtb_customer_address.id の不透明な文字列ハンドル。BeMart の AddressEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_customer_address.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。所有者は customerId、AUTHZ 検査は CustomerAddressUpdated / CustomerAddressDeleted で getById → customerId 一致確認の順で実施 Fake観察文字長 32〜32; 観察値 'addr00000000000000000000000000a1'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: addr00000000000000000000000000a1

📄GET /mypage/change response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
kana02 string|null メイ - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: アリス
phoneNumber string|null 電話番号 - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
pattern: ^0\d{1,4}-?\d{1,4}-?\d{3,4}$ minLength: 10 maxLength: 13 example: 0312345678
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
kana01 string|null セイ - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: ヤマダ
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
addr02 string|null 番地・建物名 - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 example: 神宮前1-1-1
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
postalCode string|null 郵便番号 - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
pattern: ^\d{3}-?\d{4}$ example: 1500001
pref int|null 都道府県 - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
minimum: 0 maximum: 47 example: 13
addr01 string|null 市区町村 - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 example: 渋谷区
submitTo object|null フォーム送信先リンク - /mypage/change のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
companyName string|null 会社名 - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 example: Acme Corp.
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /mypage/change response

NameTypeDescriptionMeta
message string|null 会員メッセージ - /mypage/change のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス

📄GET /mypage/change-complete response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /mypage/change-complete でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /mypage/change-complete のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /mypage/change-complete で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["title","page"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄POST /mypage/favorite response

NameTypeDescriptionMeta
alreadyExisted boolean|null 既存在フラグ - /mypage/favorite の処理状態を示す既存在フラグ。画面表示や冪等処理結果の分岐に使う真偽値。
productName string|null 商品名 - 商品の表示名 Fake観察文字長 6〜17。
minLength: 0 maxLength: 128 example: サンプル商品 A
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
unitPrice int 単価(表示/計算用) - 明細1件あたりの単価。受注/カート明細・お気に入りスナップショットでは追加時点の price02 をスナップショットして保持する(後の値引きやマスタ改定に影響されない)。BeMart 側では `int` 円整数 Fake観察数値 1200〜9800; 観察値 '1200', '9800'。
minimum: 0 maximum: 999999999 example: 1200
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001

📄DELETE /mypage/favorite response

NameTypeDescriptionMeta
alreadyAbsent boolean|null 既不存在フラグ - /mypage/favorite の処理状態を示す既不存在フラグ。画面表示や冪等処理結果の分岐に使う真偽値。
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001

📄GET /mypage/favorite-list response

NameTypeDescriptionMeta
favoriteCount int|null お気に入り件数 - /mypage/favorite-list のレスポンスで返すお気に入り件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
favorites array|null お気に入り商品一覧 - /mypage/favorite-list のレスポンスで扱うお気に入り商品一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0

📄GET /mypage/history response

NameTypeDescriptionMeta
addPoint int|null 付与ポイント - 注文により付与されるポイント数。商品単価(税抜) x pointRate x 数量で明細ごとに計算し合算。利用ポイント分を控除。発送済み(DELIVERED)遷移時に会員のpointに加算 Fake観察数値 0〜127; 観察値 '127', '0'。
minimum: 0 maximum: 2147483647 example: 127
paymentDate string 入金日 - 入金確認日時。入金済みステータスへの変更時に記録 Fake観察文字長 19〜19; 観察値 '2026-04-01 10:00:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 pattern: ^$|\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-04-01 10:00:00
message string|null 会員メッセージ - /mypage/history のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
deliveryFeeTotal int|null 送料合計 - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
minimum: 0 maximum: 999999999 example: 600
orderStatus int 受注ステータス - 1=新規受付, 3=注文取消, 4=対応中, 5=発送済み, 6=入金済み, 7=決済処理中, 8=購入処理中, 9=返品。Symfony Workflowステートマシンで遷移を制御。許可される遷移: pay(1->6), packing(1,6->4), cancel(1,4,6->3), back_to_in_progress(3->4), ship(1,6,4->5), return(5->9), cancel_return(9->5)。7と8はPurchaseFlow内で直接セットされステートマシン遷移の対象外 Fake観察数値 1〜1; 観察値 '1'。
minimum: 1 maximum: 9 example: 1
usePoint int|null 使用ポイント - 注文で使用するポイント数。実際の値引き額は usePoint x pointConversionRate(切り捨て)で計算され、不課税のポイント値引き明細として受注に追加 Fake観察数値 0〜0; 観察値 '0'。
minimum: 0 maximum: 2147483647 example: 0
orderDate string 注文日 - 注文確定日時 Fake観察文字長 19〜19; 観察値 '2026-04-01 10:00:00'。
pattern: ^\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-04-01 10:00:00
mailHistories array|null メール履歴一覧 - Fake観察数値 1〜1。
minItems: 0
charge int|null 手数料 - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
minimum: 0 maximum: 999999999 example: 0
paymentTotal int|null 支払合計 - 実際の支払金額。初期値はtotalと同値で、PointProcessorがポイント値引きのOrderItem(type=POINT_DISCOUNT、不課税)を追加後にPurchaseFlow.calculateTotal()で再計算される。計算式: total - (利用ポイント x pointConversionRate) Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700
tax int|null 税額 - 受注全体の税額合計(非推奨)。明細ごとの税額集計と差異が生じる場合があるため、正確な税額はOrderItem明細ごとのtaxを集計すべき Fake観察数値 1100〜1100; 観察値 '1100'。
minimum: 0 maximum: 999999999 example: 1100
paymentMethod string|null 支払方法 - 注文時点の支払方法名称(スナップショット)。dtb_order.payment_method / dtb_payment.payment_method と同じ EC-CUBE 境界で varchar(255) を許容する Fake観察文字長 4〜4; 観察値 '銀行振込'。
minLength: 0 maxLength: 255 example: 銀行振込
subtotal int|null 商品小計 - 商品合計金額(税込)。送料・手数料・値引き適用前の商品明細(orderItemType=1)のみの合計。PurchaseFlow.calculateSubTotal()で計算。送料無料条件の判定基準にも使用(お届け先ごとに判定) Fake観察数値 11000〜11000; 観察値 '11000'。
minimum: 0 maximum: 999999999 example: 11000
discount int|null 値引き額 - 受注全体の値引き合計額。クーポン等による値引き Fake観察数値 0〜0; 観察値 '0'。
minimum: 0 maximum: 999999999 example: 0
shippings array|null 配送一覧 - Fake観察数値 1〜1。
minItems: 0
total int|null 受注合計 - 受注合計金額。計算式: subtotal(商品税込合計) + deliveryFeeTotal(送料) + charge(手数料) - discount(値引き)。カートのtotalPriceとは別プロパティ Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /mypage/order-history response

NameTypeDescriptionMeta
offset int|null 開始位置 - /mypage/order-history の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
minimum: 0 maximum: 2147483647
limit int|null 表示件数 - /mypage/order-history の一覧表示を制御するページング/検索条件。件数、開始位置、並び順、前後リンクをクライアントが再現するための値。
minimum: 0 maximum: 2147483647
orders array|null 注文一覧 - /mypage/order-history のレスポンスで扱う注文一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
orderCount int|null 注文件数 - /mypage/order-history のレスポンスで返す注文件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647

📄POST /mypage/reorder response

NameTypeDescriptionMeta
skippedCount int|null 件数 - /mypage/reorder のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
skippedProductCodes array|null 処理識別子 - /mypage/reorder のレスポンスで扱う処理識別子。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minItems: 0
addedCount int|null 件数 - /mypage/reorder のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
cartKeys array|null 処理一覧 - /mypage/reorder のレスポンスで扱う処理一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minItems: 0
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001

📄GET /mypage/withdraw response

NameTypeDescriptionMeta
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
fields array|null 静的表示フィールド - /mypage/withdraw でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス
submitTo object|null フォーム送信先リンク - /mypage/withdraw のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001

📄POST /mypage/withdraw response

NameTypeDescriptionMeta
message string|null 会員メッセージ - /mypage/withdraw のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
cleared boolean|null 処理状態フラグ - /mypage/withdraw の処理状態を示す処理状態フラグ。画面表示や冪等処理結果の分岐に使う真偽値。
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001

📄GET /mypage/withdraw-complete response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /mypage/withdraw-complete でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /mypage/withdraw-complete のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /mypage/withdraw-complete で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["title","page"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /mypage/withdraw-confirm response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /mypage/withdraw-confirm でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /mypage/withdraw-confirm のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /shopping/checkout response

NameTypeDescriptionMeta
addPoint int|null 付与ポイント - 注文により付与されるポイント数。商品単価(税抜) x pointRate x 数量で明細ごとに計算し合算。利用ポイント分を控除。発送済み(DELIVERED)遷移時に会員のpointに加算 Fake観察数値 0〜127; 観察値 '127', '0'。
minimum: 0 maximum: 2147483647 example: 127
orderDate string 注文日 - 注文確定日時 Fake観察文字長 19〜19; 観察値 '2026-04-01 10:00:00'。
pattern: ^\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-04-01 10:00:00
paymentTotal int|null 支払合計 - 実際の支払金額。初期値はtotalと同値で、PointProcessorがポイント値引きのOrderItem(type=POINT_DISCOUNT、不課税)を追加後にPurchaseFlow.calculateTotal()で再計算される。計算式: total - (利用ポイント x pointConversionRate) Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700
completeMessage string|null 注文完了メッセージ - 注文完了画面に表示するメッセージ。主に決済プラグインが設定するカスタムメッセージ。複数プラグインからの利用を想定しappendCompleteMesssage()で追記する。HTML使用可
minLength: 0 maxLength: 255
paymentDate string 入金日 - 入金確認日時。入金済みステータスへの変更時に記録 Fake観察文字長 19〜19; 観察値 '2026-04-01 10:00:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 pattern: ^$|\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-04-01 10:00:00
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
total int|null 受注合計 - 受注合計金額。計算式: subtotal(商品税込合計) + deliveryFeeTotal(送料) + charge(手数料) - discount(値引き)。カートのtotalPriceとは別プロパティ Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700
orderStatus int 受注ステータス - 1=新規受付, 3=注文取消, 4=対応中, 5=発送済み, 6=入金済み, 7=決済処理中, 8=購入処理中, 9=返品。Symfony Workflowステートマシンで遷移を制御。許可される遷移: pay(1->6), packing(1,6->4), cancel(1,4,6->3), back_to_in_progress(3->4), ship(1,6,4->5), return(5->9), cancel_return(9->5)。7と8はPurchaseFlow内で直接セットされステートマシン遷移の対象外 Fake観察数値 1〜1; 観察値 '1'。
minimum: 1 maximum: 9 example: 1

📄GET /shopping/complete response

NameTypeDescriptionMeta
completeMessage string|null 注文完了メッセージ - 注文完了画面に表示するメッセージ。主に決済プラグインが設定するカスタムメッセージ。複数プラグインからの利用を想定しappendCompleteMesssage()で追記する。HTML使用可
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /shopping/complete で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["title","page"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
orderSource embed
src: app://self/order/header{?orderNo}

📄GET /shopping/confirm response

NameTypeDescriptionMeta
addPoint int|null 付与ポイント - 注文により付与されるポイント数。商品単価(税抜) x pointRate x 数量で明細ごとに計算し合算。利用ポイント分を控除。発送済み(DELIVERED)遷移時に会員のpointに加算 Fake観察数値 0〜127; 観察値 '127', '0'。
minimum: 0 maximum: 2147483647 example: 127
items array|null 明細一覧 - /shopping/confirm の親オブジェクト `` に含まれる明細配列。商品・カート・受注明細の文脈で解釈する。
minItems: 0
paymentMethodId int|null 支払方法ID - 受注に紐づく支払方法マスタID。Fake/EC-CUBE境界ではDB採番値として扱う。
minimum: 0 maximum: 2147483647 example: 2
customer array|null|object 会員詳細 - /shopping/confirm のレスポンスで扱う会員詳細。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0 $comment: 単一詳細画面では未選択/初期表示に空配列、取得済み状態にobjectが現れる。不透明な詳細構造は既知propertyを優先し、追加キーは互換境界として許容する。
deliveryFeeTotal int|null 送料合計 - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
minimum: 0 maximum: 999999999 example: 600
usePoint int|null 使用ポイント - 注文で使用するポイント数。実際の値引き額は usePoint x pointConversionRate(切り捨て)で計算され、不課税のポイント値引き明細として受注に追加 Fake観察数値 0〜0; 観察値 '0'。
minimum: 0 maximum: 2147483647 example: 0
charge int|null 手数料 - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
minimum: 0 maximum: 999999999 example: 0
paymentMethodName string|null 支払方法名 - 支払方法の表示名 Fake観察文字長 4〜8; 観察値 '代金引換', 'クレジットカード', '検証失敗'。
minLength: 0 maxLength: 255 example: 代金引換
paymentTotal int|null 支払合計 - 実際の支払金額。初期値はtotalと同値で、PointProcessorがポイント値引きのOrderItem(type=POINT_DISCOUNT、不課税)を追加後にPurchaseFlow.calculateTotal()で再計算される。計算式: total - (利用ポイント x pointConversionRate) Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700
preOrderId string|null 仮注文ID - 購入フローの一時セッショントークン(SHA1ハッシュ)。カートと受注を紐づける。予約注文(pre-order)IDではない。チェックアウト開始時に生成、注文確定またはカート破棄で消去 Fake観察文字長 40〜40; 観察値 'deadbeefcafe1234567890abcdef01234567890a', 'deadbeefcafe1234567890abcdef01234567890b', 'aaaa00000000000000000000000000000000aaaa', 'past00000000000000000000000000000000past', 'deadbeefcafe1234567890abcdef01234567890c', 'bbbb00000000000000000000000000000000bbbb', 'cccc00000000000000000000000000000000cccc', 'aceface0000000000000000000000000000a11ce'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: deadbeefcafe1234567890abcdef01234567890a
tax int|null 税額 - 受注全体の税額合計(非推奨)。明細ごとの税額集計と差異が生じる場合があるため、正確な税額はOrderItem明細ごとのtaxを集計すべき Fake観察数値 1100〜1100; 観察値 '1100'。
minimum: 0 maximum: 999999999 example: 1100
submitTo object|null フォーム送信先リンク - /shopping/confirm のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
subtotal int|null 商品小計 - 商品合計金額(税込)。送料・手数料・値引き適用前の商品明細(orderItemType=1)のみの合計。PurchaseFlow.calculateSubTotal()で計算。送料無料条件の判定基準にも使用(お届け先ごとに判定) Fake観察数値 11000〜11000; 観察値 '11000'。
minimum: 0 maximum: 999999999 example: 11000
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
discount int|null 値引き額 - 受注全体の値引き合計額。クーポン等による値引き Fake観察数値 0〜0; 観察値 '0'。
minimum: 0 maximum: 999999999 example: 0
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
total int|null 受注合計 - 受注合計金額。計算式: subtotal(商品税込合計) + deliveryFeeTotal(送料) + charge(手数料) - discount(値引き)。カートのtotalPriceとは別プロパティ Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700

📄GET /shopping/error response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /shopping/error でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /shopping/error のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent object|null 静的コンテンツ - /shopping/error で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
additionalProperties: required: ["page","sections","title"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /shopping/login response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /shopping/login でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /shopping/login のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent string|null 静的コンテンツ - /shopping/login で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
minLength: 0 maxLength: 255
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /shopping/non-member response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /shopping/non-member でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /shopping/non-member のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /shopping/non-member response

NameTypeDescriptionMeta
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
email string メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com
paymentMethodId int 支払方法ID - 非会員購入で作成した仮注文に紐づく支払方法ID。次の注文確認遷移 doConfirmOrder へ渡す。
preOrderId string|null 仮注文ID - 購入フローの一時セッショントークン(SHA1ハッシュ)。カートと受注を紐づける。予約注文(pre-order)IDではない。チェックアウト開始時に生成、注文確定またはカート破棄で消去 Fake観察文字長 40〜40; 観察値 'deadbeefcafe1234567890abcdef01234567890a', 'deadbeefcafe1234567890abcdef01234567890b', 'aaaa00000000000000000000000000000000aaaa', 'past00000000000000000000000000000000past', 'deadbeefcafe1234567890abcdef01234567890c', 'bbbb00000000000000000000000000000000bbbb', 'cccc00000000000000000000000000000000cccc', 'aceface0000000000000000000000000000a11ce'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: deadbeefcafe1234567890abcdef01234567890a
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス

📄GET /shopping/shipping response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /shopping/shipping でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /shopping/shipping のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
staticContent string|null 静的コンテンツ - /shopping/shipping で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
minLength: 0 maxLength: 255
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
addresses array|null 住所一覧 - /shopping/shipping のレスポンスで扱う住所一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
csrfToken string 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /shopping/shipping response

NameTypeDescriptionMeta
message string|null 注文メッセージ - /shopping/shipping のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
shippingAddressId int|null 配送先ID - /shopping/shipping のレスポンスで対象を識別する配送先ID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minimum: 0 maximum: 2147483647 $comment: EC-CUBE側の採番IDとして扱う。

📄GET /shopping/shipping-edit response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /shopping/shipping-edit でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /shopping/shipping-edit のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
staticContent string|null 静的コンテンツ - /shopping/shipping-edit で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
minLength: 0 maxLength: 255
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /shopping/shipping-edit response

NameTypeDescriptionMeta
kana02 string|null メイ - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: アリス
phoneNumber string|null 電話番号 - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
pattern: ^0\d{1,4}-?\d{1,4}-?\d{3,4}$ minLength: 10 maxLength: 13 example: 0312345678
message string|null 注文メッセージ - /shopping/shipping-edit のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス
kana01 string|null セイ - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: ヤマダ
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
addr02 string|null 番地・建物名 - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 example: 神宮前1-1-1
postalCode string|null 郵便番号 - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
pattern: ^\d{3}-?\d{4}$ example: 1500001
pref int|null 都道府県 - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
minimum: 0 maximum: 47 example: 13
addr01 string|null 市区町村 - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 example: 渋谷区
companyName string|null 会社名 - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 example: Acme Corp.
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /shopping/shipping-multiple response

NameTypeDescriptionMeta
fields array|null 静的表示フィールド - /shopping/shipping-multiple でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo string|null フォーム送信先リンク - /shopping/shipping-multiple のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
minLength: 0 maxLength: 255
staticContent string|null 静的コンテンツ - /shopping/shipping-multiple で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
minLength: 0 maxLength: 255
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
addresses array|null 住所一覧 - /shopping/shipping-multiple のレスポンスで扱う住所一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
cartItems array|null カート明細一覧 - /shopping/shipping-multiple のレスポンスで扱うカート明細一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0

📄POST /shopping/shipping-multiple response

NameTypeDescriptionMeta
message string|null 注文メッセージ - /shopping/shipping-multiple のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
allocationCount int|null 件数 - /shopping/shipping-multiple のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647

📄GET /shopping/shipping-multiple-edit response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
fields array|null 静的表示フィールド - /shopping/shipping-multiple-edit でテンプレートへ渡す表示用フィールド集合。フォーム入力値ではなく画面文脈データ。
submitTo object|null フォーム送信先リンク - /shopping/shipping-multiple-edit のフォーム送信に使う送信先リンク。HTTPメソッドと遷移先をまとめ、unsafe操作の入口を明示する。
additionalProperties: required: ["href","method"]
staticContent string|null 静的コンテンツ - /shopping/shipping-multiple-edit で表示する規約・ヘルプ・エラー等の静的ページ本文とセクション情報。
minLength: 0 maxLength: 255
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
csrfToken string 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /shopping/shipping-multiple-edit response

NameTypeDescriptionMeta
kana02 string|null メイ - 名のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'アリス', 'ハナコ', 'タロウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: アリス
phoneNumber string|null 電話番号 - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
pattern: ^0\d{1,4}-?\d{1,4}-?\d{3,4}$ minLength: 10 maxLength: 13 example: 0312345678
message string|null 注文メッセージ - /shopping/shipping-multiple-edit のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス
kana01 string|null セイ - 姓のカタカナ読み。全角カタカナのみ許可(ひらがな入力時は自動変換)。日本の氏名入力に特有の読み仮名 Fake観察文字長 3〜3; 観察値 'ヤマダ', 'サトウ'; null 18/31。
minLength: 0 maxLength: 32 pattern: ^[ァ-ヶー  ]*$ example: ヤマダ
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
addr02 string|null 番地・建物名 - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 example: 神宮前1-1-1
postalCode string|null 郵便番号 - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
pattern: ^\d{3}-?\d{4}$ example: 1500001
pref int|null 都道府県 - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
minimum: 0 maximum: 47 example: 13
addr01 string|null 市区町村 - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 example: 渋谷区
companyName string|null 会社名 - 法人顧客の社名。B2B取引やインボイスで使用 Fake観察文字長 10〜11; 観察値 'Acme Corp.', '株式会社EC-CUBE'; null 24/32。
minLength: 0 maxLength: 32 example: Acme Corp.
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /admin/block/block response

NameTypeDescriptionMeta
blockId string ブロックID - dtb_block.id の不透明な文字列ハンドル。新規作成フォームでは空文字、編集フォームでは既存ブロックID。
minLength: 0 maxLength: 128 example: 1
blockName string ブロック名 - ブロックの表示名。新規作成フォームでは空文字、編集フォームでは保存済み値。
minLength: 0 maxLength: 32
blockFileName string ブロックファイル名 - ブロックのテンプレートファイル名。新規作成フォームでは空文字、編集フォームでは保存済み値。
minLength: 0 maxLength: 32
blockDeletable bool 削除可否 - 管理画面で削除可能なユーザー定義ブロックかどうか。
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄PUT /admin/block/block response

NameTypeDescriptionMeta
blockDeletable boolean|null ブロック削除可能フラグ - このブロックを管理画面から削除できるか。システム標準ブロックは削除不可 観察値 'false', 'true'。
example: false
blockName string|null ブロック名 - ブロックの表示名 Fake観察文字長 4〜8; 観察値 'ヘッダー', 'ユーザーブロック'。
minLength: 0 maxLength: 32 example: ヘッダー
blockId string|null ブロックID - dtb_block.id の不透明な文字列ハンドル。BeMart の BlockEntity 層は数値ではなく文字列として保持する。Fake 実装は `bk-` プレフィックス付きの英数字を生成し(シード `bk-header` を含む)、SQL 実装は dtb_block.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlBlockStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (BlockUpdated / BlockDeleted) を踏むため、シードハンドル `bk-header` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 7〜9; 観察値 'bk-header', 'bk-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: bk-header
blockFileName string|null ブロックファイル名 - ブロックのテンプレートファイル名 Fake観察文字長 6〜10; 観察値 'header', 'user_block'。
minLength: 0 maxLength: 32 example: header

📄DELETE /admin/block/block response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/block/block のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
blockId string|null ブロックID - dtb_block.id の不透明な文字列ハンドル。BeMart の BlockEntity 層は数値ではなく文字列として保持する。Fake 実装は `bk-` プレフィックス付きの英数字を生成し(シード `bk-header` を含む)、SQL 実装は dtb_block.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlBlockStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (BlockUpdated / BlockDeleted) を踏むため、シードハンドル `bk-header` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 7〜9; 観察値 'bk-header', 'bk-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: bk-header

📄GET /admin/block/block-list response

NameTypeDescriptionMeta
count int|null 件数 - /admin/block/block-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
blocks array|null ブロック一覧 - /admin/block/block-list のレスポンスで扱うブロック一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
csrfToken string|null CSRFトークン - 一覧画面から送信する作成・削除フォーム用のCSRFトークン。
minLength: 0 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]*$

📄POST /admin/block/block-list response

NameTypeDescriptionMeta
blockDeletable boolean|null ブロック削除可能フラグ - このブロックを管理画面から削除できるか。システム標準ブロックは削除不可 観察値 'false', 'true'。
example: false
blockName string|null ブロック名 - ブロックの表示名 Fake観察文字長 4〜8; 観察値 'ヘッダー', 'ユーザーブロック'。
minLength: 0 maxLength: 32 example: ヘッダー
blockId string|null ブロックID - dtb_block.id の不透明な文字列ハンドル。BeMart の BlockEntity 層は数値ではなく文字列として保持する。Fake 実装は `bk-` プレフィックス付きの英数字を生成し(シード `bk-header` を含む)、SQL 実装は dtb_block.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlBlockStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (BlockUpdated / BlockDeleted) を踏むため、シードハンドル `bk-header` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 7〜9; 観察値 'bk-header', 'bk-user'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: bk-header
blockFileName string|null ブロックファイル名 - ブロックのテンプレートファイル名 Fake観察文字長 6〜10; 観察値 'header', 'user_block'。
minLength: 0 maxLength: 32 example: header

📄GET /admin/category/category response

NameTypeDescriptionMeta
parentId string|null 親カテゴリID - /admin/category/category のレスポンスで対象を識別する親カテゴリID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。
categoryName string|null カテゴリ名 - カテゴリの表示名 Fake観察文字長 4〜6; 観察値 'Food', 'Drinks'。
minLength: 0 maxLength: 255 example: Food
sortNo int|null 表示順 - 一覧における並び順 Fake観察数値 1〜20; 観察値 '1', '3', '2', '4', '10', '20'。
minimum: 0 maximum: 2147483647 example: 1
categoryId string|null カテゴリID - dtb_category.id の不透明な文字列ハンドル。BeMart の CategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (CategoryUpdated / CategoryDeleted / CategoryCreated の親解決) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。parentId(自己参照 FK parent_category_id)も同じ文字列ハンドルで表現され、非数値 parentId は SQL では NULL(ルート)に倒れる。blockId / pageId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 8〜10; 観察値 'cat-food', 'cat-drinks'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cat-food
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄PUT /admin/category/category response

NameTypeDescriptionMeta
parentId string|null 親カテゴリID - /admin/category/category のレスポンスで対象を識別する親カテゴリID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。
categoryName string|null カテゴリ名 - カテゴリの表示名 Fake観察文字長 4〜6; 観察値 'Food', 'Drinks'。
minLength: 0 maxLength: 32 example: Food
sortNo int|null 表示順 - 一覧における並び順 Fake観察数値 1〜20; 観察値 '1', '3', '2', '4', '10', '20'。
minimum: 0 maximum: 2147483647 example: 1
categoryId string|null カテゴリID - dtb_category.id の不透明な文字列ハンドル。BeMart の CategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (CategoryUpdated / CategoryDeleted / CategoryCreated の親解決) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。parentId(自己参照 FK parent_category_id)も同じ文字列ハンドルで表現され、非数値 parentId は SQL では NULL(ルート)に倒れる。blockId / pageId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 8〜10; 観察値 'cat-food', 'cat-drinks'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cat-food

📄DELETE /admin/category/category response

NameTypeDescriptionMeta
categoryId string|null カテゴリID - dtb_category.id の不透明な文字列ハンドル。BeMart の CategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (CategoryUpdated / CategoryDeleted / CategoryCreated の親解決) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。parentId(自己参照 FK parent_category_id)も同じ文字列ハンドルで表現され、非数値 parentId は SQL では NULL(ルート)に倒れる。blockId / pageId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 8〜10; 観察値 'cat-food', 'cat-drinks'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cat-food

📄GET /admin/category/category-list response

NameTypeDescriptionMeta
count int|null 件数 - /admin/category/category-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
categories array|null カテゴリ一覧 - /admin/category/category-list のレスポンスで扱うカテゴリ一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/category/category-list response

NameTypeDescriptionMeta
parentId string|null 親カテゴリID - /admin/category/category-list のレスポンスで対象を識別する親カテゴリID。DB採番ID、Fake文字列ID、互換境界IDのどれに該当するかをschemaの型とコメントで分ける。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。
categoryName string|null カテゴリ名 - カテゴリの表示名 Fake観察文字長 4〜6; 観察値 'Food', 'Drinks'。
minLength: 0 maxLength: 32 example: Food
sortNo int|null 表示順 - 一覧における並び順 Fake観察数値 1〜20; 観察値 '1', '3', '2', '4', '10', '20'。
minimum: 0 maximum: 2147483647 example: 1
categoryId string|null カテゴリID - dtb_category.id の不透明な文字列ハンドル。BeMart の CategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (CategoryUpdated / CategoryDeleted / CategoryCreated の親解決) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。parentId(自己参照 FK parent_category_id)も同じ文字列ハンドルで表現され、非数値 parentId は SQL では NULL(ルート)に倒れる。blockId / pageId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 8〜10; 観察値 'cat-food', 'cat-drinks'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cat-food

📄GET /admin/category/csv response

NameTypeDescriptionMeta
rowCount int|null 行数 - /admin/category/csv のレスポンスで返す行数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csv string|null 輸送ペイロード - CSVインポート/エクスポート本文。列構造の詳細はCSV互換サービス境界で検査する。
minLength: 0 maxLength: 5000000 $comment: CSV列の業務妥当性はCSV互換サービスで検査する。ここではJSON境界上の文字列サイズを契約する。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/category/csv response

NameTypeDescriptionMeta
deleted int|boolean|null 削除件数 - /admin/category/csv の処理状態を示す削除件数。画面表示や冪等処理結果の分岐に使う真偽値。
minimum: 0
imported int|boolean|null 取込件数 - /admin/category/csv の処理状態を示す取込件数。画面表示や冪等処理結果の分岐に使う真偽値。
minimum: 0
message string|null CSVメッセージ - /admin/category/csv のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
accepted int|boolean|null 受理件数 - /admin/category/csv の処理状態を示す受理件数。画面表示や冪等処理結果の分岐に使う真偽値。
minimum: 0
lineCount int|null CSV行数 - /admin/category/csv のレスポンスで返すCSV行数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647

📄GET /admin/category/edit response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
categories array|null カテゴリ一覧 - /admin/category/edit のレスポンスで扱うカテゴリ一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
category array|null|object カテゴリ詳細 - /admin/category/edit のレスポンスで扱うカテゴリ詳細。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0 $comment: 単一詳細画面では未選択/初期表示に空配列、取得済み状態にobjectが現れる。不透明な詳細構造は既知propertyを優先し、追加キーは互換境界として許容する。
count int|null 件数 - /admin/category/edit のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
categoryId string|null カテゴリID - dtb_category.id の不透明な文字列ハンドル。BeMart の CategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (CategoryUpdated / CategoryDeleted / CategoryCreated の親解決) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。parentId(自己参照 FK parent_category_id)も同じ文字列ハンドルで表現され、非数値 parentId は SQL では NULL(ルート)に倒れる。blockId / pageId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 8〜10; 観察値 'cat-food', 'cat-drinks'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cat-food
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄PUT /admin/class-category/class-category response

NameTypeDescriptionMeta
classCategoryId string|null 規格分類ID - dtb_class_category.id の不透明な文字列ハンドル。BeMart の ClassCategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格分類の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。classNameId / categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 6〜8; 観察値 'cc-red', 'cc-blue', 'cc-small'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cc-red
name string|null 処理表示名 - Fake観察文字長 1〜7; 観察値 'テスト管理者', '副管理者', '店舗オーナー', '削除済み管理者', 'Red', 'Blue', 'S', 'Color'。
minLength: 0 maxLength: 32 example: テスト管理者
classNameId string|null 規格名ID - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cn-color

📄DELETE /admin/class-category/class-category response

NameTypeDescriptionMeta
classCategoryId string|null 規格分類ID - dtb_class_category.id の不透明な文字列ハンドル。BeMart の ClassCategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格分類の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。classNameId / categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 6〜8; 観察値 'cc-red', 'cc-blue', 'cc-small'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cc-red

📄GET /admin/class-category/class-category-export response

NameTypeDescriptionMeta
content string CSVエクスポート本文 - /admin/class-category/class-category-export が返すCSV本文。列意味はCSV互換サービス側、JSON境界では文字列として契約する。
minLength: 0 maxLength: 5000000 $comment: CSV列の意味検査はCSV互換サービスで扱い、ここではレスポンス本文としての文字列サイズを検査する。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /admin/class-category/class-category-list response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
classNameId string|null 規格名ID - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cn-color
count int|null 件数 - /admin/class-category/class-category-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
classCategories array|null 規格分類一覧 - /admin/class-category/class-category-list のレスポンスで扱う規格分類一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minItems: 0

📄POST /admin/class-category/class-category-list response

NameTypeDescriptionMeta
classCategoryId string|null 規格分類ID - dtb_class_category.id の不透明な文字列ハンドル。BeMart の ClassCategoryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_category.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassCategoryStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格分類の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。classNameId / categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 6〜8; 観察値 'cc-red', 'cc-blue', 'cc-small'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cc-red
name string|null 処理表示名 - Fake観察文字長 1〜7; 観察値 'テスト管理者', '副管理者', '店舗オーナー', '削除済み管理者', 'Red', 'Blue', 'S', 'Color'。
minLength: 0 maxLength: 32 example: テスト管理者
classNameId string|null 規格名ID - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cn-color

📄PUT /admin/class-name/class-name response

NameTypeDescriptionMeta
name string|null 処理表示名 - Fake観察文字長 1〜7; 観察値 'テスト管理者', '副管理者', '店舗オーナー', '削除済み管理者', 'Red', 'Blue', 'S', 'Color'。
minLength: 0 maxLength: 32 example: テスト管理者
classNameId string|null 規格名ID - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cn-color

📄DELETE /admin/class-name/class-name response

NameTypeDescriptionMeta
classNameId string|null 規格名ID - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cn-color

📄GET /admin/class-name/class-name-export response

NameTypeDescriptionMeta
content string CSVエクスポート本文 - /admin/class-name/class-name-export が返すCSV本文。列意味はCSV互換サービス側、JSON境界では文字列として契約する。
minLength: 0 maxLength: 5000000 $comment: CSV列の意味検査はCSV互換サービスで扱い、ここではレスポンス本文としての文字列サイズを検査する。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /admin/class-name/class-name-list response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
count int|null 件数 - /admin/class-name/class-name-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
classNames array|null 規格名一覧 - Fake観察数値 0〜1。
minItems: 0

📄POST /admin/class-name/class-name-list response

NameTypeDescriptionMeta
name string|null 処理表示名 - Fake観察文字長 1〜7; 観察値 'テスト管理者', '副管理者', '店舗オーナー', '削除済み管理者', 'Red', 'Blue', 'S', 'Color'。
minLength: 0 maxLength: 32 example: テスト管理者
classNameId string|null 規格名ID - dtb_class_name.id の不透明な文字列ハンドル。BeMart の ClassNameEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_class_name.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlClassNameStorage では miss として扱われ getById / put / remove のいずれも 404 経路(規格名の更新・削除 Final)を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜8; 観察値 'cn-color', 'cn-size'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: cn-color

📄GET /admin/content/cache response

NameTypeDescriptionMeta
csrfToken string|null CSRFトークン - /admin/content/cache のHTMLフォーム送信用CSRFトークン。
minLength: 0 maxLength: 160

📄PUT /admin/content/cache response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/content/cache のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /admin/content/css response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csrfToken string|null CSRFトークン - /admin/content/css のHTMLフォーム送信用CSRFトークン。
minLength: 0 maxLength: 160

📄PUT /admin/content/css response

NameTypeDescriptionMeta
length int|null 本文長 - /admin/content/css のレスポンスで返す本文長。一覧、集計、CSV処理結果の規模を表す非負の数値。
minimum: 0 maximum: 2147483647
message string|null 処理メッセージ - /admin/content/css のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /admin/content/file-manager response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
tplIsTopDir boolean|null テンプレートルートディレクトリ判定 - /admin/content/file-manager の処理状態を示すテンプレートルートディレクトリ判定。画面表示や冪等処理結果の分岐に使う真偽値。
arrFileList array|null ファイル一覧 - /admin/content/file-manager のレスポンスで扱うファイル一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minItems: 0
errors array|null 検証エラー - /admin/content/file-manager のレスポンスで扱う検証エラー。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
tplNowDir string|null 現在テンプレートディレクトリ - /admin/content/file-manager の画面表示に使う現在テンプレートディレクトリ。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 0 maxLength: 255
tplParentDir string|null 親テンプレートディレクトリ - /admin/content/file-manager の画面表示に使う親テンプレートディレクトリ。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 0 maxLength: 255

📄GET /admin/content/js response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csrfToken string|null CSRFトークン - /admin/content/js のHTMLフォーム送信用CSRFトークン。
minLength: 0 maxLength: 160

📄PUT /admin/content/js response

NameTypeDescriptionMeta
length int|null 本文長 - /admin/content/js のレスポンスで返す本文長。一覧、集計、CSV処理結果の規模を表す非負の数値。
minimum: 0 maximum: 2147483647
message string|null 処理メッセージ - /admin/content/js のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /admin/content/maintenance response

NameTypeDescriptionMeta
isMaintenance boolean|null メンテナンス中フラグ - /admin/content/maintenance の処理状態を示すメンテナンス中フラグ。画面表示や冪等処理結果の分岐に使う真偽値。
csrfToken string|null CSRFトークン - /admin/content/maintenance のHTMLフォーム送信用CSRFトークン。
minLength: 0 maxLength: 160

📄PUT /admin/content/maintenance response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/content/maintenance のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
isMaintenance boolean|null メンテナンス中フラグ - /admin/content/maintenance の処理状態を示すメンテナンス中フラグ。画面表示や冪等処理結果の分岐に使う真偽値。

📄POST /admin/customer/resend-activation-mail response

NameTypeDescriptionMeta
message string|null 会員メッセージ - /admin/customer/resend-activation-mail のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
email string|null メールアドレス - 会員のログインIDを兼ねる。有効会員間で一意 ログインIDを兼ねるメールアドレス。会員登録・ログイン・通知で共通に使う。 Fake観察文字長 15〜58; 観察値 'bob@example.com', 'login-test@example.com', 'alice@example.com', 'carol@example.com', 'provisional@example.com', 'withdrawn-30000000aaaa3333bbbb4444cccc5555@example.invalid'。
format: email minLength: 3 maxLength: 254 example: alice@example.com

📄GET /admin/delivery/delivery response

NameTypeDescriptionMeta
deliveryId string|null 配送方法ID - dtb_delivery.id の不透明な文字列ハンドル。BeMart の DeliveryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_delivery.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlDeliveryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (DeliveryUpdated / DeliveryDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。blockId / pageId / categoryId と同じ Fake↔SQL 二重性 Fake観察文字長 10〜10; 観察値 'del-yamato', 'del-yupack'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: del-yamato
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
delivery array|null|object 配送方法詳細 - /admin/delivery/delivery のレスポンスで扱う配送方法詳細。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0 $comment: 単一詳細画面では未選択/初期表示に空配列、取得済み状態にobjectが現れる。不透明な詳細構造は既知propertyを優先し、追加キーは互換境界として許容する。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄PUT /admin/delivery/delivery response

NameTypeDescriptionMeta
deliveryId string|null 配送方法ID - dtb_delivery.id の不透明な文字列ハンドル。BeMart の DeliveryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_delivery.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlDeliveryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (DeliveryUpdated / DeliveryDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。blockId / pageId / categoryId と同じ Fake↔SQL 二重性 Fake観察文字長 10〜10; 観察値 'del-yamato', 'del-yupack'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: del-yamato
deliveryName string|null 配送方法名 - 管理画面で登録・更新する配送方法の表示名。実運用では店舗独自の長い名称を許容する。
minLength: 0 maxLength: 255 example: ヤマト宅急便
visible boolean|null 処理状態フラグ - 観察値 'true'。
example: true

📄DELETE /admin/delivery/delivery response

NameTypeDescriptionMeta
deliveryId string|null 配送方法ID - dtb_delivery.id の不透明な文字列ハンドル。BeMart の DeliveryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_delivery.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlDeliveryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (DeliveryUpdated / DeliveryDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。blockId / pageId / categoryId と同じ Fake↔SQL 二重性 Fake観察文字長 10〜10; 観察値 'del-yamato', 'del-yupack'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: del-yamato

📄GET /admin/delivery/delivery-list response

NameTypeDescriptionMeta
deliveries array|null 配送方法一覧 - /admin/delivery/delivery-list のレスポンスで扱う配送方法一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
count int|null 件数 - /admin/delivery/delivery-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/delivery/delivery-list response

NameTypeDescriptionMeta
deliveryId string|null 配送方法ID - dtb_delivery.id の不透明な文字列ハンドル。BeMart の DeliveryEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_delivery.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlDeliveryStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (DeliveryUpdated / DeliveryDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。blockId / pageId / categoryId と同じ Fake↔SQL 二重性 Fake観察文字長 10〜10; 観察値 'del-yamato', 'del-yupack'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: del-yamato
deliveryName string|null 配送方法名 - 管理画面で登録・更新する配送方法の表示名。実運用では店舗独自の長い名称を許容する。
minLength: 0 maxLength: 255 example: ヤマト宅急便
visible boolean|null 処理状態フラグ - 観察値 'true'。
example: true

📄GET /admin/layout/layout response

NameTypeDescriptionMeta
layoutId string|null レイアウトID - dtb_layout.id の不透明な文字列ハンドル。新規作成フォームでは null、編集フォームでは既存レイアウトID。
minLength: 0 maxLength: 128 example: 1
layoutName string レイアウト名 - レイアウトの表示名。新規作成フォームでは空文字、編集フォームでは保存済み値。
minLength: 0 maxLength: 255
deviceType int|null デバイス種別 - デバイス種別マスタ。新規作成フォームでは null、編集フォームでは保存済み値。
minimum: 0 example: 10
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。

📄PUT /admin/layout/layout response

NameTypeDescriptionMeta
deviceType int|null デバイス種別 - デバイス種別マスタ(EC-CUBE 2.xからの名残)。値: 2=モバイル, 10=PC。非連番のIDは旧バージョンのデバイスサポート(ガラケー等)に由来。ページレイアウトのデバイス別表示に使用 Fake観察数値 2〜10; 観察値 '10', '2'。
minimum: 0 example: 10
layoutId string|null レイアウトID - CMSレイアウトを識別する不透明な文字列ハンドル。seed 済みレイアウトを Fake/SQL 同型に扱う。 Fake観察文字長 13〜13; 観察値 'lo-pc-default', 'lo-sp-default'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: lo-pc-default
layoutName string|null レイアウト名 - レイアウトの表示名 Fake観察文字長 4〜5; 観察値 'PC標準', 'スマホ標準'。
minLength: 0 maxLength: 32 example: PC標準

📄GET /admin/layout/layout-list response

NameTypeDescriptionMeta
count int|null 件数 - /admin/layout/layout-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
layouts array|null レイアウト一覧 - /admin/layout/layout-list のレスポンスで扱うレイアウト一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0

📄POST /admin/mail-template/create response

NameTypeDescriptionMeta
mailTemplateId int メールテンプレートID
minimum: 1 maximum: 2147483647
mailTemplateName string テンプレート名
minLength: 1 maxLength: 255
fileName string ファイル名
minLength: 1 maxLength: 255
mailSubject string メール件名
minLength: 0 maxLength: 255

📄GET /admin/news/news response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
newsUrl string|null 外部URL - 外部リンクURL。設定時はニュース本文の代わりにこのURLへ遷移
format: uri-reference minLength: 1 maxLength: 2048 example: /products
linkMethod boolean|null 新規ウィンドウで開く - 外部URLのリンク開き方(boolean)。false=同一ウィンドウ, true=新規ウィンドウ(target="_blank")。テンプレートでtarget属性の出力制御に使用 観察値 'false'。
example: false
newsId string|null ニュースID - dtb_news.id の不透明な文字列ハンドル。BeMart の NewsEntity 層は数値ではなく文字列として保持する。Fake 実装は `nw-` プレフィックス付きの英数字を生成し(シード `nw-welcome` を含む)、SQL 実装は dtb_news.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlNewsStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminNewsFetched / NewsUpdated / NewsDeleted) を踏むため、シードハンドル `nw-welcome` や `nonexistent` は Fake / SQL 双方で 404 が同形 Fake観察文字長 10〜10; 観察値 'nw-welcome'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: nw-welcome
newsTitle string|null ニュースタイトル - ニュース記事の見出し Fake観察文字長 4〜4; 観察値 'ようこそ'。
minLength: 0 maxLength: 32 example: ようこそ
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
publishDate string|null 公開日 - ニュースの公開日時。フロントの表示順を制御 Fake観察文字長 25〜25; 観察値 '2026-01-01T00:00:00+09:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 pattern: ^$|\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-01-01T00:00:00+09:00
newsDescription string|null ニュース本文 - ニュース記事の本文。HTML入力可能でHTMLPurifierによる浄化あり Fake観察文字長 14〜14; 観察値 'EC-CUBE へようこそ。'。
minLength: 0 maxLength: 2000 example: EC-CUBE へようこそ。

📄PUT /admin/news/news response

NameTypeDescriptionMeta
newsUrl string|null 外部URL - 外部リンクURL。設定時はニュース本文の代わりにこのURLへ遷移
format: uri-reference minLength: 1 maxLength: 2048 example: /products
linkMethod boolean|null 新規ウィンドウで開く - 外部URLのリンク開き方(boolean)。false=同一ウィンドウ, true=新規ウィンドウ(target="_blank")。テンプレートでtarget属性の出力制御に使用 観察値 'false'。
example: false
newsId string|null ニュースID - dtb_news.id の不透明な文字列ハンドル。BeMart の NewsEntity 層は数値ではなく文字列として保持する。Fake 実装は `nw-` プレフィックス付きの英数字を生成し(シード `nw-welcome` を含む)、SQL 実装は dtb_news.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlNewsStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminNewsFetched / NewsUpdated / NewsDeleted) を踏むため、シードハンドル `nw-welcome` や `nonexistent` は Fake / SQL 双方で 404 が同形 Fake観察文字長 10〜10; 観察値 'nw-welcome'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: nw-welcome
newsTitle string|null ニュースタイトル - ニュース記事の見出し Fake観察文字長 4〜4; 観察値 'ようこそ'。
minLength: 0 maxLength: 32 example: ようこそ
publishDate string|null 公開日 - ニュースの公開日時。フロントの表示順を制御 Fake観察文字長 25〜25; 観察値 '2026-01-01T00:00:00+09:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 pattern: ^$|\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-01-01T00:00:00+09:00
newsDescription string|null ニュース本文 - ニュース記事の本文。HTML入力可能でHTMLPurifierによる浄化あり Fake観察文字長 14〜14; 観察値 'EC-CUBE へようこそ。'。
minLength: 0 maxLength: 2000 example: EC-CUBE へようこそ。

📄DELETE /admin/news/news response

NameTypeDescriptionMeta
newsId string|null ニュースID - dtb_news.id の不透明な文字列ハンドル。BeMart の NewsEntity 層は数値ではなく文字列として保持する。Fake 実装は `nw-` プレフィックス付きの英数字を生成し(シード `nw-welcome` を含む)、SQL 実装は dtb_news.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlNewsStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminNewsFetched / NewsUpdated / NewsDeleted) を踏むため、シードハンドル `nw-welcome` や `nonexistent` は Fake / SQL 双方で 404 が同形 Fake観察文字長 10〜10; 観察値 'nw-welcome'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: nw-welcome

📄GET /admin/news/news-list response

NameTypeDescriptionMeta
news array|null ニュース一覧 - /admin/news/news-list のレスポンスで扱うニュース一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
count int|null 件数 - /admin/news/news-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/news/news-list response

NameTypeDescriptionMeta
newsUrl string|null 外部URL - 外部リンクURL。設定時はニュース本文の代わりにこのURLへ遷移
format: uri-reference minLength: 1 maxLength: 2048 example: /products
linkMethod boolean|null 新規ウィンドウで開く - 外部URLのリンク開き方(boolean)。false=同一ウィンドウ, true=新規ウィンドウ(target="_blank")。テンプレートでtarget属性の出力制御に使用 観察値 'false'。
example: false
newsId string|null ニュースID - dtb_news.id の不透明な文字列ハンドル。BeMart の NewsEntity 層は数値ではなく文字列として保持する。Fake 実装は `nw-` プレフィックス付きの英数字を生成し(シード `nw-welcome` を含む)、SQL 実装は dtb_news.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlNewsStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminNewsFetched / NewsUpdated / NewsDeleted) を踏むため、シードハンドル `nw-welcome` や `nonexistent` は Fake / SQL 双方で 404 が同形 Fake観察文字長 10〜10; 観察値 'nw-welcome'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: nw-welcome
newsTitle string|null ニュースタイトル - ニュース記事の見出し Fake観察文字長 4〜4; 観察値 'ようこそ'。
minLength: 0 maxLength: 32 example: ようこそ
publishDate string|null 公開日 - ニュースの公開日時。フロントの表示順を制御 Fake観察文字長 25〜25; 観察値 '2026-01-01T00:00:00+09:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 pattern: ^$|\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-01-01T00:00:00+09:00
newsDescription string|null ニュース本文 - ニュース記事の本文。HTML入力可能でHTMLPurifierによる浄化あり Fake観察文字長 14〜14; 観察値 'EC-CUBE へようこそ。'。
minLength: 0 maxLength: 2000 example: EC-CUBE へようこそ。

📄POST /admin/order/bulk-delete response

NameTypeDescriptionMeta
requestedCount int|null 件数 - /admin/order/bulk-delete のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
orderNos array|null 注文番号一覧 - /admin/order/bulk-delete のレスポンスで扱う注文番号一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minItems: 0
changedCount int|null 件数 - /admin/order/bulk-delete のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647

📄POST /admin/order/create response

NameTypeDescriptionMeta
message string|null 注文メッセージ - /admin/order/create のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
paymentMethodId int|null 支払方法ID - 受注に紐づく支払方法マスタID。Fake/EC-CUBE境界ではDB採番値として扱う。
minimum: 0 maximum: 2147483647 example: 2
subtotal int|null 商品小計 - 商品合計金額(税込)。送料・手数料・値引き適用前の商品明細(orderItemType=1)のみの合計。PurchaseFlow.calculateSubTotal()で計算。送料無料条件の判定基準にも使用(お届け先ごとに判定) Fake観察数値 11000〜11000; 観察値 '11000'。
minimum: 0 maximum: 999999999 example: 11000
deliveryFeeTotal int|null 送料合計 - 全配送先の送料合計(スナップショット)。deliveryFeeAmount(地域別送料)+ deliveryFee(商品別送料)×数量 の合計。DeliveryFeePreprocessorで計算。カートと受注の両方で使用 Fake観察数値 0〜800; 観察値 '600', '0', '500', '800', '700'。
minimum: 0 maximum: 999999999 example: 600
charge int|null 手数料 - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
minimum: 0 maximum: 999999999 example: 0
discount int|null 値引き額 - 受注全体の値引き合計額。クーポン等による値引き Fake観察数値 0〜0; 観察値 '0'。
minimum: 0 maximum: 999999999 example: 0
tax int|null 税額 - 受注全体の税額合計(非推奨)。明細ごとの税額集計と差異が生じる場合があるため、正確な税額はOrderItem明細ごとのtaxを集計すべき Fake観察数値 1100〜1100; 観察値 '1100'。
minimum: 0 maximum: 999999999 example: 1100
total int|null 受注合計 - 受注合計金額。計算式: subtotal(商品税込合計) + deliveryFeeTotal(送料) + charge(手数料) - discount(値引き)。カートのtotalPriceとは別プロパティ Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700
paymentTotal int|null 支払合計 - 実際の支払金額。初期値はtotalと同値で、PointProcessorがポイント値引きのOrderItem(type=POINT_DISCOUNT、不課税)を追加後にPurchaseFlow.calculateTotal()で再計算される。計算式: total - (利用ポイント x pointConversionRate) Fake観察数値 12700〜12700; 観察値 '12700'。
minimum: 0 maximum: 999999999 example: 12700
addPoint int|null 付与ポイント - 注文により付与されるポイント数。商品単価(税抜) x pointRate x 数量で明細ごとに計算し合算。利用ポイント分を控除。発送済み(DELIVERED)遷移時に会員のpointに加算 Fake観察数値 0〜127; 観察値 '127', '0'。
minimum: 0 maximum: 2147483647 example: 127
itemCount int|null 明細件数 - /admin/order/create のレスポンスで返す明細件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 10000 example: 1
orderStatus int|null 受注ステータス - 1=新規受付, 3=注文取消, 4=対応中, 5=発送済み, 6=入金済み, 7=決済処理中, 8=購入処理中, 9=返品。Symfony Workflowステートマシンで遷移を制御。許可される遷移: pay(1->6), packing(1,6->4), cancel(1,4,6->3), back_to_in_progress(3->4), ship(1,6,4->5), return(5->9), cancel_return(9->5)。7と8はPurchaseFlow内で直接セットされステートマシン遷移の対象外 Fake観察数値 1〜1; 観察値 '1'。
minimum: 1 maximum: 9 example: 1
orderDate string|null 注文日 - 注文確定日時 Fake観察文字長 19〜19; 観察値 '2026-04-01 10:00:00'。
pattern: ^\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-04-01 10:00:00

📄GET /admin/order/edit response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
order array|null|object 注文詳細 - /admin/order/edit のレスポンスで扱う注文詳細。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0 $comment: 単一詳細画面では未選択/初期表示に空配列、取得済み状態にobjectが現れる。不透明な詳細構造は既知propertyを優先し、追加キーは互換境界として許容する。
items array|null 明細一覧 - /admin/order/edit の親オブジェクト `` に含まれる明細配列。商品・カート・受注明細の文脈で解釈する。
minItems: 0
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
csrfToken string|null CSRFトークン - 受注登録/編集フォーム送信用のCSRFトークン。Resource bodyからTwig hidden inputへ渡される。
minLength: 0 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]*$ $comment: CSRF値はRay.Csrf CsrfToken境界の責務。GET bodyではフォーム文脈を示すためにnullを許容する。

📄GET /admin/order/export-order response

NameTypeDescriptionMeta
rowCount int|null 行数 - /admin/order/export-order のレスポンスで返す行数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csv string|null 輸送ペイロード - CSVインポート/エクスポート本文。列構造の詳細はCSV互換サービス境界で検査する。
minLength: 0 maxLength: 5000000 $comment: CSV列の業務妥当性はCSV互換サービスで検査する。ここではJSON境界上の文字列サイズを契約する。

📄GET /admin/order/export-order-pdf response

NameTypeDescriptionMeta
message string|null CSVメッセージ - /admin/order/export-order-pdf のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
orderNos array 注文番号一覧 - /admin/order/export-order-pdf のレスポンスで扱う注文番号一覧。ALPS、Fake観察、Resource境界の形状から導いた業務契約。
minItems: 0
pdf string 輸送ペイロード - PDFバイナリをJSON検査可能なUTF-8文字列へ正規化した表現。内容自体のPDF構造は別境界の責務。
minLength: 0 maxLength: 5000000 $comment: PDFバイナリはResourceでUTF-8正規化してからJSON Schema検査する。PDF内部構造はOrderPdfCompatibility境界の責務。
size int|null ペイロードサイズ - /admin/order/export-order-pdf のレスポンスで運ぶペイロードサイズ。CSV/PDF/ログ等の内部形式は専用境界で扱い、JSON Schemaでは輸送上の型とサイズを契約する。
minimum: 0
fileName string ファイル名 - 商品画像のファイル名 Fake観察文字長 12〜15; 観察値 'Mail/order.twig', 'Mail/entry.twig', 'sample-a.jpg', 'sample-b.jpg'。
minLength: 1 maxLength: 255 example: Mail/order.twig

📄GET /admin/order/export-shipping response

NameTypeDescriptionMeta
rowCount int|null 行数 - /admin/order/export-shipping のレスポンスで返す行数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csv string|null 輸送ペイロード - CSVインポート/エクスポート本文。列構造の詳細はCSV互換サービス境界で検査する。
minLength: 0 maxLength: 5000000 $comment: CSV列の業務妥当性はCSV互換サービスで検査する。ここではJSON境界上の文字列サイズを契約する。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /admin/order/import-shipping response

NameTypeDescriptionMeta
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/order/import-shipping response

NameTypeDescriptionMeta
skipped int|boolean|null スキップ件数 - CSV取込で業務的に処理対象外となった行数。旧境界では真偽値も返るため互換的に許容する。
minimum: 0 $comment: CSV import response contextでは skipped はbooleanではなく件数を表す。旧Fake/Resource境界のboolean互換だけ残す。 example: 0
imported int|boolean|null 取込件数 - /admin/order/import-shipping の処理状態を示す取込件数。画面表示や冪等処理結果の分岐に使う真偽値。
minimum: 0
message string|null CSVメッセージ - /admin/order/import-shipping のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
accepted int|boolean|null 受理件数 - /admin/order/import-shipping の処理状態を示す受理件数。画面表示や冪等処理結果の分岐に使う真偽値。
minimum: 0
lineCount int|null CSV行数 - /admin/order/import-shipping のレスポンスで返すCSV行数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647

📄GET /admin/order/mail-confirm response

NameTypeDescriptionMeta
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /admin/order/order-pdf response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001

📄GET /admin/order/send-mail response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/order/send-mail response

NameTypeDescriptionMeta
mailBody string|null メール本文 - 送信済みメールのプレーンテキスト本文 Fake観察文字長 43〜43; 観察値 'この度はご注文いただきありがとうございます。\n商品の発送まで今しばらくお待ちください。'。
minLength: 0 maxLength: 128 example: この度はご注文いただきありがとうございます。 商品の発送まで今しばらくお待ちください。
message string|null 注文メッセージ - /admin/order/send-mail のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
sendDate string 送信日時 - メールの送信日時 Fake観察文字長 19〜19; 観察値 '2026-04-01 10:05:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 pattern: ^$|\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2026-04-01 10:05:00
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
mailSubject string|null メール件名 - メールの件名。テンプレート変数を含む場合あり Fake観察文字長 13〜13; 観察値 'ご注文ありがとうございます'。
minLength: 0 maxLength: 32 example: ご注文ありがとうございます
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001

📄GET /admin/order/shipping-address response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/order/shipping-address response

NameTypeDescriptionMeta
message string|null 注文メッセージ - /admin/order/shipping-address のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。

📄PUT /admin/order/shipping-address response

NameTypeDescriptionMeta
name01 string|null 姓 - 顧客・受注・配送先・お問い合わせで共通使用される姓 Fake観察文字長 2〜2; 観察値 '鈴木', '山田', '佐藤', '高橋', '退会'。
minLength: 0 maxLength: 80 example: 鈴木
addr02 string|null 番地・建物名 - 番地・ビル名・部屋番号等の詳細住所 Fake観察文字長 5〜8; 観察値 '神宮前1-1-1', '丸の内2-2-2', '梅田1-1-1', '1-2-3'; null 18/33。
minLength: 0 maxLength: 32 example: 神宮前1-1-1
postalCode string|null 郵便番号 - 日本の郵便番号。ハイフンなし7桁またはハイフン付き8桁 日本の郵便番号。入力フォームではハイフン有無をどちらも受け入れる。 Fake観察文字長 7〜8; 観察値 '1500001', '1000005', '5300001', '530-0001'; null 18/33。
pattern: ^\d{3}-?\d{4}$ example: 1500001
pref int|null 都道府県 - 日本の都道府県(1=北海道〜47=沖縄県)。住所の最上位区分として顧客・受注・配送先で使用。配送料の地域区分(DeliveryFee)や税率の地域設定(TaxRule)にも使用 都道府県ID。住所フォームの未選択状態では0、確定住所では1〜47を使う。 Fake観察数値 13〜27; 観察値 '13', '27'; null 3/9。
minimum: 0 maximum: 47 example: 13
addr01 string|null 市区町村 - 都道府県より下位の市区町村名 Fake観察文字長 3〜7; 観察値 '渋谷区', '千代田区', '大阪市北区', '大阪市北区梅田'; null 18/33。
minLength: 0 maxLength: 32 example: 渋谷区
phoneNumber string|null 電話番号 - 日本の電話番号形式(ハイフン区切り) 日本の電話番号。Fake corpusはハイフンなし中心だが、入力ではハイフン付きも許容する。 Fake観察文字長 10〜10; 観察値 '0312345678', '0901234567', '0612345678'; null 18/33。
pattern: ^0\d{1,4}-?\d{1,4}-?\d{3,4}$ minLength: 10 maxLength: 13 example: 0312345678
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
name02 string|null 名 - 顧客・受注・配送先・お問い合わせで共通使用される名 Fake観察文字長 1〜3; 観察値 'アリス', '太郎', '次郎', '花子', '三郎', '済'。
minLength: 0 maxLength: 80 example: アリス

📄GET /admin/order/shipping-notify-mail response.SubmitTo

NameTypeDescriptionMeta
method string 出荷通知メール送信は副作用を持つためPOSTのみ許可する。
href string POST先のBEAR Resource URI。HTMLではcanonical path /admin/order/shipping-notify-mail に対応する。
format: uri-reference example: page://self/admin/order/shipping-notify-mail

📄GET /admin/order/shipping-notify-mail response

NameTypeDescriptionMeta
orderNo string|null 出荷通知対象の注文番号 - 出荷通知メールを送信する対象注文の顧客向け注文番号。画面では確認表示とPOST hidden inputに使用する。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
customerId string|null 出荷通知対象の会員ID - 対象注文に紐づく会員ID。ゲスト購入または退会済み境界ではnullになり、画面ではゲスト購入として表示する。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001
message string 出荷通知メール確認メッセージ - 管理者に出荷通知メール送信の確認を促す画面メッセージ。注文時のお問い合わせ本文ではない。
minLength: 1 maxLength: 80 example: 出荷通知メールを送信します。よろしいですか?
csrfToken string 出荷通知メール送信フォームCSRFトークン - POST /admin/order/shipping-notify-mail のhidden inputで送るCSRFトークン。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
submitTo object 出荷通知メール送信リンク - 確認画面から出荷通知メール送信Resourceへ遷移するALPS unsafe遷移。
required: ["method","href"] additionalProperties:

📄POST /admin/order/shipping-notify-mail response

NameTypeDescriptionMeta
trackingNumber string|null 荷物追跡番号 - 配送業者の荷物追跡番号。confirmUrlと組み合わせて追跡URLを構成
minLength: 0 maxLength: 128 $comment: キー/追跡番号は照合用の不透明文字列で、数値演算対象ではない。
message string|null 注文メッセージ - /admin/order/shipping-notify-mail のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001
customerId string|null 会員ID - dtb_customer.id の不透明な文字列ハンドル。BeMart の Entity 層は数値ではなく文字列として保持する(マスアサインメント防止のため、Session/AuthZ 経由で読み出し、リクエスト本文からは受け取らない)。Favorite / Cart / Order の所有者キーとして横断使用 Fake観察文字長 12〜32; 観察値 'customer-001', '0123456789abcdef0123456789abcdef', 'customer-002', 'favorite-list-customer', 'favorite-html-customer', 'fedcba9876543210fedcba9876543210', 'aaaaaaaa00000000bbbbbbbb11111111', '10000000aaaa1111bbbb2222cccc3333'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: customer-001

📄PUT /admin/order/tracking-number response

NameTypeDescriptionMeta
status string Ajax処理ステータス - 管理画面の伝票番号更新Ajaxが成功判定に使用するステータス。
enum: ["OK"]
message string|null 注文メッセージ - /admin/order/tracking-number のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
trackingNumber string|null 荷物追跡番号 - 配送業者の荷物追跡番号。confirmUrlと組み合わせて追跡URLを構成
minLength: 0 maxLength: 128 $comment: キー/追跡番号は照合用の不透明文字列で、数値演算対象ではない。
orderNo string|null 注文番号 - 顧客向けの注文番号。フォーマットはカスタマイズ可能 Fake観察文字長 32〜32; 観察値 'past0000000000000000000000000001'。
minLength: 0 maxLength: 64 example: past0000000000000000000000000001

📄GET /admin/page/page response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
pageFileName string|null テンプレートファイル名 - ページのテンプレートファイル名 Fake観察文字長 3〜7; 観察値 'index', 'company', 'foo'。
minLength: 0 maxLength: 32 example: index
pageUrl string|null ページURL - ページのURLパス(Symfonyルート名。例: homepage, product_list) Fake観察文字長 3〜8; 観察値 'homepage', 'company', 'foo'。
format: uri-reference minLength: 1 maxLength: 2048 example: homepage
pageId string|null ページID - dtb_page.id の不透明な文字列ハンドル。BeMart の PageEntity 層は数値ではなく文字列として保持する。Fake 実装は `pg-` プレフィックス付きの英数字を生成し(シード `pg-homepage` を含む)、SQL 実装は dtb_page.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPageStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminPageFetched / PageUpdated / PageDeleted) を踏むため、シードハンドル `pg-homepage` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 6〜11; 観察値 'pg-homepage', 'pg-company', 'pg-foo'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: pg-homepage
pageName string|null ページ名 - 管理画面でのページ表示名 Fake観察文字長 3〜6; 観察値 'ホームページ', '会社案内', 'Foo'。
minLength: 0 maxLength: 32 example: ホームページ
csrfToken string|null 処理識別子 - フォーム送信の偽造を防ぐために送信元画面で発行されるトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
pageEditType int|null ページ編集区分 - ページ編集レベル。0=EDIT_TYPE_USER(ユーザー作成、完全編集/削除可), 1=EDIT_TYPE_PREVIEW(プレビュー), 2=EDIT_TYPE_DEFAULT(システムページ、構造ロック・削除不可), 3=EDIT_TYPE_DEFAULT_CONFIRM(内容編集可能なシステムページ、利用規約等)。editType>=2は削除不可 Fake観察数値 0〜2; 観察値 '0', '2'。
minimum: 0 example: 0

📄PUT /admin/page/page response

NameTypeDescriptionMeta
pageFileName string|null テンプレートファイル名 - ページのテンプレートファイル名 Fake観察文字長 3〜7; 観察値 'index', 'company', 'foo'。
minLength: 0 maxLength: 32 example: index
pageUrl string|null ページURL - ページのURLパス(Symfonyルート名。例: homepage, product_list) Fake観察文字長 3〜8; 観察値 'homepage', 'company', 'foo'。
format: uri-reference minLength: 1 maxLength: 2048 example: homepage
pageId string|null ページID - dtb_page.id の不透明な文字列ハンドル。BeMart の PageEntity 層は数値ではなく文字列として保持する。Fake 実装は `pg-` プレフィックス付きの英数字を生成し(シード `pg-homepage` を含む)、SQL 実装は dtb_page.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPageStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminPageFetched / PageUpdated / PageDeleted) を踏むため、シードハンドル `pg-homepage` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 6〜11; 観察値 'pg-homepage', 'pg-company', 'pg-foo'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: pg-homepage
pageName string|null ページ名 - 管理画面でのページ表示名 Fake観察文字長 3〜6; 観察値 'ホームページ', '会社案内', 'Foo'。
minLength: 0 maxLength: 32 example: ホームページ
pageEditType int|null ページ編集区分 - ページ編集レベル。0=EDIT_TYPE_USER(ユーザー作成、完全編集/削除可), 1=EDIT_TYPE_PREVIEW(プレビュー), 2=EDIT_TYPE_DEFAULT(システムページ、構造ロック・削除不可), 3=EDIT_TYPE_DEFAULT_CONFIRM(内容編集可能なシステムページ、利用規約等)。editType>=2は削除不可 Fake観察数値 0〜2; 観察値 '0', '2'。
minimum: 0 example: 0

📄DELETE /admin/page/page response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/page/page のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
pageId string|null ページID - dtb_page.id の不透明な文字列ハンドル。BeMart の PageEntity 層は数値ではなく文字列として保持する。Fake 実装は `pg-` プレフィックス付きの英数字を生成し(シード `pg-homepage` を含む)、SQL 実装は dtb_page.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPageStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminPageFetched / PageUpdated / PageDeleted) を踏むため、シードハンドル `pg-homepage` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 6〜11; 観察値 'pg-homepage', 'pg-company', 'pg-foo'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: pg-homepage

📄GET /admin/page/page-list response

NameTypeDescriptionMeta
count int|null 件数 - /admin/page/page-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
pages array|null ページ一覧 - /admin/page/page-list のレスポンスで扱うページ一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
csrfToken string|null CSRFトークン - 一覧画面から送信する作成・削除フォーム用のCSRFトークン。
minLength: 0 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]*$

📄POST /admin/page/page-list response

NameTypeDescriptionMeta
pageFileName string|null テンプレートファイル名 - ページのテンプレートファイル名 Fake観察文字長 3〜7; 観察値 'index', 'company', 'foo'。
minLength: 0 maxLength: 32 example: index
pageUrl string|null ページURL - ページのURLパス(Symfonyルート名。例: homepage, product_list) Fake観察文字長 3〜8; 観察値 'homepage', 'company', 'foo'。
format: uri-reference minLength: 1 maxLength: 2048 example: homepage
pageId string|null ページID - dtb_page.id の不透明な文字列ハンドル。BeMart の PageEntity 層は数値ではなく文字列として保持する。Fake 実装は `pg-` プレフィックス付きの英数字を生成し(シード `pg-homepage` を含む)、SQL 実装は dtb_page.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPageStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (AdminPageFetched / PageUpdated / PageDeleted) を踏むため、シードハンドル `pg-homepage` や `nonexistent-zzz` は Fake / SQL 双方で 404 が同形 Fake観察文字長 6〜11; 観察値 'pg-homepage', 'pg-company', 'pg-foo'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: pg-homepage
pageName string|null ページ名 - 管理画面でのページ表示名 Fake観察文字長 3〜6; 観察値 'ホームページ', '会社案内', 'Foo'。
minLength: 0 maxLength: 32 example: ホームページ
pageEditType int|null ページ編集区分 - ページ編集レベル。0=EDIT_TYPE_USER(ユーザー作成、完全編集/削除可), 1=EDIT_TYPE_PREVIEW(プレビュー), 2=EDIT_TYPE_DEFAULT(システムページ、構造ロック・削除不可), 3=EDIT_TYPE_DEFAULT_CONFIRM(内容編集可能なシステムページ、利用規約等)。editType>=2は削除不可 Fake観察数値 0〜2; 観察値 '0', '2'。
minimum: 0 example: 0

📄GET /admin/payment/payment response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
paymentId string|int|null 支払方法ID - dtb_payment.id の不透明な文字列ハンドル。BeMart の PaymentMethodAdminEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_payment.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPaymentMethodAdminStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (PaymentMethodAdminUpdated / PaymentMethodAdminDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜10; Fake観察数値 1〜9; 観察値 '2', 'pay-cod', 'pay-credit', '1', '9'。
minLength: 0 maxLength: 128 $comment: Fake文字列IDとEC-CUBE整数IDの両方が観察されるため、この境界だけmixedBoundaryIdとして扱う。 example: 2
payment array|null|object 支払方法詳細 - /admin/payment/payment のレスポンスで扱う支払方法詳細。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0 $comment: 単一詳細画面では未選択/初期表示に空配列、取得済み状態にobjectが現れる。不透明な詳細構造は既知propertyを優先し、追加キーは互換境界として許容する。
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄PUT /admin/payment/payment response

NameTypeDescriptionMeta
charge int|null 手数料 - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
minimum: 0 maximum: 999999999 example: 0
paymentMethodName string|null 支払方法名 - 支払方法の表示名 Fake観察文字長 4〜8; 観察値 '代金引換', 'クレジットカード', '検証失敗'。
minLength: 0 maxLength: 255 example: 代金引換
ruleMin int|null 下限金額 - /admin/payment/payment のフォーム文脈で使う下限金額。入力保持、初期値、再表示に必要な補助値。
minimum: 0 maximum: 2147483647
ruleMax int|null 上限金額 - /admin/payment/payment のフォーム文脈で使う上限金額。入力保持、初期値、再表示に必要な補助値。
minimum: 0 maximum: 2147483647
visible boolean|null 処理状態フラグ - 観察値 'true'。
example: true
paymentId string|int|null 支払方法ID - dtb_payment.id の不透明な文字列ハンドル。BeMart の PaymentMethodAdminEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_payment.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPaymentMethodAdminStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (PaymentMethodAdminUpdated / PaymentMethodAdminDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜10; Fake観察数値 1〜9; 観察値 '2', 'pay-cod', 'pay-credit', '1', '9'。
minLength: 0 maxLength: 128 $comment: Fake文字列IDとEC-CUBE整数IDの両方が観察されるため、この境界だけmixedBoundaryIdとして扱う。 example: 2

📄DELETE /admin/payment/payment response

NameTypeDescriptionMeta
paymentId string|int|null 支払方法ID - dtb_payment.id の不透明な文字列ハンドル。BeMart の PaymentMethodAdminEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_payment.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPaymentMethodAdminStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (PaymentMethodAdminUpdated / PaymentMethodAdminDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜10; Fake観察数値 1〜9; 観察値 '2', 'pay-cod', 'pay-credit', '1', '9'。
minLength: 0 maxLength: 128 $comment: Fake文字列IDとEC-CUBE整数IDの両方が観察されるため、この境界だけmixedBoundaryIdとして扱う。 example: 2

📄GET /admin/payment/payment-list response

NameTypeDescriptionMeta
payments array|null 支払方法一覧 - /admin/payment/payment-list のレスポンスで扱う支払方法一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
count int|null 件数 - /admin/payment/payment-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csrfToken string|null CSRFトークン - 一覧画面から送信する削除・表示切替フォーム用のCSRFトークン。
minLength: 0 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]*$

📄POST /admin/payment/payment-list response

NameTypeDescriptionMeta
charge int|null 手数料 - 受注の決済手数料。paymentCharge(支払方法マスタの手数料)のスナップショット。PaymentChargePreprocessorにより受注作成時にコピーされる Fake観察数値 0〜300; 観察値 '0', '300', '200'。
minimum: 0 maximum: 999999999 example: 0
paymentMethodName string|null 支払方法名 - 支払方法の表示名 Fake観察文字長 4〜8; 観察値 '代金引換', 'クレジットカード', '検証失敗'。
minLength: 0 maxLength: 255 example: 代金引換
ruleMin int|null 下限金額 - /admin/payment/payment-list のフォーム文脈で使う下限金額。入力保持、初期値、再表示に必要な補助値。
minimum: 0 maximum: 2147483647
ruleMax int|null 上限金額 - /admin/payment/payment-list のフォーム文脈で使う上限金額。入力保持、初期値、再表示に必要な補助値。
minimum: 0 maximum: 2147483647
visible boolean|null 処理状態フラグ - 観察値 'true'。
example: true
paymentId string|int|null 支払方法ID - dtb_payment.id の不透明な文字列ハンドル。BeMart の PaymentMethodAdminEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_payment.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlPaymentMethodAdminStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (PaymentMethodAdminUpdated / PaymentMethodAdminDeleted) を踏むため、シードハンドル `nonexistent-zzz` は Fake / SQL 双方で 404 が同形。categoryId / blockId / tagId と同じ Fake↔SQL 二重性 Fake観察文字長 7〜10; Fake観察数値 1〜9; 観察値 '2', 'pay-cod', 'pay-credit', '1', '9'。
minLength: 0 maxLength: 128 $comment: Fake文字列IDとEC-CUBE整数IDの両方が観察されるため、この境界だけmixedBoundaryIdとして扱う。 example: 2

📄GET /admin/product/csv-category response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csvTitle string|null CSVタイトル - /admin/product/csv-category の画面表示に使うCSVタイトル。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 0 maxLength: 255
skeletonRoute string|null スケルトンルート - /admin/product/csv-category の画面表示に使うスケルトンルート。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 0 maxLength: 255
columns array|null CSV列定義 - /admin/product/csv-category のCSV列設定。各要素は出力対象フィールドと表示名を表す。
minItems: 0
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /admin/product/csv-class-category response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csvTitle string|null CSVタイトル - /admin/product/csv-class-category の画面表示に使うCSVタイトル。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 0 maxLength: 255
skeletonRoute string|null スケルトンルート - /admin/product/csv-class-category の画面表示に使うスケルトンルート。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 0 maxLength: 255
columns array|null CSV列定義 - /admin/product/csv-class-category のCSV列設定。各要素は出力対象フィールドと表示名を表す。
minItems: 0
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/product/csv-class-category response

NameTypeDescriptionMeta
message string|null CSVメッセージ - /admin/product/csv-class-category のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
accepted int|boolean|null 受理件数 - /admin/product/csv-class-category の処理状態を示す受理件数。画面表示や冪等処理結果の分岐に使う真偽値。
minimum: 0
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /admin/product/csv-class-name response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csvTitle string|null CSVタイトル - /admin/product/csv-class-name の画面表示に使うCSVタイトル。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 0 maxLength: 255
skeletonRoute string|null スケルトンルート - /admin/product/csv-class-name の画面表示に使うスケルトンルート。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 0 maxLength: 255
columns array|null CSV列定義 - /admin/product/csv-class-name のCSV列設定。各要素は出力対象フィールドと表示名を表す。
minItems: 0
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/product/csv-class-name response

NameTypeDescriptionMeta
message string|null CSVメッセージ - /admin/product/csv-class-name のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
accepted int|boolean|null 受理件数 - /admin/product/csv-class-name の処理状態を示す受理件数。画面表示や冪等処理結果の分岐に使う真偽値。
minimum: 0
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /admin/product/csv-product response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csvTitle string|null CSVタイトル - /admin/product/csv-product の画面表示に使うCSVタイトル。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 0 maxLength: 255
skeletonRoute string|null スケルトンルート - /admin/product/csv-product の画面表示に使うスケルトンルート。業務エンティティそのものではなくテンプレート/一覧表示の補助値。
minLength: 0 maxLength: 255
columns array|null CSV列定義 - /admin/product/csv-product のCSV列設定。各要素は出力対象フィールドと表示名を表す。
minItems: 0
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /admin/product/edit response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
product array|null|object 商品詳細 - /admin/product/edit のレスポンスで扱う商品詳細。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0 $comment: 単一詳細画面では未選択/初期表示に空配列、取得済み状態にobjectが現れる。不透明な詳細構造は既知propertyを優先し、追加キーは互換境界として許容する。
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄GET /admin/product/product-class response

NameTypeDescriptionMeta
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
productCode string 商品コード - SKU/品番。在庫管理や受注明細での識別に使用 商品を識別するSKU。Fake corpusではASCII英数・ハイフン中心で、受注明細/カート明細の結合キーになる。 Fake観察文字長 10〜26。
minLength: 0 maxLength: 64 example: sample-001
classes array|null 商品規格一覧 - /admin/product/product-class のレスポンスで扱う商品規格一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0

📄POST /admin/product/product-class response

NameTypeDescriptionMeta
productClassId string 商品規格ID - 登録された dtb_product_class.id の不透明な文字列ハンドル。BeMart の RegisteredProductClassEntity 層は数値ではなく文字列として保持する。Fake 実装は採番フィクスチャ値を返し、SQL 実装は dtb_product_class.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。classCategoryId / deliveryId と同じ Fake↔SQL 二重性。
minLength: 1 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]+$ example: pc-fake-next
productCode string 商品コード - 登録した規格(SKU)の親商品を識別するSKU/品番。在庫・カート・受注明細の結合キー。
minLength: 0 maxLength: 64 example: sample-001

📄DELETE /admin/tag/tag response

NameTypeDescriptionMeta
tagId string|null タグID - dtb_tag.id の不透明な文字列ハンドル。BeMart の TagEntity 層は数値ではなく文字列として保持する。Fake 実装は `tg-` プレフィックス付きの英数字を生成し、SQL 実装は dtb_tag.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlTagStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (TagDeleted) を踏むため、シードハンドル `tg-new` / `tg-sale` は Fake 専用 Fake観察文字長 6〜7; 観察値 'tg-new', 'tg-sale'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: tg-new

📄GET /admin/tag/tag-list response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
count int|null 件数 - /admin/tag/tag-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
tags array|null タグ一覧 - /admin/tag/tag-list のレスポンスで扱うタグ一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
csrfToken string CSRFトークン - フォーム送信元を検証するトークン。Fake環境では deterministic な値を使う。
minLength: 8 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]+$ example: fake-csrf-token-bemart-2026

📄POST /admin/tag/tag-list response

NameTypeDescriptionMeta
tagId string|null タグID - dtb_tag.id の不透明な文字列ハンドル。BeMart の TagEntity 層は数値ではなく文字列として保持する。Fake 実装は `tg-` プレフィックス付きの英数字を生成し、SQL 実装は dtb_tag.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlTagStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (TagDeleted) を踏むため、シードハンドル `tg-new` / `tg-sale` は Fake 専用 Fake観察文字長 6〜7; 観察値 'tg-new', 'tg-sale'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: tg-new
tagName string|null タグ名 - 商品に付与するタグの表示名 Fake観察文字長 3〜3; 観察値 '新商品', 'セール'。
minLength: 0 maxLength: 32 example: 新商品

📄DELETE /admin/tax-rule/tax-rule response

NameTypeDescriptionMeta
taxRuleId string|null 税率ルールID - dtb_tax_rule.id の不透明な文字列ハンドル。BeMart の TaxRuleEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_tax_rule.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlTaxRuleStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (TaxRuleDeleted) を踏むため、シードハンドル(`nonexistent-zzz` 等)は Fake / SQL 双方で 404 が同形 Fake観察文字長 5〜6; 観察値 'tax-10', 'tax-8'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: tax-10

📄GET /admin/tax-rule/tax-rule-list response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
taxRules array|null 税ルール一覧 - /admin/tax-rule/tax-rule-list のレスポンスで扱う税ルール一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
count int|null 件数 - /admin/tax-rule/tax-rule-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
csrfToken string|null CSRFトークン - 一覧画面から送信する作成・削除フォーム用のCSRFトークン。
minLength: 0 maxLength: 160 pattern: ^[A-Za-z0-9_.:-]*$

📄POST /admin/tax-rule/tax-rule-list response

NameTypeDescriptionMeta
roundingType int|null 端数処理 - 1=四捨五入, 2=切り捨て, 3=切り上げ。受注明細の税額計算時の端数処理方式。TaxRuleで設定 Fake観察数値 1〜1; 観察値 '1'。
minimum: 1 maximum: 99 example: 1
taxRate number|null 税率 - 税ルールに適用する税率。8.0や10.0のような小数表現を含む百分率。
minimum: 0 maximum: 100 example: 10
taxRuleId string|null 税率ルールID - dtb_tax_rule.id の不透明な文字列ハンドル。BeMart の TaxRuleEntity 層は数値ではなく文字列として保持する。Fake 実装は 32桁hex を生成し、SQL 実装は dtb_tax_rule.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。非数値 ID は SqlTaxRuleStorage では miss として扱われ getById / put / remove のいずれも 404 経路 (TaxRuleDeleted) を踏むため、シードハンドル(`nonexistent-zzz` 等)は Fake / SQL 双方で 404 が同形 Fake観察文字長 5〜6; 観察値 'tax-10', 'tax-8'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: tax-10
applyDate string 適用日 - この税率ルールが有効になる日時。適用日以降の注文にこの税率が適用される。複数の税率ルールがある場合、注文日時点で最も新しい適用日のルールが使用される。過去の受注には影響しない Fake観察文字長 25〜25; 観察値 '2024-04-01T00:00:00+09:00', '2023-10-01T00:00:00+09:00'。
$comment: 未入金・未発送・未公開など未確定日時はEC-CUBE境界で空文字として現れるため、日付/日時文字列に加えて空文字を許容する。 pattern: ^$|\d{4}-\d{2}-\d{2}([ T]\d{2}:\d{2}:\d{2}([+-]\d{2}:?\d{2}|Z)?)?$ example: 2024-04-01T00:00:00+09:00

📄GET /admin/template/template-add response

NameTypeDescriptionMeta
form object|array|null 入力フォーム - Aura/WebForm由来のフォームオブジェクト。フレームワーク内部構造のためschemaでは存在と型のみを契約する。
$comment: Aura/WebForm由来の不透明フォーム表現。Resource境界ではフォームの存在とコンテキストだけを契約し、内部構造はフレームワーク境界に委ねるため追加キー制約を置かない。
csrfToken string

📄POST /admin/template/template-add response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/template/template-add のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
templateId string|null テンプレートID - dtb_template.id の不透明な文字列ハンドル。BeMart の TemplateEntity 層は数値ではなく文字列として保持する。Fake 実装は `tp-` プレフィックス付きのシードハンドル(tp-default-pc / tp-default-sp)を持ち、SQL 実装は dtb_template.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。Template には list アフォーダンスのみ(goTemplateList)で作成・更新・削除が無いため ID ジェネレータは存在せず、テンプレートはインストーラ/fixture が seed した行から読み出すのみ。layoutId / blockId / categoryId と同じ Fake↔SQL 二重性。templateCode(一意の install-time コード)とは別物 — TemplateEntity の投影は id ハンドルを用い templateCode は投影外 Fake観察文字長 13〜13; 観察値 'tp-default-pc', 'tp-default-sp'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: tp-default-pc
archiveName string|null テンプレートアーカイブ名 - アップロードされたテンプレートzipのファイル名。
minLength: 0 maxLength: 255
archiveSize int|null テンプレートアーカイブサイズ - アップロードされたテンプレートzipのバイトサイズ。
minimum: 0 maximum: 10485760
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem

📄GET /admin/template/template-list response

NameTypeDescriptionMeta
count int|null 件数 - /admin/template/template-list のレスポンスで返す件数。一覧・集計・処理結果の規模を表す非負整数。
minimum: 0 maximum: 2147483647
templates array|null テンプレート一覧 - /admin/template/template-list のレスポンスで扱うテンプレート一覧。配列要素はALPS意味とFake観察に基づき、固定できない動的列は例外理由を台帳化する。
minItems: 0
csrfToken string

📄PUT /admin/template/template-list response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/template/template-list のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
templateId string|null テンプレートID - dtb_template.id の不透明な文字列ハンドル。BeMart の TemplateEntity 層は数値ではなく文字列として保持する。Fake 実装は `tp-` プレフィックス付きのシードハンドル(tp-default-pc / tp-default-sp)を持ち、SQL 実装は dtb_template.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。Template には list アフォーダンスのみ(goTemplateList)で作成・更新・削除が無いため ID ジェネレータは存在せず、テンプレートはインストーラ/fixture が seed した行から読み出すのみ。layoutId / blockId / categoryId と同じ Fake↔SQL 二重性。templateCode(一意の install-time コード)とは別物 — TemplateEntity の投影は id ハンドルを用い templateCode は投影外 Fake観察文字長 13〜13; 観察値 'tp-default-pc', 'tp-default-sp'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: tp-default-pc

📄DELETE /admin/template/template-list response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/template/template-list のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
transitionId string ALPS遷移ID - このレスポンス/操作が対応するALPS遷移ID。クライアントの状態遷移追跡に使う。
minLength: 2 maxLength: 96 pattern: ^(go|do)[A-Z][A-Za-z0-9]*$ example: doAddCartItem
templateId string|null テンプレートID - dtb_template.id の不透明な文字列ハンドル。BeMart の TemplateEntity 層は数値ではなく文字列として保持する。Fake 実装は `tp-` プレフィックス付きのシードハンドル(tp-default-pc / tp-default-sp)を持ち、SQL 実装は dtb_template.id (int unsigned AUTO_INCREMENT) を文字列化して使用(同インターフェイス・異 ID 形状)。Template には list アフォーダンスのみ(goTemplateList)で作成・更新・削除が無いため ID ジェネレータは存在せず、テンプレートはインストーラ/fixture が seed した行から読み出すのみ。layoutId / blockId / categoryId と同じ Fake↔SQL 二重性。templateCode(一意の install-time コード)とは別物 — TemplateEntity の投影は id ハンドルを用い templateCode は投影外 Fake観察文字長 13〜13; 観察値 'tp-default-pc', 'tp-default-sp'。
minLength: 0 maxLength: 128 pattern: ^[A-Za-z0-9._:@/-]*$ $comment: BeMart/Fake境界で観察される不透明な文字列ID。DB採番値としての数値演算には使わない。 example: tp-default-pc

📄POST /admin/template/template-list response

NameTypeDescriptionMeta
message string|null 処理メッセージ - /admin/template/template-list のレスポンスに含まれる処理結果メッセージ。注文時お問い合わせ欄ではなく、画面遷移や完了表示のための通知文。
minLength: 0 maxLength: 32 example: 配送は平日希望です。
value string 表示値 - /admin/template/template-list のレスポンスで表示または選択肢として使う値。親コンテキスト `` に属する。
minLength: 1 maxLength: 255

Links