Color Me Shop MCP Server

Official49 toolsLive

by pepabo · JavaScript

Official remote MCP server for Color Me Shop.

io.github.pepabo/colormeshop-mcp (Color Me Shop MCP Server)

The io.github.pepabo/colormeshop-mcp server is the official remote Model Context Protocol (MCP) endpoint for Color Me Shop, a Japanese e-commerce platform operated by GMO Pepabo, Inc. It supports accessing shop operations via AI via an MCP-compatible interface.

🛠️ Key Features

Official remote Model Context Protocol (MCP) server for Color Me Shop
Transport: Streamable HTTP
Endpoint: https://agent.colorme.app/api/mcp
Tooling: toolCount: 49

🚀 Use Cases

“Show me today's unprocessed orders”
“List products with 5 or fewer in stock”
Delegate shop operations to Claude and other MCP-capable AI tools

⚡ Developer Benefits

MCP integration for e-commerce workflows using natural-language queries
Categorized topics include: ai-agent, colorme, ecommerce, mcp, model-context-protocol, remote-mcp-server

⚠️ Limitations

Server documentation excerpt does not describe authentication, rate limits, or available tools in detail.

Topics

ai-agentcolormeecommercemcpmodel-context-protocolremote-mcp-server

Declared in the repository manifest (tools.json). Not verified against a live endpoint.

getShop

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

Parameters1

_dummy

string

optional

Not used

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "_dummy": {
      "description": "Not used",
      "type": "string"
    }
  },
  "additionalProperties": false
}

getSales

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

Parameters22

ids	string	optional	受注IDで検索。カンマ区切りで複数指定可能
after	string	optional	指定日時以降の受注から検索。 `after` 未指定時は `before` の指定日時の7日前の0時、 `before` 未指定時は現在から7日前の0時がデフォルト値となります。
before	string	optional	指定日時以前の受注から検索
make_date_min	string	optional	`after`と同義
make_date_max	string	optional	`before`と同義
update_date_min	string	optional	指定日時以降に更新された受注から検索
update_date_max	string	optional	指定日時以前に更新された受注から検索
customer_ids	string	optional	購入した顧客IDで検索。カンマ区切りにすることで複数検索が可能
customer_name	string	optional	購入した顧客名で部分一致検索
customer_furigana	string	optional	購入した顧客フリガナがで部分一致検索
customer_mail	string	optional	購入した顧客メールアドレスで部分一致検索
accepted_mail_state	string	optional	受注メールの送信状態で検索 - `not_yet`: 未送信 - `sent`: 送信済み - `pass`: 送信しない
paid_mail_state	string	optional	入金メールの送信状態で検索 - `not_yet`: 未送信 - `sent`: 送信済み - `pass`: 送信しない
delivered_mail_state	string	optional	配送メールの送信状態で検索 - `not_yet`: 未送信 - `sent`: 送信済み - `pass`: 送信しない
mobile	boolean	optional	`true`なら携帯からの受注のみ取得
paid	boolean	optional	`true`なら入金済みの受注のみ取得
delivered	boolean	optional	`true`なら配送済みの受注のみ取得
canceled	boolean	optional	`true`ならキャンセル済みの受注のみ取得
payment_ids	string	optional	使用された決済のIDで検索。カンマ区切りで複数指定可能
fields	string	optional	レスポンスJSONのキーをカンマ区切りで指定
limit	integer	optional	レスポンスの件数を指定。指定がない場合は10。最大100
offset	integer	optional	指定した数値+1件目以降のデータを返す

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "ids": {
      "description": "受注IDで検索。カンマ区切りで複数指定可能",
      "type": "string"
    },
    "after": {
      "description": "指定日時以降の受注から検索。  `after` 未指定時は `before` の指定日時の7日前の0時、  `before` 未指定時は現在から7日前の0時がデフォルト値となります。 ",
      "type": "string"
    },
    "before": {
      "description": "指定日時以前の受注から検索",
      "type": "string"
    },
    "make_date_min": {
      "description": "`after`と同義",
      "type": "string"
    },
    "make_date_max": {
      "description": "`before`と同義",
      "type": "string"
    },
    "update_date_min": {
      "description": "指定日時以降に更新された受注から検索",
      "type": "string"
    },
    "update_date_max": {
      "description": "指定日時以前に更新された受注から検索",
      "type": "string"
    },
    "customer_ids": {
      "description": "購入した顧客IDで検索。カンマ区切りにすることで複数検索が可能",
      "type": "string"
    },
    "customer_name": {
      "description": "購入した顧客名で部分一致検索",
      "type": "string"
    },
    "customer_furigana": {
      "description": "購入した顧客フリガナがで部分一致検索",
      "type": "string"
    },
    "customer_mail": {
      "description": "購入した顧客メールアドレスで部分一致検索",
      "type": "string"
    },
    "accepted_mail_state": {
      "description": "受注メールの送信状態で検索  - `not_yet`: 未送信 - `sent`: 送信済み - `pass`: 送信しない ",
      "type": "string",
      "enum": [
        "not_yet",
        "sent",
        "pass"
      ]
    },
    "paid_mail_state": {
      "description": "入金メールの送信状態で検索  - `not_yet`: 未送信 - `sent`: 送信済み - `pass`: 送信しない ",
      "type": "string",
      "enum": [
        "not_yet",
        "sent",
        "pass"
      ]
    },
    "delivered_mail_state": {
      "description": "配送メールの送信状態で検索  - `not_yet`: 未送信 - `sent`: 送信済み - `pass`: 送信しない ",
      "type": "string",
      "enum": [
        "not_yet",
        "sent",
        "pass"
      ]
    },
    "mobile": {
      "description": "`true`なら携帯からの受注のみ取得",
      "type": "boolean"
    },
    "paid": {
      "description": "`true`なら入金済みの受注のみ取得",
      "type": "boolean"
    },
    "delivered": {
      "description": "`true`なら配送済みの受注のみ取得",
      "type": "boolean"
    },
    "canceled": {
      "description": "`true`ならキャンセル済みの受注のみ取得",
      "type": "boolean"
    },
    "payment_ids": {
      "description": "使用された決済のIDで検索。カンマ区切りで複数指定可能",
      "type": "string"
    },
    "fields": {
      "description": "レスポンスJSONのキーをカンマ区切りで指定",
      "type": "string"
    },
    "limit": {
      "description": "レスポンスの件数を指定。指定がない場合は10。最大100",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "指定した数値+1件目以降のデータを返す",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "additionalProperties": false
}

statSale

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

Parameters1

make_date

string

optional

集計の基準日。この日を起点に、以下の期間の売上金額と件数を返す。 - `amount_today` / `count_today`: 基準日当日の売上 - `amount_last_7days` / `count_last_7days`: 基準日の7日前の日から基準日の終わりまでの売上 - `amount_this_month` / `count_this_month`: 基準日が属する月の売上形式は"2017-04-12"、"2017/04/12"など。指定しない場合は今日の日付が使われる。

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "make_date": {
      "description": "集計の基準日。この日を起点に、以下の期間の売上金額と件数を返す。   - `amount_today` / `count_today`: 基準日当日の売上   - `amount_last_7days` / `count_last_7days`: 基準日の7日前の日から基準日の終わりまでの売上   - `amount_this_month` / `count_this_month`: 基準日が属する月の売上 形式は\"2017-04-12\"、\"2017/04/12\"など。指定しない場合は今日の日付が使われる。 ",
      "type": "string"
    }
  },
  "additionalProperties": false
}

