Shopware6文档API获取关联订单信息时请求报错问题咨询

问题原因 #

Shopware Admin API遵循RESTful规范：

• POST /api/document 是创建新文档的接口，因此会校验创建文档所需的必填字段（orderId、documentTypeId等），这就是你收到错误响应的核心原因。
• GET /api/document 才是获取文档列表的接口，你之前用GET能正常工作是符合接口设计规范的。

正确实现方式 #

要获取带订单关联的文档列表，需在GET /api/document请求中传递关联参数，具体有两种方式：

方式1：GET请求携带JSON请求体 #

保留你原本的关联结构，将请求方法改为GET，请求体保持不变：

{
    "associations": {
        "transactions": {
            "associations": {
                "order": {
                    "associations": {}
                }
            }
        }
    }
}

注意需设置请求头Content-Type: application/json，Shopware Admin API支持GET请求通过JSON体传递复杂参数。

方式2：通过URL查询参数传递关联 #

将关联结构编码为URL查询参数，示例请求URL：

/api/document?associations[transactions][associations][order]={}

这种方式适合简单关联结构，复杂场景推荐使用方式1。

额外扩展 #

如果需要添加过滤、分页等逻辑，可直接在请求体（GET方式）或查询参数中补充，比如添加文档类型过滤：

{
    "associations": {
        "transactions": {
            "associations": {
                "order": {
                    "associations": {}
                }
            }
        }
    },
    "filter": [
        {
            "type": "equals",
            "field": "documentTypeId",
            "value": "your-document-type-id"
        }
    ]
}

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