Shopify GraphQL Admin API标签过滤查询失效（GraphQL应用中正常）

问题原因 #

你在NodeJS中用模板字符串定义GraphQL查询时，query: "tag:'Ship'"里的双引号经过JSON.stringify处理后会被转义，导致实际发送给Shopify API的查询参数格式错误，无法正确匹配标签。

比如模板字符串中的这段：

query: "tag:'Ship'"

经过JSON.stringify后会变成：

query: \"tag:'Ship'\"

Shopify API无法识别这种格式的过滤条件，因此返回空结果。

解决方案 #

以下三种修复方式，推荐使用第三种（GraphQL变量），更符合最佳实践：

1. 替换引号类型 #

把查询参数的外层双引号换成单引号，内部用双引号包裹标签值：

const ORDERS_QUERY = `
query {
  orders(first:10, query: 'tag:"Ship"') {
    edges {
      node {
        id
        tags
      }
    }
  }
}
`;

JSON.stringify处理后单引号不会被转义，传递给API的参数就是正确的tag:"Ship"。

2. 手动转义双引号 #

在模板字符串里对双引号进行转义，确保JSON.stringify后保留正确格式：

const ORDERS_QUERY = `
query {
  orders(first:10, query: \\"tag:'Ship'\\") {
    edges {
      node {
        id
        tags
      }
    }
  }
}
`;

这种方式可读性较差，不推荐。

3. 使用GraphQL变量（推荐） #

将过滤条件作为变量传递，彻底避免引号转义问题，同时提升代码可维护性：

export const getShipOrders = async (accessToken) => {
  const shopGraphQl = "https://#########.myshopify.com/admin/api/2023-01/graphql.json";

  const ORDERS_QUERY = `
query GetShipOrders($tagQuery: String!) {
  orders(first:10, query: $tagQuery) {
    edges {
      node {
        id
        tags
      }
    }
  }
}
  `;

  const body = {
    query: ORDERS_QUERY,
    variables: {
      tagQuery: "tag:'Ship'"
    }
  };

  const res = await fetch(shopGraphQl, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "X-Shopify-Access-Token": accessToken,
    },
    body: JSON.stringify(body),
  });

  console.log(`status = ${res.status}, ${res.statusText}`);
  console.log(
    "data returned:\n",
    JSON.stringify((await res.json()).data.orders.edges, null, 2)
  );
};

内容的提问来源于stack exchange，提问作者MasterBrog