認証されたショップの基本情報(ショップ名・URL・ショップ運営者の登録情報・税設定など)を取得します。引数は不要です。他ツール呼び出しの前にショップの設定や運営者情報といった前提を一度押さえておく用途、またはエージェントが接続先ショップを確認したい時に使います。

受注データを一覧取得します。パラメータ未指定で直近 1 週間分、期間指定は受注日または更新日のいずれかで可能。購入者(顧客 ID・氏名・メール)による絞り込み、入金/配送/キャンセル状態での絞り込み、各種メール送信状態による絞り込みが可能(具体的なパラメータと指定方法はスキーマを参照)。limit(最大 100、デフォルト 10)/ offset でページング、fields でレスポンスキー絞り込み。特定受注は getSale、売上集計は statSale、更新系は updateSale / cancelSale / sendSalesMail。

基準日を起点に 3 つの売上集計 — 当日 / 基準日を含む直近 7 日間 / 基準日の属する月全体 — をまとめて返します。make_date(YYYY-MM-DD、省略時は現在時刻)で基準日を指定するため、過去の任意の日付やその月の集計も取得できます。任意の日数範囲や商品別内訳の集計には対応していないため、それらが必要な場合は getSales で受注一覧を取得して集計してください。今月の進捗確認、昨日の実績、特定月の売上把握などに使います。

指定した受注IDの受注詳細を 1 件取得します。sale_id(受注作成時に採番される整数 ID)を渡すと、商品明細・配送先・決済状況・キャンセル状況・送料・クーポン適用を含む受注オブジェクトが返ります。特定受注の中身を個別に確認する用途で、複数受注の条件検索は getSales、期間集計は statSale、受注への書き込みは updateSale / cancelSale / sendSalesMail を使ってください。

受注確定後の配送先訂正・メモ追記・処理状態遷移・手数料調整などに使います。sale_id で対象を特定、sale に渡したフィールドだけが置き換わります。決済が Amazon Pay / LINE Pay / 楽天ペイ(オンライン決済)の場合、熨斗・メッセージカード・ラッピング手数料の更新で決済金額が自動的に請求または返金されます(LINE Pay は減額のみ可)。受注のキャンセルは cancelSale、詳細は getSale、メール送信は sendSalesMail。

既存受注をキャンセルし、返品・返金処理を連鎖させます。sale_id で対象を特定、restock(boolean)で在庫の自動戻し入れの要否を指定。キャンセルにより商品購入数・合計金額が 0 になり canceled フラグが true に変わります。使用ポイント(ショップポイント・GMO ポイント)および対応決済(Amazon Pay / LINE Pay / 楽天ペイ / PayPay)の決済金額は自動的にキャンセル・返金されます。販売手数料確定前の受注では販売手数料も 0 になります。分割された受注のキャンセルおよび、クレジット(イプシロン)決済でキャンセル連動設定を利用したキャンセルはサポート対象外です。この操作は不可逆で、元の受注状態に戻す API はありません。受注の更新は updateSale、詳細は getSale。

指定受注に対して受注メール・入金確認メール・商品発送メールなどの通知メールを送信します。sale_id で対象受注を特定し、mail オブジェクトで送信種別やオプションを指定してください。送信後は該当種別のメール送信状態(accepted_mail_state / paid_mail_state / delivered_mail_state)が sent に更新されます。分割された受注の場合、受注メール・入金確認メールは親受注にのみ送信可能で、子受注には送れません。受注の一覧は getSales、詳細は getSale を使用。

未入金の受注に対して顧客が決済を完了するための URL を発行します。sale_id で対象受注を特定し、発行された URL を顧客に案内することで再決済フローを提供できます。URL の有効期限は発行時刻から 72 時間(3 日間)で、期限切れ後は再度 createPaymentUrls で発行し直してください。発行できないケース: 入金済みの受注、キャンセル済みの受注、本機能に対応していない決済方法の受注。受注の詳細確認は getSale、受注一覧は getSales、受注への通知メール送信は sendSalesMail を使用。

顧客を一覧取得します。会員顧客とゲスト購入由来の非会員顧客の両方が対象で、member=true で会員のみ、member=false で非会員のみに絞り込めます。氏名・メール・電話番号・郵便番号などでの部分一致検索、顧客 ID 指定、性別・メールマガジン購読状況などの属性絞り込み、登録日・更新日による期間絞り込みが可能(具体的なパラメータと指定方法はスキーマを参照)。limit(最大 100、デフォルト 10)/ offset でページング。特定顧客 1 件は getCustomer、新規登録は postCustomers、情報更新は updateCustomers を参照。

