如何通过Shopware 6 Store API获取订单的LineItems及配送信息

问题根源 #

Shopware 6的REST API默认不会自动返回订单的关联实体（如LineItems、deliveries），这类关联数据需要显式指定才能被包含在响应中——这是API的默认设计，目的是减少不必要的数据传输。

快速解决：用includes参数指定关联字段 #

在获取订单的API请求中，通过includes查询参数明确声明需要返回的关联实体及其具体字段：

单个订单查询示例 #

/api/order/{你的订单ID}?includes[order]=lineItems,deliveries&includes[order_line_item]=name,quantity,price&includes[order_delivery]=shippingMethodId,stateMachineState

• includes[order]=lineItems,deliveries：告知API返回订单对象下的lineItems和deliveries关联数据
• includes[order_line_item]=...：定义订单行项目需要返回的具体字段（按需添加）
• includes[order_delivery]=...：定义配送信息需要返回的具体字段（按需添加）

批量订单查询示例 #

如果是批量拉取订单列表，同样可以追加该参数：

/api/order?includes[order]=lineItems,deliveries&includes[order_line_item]=name,quantity&limit=20

额外检查点 #

• 确认使用的API版本（如v3）支持includes参数，dockware默认安装的Shopware稳定版均支持
• 验证API令牌权限：确保你的请求令牌拥有订单数据的读取权限（默认admin令牌具备完整权限）

其他可行请求方式 #

GraphQL API #

Shopware 6内置GraphQL接口，能更灵活地按需获取数据，无需拼接复杂的URL参数。示例查询：

query GetOrderDetails {
  order(id: "你的订单ID") {
    id
    orderNumber
    lineItems {
      name
      quantity
      price {
        totalPrice
      }
    }
    deliveries {
      shippingMethod {
        name
      }
      stateMachineState {
        name
      }
    }
  }
}

GraphQL的优势是可以精准定义返回字段，避免冗余数据，适合复杂的数据获取场景。

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