Skip to main content

getOrderList：批量获取订单列表

备注：为避免订单被重复获取，已经被标记为获取的订单默认会被过滤，如果想要获取已经被标记为获取的订单，请根据需要指定apiStatus参数；订单获取状态优先以order_status_val指定的状态为准，默认以订货宝管理后台的状态配置为准（默认待出库），如需要更改管理后台的状态配置，请联系管理员操作；如果没有指定order_status_val参数，且订货宝管理后台的状态配置中包含待审核状态，默认下单10分钟后才能获取成功，最少可配置为1分钟

入参

参数名称

是否必须

类型

描述

sKey

Y

String

用户令牌

begin

N

int

开始 默认0

step

N

int

条数，最大1000，默认100

order_status_val

N

String

自定义订单状态，多选用英文逗号隔开。如果指定了该状态值，获取订单时优先以该值为准进行匹配，否则以订货宝管理后台的状态配置为准进行匹配。

all：所有；

pricing：待核价；

pending：待审核；

stock_up：待出库；

shipped：待发货；

received：待收货；

finished：已完成；

forcedone：强制完成；

cancelled：已取消；

starttime

N

String

订单创建时间大于 格式：YYYY-MM-DD HH:ii:ss，系统按照有效时间计算，G8区时间

endtime

N

String

订单创建时间小于 格式：YYYY-MM-DD HH:ii:ss，系统按照有效时间计算，G8区时间

updateGe

N

String

修改时间大于 格式：YYYY-MM-DD HH:ii:ss，系统按照有效时间计算，G8区时间

updateLe

N

String

修改时间小于 格式：YYYY-MM-DD HH:ii:ss，系统按照有效时间计算，G8区时间

exceptionStatus

N

String

F：没有异常的订单，T：有异常的订单，all：所有订单，默认F

apiStatus

N

String

F：没有下载的订单，T：已下载的订单，all：所有订单，默认F

payStatus

N

String

付款状态

oblig：待收款；

uncollect：部分收款；

paided：已收款；

cancelled：已取消；

wait：待确认；

part：部分确认
入参示例
{
    "f":"getOrderList",
    "v":{
        "sKey":"d6eeb8243c589b7f5dc840b3a4c0a31a",
        "begin":0,
        "step":100
    }
}
返回参数

参数名称

类型

描述、 返回字段

rStatus

String

100：正常 其他：异常

message

String

信息描述

rTotal

String

数据总行数

rData

String

具体信息

rData 参数：

参数名称

类型

描述

OrderSN

String

订单编号

DeliveryDate

String

交货日期 格式：YYYY-MM-DD，若无值，则返回空或字符型null

OrderRemark

String

订单备注信息

OrderTotal

Float

金额

OrderStatus

String

订单状态，pricing：待核价；pending：待审核；stockup：待出库；shipped：待发货；received：待收货；finished：已完成；forcedone：强制完成；cancelled：已取消；

OrderDate

Int

订单提交时间  unix时间戳，10位整型

OrderUpdateDate

Int

订单修改时间 10位时间戳

OrderUpdateTime

datetime

订单修改时间 datetime 例 2018-01-01 12:00:00

OrderType

String

订单类型

C：经销商提交订单[is_admin_order=F]；

M：管理端代提交订单[is_admin_order=T]；

S：业务员代提交订单[3.0已取消]

OrderApi

String

同步状态 T：已同步过；F或为空，没有同步过

OrderSendType

String

发货方式

lastOrderAt

Int

客户上次提交订单时间

ClientNO

String

客户编号

ClientGUID

String

客户guid

IsAdminOrder

String

订单来源：T，管理端；F：订货端

SourceDevice

String

下单渠道

PayStatus

String

付款状态

oblig：待收款；

uncollect：部分收款；

paided：已收款；

cancelled：已取消；

wait：待确认；

part：部分确认

SplitType

String

拆单类型ID

SplitTypeName

String

拆单类型名称
返参示例
反参示例:

{
    "rStatus": 100,
    "message": "success",
    "rTotal": "4",
    "rData": [
        {
            "OrderSN": "DH.20200407.0002",
            "DeliveryDate": "1970-01-01",
            "OrderRemark": "",
            "OrderTotal": "10.0000",
            "OrderStatus": "stockup",
            "OrderDate": 1586247393,
            "OrderUpdateDate": 1586247403,
            "OrderUpdateTime": "2020-04-07 16:16:43",
            "OrderType": "normal",
            "OrderApi": "F",
            "OrderException": "F",
            "OrderSendType": "快递",
            "lastOrderAt": "2020-04-02 11:45:03",
            "ClientNO": "10099",
            "ClientGUID": "37413",
            "SourceDevice": "compute",
            "IsAdminOrder": "T",
            "PayStatus": "oblig"
        },
        {
            "OrderSN": "DH.20200426.0027",
            "DeliveryDate": "1970-01-01",
            "OrderRemark": "",
            "OrderTotal": "1000.0000",
            "OrderStatus": "stockup",
            "OrderDate": 1587890231,
            "OrderUpdateDate": 1587890238,
            "OrderUpdateTime": "2020-04-26 16:37:18",
            "OrderType": "normal",
            "OrderApi": "F",
            "OrderException": "F",
            "OrderSendType": "快递",
            "lastOrderAt": "2020-04-23 14:26:27",
            "ClientNO": "10099",
            "ClientGUID": "37413",
            "SourceDevice": "compute",
            "IsAdminOrder": "T",
            "PayStatus": "oblig",
            "splitType": "0",
            "splitTypeName": "A类"
        },
        {
            "OrderSN": "DH.20200426.0028",
            "DeliveryDate": "1970-01-01",
            "OrderRemark": "",
            "OrderTotal": "1000.0000",
            "OrderStatus": "stockup",
            "OrderDate": 1587890873,
            "OrderUpdateDate": 1587890878,
            "OrderUpdateTime": "2020-04-26 16:47:58",
            "OrderType": "normal",
            "OrderApi": "F",
            "OrderException": "F",
            "OrderSendType": "快递",
            "lastOrderAt": "2020-04-26 16:37:11",
            "ClientNO": "10099",
            "ClientGUID": "37413",
            "SourceDevice": "compute",
            "IsAdminOrder": "T",
            "PayStatus": "oblig"
        },
        {
            "OrderSN": "DH.20200426.0029",
            "DeliveryDate": "1970-01-01",
            "OrderRemark": "",
            "OrderTotal": "100000.0000",
            "OrderStatus": "stockup",
            "OrderDate": 1587893171,
            "OrderUpdateDate": 1587893211,
            "OrderUpdateTime": "2020-04-26 17:26:51",
            "OrderType": "normal",
            "OrderApi": "F",
            "OrderException": "F",
            "OrderSendType": "请选择",
            "lastOrderAt": "2020-04-26 16:47:53",
            "ClientNO": "10099",
            "ClientGUID": "37413",
            "SourceDevice": "android",
            "IsAdminOrder": "T",
            "PayStatus": "oblig",
            "splitType": "1111",
            "splitTypeName": "B类"
        }
    ]
}
Back to top