新規顧客をショップに登録し、作成された顧客オブジェクト(id を含む)を返します。customer に name(顧客名)・mail(メールアドレス)・pref_id(都道府県 ID 1–48)・postal(郵便番号)・address1(市区町村・番地)・tel(電話番号)・birthday(生年月日)などを指定します。会員として登録するには add_member: true、省略または false で非会員として登録。登録済み顧客の情報更新は updateCustomers、取得は getCustomer、条件検索は getCustomers を使用。

指定した顧客IDの顧客 1 件を取得します。会員・非会員(ゲスト購入のみ)を問わず、customer_id で一意に識別された顧客の氏名・連絡先・住所・ポイント残高・所属会員ランクなどを含む顧客オブジェクトを返します。一覧から特定顧客の詳細を個別に確認する時に使用。条件付きの一覧検索は getCustomers、ポイント操作は postCustomerPoints、会員ランク変更は updateCustomerMembership、会員・非会員のフラグで絞り込みたい場合は getCustomers の member パラメータを使ってください。

既存顧客(会員・非会員問わず)の属性(氏名・連絡先・住所・性別・生年月日・メルマガ受信設定など)に差分パッチを適用します。customer_id で対象を特定し、customer に含めたキーだけが置き換わります(省略したキーは変更されない)。会員ランクの変更は updateCustomerMembership、ポイント残高の増減は postCustomerPoints、現在値の確認は getCustomer、条件検索は getCustomers を参照。

指定した顧客のショップポイント残高を加算または減算します。customer_id で対象顧客、points に加算する整数を指定してください(マイナス値で減算可)。残高は加算分が現在値に足され、結果が新しい残高として返ります。顧客情報本体の取得は getCustomer、情報更新は updateCustomers、会員ランクの変更は updateCustomerMembership。

指定した会員顧客の所属する会員ランクを更新します。customer_id で対象会員、membership.membership_id で新しいランクの ID を指定してください。本機能は「カラーミーショップ アプリストア」で提供されている「会員ランク」アプリを利用しているショップでのみリクエスト可能で、未導入ショップではエラーになります。会員ランクの紐付きを解除してランクなしに戻す場合は deleteCustomerGroupMembership、顧客情報本体の取得は getCustomer、顧客情報の更新は updateCustomers を使用。

指定した会員顧客と所属会員ランクとの紐付きを解除します(ランクなしの状態に戻す)。customer_id で対象会員を指定すると、現在所属している会員ランクから外れ、ランクなしの通常会員に戻ります。本機能は「カラーミーショップ アプリストア」で提供されている「会員ランク」アプリを利用しているショップでのみリクエスト可能で、未導入ショップではエラーになります。別のランクに変更する場合は updateCustomerMembership、顧客本体の取得は getCustomer、他の顧客情報の更新は updateCustomers を使用。

商品を一覧取得します。商品名・型番・ID・カテゴリ・グループによる検索、掲載状態・登録日/更新日・価格帯・在庫状況による絞り込み、並び替えが可能(具体的なパラメータと指定方法はスキーマを参照)。limit(最大 50、デフォルト 10)/ offset でページング、fields でレスポンスキー絞り込み。特定商品は getProduct、在庫のみは getStocks、新規は postProducts、編集は updateProduct。

新規商品をショップに登録し、作成された商品オブジェクト(id を含む)を返します。product に商品名 name・価格(price=定価 / sales_price=販売価格)・大カテゴリー category_id_big・掲載設定 display_state などを指定します。一覧取得は getProducts、編集は updateProduct を使用。

指定した商品IDの商品詳細を 1 件取得します。product_id を渡すと、商品名・価格(price/sales_price)・在庫数・掲載設定・画像 URL・カテゴリ・商品グループ所属・オプション(バリエーション)構造などを含む商品オブジェクトを返します。特定商品の詳細確認や updateProduct 前の現在値参照に使用。条件付き一覧検索は getProducts、在庫情報だけなら getStocks、オプション詳細は getProductVariants、画像一覧は getProductImages を使用。

product_id で指定した商品の属性を差分更新します。product に渡したフィールドのみが置き換わり、省略したキーは現状維持。在庫数 stocks(整数、または increment フィールドで増減指定可能、負値可)。商品のカテゴリ所属を変えるには product.category_id_big / category_id_small を指定。新規作成は postProducts、カテゴリ自体の名称・SEO 等の編集は updateProductCategory、グループ自体の設定変更は updateProductGroup を使用。

