アップデートのお知らせ(各種カスタム項目のPOST,PATCHエンドポイント追加など)

BカートAPIのアップデートに伴い、新たに下記のエンドポイントおよび一部カスタム項目におけるプロパティの追加を行いました。
これらのエンドポイントを利用することで、各種カスタム項目をアプリ側から登録・更新できるため、管理画面での手動の登録作業が不要となります。

追加内容

エンドポイント

ご利用いただくにはパーソナルアクセストークンまたはOAuth2.0でのトークン発行時に下記のスコープが必要です。

スコープ名 説明
product_customs-write 商品カスタム書込み
product_set_customs-write 商品セットカスタム書込み
product_set_options-write 商品オプション書込み
customer_customs-write 会員カスタム書込み
order_customs-write 受注カスタム書込み

各カスタム項目には登録上限がありますので、APIにおいても上限を超えて登録しようとした場合にはエラーレスポンスが返されます。

カスタム項目 登録上限
商品カスタム 10件
商品セットカスタム 10件
商品オプション 50件
会員カスタム 10件
受注カスタム 5件

プロパティ

商品カスタム、商品セットカスタム、会員カスタムのGET, PATCH, POSTのレスポンスに「no」プロパティが追加されました。

例)商品カスタム取得(GET product_customs/:id)のレスポンス

{
    "product_custom": {
        "id": 14,
        "no": 1, // ← 追加
        "name": "生産者",
        "is_active": 1,
        "show_flag": 1,
        "mail_flag": 1,
        "is_html": 1,
        "sort_priority": 0,
        "created_at": "2021-04-08 11:03:38",
        "updated_at": "2021-06-11 14:43:45"
    }
}

※これらのカスタム項目を登録(POST)する際は、「no」に既存のカスタム項目と重複しない値を指定いただく必要があります。

詳しくはAPIドキュメントをご確認ください。