getSale

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

Parameters1

sale_id

integer

required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "sale_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "sale_id"
  ],
  "additionalProperties": false
}

updateSale

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

Parameters2

sale_id	integer	required
sale	object	optional

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "sale_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "sale": {
      "type": "object",
      "properties": {
        "paid": {
          "description": "入金済みであるか否か",
          "type": "boolean"
        },
        "point_state": {
          "description": "ショップポイントの付与状態。`fixed`へ変更すると、購入者にショップポイントが付与される。`fixed`から別のステータスには変更できない また、受注が分割されている場合、子受注のショップポイント付与状態は変更することができません。  - `assumed`: 仮付与 - `fixed`: 確定済み - `cenceled`: キャンセル済み ",
          "type": "string",
          "enum": [
            "assumed",
            "fixed",
            "cenceled"
          ]
        },
        "sale_deliveries": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "description": "お届け先ID",
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "account_id": {
                "description": "ショップアカウントID",
                "type": "string"
              },
              "sale_id": {
                "description": "売上ID",
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "delivery_id": {
                "description": "使用された配送方法ID",
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "detail_ids": {
                "description": "この配送に含まれる受注明細IDの配列",
                "type": "array",
                "items": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                }
              },
              "name": {
                "description": "宛名",
                "type": "string"
              },
              "furigana": {
                "description": "宛名のフリガナ",
                "type": "string"
              },
              "postal": {
                "description": "郵便番号",
                "type": "string"
              },
              "pref_id": {
                "description": "都道府県の通し番号。北海道が1、沖縄が47",
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "pref_name": {
                "description": "都道府県名",
                "type": "string"
              },
              "address1": {
                "description": "住所1",
                "type": "string"
              },
              "address2": {
                "description": "住所2",
                "type": "string"
              },
              "tel": {
                "description": "電話番号",
                "type": "string"
              },
              "preferred_date": {
                "description": "配送希望日",
                "type": "string"
              },
              "preferred_period": {
                "description": "配送希望時間帯",
                "type": "string"
              },
              "slip_number": {
                "description": "配送伝票番号",
                "type": "string"
              },
              "noshi_text": {
                "description": "熨斗の文言",
                "type": "string"
              },
              "noshi_charge": {
                "description": "熨斗の料金",
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "card_name": {
                "description": "メッセージカードの表示名",
                "type": "string"
              },
              "card_text": {
                "description": "メッセージカードのテキスト",
                "type": "string"
              },
              "card_charge": {
                "description": "メッセージカードの料金",
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "wrapping_name": {
                "description": "ラッピングの表示名",
                "type": "string"
              },
              "wrapping_charge": {
                "description": "ラッピングの料金",
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "delivery_charge": {
                "description": "配送料",
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "total_charge": {
                "description": "配送料・手数料の小計",
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "tracking_url": {
                "description": "配送状況確認URL",
                "type": "string"
              },
              "memo": {
                "description": "備考",
                "type": "string"
              },
              "delivered": {
                "description": "発送済みであるか否か",
                "type": "boolean"
              }
            },
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "sale_id"
  ],
  "additionalProperties": false
}

cancelSale

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

Parameters2

sale_id	integer	required
restock	boolean	optional	`true`の場合、在庫管理している商品について、購入された分の在庫数を充当する

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "sale_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "restock": {
      "description": "`true`の場合、在庫管理している商品について、購入された分の在庫数を充当する",
      "type": "boolean"
    }
  },
  "required": [
    "sale_id"
  ],
  "additionalProperties": false
}

sendSalesMail

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

Parameters2

sale_id	integer	required
mail	object	optional

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "sale_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "mail": {
      "type": "object",
      "properties": {
        "type": {
          "description": "送信するメールの種類  - `accepted`: 受注メールを送信する - `paid`: 入金確認メールを送信する - `delivered`: 商品発送メールを送信する ",
          "type": "string",
          "enum": [
            "accepted",
            "paid",
            "delivered"
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "sale_id"
  ],
  "additionalProperties": false
}

createPaymentUrls

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

Parameters1

sale_id

integer

required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "sale_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "sale_id"
  ],
  "additionalProperties": false
}

getCustomers

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

Parameters16

ids	string	optional	顧客IDで検索。カンマ区切りで複数指定可能
name	string	optional	顧客名で部分一致検索
furigana	string	optional	顧客フリガナで部分一致検索
mail	string	optional	顧客メールアドレスで部分一致検索
postal	string	optional	顧客の郵便番号で部分一致検索
tel	string	optional	顧客の電話番号で部分一致検索
line_uid	string	optional	LINE UIDで完全一致検索
sex	string	optional	顧客の性別で検索 - `male`: 男性 - `female`: 女性 - `not_applicable`: 未回答
member	boolean	optional	`true`なら会員登録済みの顧客から検索
receive_mail_magazine	boolean	optional	メルマガ受信可否で検索
make_date_min	string	optional	指定日時以降に登録された顧客から検索
make_date_max	string	optional	指定日時以前に登録された顧客から検索
update_date_min	string	optional	指定日時以降に更新された顧客から検索
update_date_max	string	optional	指定日時以前に更新された顧客から検索
limit	integer	optional	レスポンスの件数を指定。指定がない場合は10。最大100
offset	integer	optional	指定した数値+1件目以降のデータを返す

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "ids": {
      "description": "顧客IDで検索。カンマ区切りで複数指定可能",
      "type": "string"
    },
    "name": {
      "description": "顧客名で部分一致検索",
      "type": "string"
    },
    "furigana": {
      "description": "顧客フリガナで部分一致検索",
      "type": "string"
    },
    "mail": {
      "description": "顧客メールアドレスで部分一致検索",
      "type": "string"
    },
    "postal": {
      "description": "顧客の郵便番号で部分一致検索",
      "type": "string"
    },
    "tel": {
      "description": "顧客の電話番号で部分一致検索",
      "type": "string"
    },
    "line_uid": {
      "description": "LINE UIDで完全一致検索",
      "type": "string"
    },
    "sex": {
      "description": "顧客の性別で検索  - `male`: 男性 - `female`: 女性 - `not_applicable`: 未回答 ",
      "type": "string",
      "enum": [
        "male",
        "female",
        "not_applicable"
      ]
    },
    "member": {
      "description": "`true`なら会員登録済みの顧客から検索",
      "type": "boolean"
    },
    "receive_mail_magazine": {
      "description": "メルマガ受信可否で検索",
      "type": "boolean"
    },
    "make_date_min": {
      "description": "指定日時以降に登録された顧客から検索",
      "type": "string"
    },
    "make_date_max": {
      "description": "指定日時以前に登録された顧客から検索",
      "type": "string"
    },
    "update_date_min": {
      "description": "指定日時以降に更新された顧客から検索",
      "type": "string"
    },
    "update_date_max": {
      "description": "指定日時以前に更新された顧客から検索",
      "type": "string"
    },
    "limit": {
      "description": "レスポンスの件数を指定。指定がない場合は10。最大100",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "description": "指定した数値+1件目以降のデータを返す",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "additionalProperties": false
}

postCustomers

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

Parameters1

customer

object

required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "customer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 50,
          "description": "顧客名"
        },
        "mail": {
          "type": "string",
          "format": "email",
          "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
          "description": "メールアドレス"
        },
        "pref_id": {
          "type": "integer",
          "minimum": 1,
          "maximum": 48,
          "description": "都道府県ID"
        },
        "postal": {
          "type": "string",
          "description": "郵便番号"
        },
        "address1": {
          "type": "string",
          "description": "住所1（市区町村・番地）"
        },
        "address2": {
          "description": "住所2（建物名など）",
          "type": "string"
        },
        "tel": {
          "type": "string",
          "pattern": "^[\\d-]+$",
          "description": "電話番号"
        },
        "furigana": {
          "description": "フリガナ",
          "type": "string",
          "maxLength": 50,
          "pattern": "^[ァ-ヶー \\u3000ヷヸヹヺ]*$"
        },
        "fax": {
          "description": "FAX番号",
          "type": "string",
          "pattern": "^[\\d-]+$"
        },
        "birthday": {
          "description": "生年月日（YYYY-MM-DD形式）",
          "type": "string"
        },
        "hojin": {
          "description": "法人名",
          "type": "string",
          "maxLength": 100
        },
        "busho": {
          "description": "部署名",
          "type": "string",
          "maxLength": 50
        },
        "receive_mail_magazine": {
          "description": "メルマガ受信可否",
          "type": "boolean"
        },
        "answer_free_form1": {
          "description": "フリー項目1",
          "type": "string",
          "maxLength": 255
        },
        "answer_free_form2": {
          "description": "フリー項目2",
          "type": "string",
          "maxLength": 255
        },
        "answer_free_form3": {
          "description": "フリー項目3",
          "type": "string",
          "maxLength": 255
        },
        "other": {
          "description": "備考",
          "type": "string"
        },
        "add_member": {
          "description": "会員登録するかどうか",
          "type": "boolean"
        }
      },
      "required": [
        "name",
        "mail",
        "pref_id",
        "postal",
        "address1",
        "tel"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "customer"
  ],
  "additionalProperties": false
}

