filter・sort の利用方法

『奉行クラウド』の［検索条件設定］画面のように複雑な絞込条件に対応する API は、リクエストボディに filter（絞込条件）と sort（並び順）を指定できる仕組みを用意しています。
詳細は、API ごとのリファレンスをご参照ください。

条件の形式

奉行クラウド API の filter・sort の利用方法は、以下の形式になります。
対応している各 API で指定できる項目は異なるので、API ごとのリファレンスをご参照ください。

Request Body

{
    "filter": {
        "itemKey": "Key",
        "operator": "eq",
        "value": "検索値"
    },
    "sort": [
        "Key1 desc",
        "Key2"
    ]
}

filter（絞込条件）の指定方法

filter（絞込条件）は「itemKey」、「operator」、「value」で構成されています。

operator

奉行クラウド API で利用可能な operator は以下のとおりです。
『奉行クラウド』の［検索条件設定］画面の指定方法で選択できない演算子は、指定できません。

利用例

簡易な絞込

例：ExportGoods「商品コードが「C-00001」と等しいもの」

{
    "filter": {
        "itemKey": "SD3010001",
        "operator": "eq",
        "value": "C-00001"
    }
}

高度な絞込

「簡易な絞込」を「and」「or」に配列として指定することで「（条件１ かつ 条件２）または（条件３）」のように絞込ができます。

例：ExportGoods「（商品コードが「C-00001」以上　かつ　商品コードが「C-00003」以下）または（商品名に「Tシャツ」を含む）」

{
    "filter": {
        "or": [
            {
                "and": [
                    {
                        "itemKey": "SD3010001",
                        "operator": "ge",
                        "value": "C-00001"
                    },
                    {
                        "itemKey": "SD3010001",
                        "operator": "le",
                        "value": "C-00003"
                    }
                ]
            },
            {
                "itemKey": "SD3010002",
                "operator": "like",
                "value": "Tシャツ"
            }
        ]
    }
}