光速总部”width=

    关系

    光速零售POS (——r)使用关系数据库。当查询一个端点,包括相关记录只有如果你指定他们应该被加载。

    加载关系

    您可以使用load_relationsURL参数,请求相关记录作为sub-records返回。应提供的关系作为一个JSON编码的数组。

    GET / API / V3 /账户/ {accountID} /项目/ {itemID} . json ? load_relations = (“ItemShops”)

    示例JSON响应

    {“@attributes”:{“数”:“1”},“项目”:{“itemID”:“20”,“systemSku”:“210000000020”,…“ItemShops”:{“ItemShop”:[{“itemShopID”:“4”,“qoh”:“2”,“透露”:“0”,“componentQoh”:“0”,“componentBackorder”:“0”,“reorderPoint”:“5”,“reorderLevel”:“10”,“时间戳”:“2017 - 04 - 25 - t16:07:38 + 00:00”,“itemID”:“2”,“shopID”:“1”,“m”:{“礼物”:“0”,“specialorders”:“0”,“workorders”:“0”}},{“itemShopID”:“146”,“qoh”:“0”,“透露”:“0”,“componentQoh”:“0”,“componentBackorder”:“0”,“reorderPoint”:“0”,“reorderLevel”:“0”,“时间戳”:“2016 - 11 - 01 t20:20:13 + 00:00”,“itemID”:“2”,“shopID”:“3”,“m”:{“礼物”:“0”,“specialorders”:“0”,“workorders”:“0”}},{“itemShopID”:“8”,“qoh”:“2”,“透露”:“0”,“componentQoh”:“0”,“componentBackorder”:“0”,“reorderPoint”:“0”,“reorderLevel”:“0”,“时间戳”:“2017 - 04 - 25 - t16:07:38 + 00:00”,“itemID”:“2”,“shopID”:“0”,“m”:{“礼物”:“0”,“specialorders”:“0”,“workorders”:“0”}}]},“价格”:{…}}}

    例如,库存水平叫ItemShops的项存储在相关记录。你需要加载项端点上的ItemShops关系看到这些数据。

    如这个例子所示,指定所需的关系用json编码的数组。您还可以指定load_relations =所有获得所有可用的关系(CustomFieldValues除外)。这便于测试,但不应该用于生产,因为它非常占用资源。CustomFieldValues值只加载如果显式指定数组的关系。

    指定一个特定的项ID的例子,但是load_relations参数也可以当请求多个记录。

    每个端点页面在这个文档列出了可用的关系。

    搜索的关系

    有时你可能需要搜索基于特定的值相关的记录。要做到这一点,你的名字会给你想要的关系和参数的名称使用的相关记录。你搜索的关系必须加载使用load_relations参数。

    例如,如果您正在寻找物品库存大于1,您将使用以下URI和滤波器的参数qoh字段ItemShops关系:

    https://api.lightspeedapp.com/API/V3/Account/ {AccountID} /项目? load_relations =“ItemShops &ItemShops.qoh = >, 1

    这将返回所有项目,至少有一个相关ItemShop记录满足条件(在这种情况下,现存数量大于1)

    只能搜索1水平的关系,也就是说,你可以搜索在SaleLines关系销售端点,但不是在SaleLines.Item。

    写作的关系

    可以创建或修改很多记录作为父记录的关系。例如,当创建一个销售,您可以创建销售额度和销售支付在同一载荷通过添加子对象的销售。看到销售教程对于一个完整的示例请求。

    示例请求

    {“firstName”:“简”,“姓”:“母鹿”,“接触”:{“手机”:{“ContactPhone”:{“数量”:“360 555 2453”,“useType”:“家”}},“电子邮件”:{“ContactEmail”:{“地址”:”(电子邮件保护)”,“useType”:“主”}}}}

    有些记录类型没有自己的端点,只能以这种方式创建和修改。客户联系信息是一个常见的例子。这个有效载荷可用于创建一个客户的电话号码和电子邮件地址发送POST请求客户端点。相同的载荷可以用来更新现有客户的联系信息(本例中还将更新名称)。

    Baidu
    map