アップデートのお知らせ

BカートAPIのアップデートに伴い、新たに下記のエンドポイントおよび検索における拡張パラメータがご利用いただけるようになりました。
※既存のエンドポイントや拡張パラメータに変更点はございません。

追加内容

エンドポイント

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

スコープ名 説明
user-read アカウント情報参照
estimates-read 見積情報参照
estimate_products-read 見積商品情報参照

拡張パラメータ

カンマ区切りの複数値において、「いずれか」または「すべて」を含む条件での絞り込みが可能になりました。

パラメータ 検索条件 マッチする値の例 マッチしない値の例
A__has = x,y Aの値が x,y のすべてを含む x,y
x,y,z
w,x,y		 w,z
x
y
A__has_any = x,y Aの値が x,y のいずれかを含む w,x
y,z		 w,z
A__has_not = x,y Aの値が x,y のすべてを含まない w,z
x
y		 x,y
x,y,z
w,x,y
A__has_not_any = x,y Aの値が x,y のいずれかを含まない w,z w,x
y,z

※値にカンマを含まない場合は単一値として扱います。

商品基本、商品セット、会員、受注、受注商品、見積、見積商品に含まれる配列形式のカスタム項目に対しても拡張パラメータによる絞り込みが可能になりました。

※カスタム項目（IDを配列のキーとして指定する項目）の場合は、検索方式文字列（has, has_any など）の後ろに[ID]を指定してください。下記は一例です。既存の拡張パラメータにおいても同様のルールにて指定が可能です（「or__B = x」を除く）。

例）検索対象の項目が「custom[6]」の場合

パラメータ 検索条件
customs__has[6] = x,y customs[6]の値が x,y のすべてを含む
customs__has_any[6] = x,y customs[6]の値が x,y のいずれかを含む
customs__has_not[6] = x,y customs[6]の値が x,y のすべてを含まない
customs__has_not_any[6] = x,y customs[6]の値が x,y のいずれかを含まない

拡張パラメータの詳細はAPIドキュメントをご確認ください。