getCustomer

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

Parameters1

customer_id

integer

required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "customer_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "customer_id"
  ],
  "additionalProperties": false
}

updateCustomers

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

Parameters2

customer_id	integer	required	更新対象の顧客ID
customer	object	required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "customer_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "更新対象の顧客ID"
    },
    "customer": {
      "type": "object",
      "properties": {
        "name": {
          "description": "顧客名",
          "type": "string",
          "maxLength": 50
        },
        "furigana": {
          "description": "フリガナ",
          "type": "string",
          "maxLength": 50,
          "pattern": "^[ァ-ヶー \\u3000ヷヸヹヺ]*$"
        },
        "mail": {
          "description": "メールアドレス",
          "type": "string",
          "format": "email",
          "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
        },
        "pref_id": {
          "description": "都道府県ID",
          "type": "integer",
          "minimum": 1,
          "maximum": 48
        },
        "postal": {
          "description": "郵便番号",
          "type": "string"
        },
        "address1": {
          "description": "住所1（市区町村・番地）",
          "type": "string"
        },
        "address2": {
          "description": "住所2（建物名など）",
          "type": "string"
        },
        "tel": {
          "description": "電話番号",
          "type": "string",
          "pattern": "^[\\d-]+$"
        },
        "tel_mobile": {
          "description": "携帯電話番号",
          "type": "string",
          "pattern": "^[\\d-]+$"
        },
        "fax": {
          "description": "FAX番号",
          "type": "string",
          "pattern": "^[\\d-]+$"
        },
        "sex": {
          "description": "性別",
          "type": "string",
          "enum": [
            "male",
            "female",
            "not_applicable"
          ]
        },
        "birthday": {
          "description": "生年月日（YYYY-MM-DD形式）",
          "type": "string"
        },
        "hojin": {
          "description": "法人名",
          "type": "string",
          "maxLength": 100
        },
        "busho": {
          "description": "部署名",
          "type": "string",
          "maxLength": 50
        },
        "receive_mail_magazine": {
          "description": "メルマガ受信可否",
          "type": "boolean"
        },
        "answer_free_form1": {
          "description": "フリー項目1",
          "type": "string",
          "maxLength": 255
        },
        "answer_free_form2": {
          "description": "フリー項目2",
          "type": "string",
          "maxLength": 255
        },
        "answer_free_form3": {
          "description": "フリー項目3",
          "type": "string",
          "maxLength": 255
        },
        "other": {
          "description": "備考",
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "customer_id",
    "customer"
  ],
  "additionalProperties": false
}

postCustomerPoints

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

Parameters2

customer_id	integer	required
points	integer	required	増減させるポイント数

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "customer_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "points": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "増減させるポイント数"
    }
  },
  "required": [
    "customer_id",
    "points"
  ],
  "additionalProperties": false
}

updateCustomerMembership

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

Parameters2

customer_id	integer	required	更新対象の顧客ID
membership	object	required	会員ランク情報

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "customer_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "更新対象の顧客ID"
    },
    "membership": {
      "type": "object",
      "properties": {
        "membership_id": {
          "type": "string",
          "description": "会員ランクID"
        }
      },
      "required": [
        "membership_id"
      ],
      "additionalProperties": false,
      "description": "会員ランク情報"
    }
  },
  "required": [
    "customer_id",
    "membership"
  ],
  "additionalProperties": false
}

deleteCustomerGroupMembership

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

Parameters1

customer_id

integer

required

解除対象の顧客ID

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "customer_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "解除対象の顧客ID"
    }
  },
  "required": [
    "customer_id"
  ],
  "additionalProperties": false
}

getProducts

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

Parameters25

