# 5.查询订单发票

# 简要描述

  • 查询指定 Swifood 订单的支付小票或退款小票,并以 PDF、TXT 或 JSON 格式返回。
  • 本接口仅查询发票内容,不记录打印次数,也不会产生重打印标识。

# HTTP 请求信息

# 请求 URL

  • {domain}/open-api/order/invoice

# 请求方式

  • POST

# 请求头

参数名 是否必填 类型 说明
Content-Type 是 string application/json

# 请求体参数

参数名 是否必填 类型 长度 示例 说明
appId 是 string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 应用 ID(由 Swifood 提供)
storeKey 是 string 100 CVIEIYUNHTS0 店铺标识(由 Swifood 提供)
param 是 string - - JSON 格式的业务参数字符串
sign 是 string - abcdef param 的 RSA 签名,参阅接口签名流程

# Param 参数

参数名 是否必填 类型 示例 说明
orderNo 是 string TB202610120001 Swifood 订单号
printType 是 integer 2 小票类型:2 支付小票,6 退款小票
format 是 integer 1 输出格式:1 PDF,2 TXT,3 JSON

# 请求体示例

{
  "appId": "45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892",
  "storeKey": "CVIEIYUNHTS0",
  "sign": "abcdef",
  "param": "{\"orderNo\":\"TB202610120001\",\"printType\":2,\"format\":3}"
}

使用应用私钥对原始 param 字符串进行 RSA 签名。请求中的 param 必须与生成 sign 时使用的字符串完全一致。

# 成功响应

响应内容和 Content-Type 取决于请求参数 format。

format 输出格式 Content-Type 响应内容
1 PDF application/pdf 58 mm 宽的 PDF 文件流;响应头 Content-Disposition 为 inline; filename="invoice-{orderNo}.pdf"
2 TXT text/plain;charset=UTF-8 UTF-8 编码的纯文本小票,各行以换行符分隔
3 JSON application/json;charset=UTF-8 结构化的小票行内容

# PDF 响应示例

响应体为 PDF 二进制内容,可直接预览或保存为文件。

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: inline; filename="invoice-TB202610120001.pdf"

%PDF-...

# TXT 响应示例

SWIFOOD RESTAURANT
Invoice No: 000000000001
Order No: TB202610120001
...

# JSON 响应参数

参数名 类型 说明
orderContent array<string> 小票内容,按行拆分

# JSON 响应示例

{
  "orderContent": [
    "SWIFOOD RESTAURANT",
    "Invoice No: 000000000001",
    "Order No: TB202610120001"
  ]
}

# 失败响应

当订单不存在、指定类型的小票不存在或小票内容为空时,接口返回错误响应,例如:

{
  "code": 21000,
  "message": "Invoice content not found.",
  "data": null
}

其他状态码请参阅 API 通用提示码。