未结清账单-销售订单列表接口

提供获取用户未结清账单对应的销售订单列表能力，支持分页查询，可获取订单的详细信息、客户信息及发货区域映射等相关数据。

适用场景

查询用户未结清账单所关联的销售订单信息

了解未结清账单对应的销售订单的额度消耗、状态等情况

接口类型

POST

请求频率限制

默认频率：以平台配额为准

请求说明

请求URL

正式环境：https://www.westmonth.com/openapi/quotaPeriod/getQuotaOrders
测试环境：https://testing.westmonth.com/openapi/quotaPeriod/getQuotaOrders

请求参数

Header参数

参数名	类型	必填	示例值	说明
Authorization	string	是	authorization	身份验证Token
Content-Type	string	是	application/json	建议固定传此值

Body参数

根字段

参数名	类型	必填	默认值	可选值	说明
page	integer	是	-	-	当前页码
page_size	integer	是	-	-	每页展示数量
customer_id	integer	否	-	-	客户ID
customer_uid	string	否	-	-	客户UID
customer_name	string	否	-	-	客户名称

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
code	integer	请求状态code
msg	string	请求状态说明
data	object	返回数据对象

data对象字段

字段	类型	说明
list	array	订单列表
total	integer	订单数量
quota_customer	object	客户主数据
delivery_region_type_formats	object	发货区域数据映射

list数组字段

字段	类型	说明
num	integer	账期期数
started_at	string	账期开始时间
id	integer	账期订单id
order_no	string	订单单号
quotax_period_id	integer	账期id
quota	string	消耗额度
refunded_quota	string	已退额度
order_id	integer	订单id
order_status	string	订单状态
shipped_at	string	发货时间
created_at	string	下单时间
customer_id	integer	客户id
customer_uid	string	客户uid
customer_name	string	客户名称
salesperson_name	string	业务员
salesperson_id	integer	业务员id
ended_at	string	账期结束时间
delivery_region_type	integer	发货区域（1国内；2国外）
quota_format	string	消耗额度-格式化
refunded_quota_format	string	已退额度-格式化

quota_customer对象字段

字段	类型	说明
customer_id	integer	客户id
customer_uid	string	客户uid
customer_name	string	客户名称

delivery_region_type_formats对象字段

字段	类型	说明
1	string	国内（发货区域类型为1时的说明）
2	string	国外（发货区域类型为2时的说明）

调用示例

URL请求

请求示例

{
  "page": 1,
  "page_size": 30
}

成功返回示例

{
    "code": 0,
    "msg": "",
    "data": {
        "list": [],
        "total": 0,
        "quota_customer": {
            "customer_id": 880,
            "customer_uid": "WM202405271201537338",
            "customer_name": "1"
        },
        "delivery_region_type_formats": {
            "1": "国内",
            "2": "海外"
        }
    }
}

失败返回示例

{
    "code": 3,
    "msg": "授权无效 authorization timestamp error",
    "data": []
}

错误处理

公共错误码

HTTP status code	错误码	错误信息	描述

常见问题

版本历史

版本	日期	修改说明
v1.0	2025-07-09	初始版本

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "",
    "data": {
        "list": [
            {
                "num": 1,
                "started_at": "2025-05-01",
                "id": 1025933,
                "order_no": "BOP2505211145020",
                "quotax_period_id": 3186,
                "quota": "68.23",
                "refunded_quota": "0.00",
                "order_id": 1843515,
                "order_status": "failed",
                "shipped_at": "",
                "created_at": "2025-05-21",
                "customer_id": 19037,
                "customer_uid": "WM202505051127543538",
                "customer_name": "测试001",
                "salesperson_name": "程清梅",
                "salesperson_id": 311,
                "ended_at": "2025-08-31",
                "delivery_region_type": 2,
                "quota_format": "￥68.23",
                "refunded_quota_format": "￥0.00"
            }
        ],
        "total": 9,
        "quota_customer": {
            "customer_id": 19037,
            "customer_uid": "WM202505051127543538",
            "customer_name": "测试001"
        },
        "delivery_region_type_formats": {
            "1": "国内",
            "2": "海外"
        }
    }
}

未结清账单-销售订单列表

未结清账单-销售订单列表接口#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Body参数#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

常见问题#

版本历史#

请求参数

请求示例代码

返回响应

未结清账单-销售订单列表接口

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

版本历史