ids	string	optional	商品IDで検索。カンマ区切りにすることで複数検索が可能
category_id_big	integer	optional	大カテゴリーIDで検索
category_id_small	integer	optional	小カテゴリーIDで検索
group_ids	integer	optional	グループIDで検索。カンマ区切りにすることで複数検索が可能
model_number	string	optional	型番で部分一致検索
name	string	optional	商品名で部分一致検索
display_state	string	optional	掲載設定で検索 - `showing`: 掲載状態 - `hidden`: 非掲載状態 - `showing_for_members`: 会員にのみ掲載 - `sale_for_members`: 掲載状態だが購入は会員のみ可能
stocks	integer	optional	在庫管理している商品のうち、在庫数が指定した数値以下の商品を検索。オプションごとに在庫管理している商品は、オプションごとの在庫数で検索される
stock_managed	boolean	optional	`true`の場合、在庫管理している商品を検索
recent_zero_stocks	boolean	optional	`true` の場合、在庫管理している商品のうち、過去1週間以内に更新され在庫数が0の商品を検索
make_date_min	string	optional	指定日時以降に作成された商品から検索
make_date_max	string	optional	指定日時以前に作成された商品から検索
update_date_min	string	optional	指定日時以降に更新された商品から検索
update_date_max	string	optional	指定日時以前に更新された商品から検索
sales_price_min	integer	optional	販売価格が指定した金額以上の商品を検索。0以上の整数のみ有効
sales_price_max	integer	optional	販売価格が指定した金額以下の商品を検索。0以上の整数のみ有効
price_min	integer	optional	定価が指定した金額以上の商品を検索。0以上の整数のみ有効
price_max	integer	optional	定価が指定した金額以下の商品を検索。0以上の整数のみ有効
members_price_min	integer	optional	会員価格が指定した金額以上の商品を検索。0以上の整数のみ有効
members_price_max	integer	optional	会員価格が指定した金額以下の商品を検索。0以上の整数のみ有効
jan_code	string	optional	JANコードで完全一致検索
sort	string	optional	商品の並び順を指定します。カラム名の前に `-` を付けると降順、なしで昇順です。カンマ区切りで複数指定できます。デフォルトは作成日の降順(`-make_date`)です。指定可能なカラム: `make_date` (作成日), `update_date` (更新日), `sales_price` (販売価格), `price` (定価), `members_price` (会員価格) 例: - `sort=sales_price` — 販売価格の昇順 - `sort=-update_date` — 更新日の降順 - `sort=-sales_price,make_date` — 販売価格の降順 → 作成日の昇順
fields	string	optional	レスポンスJSONのキーをカンマ区切りで指定
limit	integer	optional	レスポンスの件数を指定。指定がない場合は10。最大50
offset	integer	optional	指定した数値+1件目以降のデータを返す

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "ids": {
      "description": "商品IDで検索。カンマ区切りにすることで複数検索が可能",
      "type": "string"
    },
    "category_id_big": {
      "description": "大カテゴリーIDで検索",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "category_id_small": {
      "description": "小カテゴリーIDで検索",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "group_ids": {
      "description": "グループIDで検索。カンマ区切りにすることで複数検索が可能",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "model_number": {
      "description": "型番で部分一致検索",
      "type": "string"
    },
    "name": {
      "description": "商品名で部分一致検索",
      "type": "string"
    },
    "display_state": {
      "description": "掲載設定で検索  - `showing`: 掲載状態 - `hidden`: 非掲載状態 - `showing_for_members`: 会員にのみ掲載 - `sale_for_members`: 掲載状態だが購入は会員のみ可能 ",
      "type": "string",
      "enum": [
        "showing",
        "hidden",
        "showing_for_members",
        "sale_for_members"
      ]
    },
    "stocks": {
      "description": "在庫管理している商品のうち、在庫数が指定した数値以下の商品を検索。オプションごとに在庫管理している商品は、オプションごとの在庫数で検索される",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "stock_managed": {
      "description": "`true`の場合、在庫管理している商品を検索",
      "type": "boolean"
    },
    "recent_zero_stocks": {
      "description": "`true` の場合、在庫管理している商品のうち、過去1週間以内に更新され在庫数が0の商品を検索",
      "type": "boolean"
    },
    "make_date_min": {
      "description": "指定日時以降に作成された商品から検索",
      "type": "string"
    },
    "make_date_max": {
      "description": "指定日時以前に作成された商品から検索",
      "type": "string"
    },
    "update_date_min": {
      "description": "指定日時以降に更新された商品から検索",
      "type": "string"
    },
    "update_date_max": {
      "description": "指定日時以前に更新された商品から検索",
      "type": "string"
    },
    "sales_price_min": {
      "description": "販売価格が指定した金額以上の商品を検索。0以上の整数のみ有効",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "sales_price_max": {
      "description": "販売価格が指定した金額以下の商品を検索。0以上の整数のみ有効",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "price_min": {
      "description": "定価が指定した金額以上の商品を検索。0以上の整数のみ有効",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "price_max": {
      "description": "定価が指定した金額以下の商品を検索。0以上の整数のみ有効",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "members_price_min": {
      "description": "会員価格が指定した金額以上の商品を検索。0以上の整数のみ有効",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "members_price_max": {
      "description": "会員価格が指定した金額以下の商品を検索。0以上の整数のみ有効",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "jan_code": {
      "description": "JANコードで完全一致検索",
      "type": "string"
    },
    "sort": {
      "description": "商品の並び順を指定します。カラム名の前に `-` を付けると降順、なしで昇順です。カンマ区切りで複数指定できます。デフォルトは作成日の降順(`-make_date`)です。 指定可能なカラム: `make_date` (作成日), `update_date` (更新日), `sales_price` (販売価格), `price` (定価), `members_price` (会員価格)  例: - `sort=sales_price` — 販売価格の昇順 - `sort=-update_date` — 更新日の降順 - `sort=-sales_price,make_date` — 販売価格の降順 → 作成日の昇順 ",
      "type": "string"
    },
    "fields": {
      "description": "レスポンスJSONのキーをカンマ区切りで指定",
      "type": "string"
    },
    "limit": {
      "description": "レスポンスの件数を指定。指定がない場合は10。最大50",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "指定した数値+1件目以降のデータを返す",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "additionalProperties": false
}

postProducts

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

Parameters1

product

object

optional

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "product": {
      "type": "object",
      "properties": {
        "name": {
          "description": "商品名",
          "type": "string",
          "maxLength": 100
        },
        "price": {
          "description": "定価",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "category_id_big": {
          "description": "大カテゴリーID",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "cost": {
          "description": "原価",
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "sales_price": {
          "description": "販売価格 フリープランを利用しているショップの場合、最低価格は100円です。 ",
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "members_price": {
          "description": "会員価格 フリープランを利用しているショップの場合、最低価格は100円です。 ",
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "model_number": {
          "description": "型番",
          "type": "string",
          "maxLength": 50
        },
        "expl": {
          "description": "商品説明",
          "type": "string"
        },
        "simple_expl": {
          "description": "簡易説明",
          "type": "string",
          "maxLength": 255
        },
        "smartphone_expl": {
          "description": "スマホ向けショップの商品説明",
          "type": "string"
        },
        "display_state": {
          "description": "掲載設定  - `showing`: 掲載状態 - `hidden`: 非掲載状態 - `showing_for_members`: 会員にのみ掲載 - `sale_for_members`: 掲載状態だが購入は会員のみ可能 ",
          "type": "string",
          "enum": [
            "showing",
            "hidden",
            "showing_for_members",
            "sale_for_members"
          ]
        },
        "stock_managed": {
          "description": "在庫管理する場合は `true`",
          "type": "boolean"
        },
        "tax_reduced": {
          "description": "`true` の場合は軽減税率対象",
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

getProduct

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

Parameters1

product_id

integer

required

商品ID

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "商品ID"
    }
  },
  "required": [
    "product_id"
  ],
  "additionalProperties": false
}

updateProduct

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

Parameters2

product_id	integer	required	商品ID
product	object	optional

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "商品ID"
    },
    "product": {
      "type": "object",
      "properties": {
        "name": {
          "description": "商品名",
          "type": "string",
          "maxLength": 100
        },
        "price": {
          "description": "定価",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "category_id_big": {
          "description": "大カテゴリーID",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "category_id_small": {
          "description": "小カテゴリーID",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "cost": {
          "description": "原価",
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "sales_price": {
          "description": "販売価格 フリープランを利用しているショップの場合、最低価格は100円です。 ",
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "members_price": {
          "description": "会員価格 フリープランを利用しているショップの場合、最低価格は100円です。 ",
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "model_number": {
          "description": "型番",
          "type": "string",
          "maxLength": 50
        },
        "expl": {
          "description": "商品説明",
          "type": "string"
        },
        "simple_expl": {
          "description": "簡易説明",
          "type": "string",
          "maxLength": 255
        },
        "smartphone_expl": {
          "description": "スマホ向けショップの商品説明",
          "type": "string"
        },
        "display_state": {
          "description": "掲載設定  - `showing`: 掲載状態 - `hidden`: 非掲載状態 - `showing_for_members`: 会員にのみ掲載 - `sale_for_members`: 掲載状態だが購入は会員のみ可能 ",
          "type": "string",
          "enum": [
            "showing",
            "hidden",
            "showing_for_members",
            "sale_for_members"
          ]
        },
        "stock_managed": {
          "description": "在庫管理する場合は `true`",
          "type": "boolean"
        },
        "stocks": {
          "description": "（推奨） `increment`を利用すると、その数値だけ在庫数を増減させることが可能です。負の値も指定可能です。（-1, 1 等） ```json \"stocks\": {   \"increment\": 3 } ```  `increment`を利用せずに数値を指定した場合は、在庫数をその数値で更新します。商品オプションごとに在庫管理している場合、このパラメータは無視されます。 ",
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "increment": {
                  "description": "在庫数の増減値",
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                }
              },
              "additionalProperties": false
            },
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          ]
        },
        "group_ids": {
          "description": "グループIDの配列",
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "variants": {
          "description": "商品オプションによるバリエーションごとに更新",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "option1_value": {
                "description": "オプション1の値",
                "type": "string"
              },
              "option2_value": {
                "description": "オプション2の値",
                "type": "string"
              },
              "stocks": {
                "description": "上記`stocks`と同様に、数値、または増減値を用いて在庫数を更新できます。",
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "increment": {
                        "description": "在庫数の増減値",
                        "type": "integer",
                        "minimum": -9007199254740991,
                        "maximum": 9007199254740991
                      }
                    },
                    "additionalProperties": false
                  },
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  }
                ]
              }
            },
            "additionalProperties": false
          }
        },
        "tax_reduced": {
          "description": "`true` の場合は軽減税率対象",
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "product_id"
  ],
  "additionalProperties": false
}

getProductVariants

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

Parameters5

product_id	integer	required	商品ID
model_number	string	optional	型番で部分一致検索
fields	string	optional	レスポンスJSONのキーをカンマ区切りで指定
limit	integer	optional	レスポンスの件数を指定。指定がない場合は10。最大50
offset	integer	optional	指定した数値+1件目以降のデータを返す

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "商品ID"
    },
    "model_number": {
      "description": "型番で部分一致検索",
      "type": "string"
    },
    "fields": {
      "description": "レスポンスJSONのキーをカンマ区切りで指定",
      "type": "string"
    },
    "limit": {
      "description": "レスポンスの件数を指定。指定がない場合は10。最大50",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "指定した数値+1件目以降のデータを返す",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "product_id"
  ],
  "additionalProperties": false
}

postProductPickup

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

Parameters3

product_id	integer	required	商品ID
pickup_type	integer	optional	おすすめ商品情報種別（0:おすすめ商品, 1:売れ筋商品, 3:新着商品, 4:イチオシ商品）
order_num	integer	optional	商品の表示順

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "商品ID"
    },
    "pickup_type": {
      "description": "おすすめ商品情報種別（0:おすすめ商品, 1:売れ筋商品, 3:新着商品, 4:イチオシ商品）",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "order_num": {
      "description": "商品の表示順",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "product_id"
  ],
  "additionalProperties": false
}

putProductPickup

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

Parameters3

product_id	integer	required	商品ID
pickup_type	integer	optional	おすすめ商品情報種別（0:おすすめ商品, 1:売れ筋商品, 3:新着商品, 4:イチオシ商品）
order_num	integer	optional	商品の表示順

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "商品ID"
    },
    "pickup_type": {
      "description": "おすすめ商品情報種別（0:おすすめ商品, 1:売れ筋商品, 3:新着商品, 4:イチオシ商品）",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "order_num": {
      "description": "商品の表示順",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "product_id"
  ],
  "additionalProperties": false
}

deleteProductPickup

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

Parameters2

product_id	integer	required	商品ID
pickup_type	integer	required	おすすめ商品情報種別（0:おすすめ商品, 1:売れ筋商品, 3:新着商品, 4:イチオシ商品）

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "商品ID"
    },
    "pickup_type": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "おすすめ商品情報種別（0:おすすめ商品, 1:売れ筋商品, 3:新着商品, 4:イチオシ商品）"
    }
  },
  "required": [
    "product_id",
    "pickup_type"
  ],
  "additionalProperties": false
}

getProductImages

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

Parameters1

product_id

integer

required

商品ID

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "商品ID"
    }
  },
  "required": [
    "product_id"
  ],
  "additionalProperties": false
}

getProductAdvertisings

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

Parameters4

product_ids	string	optional	商品IDで検索。カンマ区切りにすることで複数検索が可能
display_state	string	optional	商品の掲載設定で検索 - `showing`: 掲載状態 - `hidden`: 非掲載状態 - `showing_for_members`: 会員にのみ掲載 - `sale_for_members`: 掲載状態だが購入は会員のみ可能
limit	integer	optional	レスポンスの件数を指定。指定がない場合は50。最大250
offset	integer	optional	指定した数値+1件目以降のデータを返す

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "product_ids": {
      "description": "商品IDで検索。カンマ区切りにすることで複数検索が可能",
      "type": "string"
    },
    "display_state": {
      "description": "商品の掲載設定で検索  - `showing`: 掲載状態 - `hidden`: 非掲載状態 - `showing_for_members`: 会員にのみ掲載 - `sale_for_members`: 掲載状態だが購入は会員のみ可能 ",
      "type": "string",
      "enum": [
        "showing",
        "hidden",
        "showing_for_members",
        "sale_for_members"
      ]
    },
    "limit": {
      "description": "レスポンスの件数を指定。指定がない場合は50。最大250",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "指定した数値+1件目以降のデータを返す",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "additionalProperties": false
}

getReviews

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

Parameters2

limit	integer	optional	レスポンスの件数を指定。指定がない場合は10。最大100
offset	integer	optional	指定した数値+1件目以降のデータを返す

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "limit": {
      "description": "レスポンスの件数を指定。指定がない場合は10。最大100",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "指定した数値+1件目以降のデータを返す",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "additionalProperties": false
}

getStocks

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

Parameters11

ids	string	optional	商品IDで検索。カンマ区切りにすることで複数検索が可能
category_id_big	integer	optional	大カテゴリーIDで検索
category_id_small	integer	optional	小カテゴリーIDで検索
model_number	string	optional	型番で部分一致検索
name	string	optional	商品名で部分一致検索
display_state	string	optional	掲載設定で検索 - `showing`: 掲載状態 - `hidden`: 非掲載状態 - `showing_for_members`: 会員にのみ掲載 - `sale_for_members`: 掲載状態だが購入は会員のみ可能
stocks	integer	optional	在庫管理している商品のうち、在庫数が指定した数値以下の商品を検索。オプションごとに在庫管理している商品は、オプションごとの在庫数で検索される
recent_zero_stocks	boolean	optional	`true` の場合、過去1週間以内にオプションが更新された商品から検索
fields	string	optional	レスポンスJSONのキーをカンマ区切りで指定
limit	integer	optional	レスポンスの件数を指定。指定がない場合は10。最大50
offset	integer	optional	指定した数値+1件目以降のデータを返す

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "ids": {
      "description": "商品IDで検索。カンマ区切りにすることで複数検索が可能",
      "type": "string"
    },
    "category_id_big": {
      "description": "大カテゴリーIDで検索",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "category_id_small": {
      "description": "小カテゴリーIDで検索",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "model_number": {
      "description": "型番で部分一致検索",
      "type": "string"
    },
    "name": {
      "description": "商品名で部分一致検索",
      "type": "string"
    },
    "display_state": {
      "description": "掲載設定で検索  - `showing`: 掲載状態 - `hidden`: 非掲載状態 - `showing_for_members`: 会員にのみ掲載 - `sale_for_members`: 掲載状態だが購入は会員のみ可能 ",
      "type": "string",
      "enum": [
        "showing",
        "hidden",
        "showing_for_members",
        "sale_for_members"
      ]
    },
    "stocks": {
      "description": "在庫管理している商品のうち、在庫数が指定した数値以下の商品を検索。オプションごとに在庫管理している商品は、オプションごとの在庫数で検索される",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "recent_zero_stocks": {
      "description": "`true` の場合、過去1週間以内にオプションが更新された商品から検索",
      "type": "boolean"
    },
    "fields": {
      "description": "レスポンスJSONのキーをカンマ区切りで指定",
      "type": "string"
    },
    "limit": {
      "description": "レスポンスの件数を指定。指定がない場合は10。最大50",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "指定した数値+1件目以降のデータを返す",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "additionalProperties": false
}

getProductGroups

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

Parameters1

_dummy

string

optional

Not used

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "_dummy": {
      "description": "Not used",
      "type": "string"
    }
  },
  "additionalProperties": false
}

createProductGroup

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

Parameters1

group

object

required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "group": {
      "type": "object",
      "properties": {
        "name": {
          "description": "商品グループ名",
          "type": "string",
          "maxLength": 100
        },
        "expl": {
          "description": "商品グループ説明",
          "type": "string"
        },
        "display_state": {
          "description": "掲載設定  - `showing`: 掲載 - `hidden`: 非掲載 - `members_only`: 会員にのみ掲載 ",
          "type": "string",
          "enum": [
            "showing",
            "hidden",
            "members_only"
          ]
        },
        "parent_group_id": {
          "description": "親商品グループID。 特定の商品グループの配下に作成したくない場合は nil を指定してください。 ",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "meta_tag": {
          "description": "SEOメタタグ情報",
          "type": "object",
          "properties": {
            "title": {
              "description": "メタタイトル  HTML `<title>` タグに使用されるタイトル文字列。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 255
            },
            "keywords": {
              "description": "メタキーワード  HTML `<meta name=\"keywords\">` タグに使用されるキーワード文字列。 複数のキーワードはカンマで区切って指定します。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 65535
            },
            "description": {
              "description": "メタディスクリプション  HTML `<meta name=\"description\">` タグに使用される説明文字列。 検索エンジンの検索結果に表示される要約文として使用されます。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 65535
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "group"
  ],
  "additionalProperties": false
}

getProductGroup

指定した商品グループ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 を使用してください。

Parameters1

group_id

integer

required

商品グループID

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "group_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "商品グループID"
    }
  },
  "required": [
    "group_id"
  ],
  "additionalProperties": false
}

updateProductGroup

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

Parameters2

group_id	integer	required	商品グループID
group	object	required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "group_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "商品グループID"
    },
    "group": {
      "type": "object",
      "properties": {
        "name": {
          "description": "商品グループ名",
          "type": "string",
          "maxLength": 100
        },
        "expl": {
          "description": "商品グループ説明",
          "type": "string"
        },
        "display_state": {
          "description": "掲載設定  - `showing`: 掲載 - `hidden`: 非掲載 - `members_only`: 会員にのみ掲載 ",
          "type": "string",
          "enum": [
            "showing",
            "hidden",
            "members_only"
          ]
        },
        "meta_tag": {
          "description": "SEOメタタグ情報",
          "type": "object",
          "properties": {
            "title": {
              "description": "メタタイトル  HTML `<title>` タグに使用されるタイトル文字列。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 255
            },
            "keywords": {
              "description": "メタキーワード  HTML `<meta name=\"keywords\">` タグに使用されるキーワード文字列。 複数のキーワードはカンマで区切って指定します。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 65535
            },
            "description": {
              "description": "メタディスクリプション  HTML `<meta name=\"description\">` タグに使用される説明文字列。 検索エンジンの検索結果に表示される要約文として使用されます。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 65535
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "group_id",
    "group"
  ],
  "additionalProperties": false
}

getProductCategories

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

Parameters1

_dummy

string

optional

Not used

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "_dummy": {
      "description": "Not used",
      "type": "string"
    }
  },
  "additionalProperties": false
}

createProductCategory

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

Parameters1

updateProductCategory

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

Parameters2

id	integer	required	更新する大カテゴリーのID
category	object	required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "更新する大カテゴリーのID"
    },
    "category": {
      "type": "object",
      "properties": {
        "name": {
          "description": "商品カテゴリー名",
          "type": "string",
          "maxLength": 100
        },
        "expl": {
          "description": "商品カテゴリー説明",
          "type": "string"
        },
        "sort": {
          "description": "表示順  カテゴリーの表示順序を指定します。数値が小さいほど上位に表示されます。 未指定の場合は0が設定されます。 ",
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "display_state": {
          "description": "掲載設定  - `showing`: 掲載 - `hidden`: 非掲載 - `members_only`: 会員にのみ掲載 ",
          "type": "string",
          "enum": [
            "showing",
            "hidden",
            "members_only"
          ]
        },
        "meta_tag": {
          "description": "SEOメタタグ情報",
          "type": "object",
          "properties": {
            "title": {
              "description": "メタタイトル  HTML `<title>` タグに使用されるタイトル文字列。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 255
            },
            "keywords": {
              "description": "メタキーワード  HTML `<meta name=\"keywords\">` タグに使用されるキーワード文字列。 複数のキーワードはカンマで区切って指定します。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 65535
            },
            "description": {
              "description": "メタディスクリプション  HTML `<meta name=\"description\">` タグに使用される説明文字列。 検索エンジンの検索結果に表示される要約文として使用されます。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 65535
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "category"
  ],
  "additionalProperties": false
}

createProductCategoryChild

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

Parameters2

category_id	integer	required	親となる商品カテゴリーのID（大カテゴリーID）
category	object	required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "category_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "親となる商品カテゴリーのID（大カテゴリーID）"
    },
    "category": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 100,
          "description": "商品カテゴリー名"
        },
        "expl": {
          "description": "商品カテゴリー説明",
          "type": "string"
        },
        "sort": {
          "description": "表示順  カテゴリーの表示順序を指定します。数値が小さいほど上位に表示されます。 未指定の場合は0が設定されます。 ",
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "display_state": {
          "description": "掲載設定  - `showing`: 掲載（デフォルト） - `hidden`: 非掲載 - `members_only`: 会員のみ掲載 ",
          "type": "string",
          "enum": [
            "showing",
            "hidden",
            "members_only"
          ]
        },
        "meta_tag": {
          "description": "SEOメタタグ情報",
          "type": "object",
          "properties": {
            "title": {
              "description": "メタタイトル  HTML `<title>` タグに使用されるタイトル文字列。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 255
            },
            "keywords": {
              "description": "メタキーワード  HTML `<meta name=\"keywords\">` タグに使用されるキーワード文字列。 複数のキーワードはカンマで区切って指定します。 HTMLタグは使用できません。 ",
              "type": "string"
            },
            "description": {
              "description": "メタディスクリプション  HTML `<meta name=\"description\">` タグに使用される説明文字列。 検索エンジンの検索結果に表示される要約文として使用されます。 HTMLタグは使用できません。 ",
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      },
      "required": [
        "name"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "category_id",
    "category"
  ],
  "additionalProperties": false
}

updateProductCategoryChild

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

Parameters3

category_id	integer	required	更新する小カテゴリーの親となる大カテゴリーID
id	integer	required	更新する小カテゴリーのID
category	object	required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "category_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "更新する小カテゴリーの親となる大カテゴリーID"
    },
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "更新する小カテゴリーのID"
    },
    "category": {
      "type": "object",
      "properties": {
        "name": {
          "description": "商品カテゴリー名",
          "type": "string",
          "maxLength": 100
        },
        "expl": {
          "description": "商品カテゴリー説明",
          "type": "string"
        },
        "sort": {
          "description": "表示順  カテゴリーの表示順序を指定します。数値が小さいほど上位に表示されます。 未指定の場合は0が設定されます。 ",
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "display_state": {
          "description": "掲載設定  - `showing`: 掲載 - `hidden`: 非掲載 - `members_only`: 会員にのみ掲載 ",
          "type": "string",
          "enum": [
            "showing",
            "hidden",
            "members_only"
          ]
        },
        "meta_tag": {
          "description": "SEOメタタグ情報",
          "type": "object",
          "properties": {
            "title": {
              "description": "メタタイトル  HTML `<title>` タグに使用されるタイトル文字列。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 255
            },
            "keywords": {
              "description": "メタキーワード  HTML `<meta name=\"keywords\">` タグに使用されるキーワード文字列。 複数のキーワードはカンマで区切って指定します。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 65535
            },
            "description": {
              "description": "メタディスクリプション  HTML `<meta name=\"description\">` タグに使用される説明文字列。 検索エンジンの検索結果に表示される要約文として使用されます。 HTMLタグは使用できません。 ",
              "type": "string",
              "maxLength": 65535
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "category_id",
    "id",
    "category"
  ],
  "additionalProperties": false
}

getPayments

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

Parameters1

_dummy

string

optional

Not used

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "_dummy": {
      "description": "Not used",
      "type": "string"
    }
  },
  "additionalProperties": false
}

getDeliveries

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

Parameters1

_dummy

string

optional

Not used

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "_dummy": {
      "description": "Not used",
      "type": "string"
    }
  },
  "additionalProperties": false
}

getDeliveryDateSetting

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

Parameters1

_dummy

string

optional

Not used

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "_dummy": {
      "description": "Not used",
      "type": "string"
    }
  },
  "additionalProperties": false
}

getGift

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

Parameters1

_dummy

string

optional

Not used

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "_dummy": {
      "description": "Not used",
      "type": "string"
    }
  },
  "additionalProperties": false
}

getCoupons

ショップに登録されているクーポンの一覧を取得します。クエリパラメータは不要で、削除されていない全クーポン(顧客がチェックアウト時にコード入力して使う値引き)が返されます。各エントリには 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 を使用。

Parameters1

_dummy

string

optional

Not used

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "_dummy": {
      "description": "Not used",
      "type": "string"
    }
  },
  "additionalProperties": false
}