指定商品の商品オプション(サイズ・カラーごとの SKU 等のバリエーション)一覧を取得します。product_id で対象商品を指定し、各オプションの型番・在庫数・価格などを含む variant オブジェクトの配列を返します。model_number で型番の部分一致検索、limit(最大 100、デフォルト 10)/ offset でページング、fields でレスポンスのキーを絞り込み可能。バリエーションを持たない商品の場合は空配列が返ります。オプション別在庫の更新は updateProduct の product.variants を使用。

指定商品にピックアップ設定を新規登録します。product_id で対象商品、pickup_type で種別(0=おすすめ商品 / 1=売れ筋商品 / 3=新着商品 / 4=イチオシ商品)、order_num で同一 pickup_type 内での表示順(0 以上の整数)を指定します。ピックアップ枠はショップ全体で上記 4 種類しかなく、それぞれ独立した並び順を持ちます。公開ストアのピックアップ枠に商品を新規追加したい時に使用。登録済みピックアップの種別や並び順変更は putProductPickup、枠からの除外は deleteProductPickup。

指定商品の既存ピックアップ設定の表示順 (order_num) を変更します。product_id と pickup_type で対象ピックアップを識別し(pickup_type は postProductPickup と同じ 4 種の enum: 0 / 1 / 3 / 4 から指定)、order_num に新しい表示順(0 以上の整数)を渡します。pickup_type は識別キーであり本ツールでは変更できません。新規登録は postProductPickup、削除は deleteProductPickup。

指定商品を特定のピックアップ枠から外します。product_id と pickup_type(postProductPickup と同じ 4 種の enum)で対象を特定すると、その種別のピックアップ一覧から該当商品が取り除かれます。商品自体は削除されず、ピックアップ枠への登録のみが解除されます。新規登録は postProductPickup、種別・並び順の変更は putProductPickup。

指定商品に登録されている全画像情報を取得します。product_id で対象商品を指定すると、ポジション 0〜49(最大 50 枚)の position と画像 URL を含む画像オブジェクトの配列が返ります。画像のみを参照したい時に使い、商品本体の取得は getProduct。

商品毎の広告・ショッピングフィード向けの付加属性(Google 商品カテゴリ・GTIN・MPN・ブランド・色・サイズ・性別・商品状態など)の一覧を取得します。product_ids(カンマ区切り)で特定商品のみ、display_state で掲載設定で絞り込み、limit(最大 250、デフォルト 50)/ offset でページング可能。商品本体の詳細は getProduct を参照。

ショップの商品レビュー一覧を取得します。limit(最大 100、デフォルト 10)/ offset でページング。各レビューには投稿者ニックネーム・対象 product_id・star(評価値)・title・comment・status(承認状態: pending / approved / rejected)・posted_at などが含まれます。削除済み以外は承認状態を問わず返ります。商品本体の詳細は getProduct を参照。

在庫管理が有効な商品の在庫情報を一覧取得します。条件なしで呼ぶと該当商品の在庫を返し、商品名・型番・商品 ID・カテゴリ・掲載設定で絞り込み可能。stocks パラメータで指定数以下の在庫のもののみ抽出することもできます(他の絞り込みパラメータの詳細はスキーマを参照)。limit(最大 50、デフォルト 10)/ offset でページング。個別商品の在庫更新は updateProduct の product.stocks、オプション別在庫の確認は getProductVariants。

ショップに登録されている商品グループ(関連商品をまとめて表示する集合、例: 「セール対象」「新作コレクション」)の一覧を取得します。パラメータ不要で、全グループが返されます。各エントリには id・name・display_state(表示状態)・parent_group_id(親グループ ID、ある場合)・meta_tag(SEO 用)・image_url・sort などが含まれます。特定グループ 1 件の取得は getProductGroup、新規作成は createProductGroup、編集は updateProductGroup、商品の階層カテゴリ(大/小分類)は getProductCategories を使用。

新しい商品グループ(関連商品をまとめて表示する集合、例: 「セール対象」「新作コレクション」)を作成し、作成されたグループオブジェクト(id を含む)を返します。group の name と display_state が必須、parent_group_id(親グループ配下に入れる場合)・meta_tag(SEO 用メタタグ)・expl(説明文)は任意。本ツールはグループ自体の作成のみを扱い、商品の所属づけは各商品に対して updateProduct の product.group_ids で行ってください。既存グループの編集は updateProductGroup、階層カテゴリ(大/小分類)は createProductCategory を使用。

