API Doc

# 4. 税费试算

# 简要描述

  • Swifood通过订单价格、服务费、折扣类型、折扣金额等信息，计算出商品的税费相关信息。

# HTTP请求信息

# 请求URL

  • {domain}/open-api/order/tax/calculate

# 请求方式

  • POST

# 请求头

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

# 请求体参数

参数名 是否必填 类型 长度 示例 说明
appId 是 string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 应用 id （Swifood 提供）
storeKey 是 string 100 CVIEIYUNHTS0 店铺标识 （Swifood 提供）
param 是 string - - 请求参数字符串
sign 是 string - param 的RSA签名

# Param 参数

参数名 是否必填 类型 长度 示例 说明
totalAmount 是 integer 0 - 100000000 1000 订单税后总价
serviceFee 否 integer 0 - 10000000 100 服务费
discountType 否 integer - 1 折扣类型 1：pwd折扣；2：普通折扣；4：sc折扣
discountAmount 否 integer - 100 普通折扣折扣金额 （当为普通打折时，该参数填写）
promoDiscountType 否 integer - 1 1整单折扣 2商品折扣
deliveryFee 否 integer - 100 配送费（外卖订单必填）
packingFee 否 integer - 100 打包费（外卖订单必填）
productInfo 否 List 1 - 210 - 商品信息

# Product Info Param

Parameter Name Required Type Length Limit Example Description
productName Yes string 1 - 50 coffee 商品名称
price Yes integer 0 - 1000000 100 商品税后单价 单位：分
quantity Yes integer 1 - 1000 1 商品数量
discountAmount No integer 1 - 1000000 商品折扣金额（当为普通打折时，该值必填）

# 请求体示例

{
  "appId": "OpenTestAppId",
  "storeKey": "OpenTestStoreKey",
  "sign": "OpenTestSign",
  "param": "{\"productInfo\":[{\"productName\":\"item1\",\"price\":100,\"quantity\": 1},{\"productName\":\"item2\",\"price\":100,\"quantity\":1}],\"totalAmount\":200}"
}

# 响应示例

# 状态码 Refer to this list

# 响应参数

参数名 类型 示 例 说明
code integer 10000 状态码 Refer to List
message string success 状态码说明
data string - 返回的参数
- productAmount integer 100 订单税前价格
- taxAmount integer - 订单税费金额
- vatableSales integer - 订单需要缴税的商品的税前总额，不包含服务费
- vatExemptSales integer - 订单免税商品（pwd折扣商品）税前销售金额
- vatExemption integer - 订单免税的税费金额
- zeroRatedSales integer - 订单免税商品
- discountedAmount integer 80 订单折扣后金额
- productTaxInfo List - 商品税费信息

# Product Tax Info Param

Parameter Name Type Length Limit Description
productName string 1 - 50 商品名称
productAmount integer 1 - 1000000 商品税前价格 单位：分
taxAmount integer - 税费金额
vatableSales integer - 需要缴税的商品的税前总额，不包含服务费
vatExemptSales integer - 免税商品（pwd折扣商品）税前销售金额
vatExemption integer - 免税的税费金额
zeroRatedSales integer - 免税商品
discountedAmount integer 80 订单折扣后金额
{
  "code": 10000,
  "message": "success",
  "data": {
    "productAmount": 200,
    "taxAmount": 12,
    "vatableSales": 100,
    "vatExemptSales": 0,
    "vatExemption": 0,
    "zeroRatedSales": 0,
    "productTaxInfo": [
      {
        "productName": "test1",
        "productAmount": 86,
        "taxAmount": 14,
        "vatableSales": 86,
        "vatExemptSales": 0,
        "vatExemption": 0,
        "zeroRatedSales": 0
      },
      {
        "productName": "test2",
        "productAmount": 90,
        "taxAmount": 16,
        "vatableSales": 90,
        "vatExemptSales": 0,
        "vatExemption": 0,
        "zeroRatedSales": 0
      }
    ]
  }
}

# 失败响应示例

{
    "code":21000,
    "message":"Service error, please contact administrator",
    "data":null
}

← 5. 查询订单 →