createCoupon

新規ショップクーポン(チェックアウト時に顧客がコード入力する値引き)を作成し、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。

Parameters1

shop_coupon

object

optional

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "shop_coupon": {
      "type": "object",
      "properties": {
        "name": {
          "description": "クーポン名",
          "type": "string"
        },
        "code": {
          "type": "string",
          "description": "クーポンコード"
        },
        "coupon_type": {
          "type": "string",
          "enum": [
            "amount",
            "rate",
            "delivery_charge"
          ],
          "description": "クーポン種別  - `amount`: 定額 - `rate`: 定率 - `delivery_charge`: 送料無料 "
        },
        "discount_amount": {
          "description": "割引金額または割引率  - coupon_type: `amount` の場合は円単位の金額（例: 100 = 100円割引） - coupon_type: `rate` の場合は%単位の割引率（例: 10 = 10%割引） - coupon_type: `delivery_charge` の場合は0を指定（送料から自動計算） ",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "minimum_amount": {
          "description": "利用最低額",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "starts_at": {
          "type": "string",
          "description": "利用開始日（YYYY-MM-DD形式で指定。ends_atより前の日付である必要があります）"
        },
        "ends_at": {
          "type": "string",
          "description": "利用終了日（YYYY-MM-DD形式で指定。starts_atより後の日付である必要があります）"
        },
        "total_usage_limit": {
          "description": "総利用可能数",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "usage_limit": {
          "description": "ユーザ毎の利用可能数  - `indisposable`: 無制限 - `disposable`: 一度のみ ",
          "type": "string",
          "enum": [
            "indisposable",
            "disposable"
          ]
        },
        "group_limit_type": {
          "description": "商品グループによる制限  - `none`: 無制限（group_idsは無視される） - `including`: 指定したgroup_idsに含まれる商品のみ対象 - `excluding`: 指定したgroup_idsに含まれる商品を除外 ",
          "type": "string",
          "enum": [
            "none",
            "including",
            "excluding"
          ]
        },
        "status": {
          "description": "クーポンの利用可否  - `unavailable`: 利用不可 - `available`: 利用可能 ",
          "type": "string",
          "enum": [
            "unavailable",
            "available"
          ]
        },
        "group_ids": {
          "description": "商品グループID配列（group_limit_typeがnone以外の場合に使用）",
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          }
        }
      },
      "required": [
        "code",
        "coupon_type",
        "starts_at",
        "ends_at"
      ],
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

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 を使用。

Parameters1

coupon_id

integer

required

Coupon ID

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "coupon_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Coupon ID"
    }
  },
  "required": [
    "coupon_id"
  ],
  "additionalProperties": false
}

