Square Connect API:检索类别中的所有项目

时间:2017-12-04 22:39:35

标签: square square-connect

我一直在阅读Square Connect API并搞乱目录部分。

我无法找到如何检索与特定类别相关联的所有项目及其数据。有人可以指出我正确的方向。

我以为是

BatchRetrieveCatalogObjects endpoint

我使用的是类别ID,但它只返回了目录的数据。我需要项目的每个ID来检索他们的个人数据。

我希望在JSON中的一个请求中传播所有项目及其数据的列表。

要传递给端点的JSON数据:

data = {
                "object_ids": [
                    "category id"
                ],
                "include_related_objects": True
            }

我与API的关联:

 category_item_endpoint =  self.connection.post('/v2/catalog/batch-retrieve', data)

我正在使用python3和请求库。

2 个答案:

答案 0 :(得分:1)

您可能最幸运的是列出整个目录GET /v2/catalog/list,然后在获取数据后应用过滤(在本例中为特定的catagory_id)。根据文档做你想要的东西,端点/查询组合似乎不可能。

答案 1 :(得分:1)

为了列出类别中的项目,我发现使用 / v2 / catalog / search 端点是最简单的。只需遵循有关接受哪些参数的文档即可。以下是我用来按类别ID列出项目的搜索参数。

let sParams: JSON = [
        "object_types": [
            "ITEM"
        ],
        "include_related_objects": true,
        "include_deleted_objects": false,
        "query": [
            "exact_query": [
                "attribute_name": "category_id",
                "attribute_value": id
            ]
        ],
        "limit": 1000
    ]