一方订单服务,采购单同步接口

路径 /industry/order/info/update
版本号 1.0.2
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 5000

请求参数

名称 类型 是否必选 示例值 描述
orderInfo Struct
externalId String 例如:淘宝账号id 外部账号ID
externalName String 例如:淘宝账号nick 外部账号名称
externalType String 102 淘宝账号:102;支付宝账号:101;1688账号:100
bizSource Int 2 业务来源:淘宝心选:1;天天特卖:2
orderId String 12345675432 主订单ID
orderStatus Int 1 订单状态(新增:1;删除:0)
tradeStatus Int 1 交易状态:0=生产中 1=完成
orderAmount Long 100000 订单数
orderPostage Long 10 订单邮费
orderTime Long 时间戳 下单时间
planTime Long 时间戳 计划完成时间
payTime Long 时间戳 支付时间
orderType Int 1 订单类型:1=外部订单
factoryExternalId String 3456786543 指定工厂外部账号ID
factoryExternalName String 张三 指定工厂外部账号名称
factoryExternalType String 淘宝账号:102;支付宝账号:101;1688账号:100 指定工厂外部账号类型
recipientName String 李四 收件人
recipientProvince String 浙江 收件省
recipientAddress String 文一西路969号 收件地址
recipientCode String 310000 邮编
recipientPhone String 手机号
recipientTel String 0571-123456 电话号码
orderSubInfoDTOs List 子订单信息
orderSubId String 确保每个主订单下唯一 子订单ID
itemId String 如淘宝订单的SKU 商品ID
itemName String 玩具 商品名称
itemNum Long 888 商品数量
itemPrice String 100 商品价格
itemBar String 987656789 商品条码
itemRfid String 87656789 商品rfid码
orderStatus Int 1 订单状态(新增:1;删除:0)
itemPic List http://abc.jpg 图片地址
cropId String 6789 企业唯一标识:如钉钉里的cropId,LH里的appId
userId String 789987 员工唯一标识:钉钉的userId、IOT的employeeId
source String DINGDING 钉钉填写DINGDING,多租户saas填写SAAS

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

响应结果

externalId String

外部账号ID

gmtCreate Long

创建时间

gmtModified Long

修改时间

externalName String

外部账号名称

externalType String

外部账号类型

bizSource Int

业务来源

orderId String

订单Id

orderStatus Int

订单状态

tradeStatus Int

交易状态

orderAmount Long

订单数量

orderPostage Long

订单邮费

orderTime Long

下单时间

planTime Long

计划完成时间

payTime Long

支付时间

orderType Int

orderType

factoryExternalId String

工厂外部账号ID

factoryExternalName String

工厂外部账号名称

factoryExternalType String

工厂外部账号类型

recipientName String

收件人

recipientProvince String

收件省

recipientAddress String

收件地址

recipientCode String

邮编

recipientPhone String

收件手机

recipientTel String

收件电话

orderSubInfoDTOs JSON

子订单信息

gmtCreate Long

创建时间

gmtModified Long

修改时间

orderSubId String

子订单id

itemId String

货品ID

itemName String

货品名称

itemPic JSON

货品图片

itemNum Long

货品数量

itemPrice Long

货品价格

itemBar String

货品条码

itemRfid String

货品RFID码

orderStatus Int

订单状态

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.2"
	},
	"params":{
		"orderInfo": "value0",
		"cropId": "6789",
		"userId": "789987",
		"source": "DINGDING"
	}
}

正常返回示例

JSON格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
                "annexes":[
                    "http://file.com/123",
                    "http://file.com/123"
                ],
                "companyName":"采购公司名称",
                "contractType":2,
                "dueTime":1560851982974,
                "externalId":"外部订单号",
                "orderId":123456789123456780,
                "orderProductDTOs":[
                    {
                        "amount":100000000,
                        "price":"8888.8888",
                        "productId":123456
                    }
                ],
                "orderTime":1560851982944,
                "recipientAddress":"详细地址",
                "recipientCity":"杭州",
                "recipientDistrict":"余杭",
                "recipientName":"收货人姓名",
                "recipientPhone":"收货人手机",
                "recipientProvince":"浙江",
                "remark":"备注",
                "totalAmount":"100000件",
                "totalPrice":8888888888888,
                "workingType":2
            }
}

异常返回示例

JSON格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}

错误码

HttpCode 错误码 错误信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error