deleteCoupon

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

Parameters1

coupon_id

integer

required

Coupon ID

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "coupon_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Coupon ID"
    }
  },
  "required": [
    "coupon_id"
  ],
  "additionalProperties": false
}

updateCoupon

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

Parameters2

coupon_id	integer	required	Coupon ID
shop_coupon	object	optional

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "coupon_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Coupon ID"
    },
    "shop_coupon": {
      "type": "object",
      "properties": {
        "name": {
          "description": "クーポン名",
          "type": "string"
        },
        "code": {
          "description": "クーポンコード",
          "type": "string"
        },
        "coupon_type": {
          "description": "クーポン種別  - `amount`: 定額 - `rate`: 定率 - `delivery_charge`: 送料無料 ",
          "type": "string",
          "enum": [
            "amount",
            "rate",
            "delivery_charge"
          ]
        },
        "discount_amount": {
          "description": "割引金額または割引率  - coupon_type: `amount` の場合は円単位の金額（例: 50 = 50円割引） - coupon_type: `rate` の場合は%単位の割引率（例: 10 = 10%割引） - coupon_type: `delivery_charge` の場合は0を指定（送料から自動計算） ",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "minimum_amount": {
          "description": "利用最低額",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "starts_at": {
          "description": "利用開始日（YYYY-MM-DD形式で指定。ends_atより前の日付である必要があります）",
          "type": "string"
        },
        "ends_at": {
          "description": "利用終了日（YYYY-MM-DD形式で指定。starts_atより後の日付である必要があります）",
          "type": "string"
        },
        "total_usage_limit": {
          "description": "総利用可能数（0は無制限を意味します）",
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "usage_limit": {
          "description": "ユーザ毎の利用可能数  - `indisposable`: 無制限 - `disposable`: 一度のみ ",
          "type": "string",
          "enum": [
            "indisposable",
            "disposable"
          ]
        },
        "group_limit_type": {
          "description": "商品グループによる制限  - `none`: 無制限（group_idsは無視される） - `including`: 指定したgroup_idsに含まれる商品のみ対象 - `excluding`: 指定したgroup_idsに含まれる商品を除外 ",
          "type": "string",
          "enum": [
            "none",
            "including",
            "excluding"
          ]
        },
        "status": {
          "description": "クーポンの利用可否  - `unavailable`: 利用不可 - `available`: 利用可能 ",
          "type": "string",
          "enum": [
            "unavailable",
            "available"
          ]
        },
        "group_ids": {
          "description": "商品グループID配列（group_limit_typeがnone以外の場合に使用）",
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          }
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "coupon_id"
  ],
  "additionalProperties": false
}

getTemplates

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

Parameters1

_dummy

string

optional

Not used

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "_dummy": {
      "description": "Not used",
      "type": "string"
    }
  },
  "additionalProperties": false
}

getTemplatePreview

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

Parameters1

template_id

integer

required

テンプレートID

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "template_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "テンプレートID"
    }
  },
  "required": [
    "template_id"
  ],
  "additionalProperties": false
}