指定した商品グループIDの詳細を 1 件取得します。group_id を渡すと、name・display_state(表示状態)・parent_group_id(親グループ階層)・meta_tag(SEO 用)・expl(説明文)・image_url・sort などを含むグループオブジェクトを返します(所属商品の一覧は含まれません)。グループ一覧は getProductGroups、新規作成は createProductGroup、編集は updateProductGroup を使用。所属商品を確認するには getProducts の group_ids 絞り込みを、商品のグループへの紐づけは updateProduct の product.group_ids を使用してください。

商品グループの設定(name・display_state・meta_tag・expl)を部分書き換えします。group_id で対象を特定、group に渡したキーだけが更新対象。本ツールはグループ自体の属性のみを扱い、所属商品の追加・除外は含まれません。商品の所属は商品側で updateProduct の product.group_ids を使って変更してください。新規作成は createProductGroup、現在値は getProductGroup を参照。

ショップに登録されている商品カテゴリー(大カテゴリーと小カテゴリーの 2 階層構造)の一覧を取得します。パラメータ不要で、大カテゴリーのオブジェクトを配列で返し、配下の小カテゴリーは各エントリの children 配列に格納されます。各エントリには id_big / id_small・name・sort(表示順)・display_state・meta_tag(SEO 用)・image_url などが含まれます。新規の大カテゴリー作成は createProductCategory、小カテゴリー作成は createProductCategoryChild、編集はそれぞれ updateProductCategory / updateProductCategoryChild、商品グループ(別概念、集合的なタグ的な集合)の参照は getProductGroups を使用。

新しい大カテゴリーを商品カテゴリー階層のトップレベルに作成します。category.name(必須、カテゴリー名)、sort(表示順、0 以上の整数)、meta_tag(SEO 用の title / keywords / description、HTML タグは不可)などを指定します。作成された大カテゴリー配下に小カテゴリーを作るには createProductCategoryChild、既存大カテゴリーの編集は updateProductCategory、一覧は getProductCategories を使用。商品グループ(別概念、集合的なタグ的な集合)の作成は createProductGroup を使用。

大カテゴリーを部分変更し、更新後のカテゴリーを返します。id で対象を特定し、category に含めたキーのみが上書きされます。メタタグ(title / keywords / description)に HTML タグは含められません。sort(表示順)は 0 以上の整数。配下の小カテゴリーの更新は updateProductCategoryChild、新規作成は createProductCategory、一覧は getProductCategories を参照。

指定した大カテゴリー配下に新規の小カテゴリーを作成します。category_id で親大カテゴリーを指定し、category.name(必須)・sort(表示順、0 以上の整数)・meta_tag(title / keywords / description に HTML タグ不可)を渡します。小カテゴリーは 2 階層目のため、その配下に更に子カテゴリーを作ることはできません。既存小カテゴリーの編集は updateProductCategoryChild、大カテゴリーの新規作成は createProductCategory、一覧は getProductCategories を使用。

小カテゴリー(大カテゴリー配下の 2 階層目)の name / sort / display_state / meta_tag などを差分変更します。category_id で親大カテゴリー、id で対象小カテゴリーを特定し、category に更新したいキーだけ渡します。メタタグ(title / keywords / description)に HTML タグは含められません。新規作成は createProductCategoryChild、大カテゴリーの更新は updateProductCategory、一覧は getProductCategories を参照。

ショップで有効な決済設定の一覧を取得します。クエリ不要で、有効な決済方法の ID・名称・手数料ルール・対応条件が返ります。カートで顧客に決済方法を提示する前の参照や、受注データの payment_id と突合する際に使います。

ショップで有効な配送方法の一覧を取得します。引数不要で、登録済み配送方法の ID・名称・料金計算ルール・対応エリアが返ります。受注作成前の配送方法選択肢の提示、または受注データの delivery_id と突合する際の参照に使います。配送希望日時の設定は getDeliveryDateSetting を参照。

ショップの配送希望日時に関する設定(希望日の受付可否、指定可能な日数範囲、受付時間帯、リードタイム等)を取得します。本設定は配送方法ごとではなくショップ全体で共通です。引数不要で、現在値が返ります。受注時のカートで配送日時を選択肢として提示する前の参照や、受注データの delivery_date と突合する時に使います。配送方法そのものの一覧は getDeliveries を参照。

ショップ全体のギフト設定(ラッピング・のし・メッセージカードなどのギフトオプションの有無・料金・名入れ可否・表示設定など)を取得します。引数不要で、現在値が返ります。受注時にギフト適用可能かの判定や、カートでギフト料金を加算する前の参照に使います。

