格物 开放 API售后与开票

REST API · 接口参考

REST API 参考 · 员工福利购物 / 企业采购

售后与开票

售后按子订单发起,已发货的回传退货运单。企业购订单提交后自动开票,抬头取自注册时的企业信息。

#发起售后

POST/v1/enterprise/refunds

鉴权用户态

按子订单发起;一单多件时 subOrderId 必填(取自订单详情 subOrders)。退款金额退回员工额度。

请求体application/json

字段类型必填说明
bizOrderIdstring是
subOrderIdstring否
reasonIdstring否
reasonTextstring否
amountnumber否退款金额(元),不传按可退全额
needReturnboolean否是否需要寄回商品

返回字段

字段类型说明
okboolean
refundobject
refund.refundIdstring
refund.bizOrderIdstring
refund.subOrderIdstring
refund.statusinteger0 已撤销 / 1–8 处理中到完成,展示用 statusLabel
refund.statusLabelstring
refund.amountnumber
refund.reasonstring
refund.createdAtstring
subOrderIdstring

错误

  • 400 NOT_PAID / ORDER_CLOSED / SUB_ORDER_REQUIRED / SUB_ORDER_INVALID / REASON_INVALID / PROOF_REQUIRED / NO_REFUNDABLE_AMOUNT / SUBMIT_FAILED / NOT_FOUND 等

调用示例

1curl -X POST "https://api.gowu.net/v1/enterprise/refunds" \2  -H "x-app-key: $GOWU_APP_KEY" \3  -H "x-timestamp: $TS" \4  -H "x-nonce: $NONCE" \5  -H "x-sign-version: 2" \6  -H "x-signature: $SIG" \7  -H "x-open-user: u-001" \8  -H "content-type: application/json" \9  -d '{"bizOrderId":"…","reasonId":"…","amount":23.9,"needReturn":true}'

返回示例

1{2  "ok": true,3  "refund": {4    "refundId": "string",5    "bizOrderId": "string",6    "subOrderId": "string",7    "status": 0,8    "statusLabel": "string",9    "amount": 0,10    "reason": "string",11    "createdAt": "string"12  },13  "subOrderId": "string"14}

#售后列表

GET/v1/enterprise/refunds

鉴权用户态

查询参数

字段类型必填说明
limitinteger否默认 50。≥ 1,≤ 200

返回字段

字段类型说明
itemsobject[]
items[].refundIdstring
items[].bizOrderIdstring
items[].subOrderIdstring
items[].statusinteger0 已撤销 / 1–8 处理中到完成,展示用 statusLabel
items[].statusLabelstring
items[].amountnumber
items[].reasonstring
items[].createdAtstring

调用示例

1curl -X GET "https://api.gowu.net/v1/enterprise/refunds" \2  -H "x-app-key: $GOWU_APP_KEY" \3  -H "x-timestamp: $TS" \4  -H "x-nonce: $NONCE" \5  -H "x-sign-version: 2" \6  -H "x-signature: $SIG" \7  -H "x-open-user: u-001"

返回示例

1{2  "items": [3    {4      "refundId": "string",5      "bizOrderId": "string",6      "subOrderId": "string",7      "status": 0,8      "statusLabel": "string",9      "amount": 0,10      "reason": "string",11      "createdAt": "string"12    }13  ]14}

#售后详情 / 撤销、回传退货运单

GETPOST/v1/enterprise/refunds/{refundId}

鉴权用户态

GET

售后详情

路径参数

字段类型必填说明
refundIdstring是

返回字段

字段类型说明
refundIdstring
bizOrderIdstring
subOrderIdstring
statusinteger0 已撤销 / 1–8 处理中到完成,展示用 statusLabel
statusLabelstring
amountnumber
reasonstring
createdAtstring

错误

  • 404 资源不存在,或不归属你的 appKey / 当前用户

POST

撤销售后 / 回传退货运单

?action=cancel(缺省)撤销;?action=return 寄回商品后回传运单。失败返回 400 { ok: false, message }。

路径参数

字段类型必填说明
refundIdstring是

查询参数

字段类型必填说明
actionstring否可选值:cancel / return。默认 "cancel"

请求体application/json · 仅 action=return 时需要

字段类型必填说明
logisticsCompanystring否快递公司编码或中文名
invoiceNostring否退货运单号
mobilestring否

返回字段

字段类型说明
okboolean
messagestring

错误

  • 400 操作不允许,见 message

调用示例

1curl -X GET "https://api.gowu.net/v1/enterprise/refunds/{refundId}" \2  -H "x-app-key: $GOWU_APP_KEY" \3  -H "x-timestamp: $TS" \4  -H "x-nonce: $NONCE" \5  -H "x-sign-version: 2" \6  -H "x-signature: $SIG" \7  -H "x-open-user: u-001"

返回示例

1{2  "refundId": "string",3  "bizOrderId": "string",4  "subOrderId": "string",5  "status": 0,6  "statusLabel": "string",7  "amount": 0,8  "reason": "string",9  "createdAt": "string"10}

#开票记录

GET/v1/buyer/invoices

开票记录(状态、发票号、下载地址)

鉴权用户态

出现在福利 / 采购 · 售后、发票与账单

订单提交后自动开票,抬头取企业开户时的信息。最多返回最近 100 条。

返回字段

字段类型说明
itemsobject[]
items[].idstring
items[].purchaseOrderIdstring
items[].titlestring
items[].taxNostring
items[].amountstring
items[].statusstringapplied = 上游已受理;issued = 已开出。可选值:pending / applied / issued / failed / rejected
items[].upstreamInvoiceNosstring[]
items[].fileUrlstring发票下载地址(issued 后)
items[].upstreamErrorstringfailed 时上游给的原因
items[].createdAtstring

调用示例

1curl -X GET "https://api.gowu.net/v1/buyer/invoices" \2  -H "x-app-key: $GOWU_APP_KEY" \3  -H "x-timestamp: $TS" \4  -H "x-nonce: $NONCE" \5  -H "x-sign-version: 2" \6  -H "x-signature: $SIG" \7  -H "x-open-user: u-001"

返回示例

1{2  "items": [3    {4      "id": "string",5      "purchaseOrderId": "string",6      "title": "string",7      "taxNo": "string",8      "amount": "string",9      "status": "pending",10      "upstreamInvoiceNos": [11        "string"12      ],13      "fileUrl": "string",14      "upstreamError": "string",15      "createdAt": "string"16    }17  ]18}