getTemplatePage

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

Parameters2

template_id	integer	required	テンプレートID
page_type	string	required	ページ種別 - `index`: 共通 - `top`: トップ - `product_list`: 商品一覧 - `product`: 商品詳細 - `shopkeeper`: 特定商取引 - `product_srh`: 商品検索結果 - `option_stock`: オプション在庫・値段表 - `privacy`: プライバシーポリシー

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "template_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "テンプレートID"
    },
    "page_type": {
      "type": "string",
      "enum": [
        "index",
        "top",
        "product_list",
        "product",
        "shopkeeper",
        "product_srh",
        "option_stock",
        "privacy"
      ],
      "description": "ページ種別  - `index`: 共通 - `top`: トップ - `product_list`: 商品一覧 - `product`: 商品詳細 - `shopkeeper`: 特定商取引 - `product_srh`: 商品検索結果 - `option_stock`: オプション在庫・値段表 - `privacy`: プライバシーポリシー "
    }
  },
  "required": [
    "template_id",
    "page_type"
  ],
  "additionalProperties": false
}

updateTemplatePage

指定テンプレートの指定ページ種別の 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 を参照。

Parameters3

template_id	integer	required	テンプレートID
page_type	string	required	ページ種別 - `index`: 共通 - `top`: トップ - `product_list`: 商品一覧 - `product`: 商品詳細 - `shopkeeper`: 特定商取引 - `product_srh`: 商品検索結果 - `option_stock`: オプション在庫・値段表 - `privacy`: プライバシーポリシー
template_page	object	required