ショップに登録されているクーポンの一覧を取得します。クエリパラメータは不要で、削除されていない全クーポン(顧客がチェックアウト時にコード入力して使う値引き)が返されます。各エントリには id・name・code・coupon_type(amount=定額円引き / rate=定率% / delivery_charge=送料無料)・discount_amount・starts_at・ends_at・status・total_usage_limit・usage_limit などが含まれます。特定クーポン 1 件の取得は getCoupon、新規作成は createCoupon、変更は updateCoupon、削除は deleteCoupon を使用。

新規ショップクーポン(チェックアウト時に顧客がコード入力する値引き)を作成し、id を含むクーポンオブジェクトを返します。shop_coupon 必須項目: code・coupon_type(amount=定額円引き / rate=定率% / delivery_charge=送料無料)・starts_at・ends_at。discount_amount の単位は coupon_type が amount なら円、rate なら %(1〜100 の範囲)。delivery_charge の場合は discount_amount を指定する必要はありません。任意項目: minimum_amount(最低購入金額)、対象商品の絞り込み(group_limit_type / group_ids)、利用回数制限(total_usage_limit 等)。変更は updateCoupon、削除は deleteCoupon、参照は getCoupons / getCoupon。

指定したクーポンIDのショップクーポン 1 件を取得します。coupon_id を渡すと、code(クーポンコード)・coupon_type(amount/rate/delivery_charge)・discount_amount(単位は coupon_type が amount なら円、rate なら %)・starts_at・ends_at・minimum_amount(最低購入金額)・利用回数制限などを含むクーポンオブジェクトを返します。発行済みクーポンの詳細確認や updateCoupon 前の現在値チェックに使用。一覧は getCoupons、変更は updateCoupon、削除は deleteCoupon、新規作成は createCoupon を使用。

指定したクーポンIDのショップクーポンを削除します。coupon_id で対象を特定すると該当クーポンが削除され、以降は顧客が code を入力しても使用できなくなります。削除の取り消し API はありません。一時的に使えなくしたいだけなら updateCoupon で status を変更してください。現在値の確認は getCoupon、新規作成は createCoupon、一覧は getCoupons を参照。

既存クーポンの設定を差分マージします。shop_coupon に含めたキーのみ更新され、省略したキーはそのまま。coupon_id で対象を特定。discount_amount の単位は coupon_type によって円(amount)または %(rate、1〜100 範囲)に変わるため、coupon_type を変更する時は discount_amount もセットで見直してください(delivery_charge では discount_amount は不要)。新規作成は createCoupon、削除は deleteCoupon、現在値は getCoupon を参照。

ショップに保存されているテンプレート(ショップページの HTML/CSS デザイン、使用中・未使用を問わない)の一覧を取得します。クエリ不要、全テンプレートの id・name・state・make_date・update_date が返ります。特定テンプレートのページ HTML/CSS 取得は getTemplatePage、ブラウザでプレビューするには getTemplatePreview で URL 発行、ページ更新は updateTemplatePage。

指定したテンプレートをブラウザで確認するための一時プレビュー URL を発行して返します。template_id で対象テンプレートを指定すると、そのテンプレートで現在のショップを表示する URL が返されます。URL の有効期限は発行時刻から 1 時間で、期限切れ後は再度 getTemplatePreview で発行し直してください。編集前の見た目確認や、updateTemplatePage 反映後の表示チェックに使用。テンプレートのページソース(HTML/CSS)取得は getTemplatePage、編集反映は updateTemplatePage、テンプレート一覧は getTemplates を使用。

指定したテンプレートの指定ページ種別の HTML と CSS ソースを取得します。template_id でテンプレートを指定、page_type で以下のいずれかを指定: index(共通) / top(トップ) / product_list(商品一覧) / product(商品詳細) / product_srh(商品検索結果) / option_stock(オプション在庫・値段表) / shopkeeper(特定商取引) / privacy(プライバシーポリシー)。該当ページの現在のテンプレートソースコードが返ります。編集前の現在値確認やバックアップに使用。編集反映は updateTemplatePage、ブラウザでプレビューは getTemplatePreview で URL 発行、テンプレート一覧は getTemplates。

指定テンプレートの指定ページ種別の HTML / CSS ソースを更新します。template_id でテンプレートを特定、page_type は getTemplatePage と同じ 8 種の enum(index / top / product / product_list / product_srh / option_stock / shopkeeper / privacy)から指定、template_page に新しい HTML / CSS の本文を渡します。更新時にテンプレートの変更履歴が自動記録され、親テンプレートの update_date も更新されます。更新前の現在値は getTemplatePage、ブラウザ表示は getTemplatePreview、テンプレート一覧は getTemplates を参照。