受注カスタム項目、商品オプションに対応します

Bカート本体に追加されました受注カスタム機能と商品オプション機能を、APIでご利用いただける様にアップデートいたします。

エンドポイントの追加だけでなく既存のエンドポイントの一部に影響がございますので、ご確認をお願いいたします。


実施日時

2020年8月4日（火）午前10:00頃より実施いたします。

追加されるエンドポイント

  • 受注カスタム項目（order_customs）
  • 商品オプション（product_set_options）

影響のあるエンドポイント

  • 商品セット（product_sets）
  • 受注（orders）
  • 受注商品（order_products）

参考 Bカート本体側の変更点


受注カスタム項目（order_customs） エンドポイント追加

受注カスタム項目の設定の取得（GET）が可能になります。
※ 更新（PATCH）、追加（POST）は不可

レスポンス項目

キー名 Bカートでの名称 説明
id 受注カスタム項目ID
name 項目名
is_active 状態 無効=0、有効＝1
input_type フォームタイプ text/textarea/select/check/radioのいずれか
input_choices 選択肢の登録 text、textareaの場合はnull
input_choices[view_name] 選択肢の表示名
input_choices[value] 選択肢の値
sort_priority 表示順 -127~127


レスポンスサンプル

{
    "order_customs": [
        {
            "id": 1,
            "name": "受注カスタム項目1",
            "is_active": 1,
            "input_type": "text",
            "input_choices": null,
            "sort_priority": 0,
            "created_at": "2020-05-27 11:27:15",
            "updated_at": "2020-05-27 11:27:15"
        },
        {
            "id": 2,
            "name": "受注カスタム項目2",
            "is_active": 1,
            "input_type": "select",
            "input_choices": [
                {
                    "view_name": "セレクト1",
                    "value": 1
                },
                {
                    "view_name": "セレクト2",
                    "value": 2
                }
            ],
            "sort_priority": 5,
            "created_at": "2020-05-27 11:27:52",
            "updated_at": "2020-05-27 11:27:52"
        }
    ]
}



商品オプション（product_set_options） エンドポイント追加

商品オプションの設定の取得（GET）が可能になります。
※ 更新（PATCH）、追加（POST）は不可

レスポンス項目

キー名 Bカートでの名称 説明
id 商品オプションID
name 項目名
is_active 状態 無効=0、有効=1
input_type フォームタイプ text/textarea/select/check/radioのいずれか
input_rules 入力確認 text、textareaの場合はnull
input_rules[type] 入力確認、文字種の制限 全文字種/半角英字/半角英数字/整数/数値
input_rules[limit_type] 入力確認、文字数の制限 数値で指定=size/桁数で指定=digit ※typeが整数か数値の場合のみ
input_rules[limit_min] 入力確認、最小
input_rules[limit_max] 入力確認、最大
input_choices 選択肢の登録 select、check、radioの場合はnull
input_choices[view_name] 選択肢の表示名
input_choices[value] 選択肢の値
unit 単位
is_description_html 説明でHTMLを使用 しない=0、する=1
description 説明
required 入力確認 必須=true、任意=false
sort_priority 表示順 -127~127


レスポンスサンプル

{
    "product_set_options": [
        {
            "id": 1,
            "name": "商品オプション1",
            "is_active": 1,
            "input_type": "text",
            "input_choices": null,
            "input_rules": {
                "type": "整数",
                "limit_type": "size",
                "limit_min": "1",
                "limit_max": "10"
            },
            "unit": null,
            "is_description_html": 0,
            "description": "説明欄。\r\n最大10文字までです。",
            "required": false,
            "sort_priority": 0,
            "created_at": "2020-05-27 11:18:23",
            "updated_at": "2020-05-27 11:18:23"
        },
        {
            "id": 3,
            "name": "商品オプション2",
            "is_active": 1,
            "input_type": "select",
            "input_choices": [
                {
                    "view_name": "red",
                    "value": 1
                },
                {
                    "view_name": "blue",
                    "value": 2
                }
            ],
            "input_rules": null,
            "unit": "個",
            "is_description_html": 0,
            "description": "一つ選んでください",
            "required": false,
            "sort_priority": 1,
            "created_at": "2020-05-27 11:20:34",
            "updated_at": "2020-05-27 11:20:53"
        }
    ]
}



商品セット（product_sets）の変更点

商品セットに紐付くオプションのIDを取得（GET）、更新（PATCH）、追加（POST）が可能になります。

追加される項目

項目名 キー名 値
商品オプションID option_ids IDの配列


レスポンス、リクエストサンプル

{
    "product_set": {
        "id": 1,
        "product_id": 1,
        ~~~~~~~~~~~~
        一部省略
        ~~~~~~~~~~~~
        "option_ids": [
            1,
            2
        ],
        "shipping_group_id": 3,
        "shipping_size": 0
    }
}



受注（orders）の変更点

受注に紐付くカスタム項目のIDと値の取得（GET）が可能になります。
※ 更新（PATCH）は不可

追加される項目

項目名 キー名 値
受注カスタム項目 customs IDと値の配列
customs[field_id] 受注カスタム項目ID
customs[value] 入力された値


レスポンスサンプル

{
    "order": {
        "id": 128,
        "code": "13354411463",
        "memo": "電話番号 075-000-0000",
        ~~~~~~~~~~~~
        一部省略
        ~~~~~~~~~~~~
        "customs": [
            {
                "field_id": 1,
                "value": "急ぎ"
            },
            {
                "field_id": 2,
                "value": "以前不良品をお送りしている"
            }
        ],
        "enquete1": "1"
        ~~~~~~~~~~~~
        一部省略
        ~~~~~~~~~~~~
    }
}



受注商品（order_products）の変更点

受注商品に紐付く商品オプションのIDと値の取得（GET）が可能になります。
※ 更新（PATCH）は不可

追加される項目

項目名 キー名 値
商品オプション options IDと値の配列
options[field_id] 商品オプションID
options[value] 入力された値


レスポンスサンプル

{
    "order_product": {
        "id": 2,
        "order_id": 128,
        ~~~~~~~~~~~~
        一部省略
        ~~~~~~~~~~~~
        "options": [
            {
                "field_id": 1,
                "value": "1"
            },
            {
                "field_id": 2,
                "value": "有り"
            }
        ]
    }
}