Raw schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "template_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "テンプレートID"
    },
    "page_type": {
      "type": "string",
      "enum": [
        "index",
        "top",
        "product_list",
        "product",
        "shopkeeper",
        "product_srh",
        "option_stock",
        "privacy"
      ],
      "description": "ページ種別  - `index`: 共通 - `top`: トップ - `product_list`: 商品一覧 - `product`: 商品詳細 - `shopkeeper`: 特定商取引 - `product_srh`: 商品検索結果 - `option_stock`: オプション在庫・値段表 - `privacy`: プライバシーポリシー "
    },
    "template_page": {
      "type": "object",
      "properties": {
        "html": {
          "description": "HTMLコンテンツ。デザインテンプレートで利用できる独自タグを含めることが可能。 `index`（共通）ページ種別の場合、`<{include file = $file_name}>`タグを含める必要がある。 カラーミーショップで契約中のプランがプラチナ、プレミアムの場合、最大120,000文字。そのほかは、最大65,530文字。 ",
          "type": "string"
        },
        "css": {
          "description": "CSSコンテンツ。最大65,535文字",
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "template_id",
    "page_type",
    "template_page"
  ],
  "additionalProperties": false
}

README.md4 KBView on GitHub

Color Me Shop MCP Server

日本語版 README はこちら / Japanese README

The official remote Model Context Protocol (MCP) server for Color Me Shop — a Japanese e-commerce platform operated by GMO Pepabo, Inc.

Run your online store through natural conversation with AI. "Show me today's unprocessed orders" or "List products with 5 or fewer in stock" — delegate your shop operations to Claude and other MCP-capable AI tools.

Endpoint

code

https://agent.colorme.app/api/mcp

Transport: Streamable HTTP. Authentication: OAuth 2.1 with Dynamic Client Registration (handled automatically by supported clients).

Features

Order management — list and search orders (by date, customer, payment status), update, cancel, view sales statistics, send order emails, and generate payment URLs
Product management — list and search products, register, update, manage inventory/categories/groups, configure featured products
Customer management — list and search customers, register, update, award points, manage membership ranks
Coupon management — create, update, and delete coupons
Shop settings — inspect delivery methods, payment methods, gift settings, and product reviews

Access is scoped via Color Me Shop OAuth with least-privilege permissions.

Pricing

MCP server access is free on all Color Me Shop plans. Standard Color Me Shop subscription fees apply as usual.

Quick Start

Before connecting, install the "Color Me Shop AI Connector" app from the Color Me Shop App Store.

Claude Code

bash

claude mcp add --transport http colormeshop https://agent.colorme.app/api/mcp

Then run /mcp inside Claude Code and select Authenticate to complete the OAuth flow.

Claude Code MCP docs

Claude Desktop / claude.ai

Settings → Connectors → Add custom connector → enter:

code

https://agent.colorme.app/api/mcp

OAuth is handled automatically by Claude.

Cursor

Add to .cursor/mcp.json:

json

{
  "mcpServers": {
    "colormeshop": {
      "url": "https://agent.colorme.app/api/mcp"
    }
  }
}

OpenAI Codex CLI

bash

codex mcp add colormeshop --url https://agent.colorme.app/api/mcp

Gemini CLI

See the Gemini CLI MCP server documentation for adding remote MCP servers.

Local stdio bridge (advanced)

For clients that only support stdio transport, use mcp-remote:

json

{
  "mcpServers": {
    "colormeshop": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://agent.colorme.app/api/mcp"]
    }
  }
}

Documentation

Requirements

A Color Me Shop account
The "Color Me Shop AI Connector" app installed from the App Store
An MCP-compatible client (Claude Desktop, Claude Code, Cursor, OpenAI Codex CLI, Gemini CLI, etc.)

Support

For service-related inquiries: Color Me Shop contact
For issues with this repository: please open a GitHub Issue

Install

Tools (49)

getShopgetSalesstatSalegetSaleupdateSalecancelSalesendSalesMailcreatePaymentUrls

Remote endpoint

Streamable HTTP

Hosted server - connect over the network, no local install.

url

https://agent.colorme.app/api/mcp

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "colormeshop-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://agent.colorme.app/api/mcp"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.

io.github.pepabo/colormeshop-mcp (Color Me Shop MCP Server)

🛠️ Key Features

🚀 Use Cases

⚡ Developer Benefits

⚠️ Limitations

Topics

getShop

getSales

statSale

getSale

updateSale

cancelSale

sendSalesMail

createPaymentUrls

getCustomers

postCustomers

getCustomer

updateCustomers

postCustomerPoints

updateCustomerMembership

deleteCustomerGroupMembership

getProducts

postProducts

getProduct

updateProduct

getProductVariants

postProductPickup

putProductPickup

deleteProductPickup

getProductImages

getProductAdvertisings

getReviews

getStocks

getProductGroups

createProductGroup

getProductGroup

updateProductGroup

getProductCategories

createProductCategory

updateProductCategory

createProductCategoryChild

updateProductCategoryChild

getPayments

getDeliveries

getDeliveryDateSetting

getGift

getCoupons

createCoupon

getCoupon

deleteCoupon

updateCoupon

getTemplates

getTemplatePreview

getTemplatePage

updateTemplatePage

Color Me Shop MCP Server

Endpoint

Features

Pricing

Quick Start

Claude Code

Claude Desktop / claude.ai

Cursor

OpenAI Codex CLI

Gemini CLI

Local stdio bridge (advanced)

Documentation

Requirements

Support

Install

Remote endpoint

Related servers