版权所有©,上海海鼎信息工程股份有限公司,2016-2025,保留所有权利。
1. 接口定义
1.1. 客户提货服务
1.1.1. 订单呼叫云打印
POST /{tenant_id}/storedelivery/deliverservice/order/call/cloud/print
1.1.1.1. 说明
订单呼叫云打印
1.1.1.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
param |
参数 |
1.1.1.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.1.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/order/call/cloud/print?operator=string
请求 body
{
"printer" : "string",
"order_id" : "string",
"tpl_names" : [ "string" ]
}
1.1.1.5. HTTP响应示例
响应 200
{
"message" : "string",
"success" : true
}
1.1.2. 订单取消平台配送
POST /{tenant_id}/storedelivery/deliverservice/order/deliver/thirdparty/cancel
1.1.2.1. 说明
订单取消平台配送
1.1.2.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
body |
1.1.2.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.2.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/order/deliver/thirdparty/cancel?operator=string
请求 body
{
"order_id" : "111"
}
1.1.2.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.3. 打印结果回传
POST /{tenant_id}/storedelivery/deliverservice/order/printResult
1.1.3.1. 说明
打印结果回传
1.1.3.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
request |
回传结果请求 |
1.1.3.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.3.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/order/printResult?operator=string
请求 body
{
"id" : "string",
"printer" : "JPOS",
"time" : "2020-06-17 10:00:00",
"success" : true,
"message" : "string",
"business_type" : "order、orderPickTask",
"business_key" : "123456",
"tmpl_names" : "[\"外卖订单\", \"拣货单\"]"
}
1.1.3.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.4. 取指定订单
GET /{tenant_id}/storedelivery/deliverservice/order/{id}
1.1.4.1. 说明
取指定订单,如果需要获取订单商品明细等其他信息,URL需要传parts参数
1.1.4.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
orderId |
订单id |
string |
Path |
tenant_id |
租户ID |
string |
Query |
parts |
返回多个部分用英文,隔开。需要返回的部分,items(商品详情)、item.details(商品组合详情),、item.details(商品组合详情)、item.change.records(换货记录)、paymentDetails(支付详情)、invoiceDetails(发票详情)、printBills(打印数据)、prom(促销详情)、crm(营销详情)、logs(日志详情)、waybill.printinfo(运单打印信息) |
string |
1.1.4.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.4.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/order/{id}
1.1.4.5. HTTP响应示例
响应 200
{
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "88822222222",
"shop" : {
"id" : "string",
"name" : "string"
},
"source" : "小程序",
"state" : "string",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "脱敏名称**",
"private_mobile" : "189389928893"
}
},
"weight" : 500.0,
"invoice" : {
"required" : false,
"result" : "开票成功",
"details" : [ {
"type" : "plain",
"kind" : "paper",
"title" : "XX公司",
"content" : "上海股份有限公司",
"amount" : 12.03,
"tax" : 2.32,
"account" : "0023415445",
"telephone" : "12344545111",
"bank" : "中国银行XXX",
"address" : "福建厦门XX",
"remark" : "plain",
"email" : "chw@qq.com",
"time" : "2019-07-15 16:56:23",
"url" : "a.jpg",
"title_type" : "person",
"buyer_tax_code" : "1232000046600736XP",
"taxer_id" : "1212345046600736XP",
"print_number" : "123456",
"securaty_code" : "2114445",
"check_code" : "201622",
"serial_no" : "454557884564545"
} ],
"error_reason" : "string",
"apply_qrcode" : "string"
},
"payment" : {
"type" : "online",
"state" : "paid",
"payee" : {
"id" : "string",
"name" : "string"
},
"amount" : 14.02,
"freight" : 14.02,
"details" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"type" : "5",
"amount" : 12.33,
"cashier" : true,
"score" : 100.0,
"flowno" : "3223232323",
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"pay_time" : "2019-03-02 12:00:01",
"pay_bill_id" : "0122333333",
"cod_amount" : 0.0,
"earnest_amount" : 0.0,
"package_total" : 14.02,
"other_fee" : 0.0
},
"delivery" : {
"type" : "deliver",
"state" : "none",
"receiver" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "脱敏名称**",
"private_mobile" : "189389928893"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"remark" : "定时达",
"operation_state" : "none",
"ship_mode" : "string",
"ship_delivery_mode" : "string",
"wrh_order_id" : "32323",
"ship_id" : "23232323",
"waybill_id" : "123",
"carrier_note" : "加快",
"pre_type" : "normal:正常,dsd:定时达,half_day:半日达",
"pre_start_delivery_time" : "2016-03-02 12:00:01",
"pre_end_delivery_time" : "2016-03-02 14:00:01",
"pickup_code" : "123456",
"city_token" : "123456",
"selftake_code" : "123456",
"pre_selftake_time" : "03月05日 晚上",
"selftake_confirmed" : true
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:01",
"modified" : "2016-03-02 12:00:01",
"state" : "已付款",
"attribute" : "string",
"order_id" : "1223654",
"main_order_id" : "1223432",
"inner_order_id" : "1223432",
"dpt_station_time" : "2016-03-02 12:00:01",
"station_id" : "254145",
"station_name" : "254145",
"station_order_no" : "1",
"finished_time" : "2016-03-02 12:00:01",
"order_type" : {
"id" : "string",
"name" : "string"
},
"wrh_id" : "string"
},
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 1.0,
"total" : 2.0,
"front" : {
"spec" : "蓝色;微甜 少冰/多糖",
"spec2" : "500g",
"unit" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ],
"tags" : [ {
"id" : "string",
"name" : "string"
} ],
"sku_id" : "052700601",
"spu_id" : "052700601",
"item_id" : "052700601"
},
"details" : [ {
"id" : "121212",
"title" : "矿泉水",
"quantity" : 4.0,
"ratio" : 3.0,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"package_info" : {
"thermosphere" : "string",
"quantity" : 125.0,
"total" : 205.44,
"packageName" : "保温袋"
},
"front_spec" : "辣",
"real_quantity" : 0.0,
"fault_tolerant_info" : "string",
"trace_codes" : [ "string" ],
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"item_no" : "1",
"sku_id" : "00321",
"product_id" : "2123",
"item_title" : "葡萄",
"unit_price" : 2.0,
"purchase_price" : 2.0,
"weight" : 1.0,
"pay_amount" : 2.0,
"discount_amount" : 12.02,
"apported_discount_amount" : 12.02,
"package_qty" : 125.0,
"package_total" : 205.44,
"price" : 122.34,
"cost_price" : 122.34,
"shop_price" : 122.22,
"shop_total" : 122.22,
"settle_price" : 122.2222,
"settle_total" : 122.22,
"settle_discountAmount" : 122.22,
"consume_scores" : 12.2,
"image_url" : "http://aaa/bbb.png",
"item_id" : "1",
"is_collocation" : false,
"relation_item_id" : "2123",
"relation_sku_id" : "2123",
"orig_mas_sku_id" : "string",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_weight" : 1.0,
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"weight" : 0.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"orig_extra_info" : {
"spec" : "1*1",
"unit" : "个"
},
"fault_tolerant_info" : "string",
"salesman" : {
"id" : "string",
"name" : "string"
},
"trace_codes" : [ "string" ],
"extra_info" : "{\"inv_mgr\": false}",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"service_options" : "清洁/杀菌",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ]
},
"order_store" : {
"id" : "string",
"name" : "string"
},
"approve_state" : "none",
"wrh_state" : "initial",
"customer_note" : "note",
"seller_note" : "note",
"cancel_type" : "customerCancel",
"cancel_reason" : "我不想要了",
"source_order_id" : "5346567534545645",
"suspend_info" : {
"suspended" : true,
"code" : "string",
"caption" : "string",
"time" : "2017-12-26 16:40:19"
},
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "商品不存在",
"is_private" : true,
"item_count" : 1,
"sku_quantity" : 1.0,
"real_total" : 120.01,
"orig_total" : 120.01,
"user_number" : 2,
"settle_amount" : 120.01,
"settle_commission" : 120.01,
"selttle_commission" : 120.01,
"settle_freight" : 120.01,
"performance_service_fee" : 120.01,
"shop_amount" : 120.01,
"freight_discount" : 33.33,
"package_discount" : 33.33,
"invoice_take_code" : "string",
"fault_tolerant_info" : "string",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"calc_data" : true,
"wrh_id" : "4184",
"tags" : [ {
"name" : "首单"
} ],
"reissue_reason" : "string",
"responsible_party" : "string",
"sale_order_id" : "string",
"allow_actions" : [ "string" ],
"address_change_fee" : 0.0,
"item_change_records" : [ {
"reason" : "string",
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 1.0,
"total" : 2.0,
"front" : {
"spec" : "蓝色;微甜 少冰/多糖",
"spec2" : "500g",
"unit" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ],
"tags" : [ {
"id" : "string",
"name" : "string"
} ],
"sku_id" : "052700601",
"spu_id" : "052700601",
"item_id" : "052700601"
},
"details" : [ {
"id" : "121212",
"title" : "矿泉水",
"quantity" : 4.0,
"ratio" : 3.0,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"package_info" : {
"thermosphere" : "string",
"quantity" : 125.0,
"total" : 205.44,
"packageName" : "保温袋"
},
"front_spec" : "辣",
"real_quantity" : 0.0,
"fault_tolerant_info" : "string",
"trace_codes" : [ "string" ],
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"item_no" : "1",
"sku_id" : "00321",
"product_id" : "2123",
"item_title" : "葡萄",
"unit_price" : 2.0,
"purchase_price" : 2.0,
"weight" : 1.0,
"pay_amount" : 2.0,
"discount_amount" : 12.02,
"apported_discount_amount" : 12.02,
"package_qty" : 125.0,
"package_total" : 205.44,
"price" : 122.34,
"cost_price" : 122.34,
"shop_price" : 122.22,
"shop_total" : 122.22,
"settle_price" : 122.2222,
"settle_total" : 122.22,
"settle_discountAmount" : 122.22,
"consume_scores" : 12.2,
"image_url" : "http://aaa/bbb.png",
"item_id" : "1",
"is_collocation" : false,
"relation_item_id" : "2123",
"relation_sku_id" : "2123",
"orig_mas_sku_id" : "string",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_weight" : 1.0,
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"weight" : 0.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"orig_extra_info" : {
"spec" : "1*1",
"unit" : "个"
},
"fault_tolerant_info" : "string",
"salesman" : {
"id" : "string",
"name" : "string"
},
"trace_codes" : [ "string" ],
"extra_info" : "{\"inv_mgr\": false}",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"service_options" : "清洁/杀菌",
"is_gift" : true
} ],
"change_items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 1.0,
"total" : 2.0,
"front" : {
"spec" : "蓝色;微甜 少冰/多糖",
"spec2" : "500g",
"unit" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ],
"tags" : [ {
"id" : "string",
"name" : "string"
} ],
"sku_id" : "052700601",
"spu_id" : "052700601",
"item_id" : "052700601"
},
"details" : [ {
"id" : "121212",
"title" : "矿泉水",
"quantity" : 4.0,
"ratio" : 3.0,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"package_info" : {
"thermosphere" : "string",
"quantity" : 125.0,
"total" : 205.44,
"packageName" : "保温袋"
},
"front_spec" : "辣",
"real_quantity" : 0.0,
"fault_tolerant_info" : "string",
"trace_codes" : [ "string" ],
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"item_no" : "1",
"sku_id" : "00321",
"product_id" : "2123",
"item_title" : "葡萄",
"unit_price" : 2.0,
"purchase_price" : 2.0,
"weight" : 1.0,
"pay_amount" : 2.0,
"discount_amount" : 12.02,
"apported_discount_amount" : 12.02,
"package_qty" : 125.0,
"package_total" : 205.44,
"price" : 122.34,
"cost_price" : 122.34,
"shop_price" : 122.22,
"shop_total" : 122.22,
"settle_price" : 122.2222,
"settle_total" : 122.22,
"settle_discountAmount" : 122.22,
"consume_scores" : 12.2,
"image_url" : "http://aaa/bbb.png",
"item_id" : "1",
"is_collocation" : false,
"relation_item_id" : "2123",
"relation_sku_id" : "2123",
"orig_mas_sku_id" : "string",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_weight" : 1.0,
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"weight" : 0.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"orig_extra_info" : {
"spec" : "1*1",
"unit" : "个"
},
"fault_tolerant_info" : "string",
"salesman" : {
"id" : "string",
"name" : "string"
},
"trace_codes" : [ "string" ],
"extra_info" : "{\"inv_mgr\": false}",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"service_options" : "清洁/杀菌",
"is_gift" : true
} ]
} ],
"pick_info" : {
"time" : "2020-06-17 10:00:00",
"source" : "string",
"operator_id" : "string",
"operator_name" : "string",
"auto_picked_finish" : true
},
"print_count" : 0
}
1.1.5. 打包明细修改
POST /{tenant_id}/storedelivery/deliverservice/order/{order_id}/mod/packInfo
1.1.5.1. 说明
打包明细修改
1.1.5.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
mod |
打包商品明细请求 |
1.1.5.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.5.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/order/{order_id}/mod/packInfo?operator_id=string
请求 body
{
"details" : [ {
"skuId" : "213323232",
"skuName" : "213323232",
"qty" : 1.0,
"amount" : 1.0
} ]
}
1.1.6. 查询数据库订单(新查询)
POST /{tenant_id}/storedelivery/deliverservice/orders/db/query
1.1.6.1. 说明
查询订单(新查询)
1.1.6.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
desc |
倒序 |
boolean |
Query |
page |
页码,从0开始,必须>=0 |
integer (int32) |
Query |
page_size |
分页大小,范围是[1,100] |
integer (int32) |
Query |
sort_key |
排序字段,取值范围:created(创建时间) |
string |
Body |
filter |
查询条件 |
1.1.6.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.6.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/orders/db/query?desc=true&page=0&page_size=0
请求 body
{
"station_id_in" : "[\"0001\"]",
"order_id_or_front_station_order_no_eq" : "01",
"order_id_eq" : "718597703857",
"front_created_start" : "2025-03-05 10:20:30",
"front_created_end" : "2025-03-05 16:28:32",
"pick_info_operator_id_eq" : "9527",
"pick_info_operator_id_in" : [ "string" ],
"operation_state_in" : "[\"accepted\"]",
"state_in" : "[\"confirmed\"]",
"created_start" : "2025-03-03 00:00:00",
"created_end" : "2025-03-03 23:59:59",
"need_count_total" : true,
"fetch_parts" : "items"
}
1.1.6.5. HTTP响应示例
响应 200
{
"total" : 100,
"page" : 1,
"orders" : [ {
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "88822222222",
"shop" : {
"id" : "string",
"name" : "string"
},
"source" : "小程序",
"state" : "string",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "脱敏名称**",
"private_mobile" : "189389928893"
}
},
"weight" : 500.0,
"invoice" : {
"required" : false,
"result" : "开票成功",
"details" : [ {
"type" : "plain",
"kind" : "paper",
"title" : "XX公司",
"content" : "上海股份有限公司",
"amount" : 12.03,
"tax" : 2.32,
"account" : "0023415445",
"telephone" : "12344545111",
"bank" : "中国银行XXX",
"address" : "福建厦门XX",
"remark" : "plain",
"email" : "chw@qq.com",
"time" : "2019-07-15 16:56:23",
"url" : "a.jpg",
"title_type" : "person",
"buyer_tax_code" : "1232000046600736XP",
"taxer_id" : "1212345046600736XP",
"print_number" : "123456",
"securaty_code" : "2114445",
"check_code" : "201622",
"serial_no" : "454557884564545"
} ],
"error_reason" : "string",
"apply_qrcode" : "string"
},
"payment" : {
"type" : "online",
"state" : "paid",
"payee" : {
"id" : "string",
"name" : "string"
},
"amount" : 14.02,
"freight" : 14.02,
"details" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"type" : "5",
"amount" : 12.33,
"cashier" : true,
"score" : 100.0,
"flowno" : "3223232323",
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"pay_time" : "2019-03-02 12:00:01",
"pay_bill_id" : "0122333333",
"cod_amount" : 0.0,
"earnest_amount" : 0.0,
"package_total" : 14.02,
"other_fee" : 0.0
},
"delivery" : {
"type" : "deliver",
"state" : "none",
"receiver" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "脱敏名称**",
"private_mobile" : "189389928893"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"remark" : "定时达",
"operation_state" : "none",
"ship_mode" : "string",
"ship_delivery_mode" : "string",
"wrh_order_id" : "32323",
"ship_id" : "23232323",
"waybill_id" : "123",
"carrier_note" : "加快",
"pre_type" : "normal:正常,dsd:定时达,half_day:半日达",
"pre_start_delivery_time" : "2016-03-02 12:00:01",
"pre_end_delivery_time" : "2016-03-02 14:00:01",
"pickup_code" : "123456",
"city_token" : "123456",
"selftake_code" : "123456",
"pre_selftake_time" : "03月05日 晚上",
"selftake_confirmed" : true
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:01",
"modified" : "2016-03-02 12:00:01",
"state" : "已付款",
"attribute" : "string",
"order_id" : "1223654",
"main_order_id" : "1223432",
"inner_order_id" : "1223432",
"dpt_station_time" : "2016-03-02 12:00:01",
"station_id" : "254145",
"station_name" : "254145",
"station_order_no" : "1",
"finished_time" : "2016-03-02 12:00:01",
"order_type" : {
"id" : "string",
"name" : "string"
},
"wrh_id" : "string"
},
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 1.0,
"total" : 2.0,
"front" : {
"spec" : "蓝色;微甜 少冰/多糖",
"spec2" : "500g",
"unit" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ],
"tags" : [ {
"id" : "string",
"name" : "string"
} ],
"sku_id" : "052700601",
"spu_id" : "052700601",
"item_id" : "052700601"
},
"details" : [ {
"id" : "121212",
"title" : "矿泉水",
"quantity" : 4.0,
"ratio" : 3.0,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"package_info" : {
"thermosphere" : "string",
"quantity" : 125.0,
"total" : 205.44,
"packageName" : "保温袋"
},
"front_spec" : "辣",
"real_quantity" : 0.0,
"fault_tolerant_info" : "string",
"trace_codes" : [ "string" ],
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"item_no" : "1",
"sku_id" : "00321",
"product_id" : "2123",
"item_title" : "葡萄",
"unit_price" : 2.0,
"purchase_price" : 2.0,
"weight" : 1.0,
"pay_amount" : 2.0,
"discount_amount" : 12.02,
"apported_discount_amount" : 12.02,
"package_qty" : 125.0,
"package_total" : 205.44,
"price" : 122.34,
"cost_price" : 122.34,
"shop_price" : 122.22,
"shop_total" : 122.22,
"settle_price" : 122.2222,
"settle_total" : 122.22,
"settle_discountAmount" : 122.22,
"consume_scores" : 12.2,
"image_url" : "http://aaa/bbb.png",
"item_id" : "1",
"is_collocation" : false,
"relation_item_id" : "2123",
"relation_sku_id" : "2123",
"orig_mas_sku_id" : "string",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_weight" : 1.0,
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"weight" : 0.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"orig_extra_info" : {
"spec" : "1*1",
"unit" : "个"
},
"fault_tolerant_info" : "string",
"salesman" : {
"id" : "string",
"name" : "string"
},
"trace_codes" : [ "string" ],
"extra_info" : "{\"inv_mgr\": false}",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"service_options" : "清洁/杀菌",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ]
},
"order_store" : {
"id" : "string",
"name" : "string"
},
"approve_state" : "none",
"wrh_state" : "initial",
"customer_note" : "note",
"seller_note" : "note",
"cancel_type" : "customerCancel",
"cancel_reason" : "我不想要了",
"source_order_id" : "5346567534545645",
"suspend_info" : {
"suspended" : true,
"code" : "string",
"caption" : "string",
"time" : "2017-12-26 16:40:19"
},
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "商品不存在",
"is_private" : true,
"item_count" : 1,
"sku_quantity" : 1.0,
"real_total" : 120.01,
"orig_total" : 120.01,
"user_number" : 2,
"settle_amount" : 120.01,
"settle_commission" : 120.01,
"selttle_commission" : 120.01,
"settle_freight" : 120.01,
"performance_service_fee" : 120.01,
"shop_amount" : 120.01,
"freight_discount" : 33.33,
"package_discount" : 33.33,
"invoice_take_code" : "string",
"fault_tolerant_info" : "string",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"calc_data" : true,
"wrh_id" : "4184",
"tags" : [ {
"name" : "首单"
} ],
"reissue_reason" : "string",
"responsible_party" : "string",
"sale_order_id" : "string",
"allow_actions" : [ "string" ],
"address_change_fee" : 0.0,
"item_change_records" : [ {
"reason" : "string",
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 1.0,
"total" : 2.0,
"front" : {
"spec" : "蓝色;微甜 少冰/多糖",
"spec2" : "500g",
"unit" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ],
"tags" : [ {
"id" : "string",
"name" : "string"
} ],
"sku_id" : "052700601",
"spu_id" : "052700601",
"item_id" : "052700601"
},
"details" : [ {
"id" : "121212",
"title" : "矿泉水",
"quantity" : 4.0,
"ratio" : 3.0,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"package_info" : {
"thermosphere" : "string",
"quantity" : 125.0,
"total" : 205.44,
"packageName" : "保温袋"
},
"front_spec" : "辣",
"real_quantity" : 0.0,
"fault_tolerant_info" : "string",
"trace_codes" : [ "string" ],
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"item_no" : "1",
"sku_id" : "00321",
"product_id" : "2123",
"item_title" : "葡萄",
"unit_price" : 2.0,
"purchase_price" : 2.0,
"weight" : 1.0,
"pay_amount" : 2.0,
"discount_amount" : 12.02,
"apported_discount_amount" : 12.02,
"package_qty" : 125.0,
"package_total" : 205.44,
"price" : 122.34,
"cost_price" : 122.34,
"shop_price" : 122.22,
"shop_total" : 122.22,
"settle_price" : 122.2222,
"settle_total" : 122.22,
"settle_discountAmount" : 122.22,
"consume_scores" : 12.2,
"image_url" : "http://aaa/bbb.png",
"item_id" : "1",
"is_collocation" : false,
"relation_item_id" : "2123",
"relation_sku_id" : "2123",
"orig_mas_sku_id" : "string",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_weight" : 1.0,
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"weight" : 0.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"orig_extra_info" : {
"spec" : "1*1",
"unit" : "个"
},
"fault_tolerant_info" : "string",
"salesman" : {
"id" : "string",
"name" : "string"
},
"trace_codes" : [ "string" ],
"extra_info" : "{\"inv_mgr\": false}",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"service_options" : "清洁/杀菌",
"is_gift" : true
} ],
"change_items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 1.0,
"total" : 2.0,
"front" : {
"spec" : "蓝色;微甜 少冰/多糖",
"spec2" : "500g",
"unit" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ],
"tags" : [ {
"id" : "string",
"name" : "string"
} ],
"sku_id" : "052700601",
"spu_id" : "052700601",
"item_id" : "052700601"
},
"details" : [ {
"id" : "121212",
"title" : "矿泉水",
"quantity" : 4.0,
"ratio" : 3.0,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"package_info" : {
"thermosphere" : "string",
"quantity" : 125.0,
"total" : 205.44,
"packageName" : "保温袋"
},
"front_spec" : "辣",
"real_quantity" : 0.0,
"fault_tolerant_info" : "string",
"trace_codes" : [ "string" ],
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"item_no" : "1",
"sku_id" : "00321",
"product_id" : "2123",
"item_title" : "葡萄",
"unit_price" : 2.0,
"purchase_price" : 2.0,
"weight" : 1.0,
"pay_amount" : 2.0,
"discount_amount" : 12.02,
"apported_discount_amount" : 12.02,
"package_qty" : 125.0,
"package_total" : 205.44,
"price" : 122.34,
"cost_price" : 122.34,
"shop_price" : 122.22,
"shop_total" : 122.22,
"settle_price" : 122.2222,
"settle_total" : 122.22,
"settle_discountAmount" : 122.22,
"consume_scores" : 12.2,
"image_url" : "http://aaa/bbb.png",
"item_id" : "1",
"is_collocation" : false,
"relation_item_id" : "2123",
"relation_sku_id" : "2123",
"orig_mas_sku_id" : "string",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_weight" : 1.0,
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"weight" : 0.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"orig_extra_info" : {
"spec" : "1*1",
"unit" : "个"
},
"fault_tolerant_info" : "string",
"salesman" : {
"id" : "string",
"name" : "string"
},
"trace_codes" : [ "string" ],
"extra_info" : "{\"inv_mgr\": false}",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"service_options" : "清洁/杀菌",
"is_gift" : true
} ]
} ],
"pick_info" : {
"time" : "2020-06-17 10:00:00",
"source" : "string",
"operator_id" : "string",
"operator_name" : "string",
"auto_picked_finish" : true
},
"print_count" : 0
} ],
"page_count" : 5,
"page_size" : 20
}
1.1.7. 查询订单(新查询)
POST /{tenant_id}/storedelivery/deliverservice/orders/query
1.1.7.1. 说明
查询订单(新查询)
1.1.7.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
desc |
倒序 |
boolean |
Query |
page |
页码,从0开始,必须>=0 |
integer (int32) |
Query |
page_size |
分页大小,范围是[1,100] |
integer (int32) |
Query |
sort_key |
排序字段,取值范围:front_created()、created(创建时间)、modified(最后修改时间) |
string |
Body |
filter |
查询条件 |
1.1.7.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.7.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/orders/query?desc=true&page=0&page_size=0
请求 body
{
"states" : [ "string" ],
"suspended" : true,
"source" : "小程序",
"prePage" : 0,
"hasInvoice" : false,
"platform_id" : "jdo2o",
"platform_ids" : [ "string" ],
"shop_id" : "0002",
"pre_type" : "normal",
"station_ids" : [ "string" ],
"approve_states" : [ "string" ],
"delivery_states" : [ "string" ],
"delivery_types" : [ "string" ],
"carrier_states" : [ "string" ],
"carrier_types" : [ "string" ],
"payment_states" : [ "string" ],
"payment_types" : [ "string" ],
"payment_out_pay_id" : "string",
"receiver_mobile" : "18857485554",
"receiver_mobile_like" : "5554",
"receiver_name" : "张三",
"carrier_id" : "0003",
"waybill_id" : "0003",
"front_order_id" : "32323232323323",
"front_order_id_prefix" : "32323232323323",
"front_order_ids" : "32323232323323",
"front_created_start" : "2016-03-02 12:00:01",
"front_created_end" : "2016-03-02 12:00:01",
"created_start" : "2016-03-02 12:00:01",
"created_end" : "2016-03-02 12:00:01",
"modified_start" : "2016-03-02 12:00:01",
"modified_end" : "2016-03-02 12:00:01",
"cancel_type" : "customerCancel",
"have_return" : true,
"refund_state" : "none",
"operation_state" : "none",
"operation_states" : "[none,shipping]",
"operation_shipping_time_start" : "2016-03-02 12:00:01",
"operation_shipping_time_end" : "2016-03-02 12:00:01",
"operation_handover_time_start" : "2016-03-02 12:00:01",
"operation_handover_time_end" : "2016-03-02 12:00:01",
"order_id" : "1000002111",
"order_ids" : [ "string" ],
"customer_name" : "张三",
"customer_id" : "8568",
"shipping_operator" : "张三",
"handover_operator" : "张三",
"address_contains" : "福建省",
"delivered_time_start" : "2016-03-02 12:00:01",
"delivered_time_end" : "2016-03-02 12:00:01",
"delivering_time_start" : "2016-03-02 12:00:01",
"delivering_time_end" : "2016-03-02 12:00:01",
"deliveryman_name" : "张三",
"delivery_id" : "111",
"product_contains" : "sku1111",
"sku_title" : "冰红茶",
"has_exception" : false,
"exception_code_contains" : "false",
"selftake_code" : "123456",
"index_modified_start" : "2016-03-02 12:00:01",
"index_modified_end" : "2016-03-02 12:00:01",
"has_billing" : true,
"has_customer_note" : true,
"bill_id_like" : "32323",
"bill_id_eq" : "3232323",
"customer_mobile" : "18896551546",
"custom_order_state" : [ "string" ],
"salesman_id_eq" : "3232323",
"app_id_eq" : "3232323",
"type_eq" : "拼团订单",
"has_delivery_exception" : true,
"front_main_order_id_eq" : "1223432",
"front_main_order_id_start_with" : "1223432",
"front_main_order_id_in" : "['123','456']",
"front_sku_id" : "string",
"sku_id" : "string",
"sku_id_in" : "[\"sku1\", \"sku2\"]",
"source_order_id_eq" : "213",
"source_order_id_in" : [ "string" ],
"wrh_id_start_with" : "3232323",
"wrh_id_in" : "3232323",
"vendor_code_eq" : "3232323",
"vendor_code_start_with" : "3232323",
"vendor_code_in" : "3232323",
"ship_mode" : "string",
"deliver_shipped_operator" : "rs",
"prom_id" : "string",
"prom_id_in" : [ "string" ],
"prom_key" : "string",
"prom_key_in" : [ "string" ],
"prom_name_like" : "string",
"fetch_parts" : "string",
"pick_info_source_eq" : "string",
"pick_info_operator_id_eq" : "string",
"pick_info_operator_id_in" : [ "string" ],
"pick_info_operator_name_like" : "string",
"pick_info_time_start" : "2020-06-17 10:00:00",
"pick_info_time_end" : "2020-06-17 10:00:00",
"pick_info_is_auto_picked_finish" : true,
"front_station_order_no_eq" : "string",
"order_id_or_front_station_order_no_eq" : "string",
"receiver_mobile_end_with" : "5554",
"customer_mobile_end_with" : "5554",
"receiver_private_mobile_end_with" : "string"
}
1.1.7.5. HTTP响应示例
响应 200
{
"total" : 100,
"page" : 1,
"orders" : [ {
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"id" : "88822222222",
"shop" : {
"id" : "string",
"name" : "string"
},
"source" : "小程序",
"state" : "string",
"customer" : {
"id" : "10001",
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "脱敏名称**",
"private_mobile" : "189389928893"
}
},
"weight" : 500.0,
"invoice" : {
"required" : false,
"result" : "开票成功",
"details" : [ {
"type" : "plain",
"kind" : "paper",
"title" : "XX公司",
"content" : "上海股份有限公司",
"amount" : 12.03,
"tax" : 2.32,
"account" : "0023415445",
"telephone" : "12344545111",
"bank" : "中国银行XXX",
"address" : "福建厦门XX",
"remark" : "plain",
"email" : "chw@qq.com",
"time" : "2019-07-15 16:56:23",
"url" : "a.jpg",
"title_type" : "person",
"buyer_tax_code" : "1232000046600736XP",
"taxer_id" : "1212345046600736XP",
"print_number" : "123456",
"securaty_code" : "2114445",
"check_code" : "201622",
"serial_no" : "454557884564545"
} ],
"error_reason" : "string",
"apply_qrcode" : "string"
},
"payment" : {
"type" : "online",
"state" : "paid",
"payee" : {
"id" : "string",
"name" : "string"
},
"amount" : 14.02,
"freight" : 14.02,
"details" : [ {
"code" : "支付方式代码",
"name" : "支付宝",
"type" : "5",
"amount" : 12.33,
"cashier" : true,
"score" : 100.0,
"flowno" : "3223232323",
"account_no" : "002002",
"account_name" : "工行",
"discount_amount" : 100.0,
"pay_id" : "3223232323",
"out_pay_id" : "3223232323",
"extra_info" : "{\"session\", \"123\"}"
} ],
"extra" : [ {
"id" : "distance_freight",
"name" : "远距离运费",
"value" : "0.01"
} ],
"pay_time" : "2019-03-02 12:00:01",
"pay_bill_id" : "0122333333",
"cod_amount" : 0.0,
"earnest_amount" : 0.0,
"package_total" : 14.02,
"other_fee" : 0.0
},
"delivery" : {
"type" : "deliver",
"state" : "none",
"receiver" : {
"contact" : {
"name" : "李飞",
"telephone" : "189389928893",
"mobile" : "189389928893",
"email" : "55151@qq.com",
"fax" : "123123",
"private_name" : "脱敏名称**",
"private_mobile" : "189389928893"
},
"address" : {
"country" : "中国",
"province" : "福建省",
"city" : "厦门市",
"district" : "思明区",
"street" : "前埔",
"postcode" : "363423",
"latitude" : "45.3,范围0-90",
"longtitude" : "121.2,范围0-180",
"coordinate_type" : "GCJ02",
"private_street" : "脱敏地址**"
}
},
"station" : {
"id" : "string",
"name" : "string"
},
"vendor" : {
"code" : "string",
"name" : "string"
},
"wrh" : {
"code" : "string",
"name" : "string"
},
"carrier" : {
"state" : "initial",
"type" : "self",
"carrier" : {
"id" : "string",
"name" : "string"
},
"merchant" : {
"id" : "string",
"name" : "string"
},
"deliveryman" : {
"id" : "string",
"name" : "string"
},
"deliveryman_mobile" : "18859658865",
"exception_reason" : "异常原因",
"delivery_id" : "8548418",
"delivery_name" : "8548418"
},
"remark" : "定时达",
"operation_state" : "none",
"ship_mode" : "string",
"ship_delivery_mode" : "string",
"wrh_order_id" : "32323",
"ship_id" : "23232323",
"waybill_id" : "123",
"carrier_note" : "加快",
"pre_type" : "normal:正常,dsd:定时达,half_day:半日达",
"pre_start_delivery_time" : "2016-03-02 12:00:01",
"pre_end_delivery_time" : "2016-03-02 14:00:01",
"pickup_code" : "123456",
"city_token" : "123456",
"selftake_code" : "123456",
"pre_selftake_time" : "03月05日 晚上",
"selftake_confirmed" : true
},
"front" : {
"platform" : {
"id" : "string",
"name" : "string"
},
"app" : {
"id" : "string",
"name" : "string"
},
"created" : "2016-03-02 12:00:01",
"modified" : "2016-03-02 12:00:01",
"state" : "已付款",
"attribute" : "string",
"order_id" : "1223654",
"main_order_id" : "1223432",
"inner_order_id" : "1223432",
"dpt_station_time" : "2016-03-02 12:00:01",
"station_id" : "254145",
"station_name" : "254145",
"station_order_no" : "1",
"finished_time" : "2016-03-02 12:00:01",
"order_type" : {
"id" : "string",
"name" : "string"
},
"wrh_id" : "string"
},
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 1.0,
"total" : 2.0,
"front" : {
"spec" : "蓝色;微甜 少冰/多糖",
"spec2" : "500g",
"unit" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ],
"tags" : [ {
"id" : "string",
"name" : "string"
} ],
"sku_id" : "052700601",
"spu_id" : "052700601",
"item_id" : "052700601"
},
"details" : [ {
"id" : "121212",
"title" : "矿泉水",
"quantity" : 4.0,
"ratio" : 3.0,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"package_info" : {
"thermosphere" : "string",
"quantity" : 125.0,
"total" : 205.44,
"packageName" : "保温袋"
},
"front_spec" : "辣",
"real_quantity" : 0.0,
"fault_tolerant_info" : "string",
"trace_codes" : [ "string" ],
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"item_no" : "1",
"sku_id" : "00321",
"product_id" : "2123",
"item_title" : "葡萄",
"unit_price" : 2.0,
"purchase_price" : 2.0,
"weight" : 1.0,
"pay_amount" : 2.0,
"discount_amount" : 12.02,
"apported_discount_amount" : 12.02,
"package_qty" : 125.0,
"package_total" : 205.44,
"price" : 122.34,
"cost_price" : 122.34,
"shop_price" : 122.22,
"shop_total" : 122.22,
"settle_price" : 122.2222,
"settle_total" : 122.22,
"settle_discountAmount" : 122.22,
"consume_scores" : 12.2,
"image_url" : "http://aaa/bbb.png",
"item_id" : "1",
"is_collocation" : false,
"relation_item_id" : "2123",
"relation_sku_id" : "2123",
"orig_mas_sku_id" : "string",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_weight" : 1.0,
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"weight" : 0.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"orig_extra_info" : {
"spec" : "1*1",
"unit" : "个"
},
"fault_tolerant_info" : "string",
"salesman" : {
"id" : "string",
"name" : "string"
},
"trace_codes" : [ "string" ],
"extra_info" : "{\"inv_mgr\": false}",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"service_options" : "清洁/杀菌",
"is_gift" : true
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ]
},
"order_store" : {
"id" : "string",
"name" : "string"
},
"approve_state" : "none",
"wrh_state" : "initial",
"customer_note" : "note",
"seller_note" : "note",
"cancel_type" : "customerCancel",
"cancel_reason" : "我不想要了",
"source_order_id" : "5346567534545645",
"suspend_info" : {
"suspended" : true,
"code" : "string",
"caption" : "string",
"time" : "2017-12-26 16:40:19"
},
"has_exception" : true,
"exception_codes" : "sku",
"exception_remark" : "商品不存在",
"is_private" : true,
"item_count" : 1,
"sku_quantity" : 1.0,
"real_total" : 120.01,
"orig_total" : 120.01,
"user_number" : 2,
"settle_amount" : 120.01,
"settle_commission" : 120.01,
"selttle_commission" : 120.01,
"settle_freight" : 120.01,
"performance_service_fee" : 120.01,
"shop_amount" : 120.01,
"freight_discount" : 33.33,
"package_discount" : 33.33,
"invoice_take_code" : "string",
"fault_tolerant_info" : "string",
"extra_info" : "{\"lcUserAccessToken\", \"123\"}",
"calc_data" : true,
"wrh_id" : "4184",
"tags" : [ {
"name" : "首单"
} ],
"reissue_reason" : "string",
"responsible_party" : "string",
"sale_order_id" : "string",
"allow_actions" : [ "string" ],
"address_change_fee" : 0.0,
"item_change_records" : [ {
"reason" : "string",
"created" : "2020-06-17 10:00:00",
"modified" : "2020-06-17 10:00:00",
"creator" : "string",
"modifier" : "string",
"items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 1.0,
"total" : 2.0,
"front" : {
"spec" : "蓝色;微甜 少冰/多糖",
"spec2" : "500g",
"unit" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ],
"tags" : [ {
"id" : "string",
"name" : "string"
} ],
"sku_id" : "052700601",
"spu_id" : "052700601",
"item_id" : "052700601"
},
"details" : [ {
"id" : "121212",
"title" : "矿泉水",
"quantity" : 4.0,
"ratio" : 3.0,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"package_info" : {
"thermosphere" : "string",
"quantity" : 125.0,
"total" : 205.44,
"packageName" : "保温袋"
},
"front_spec" : "辣",
"real_quantity" : 0.0,
"fault_tolerant_info" : "string",
"trace_codes" : [ "string" ],
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"item_no" : "1",
"sku_id" : "00321",
"product_id" : "2123",
"item_title" : "葡萄",
"unit_price" : 2.0,
"purchase_price" : 2.0,
"weight" : 1.0,
"pay_amount" : 2.0,
"discount_amount" : 12.02,
"apported_discount_amount" : 12.02,
"package_qty" : 125.0,
"package_total" : 205.44,
"price" : 122.34,
"cost_price" : 122.34,
"shop_price" : 122.22,
"shop_total" : 122.22,
"settle_price" : 122.2222,
"settle_total" : 122.22,
"settle_discountAmount" : 122.22,
"consume_scores" : 12.2,
"image_url" : "http://aaa/bbb.png",
"item_id" : "1",
"is_collocation" : false,
"relation_item_id" : "2123",
"relation_sku_id" : "2123",
"orig_mas_sku_id" : "string",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_weight" : 1.0,
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"weight" : 0.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"orig_extra_info" : {
"spec" : "1*1",
"unit" : "个"
},
"fault_tolerant_info" : "string",
"salesman" : {
"id" : "string",
"name" : "string"
},
"trace_codes" : [ "string" ],
"extra_info" : "{\"inv_mgr\": false}",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"service_options" : "清洁/杀菌",
"is_gift" : true
} ],
"change_items" : [ {
"uuid" : "string",
"spec" : "1*1",
"unit" : "瓶",
"barcode" : "123456",
"quantity" : 1.0,
"total" : 2.0,
"front" : {
"spec" : "蓝色;微甜 少冰/多糖",
"spec2" : "500g",
"unit" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ],
"tags" : [ {
"id" : "string",
"name" : "string"
} ],
"sku_id" : "052700601",
"spu_id" : "052700601",
"item_id" : "052700601"
},
"details" : [ {
"id" : "121212",
"title" : "矿泉水",
"quantity" : 4.0,
"ratio" : 3.0,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"package_info" : {
"thermosphere" : "string",
"quantity" : 125.0,
"total" : 205.44,
"packageName" : "保温袋"
},
"front_spec" : "辣",
"real_quantity" : 0.0,
"fault_tolerant_info" : "string",
"trace_codes" : [ "string" ],
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0
} ],
"promotion" : {
"favs" : [ {
"id" : "1111",
"name" : "满减",
"type" : "string",
"amount" : 10.5,
"remark" : "测试优惠",
"factor" : {
"total" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与金额是:20",
"qty" : "A(40) B(160)-》100满减20。如果本商品是A,则最终A参与数量是:1",
"sku_items" : "买2A+3B,赠送一个C,当前商品是C,则skuItems记录 2A和3B的参与详情"
},
"sku_act_id" : "1111",
"merchant_act_id" : "1111",
"batch_act_id" : "1111",
"child_type" : "string",
"prom_cls" : "string",
"voucher_code" : "111111111",
"settle_details" : [ {
"role" : "shop(商家)、platform(平台)、agent(代理商)",
"discount" : 1.0
} ],
"share_details" : "[]"
} ],
"discount_amount" : 0.1,
"apported_discount_amount" : 0.1
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"item_no" : "1",
"sku_id" : "00321",
"product_id" : "2123",
"item_title" : "葡萄",
"unit_price" : 2.0,
"purchase_price" : 2.0,
"weight" : 1.0,
"pay_amount" : 2.0,
"discount_amount" : 12.02,
"apported_discount_amount" : 12.02,
"package_qty" : 125.0,
"package_total" : 205.44,
"price" : 122.34,
"cost_price" : 122.34,
"shop_price" : 122.22,
"shop_total" : 122.22,
"settle_price" : 122.2222,
"settle_total" : 122.22,
"settle_discountAmount" : 122.22,
"consume_scores" : 12.2,
"image_url" : "http://aaa/bbb.png",
"item_id" : "1",
"is_collocation" : false,
"relation_item_id" : "2123",
"relation_sku_id" : "2123",
"orig_mas_sku_id" : "string",
"orig_sku_id" : "121212",
"orig_item_title" : "【组合】洗护套装",
"orig_price" : 122.22,
"orig_qty" : 2.0,
"orig_barcode" : "1212",
"orig_image_url" : "string",
"orig_weight" : 1.0,
"orig_item" : {
"type" : "multi",
"barcode" : "121221",
"price" : 33.22,
"quantity" : 3.0,
"weight" : 0.0,
"sku_id" : "121221",
"item_title" : "【组合】洗护套装",
"image_url" : "string",
"combined_id" : "121221",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"orig_extra_info" : {
"spec" : "1*1",
"unit" : "个"
},
"fault_tolerant_info" : "string",
"salesman" : {
"id" : "string",
"name" : "string"
},
"trace_codes" : [ "string" ],
"extra_info" : "{\"inv_mgr\": false}",
"tags" : "标签",
"real_weight" : 0.0,
"real_quantity" : 0.0,
"sku_shelf_position_code" : "string",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"service_options" : "清洁/杀菌",
"is_gift" : true
} ]
} ],
"pick_info" : {
"time" : "2020-06-17 10:00:00",
"source" : "string",
"operator_id" : "string",
"operator_name" : "string",
"auto_picked_finish" : true
},
"print_count" : 0
} ],
"page_count" : 5,
"page_size" : 20
}
1.1.8. 获取门店订单可用承运商
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/availablecarriers
1.1.8.1. 说明
获取门店订单可用承运商
1.1.8.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
id |
订单号 |
string |
1.1.8.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.8.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/availablecarriers
1.1.8.5. HTTP响应示例
响应 200
{
"carriers" : [ {
"id" : "string",
"name" : "string"
} ],
"store_carriers" : [ {
"uuid" : "string",
"carrier" : {
"id" : "string",
"name" : "string"
},
"proxy" : true,
"line_number" : 1,
"carrier_merchant" : {
"id" : "string",
"name" : "string"
},
"carrier_system" : {
"id" : "string",
"name" : "string"
},
"priority" : 1
} ]
}
1.1.9. 取得订单投递失败的可选原因
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/deliverfailreasons
1.1.9.1. 说明
取得订单投递失败的可选原因
1.1.9.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
type |
投递失败原因类型,取值范围:refused(客户拒收)、redeliver(未妥投) |
string |
1.1.9.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.9.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/deliverfailreasons
1.1.9.5. HTTP响应示例
响应 200
{
"reasons" : [ {
"type" : "redeliver",
"reason" : "原因说明"
} ]
}
1.1.10. 取得订单上架异常的可选原因
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/listingexceptionreasons
1.1.10.1. 说明
取得订单上架异常的可选原因
1.1.10.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.1.10.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.10.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/listingexceptionreasons
1.1.10.5. HTTP响应示例
响应 200
{
"values" : [ "string" ],
"empty" : true
}
1.1.11. 取单个客户订单
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}
1.1.11.1. 说明
取单个客户订单
1.1.11.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
fetch_parts |
需要返回的订单部分,取值范围:items(商品详情)、item.details(组合商品详情)、paymentDetails(支付详情)、invoiceDetails(发票详情)、quota(订单指标)、items.station(明细站点详情) |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
1.1.11.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.11.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string?operator_id=string
1.1.11.5. HTTP响应示例
响应 200
{
"id" : "1001001",
"status" : "confirming",
"total" : 12.03,
"items" : [ {
"quantity" : 12.0,
"total" : 12.25,
"itemCustomField" : {
"sfield1" : "aaa",
"sfield2" : "bbb",
"sfield3" : "ccc",
"sfield4" : "ddd",
"sfield5" : "eee",
"sfield6" : "ggg",
"sfield7" : "eee",
"sfield8" : "fff",
"nfield1" : 23.0,
"nfield2" : 34.0,
"item_code" : "323231"
},
"weight" : 0.0,
"disp" : false,
"unit" : "瓶",
"front" : {
"spec" : "string",
"spec2" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ]
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"tags" : [ {
"name" : "首单"
} ],
"item_no" : "1",
"item_code" : "32323",
"item_name" : "可乐",
"spec" : "1*1",
"barcode" : "32323",
"product_id" : "32323",
"unit_price" : 32.05,
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"fav_price" : 12.54,
"fav_total" : 12.25,
"image_url" : "http://aaa/bbb.png",
"details" : [ {
"id" : "323231",
"title" : "aaa",
"quantity" : 12.0,
"ratio" : 0.25,
"disp" : false,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"fault_tolerant_info" : "string",
"real_quantity" : 12.54,
"rtn_quantity" : 12.0,
"barcode" : "32323",
"trace_codes" : [ "string" ],
"trace_code_details" : [ {
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"sku_shelf_position_code" : "string"
} ],
"orig_item" : {
"quantity" : 12.0,
"weight" : 12.0,
"item_code" : "32323",
"item_name" : "可乐",
"qpc" : "1*1",
"unit" : "份",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"fault_tolerant_info" : "string",
"item_id" : "string",
"real_weight" : 12.54,
"total_weight" : 12.54,
"real_quantity" : 12.54,
"category_id" : "10002",
"print_cup_sticker" : false,
"trace_codes" : [ "string" ],
"trace_code_details" : [ {
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"package_qty" : 125.0,
"package_total" : 205.44,
"discount_amount" : 12.02,
"sku_shelf_position_code" : "string"
} ],
"mobile" : "15855885589",
"salechannel" : "mdj",
"deliveryman" : "李三",
"quotas" : [ {
"action" : "expect_shipping",
"time" : "2021-09-26 16:40:19",
"remark" : "无",
"action_name" : "期望拣货完成时间"
} ],
"tags" : [ {
"name" : "首单"
} ],
"front" : {
"attribute" : {
"is_sqt_order" : true,
"is_sqt_invoice" : true
},
"station_order_no" : "1",
"order_id" : "1223654"
},
"store_id" : "0002",
"type_caption" : "一小时达",
"ship_location" : "store",
"ship_location_caption" : "上海",
"customer_info" : "string",
"private_customer_info" : "string",
"payment_type" : "货到付款",
"delivery_type" : "送货上门",
"pre_type" : "normal:正常,dsd:定时达,half_day:半日达",
"package_total" : 14.02,
"status_caption" : "已取消",
"create_time" : "2017-11-27 18:38:42",
"shipping_time" : "2017-11-27 18:38:42",
"ship_time" : "2017-11-27 18:38:42",
"sign_time" : "2017-11-27 18:38:42",
"exception_type" : "stopped",
"exception_info" : "string",
"has_exception" : false,
"exception_codes" : "sku(商品异常),amount(金额异常),shopAmount(货款金额异常),carrier(承运异常),invoice(开票异常),delivery.address(配送地址信息异常),traceCode(溯源码异常)",
"orig_total" : 12.03,
"invoice" : {
"required" : false,
"details" : [ {
"amount" : 12.02,
"content" : "某某公司",
"title" : "plain",
"title_type" : "person",
"taxer_id" : "1212345046600736XP"
} ],
"apply_qrcode" : "string"
},
"freight" : 12.03,
"freight_discount" : 33.33,
"order_store" : {
"id" : "string",
"name" : "string"
},
"expected_delivered_date" : "2014-02-03",
"expected_delivered_time_slot" : "11:00-12:00",
"payable_amount" : 12.02,
"customer_note" : "无",
"private_mobile" : "189389928893",
"private_street" : "脱敏地址**",
"salechannel_name" : "美到家",
"cancel_type" : "customerCancel",
"carrier_type" : "express",
"carrier_state" : "pickupFailed",
"deliveryman_mobile" : "15655895658",
"carrier_id" : "self",
"carrier_name" : "顺丰",
"waybill_id" : "123456",
"carrier_exception_remark" : "门店不存在",
"multi_store" : false,
"fault_tolerant_info" : "string",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"sku_quantity" : 1.0,
"real_total" : 120.01,
"discount_amount" : 0.0,
"item_total" : 0.0,
"allow_actions" : [ "string" ],
"extra_info" : {
"userStoredPromAmount" : "string",
"userRealPayAmount" : "string",
"userRealPromAmount" : "string",
"userPrepaidAmount" : "string"
},
"print_info" : {
"parameters" : [ {
"name" : "string",
"value" : "string"
} ]
},
"selftake_code" : "123456",
"member_info" : {
"member_id" : "12253",
"card_no" : "22323",
"member_gid" : "12253",
"outer_member_id" : "12253",
"mobile" : "12253"
}
}
1.1.12. 商家主动发起退款
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/applyrtn
1.1.12.1. 说明
商家主动发起退款
1.1.12.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户Id |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
request |
申请请求对象 |
1.1.12.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.12.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/applyrtn?operator_id=string
请求 body
{
"reason" : "不想要了",
"policy" : "取值:orig_sku(原商品)、sku(现商品)",
"items" : [ {
"quantity" : 1.0,
"weights" : "1",
"order_item_no" : "1",
"item_code" : "0001",
"real_total_weight" : 1.0,
"refund_amount" : 12.03
} ],
"type" : "取值:refund(仅退款)、refundAndRtn(退款退货)",
"apply_type" : "weight_diff",
"rtn_id" : "string"
}
1.1.12.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string",
"apply_ids" : "多个申请幂等ID"
}
1.1.13. 调整承运商
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/carrier
1.1.13.1. 说明
调整承运商
1.1.13.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
detail |
承运商详情 |
1.1.13.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.13.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/carrier?operator_id=string
请求 body
{
"action" : "string",
"carrier_type" : "express",
"carrier_id" : "sf",
"carrier_name" : "顺丰速运",
"carrier_merchant_id" : "string",
"carrier_merchant_name" : "string",
"deliveryman_id" : "32332",
"deliveryman" : "李某",
"deliveryman_mobile" : "1565586545",
"waybill_id" : "32332",
"freight" : 1.11
}
1.1.14. 更新承运商配送信息
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/carrier/update
1.1.14.1. 说明
更新承运商配送信息
1.1.14.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
detail |
承运商详情 |
1.1.14.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.14.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/carrier/update?operator_id=string
请求 body
{
"carrier_id" : "sf",
"carrier_name" : "顺丰速运",
"waybill_id" : "32332"
}
1.1.15. 商品明细换货
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/change/items
1.1.15.1. 说明
商品明细换货
1.1.15.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
mod |
修改商品换货明细请求 |
1.1.15.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.15.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/change/items?operator_id=string
请求 body
{
"policy" : "取值:orig_sku(原商品)、sku(现商品),默认现商品",
"reason" : "string",
"item_no" : "1",
"item_code" : "32323",
"adjust_item_code" : "12"
}
1.1.16. 确认商品实际数量
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/confirm/itemqty
1.1.16.1. 说明
确认商品实际数量(只记录实际数量,不修改原数量)
1.1.16.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
mod |
商品明细实际数量请求 |
1.1.16.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.16.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/confirm/itemqty?operator_id=string
请求 body
{
"items" : [ {
"item_no" : "1",
"item_code" : "32323",
"real_weight" : 0.0,
"real_quantity" : 0.0
} ]
}
1.1.17. 订单取消接单(冲账)检查
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/delistingcheck
1.1.17.1. 说明
订单取消接单(冲账)检查
1.1.17.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.1.17.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.17.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/delistingcheck
1.1.17.5. HTTP响应示例
响应 200
{
"accepted" : true,
"message" : "恭喜您,验证通过"
}
1.1.18. 提货检查
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/delivercheck
1.1.18.1. 说明
提货检查
1.1.18.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
check_code |
验证码 |
string |
1.1.18.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.18.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/delivercheck
1.1.18.5. HTTP响应示例
响应 200
{
"accepted" : true,
"message" : "恭喜您,验证通过"
}
1.1.19. 明细溯源码记录
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/itemtracecode/save
1.1.19.1. 说明
明细溯源码记录
1.1.19.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
mod |
明细溯源码保存请求 |
1.1.19.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.19.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/itemtracecode/save?operator_id=string
请求 body
{
"items" : [ {
"details" : "32323",
"item_no" : "1",
"item_code" : "32323",
"trace_codes" : [ "string" ],
"trace_code_details" : [ {
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ]
} ]
}
1.1.20. 订单接单(上架)检查
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/listingcheck
1.1.20.1. 说明
订单接单(上架)检查
1.1.20.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.1.20.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.20.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/listingcheck
1.1.20.5. HTTP响应示例
响应 200
{
"accepted" : true,
"message" : "恭喜您,验证通过"
}
1.1.21. 报告上架异常
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/listingexception
1.1.21.1. 说明
报告上架异常
1.1.21.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
detail |
上架异常详情 |
1.1.21.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.21.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/listingexception?operator_id=string
请求 body
{
"reason" : "商品不存在,上架异常"
}
1.1.22. 修改商品明细
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/mod/items
1.1.22.1. 说明
修改商品明细
1.1.22.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
mod |
修改商品明细请求 |
1.1.22.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.22.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/mod/items?operator_id=string
请求 body
{
"type" : "weight_diff",
"reason" : "补差",
"items" : [ {
"quantity" : 12.0,
"details" : [ {
"field" : "total,fav_total,quantity",
"before" : "10",
"after" : "12"
} ],
"item_no" : "1",
"item_code" : "32323"
} ],
"payments" : [ {
"name" : "支付宝",
"amount" : 12.03,
"card_number" : "22121",
"store_pay" : false,
"need_cash" : false
} ]
}
1.1.23. 付款检查
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/paycheck
1.1.23.1. 说明
付款检查
1.1.23.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.1.23.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.23.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/paycheck
1.1.23.5. HTTP响应示例
响应 200
{
"accepted" : true,
"message" : "恭喜您,验证通过"
}
1.1.24. 取订单的打印数据
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/printdata
operation.deprecated |
1.1.24.1. 说明
取订单的打印数据
1.1.24.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
names |
打印模版名称name:拣货单、外卖订单、运单,长度不超过40,打印多个用英文逗号隔开如:拣货单,外卖订单。不传表示打印全部 |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
1.1.24.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.24.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/printdata?operator_id=string
1.1.24.5. HTTP响应示例
响应 200
{
"parts" : [ "string" ],
"order_id" : "21212",
"time" : "2019-07-03 13:06:46"
}
1.1.25. 指定订单号查询退款申请列表
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/refunds
1.1.25.1. 说明
指定订单号查询退款申请列表
1.1.25.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.1.25.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.25.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/refunds
1.1.25.5. HTTP响应示例
响应 200
{
"values" : [ {
"order_id" : "32323",
"refundReq_id" : "32323",
"refund_total" : 12.02,
"products" : [ {
"skuId" : "00212",
"qty" : 12.0,
"total" : 12.25
} ],
"payment_details" : [ {
"name" : "支付宝",
"amount" : 12.03,
"card_number" : "22121",
"store_pay" : false,
"need_cash" : false
} ]
} ]
}
1.1.26. 确认自提
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/selftake
1.1.26.1. 说明
确认自提,仅支持非货到付款自提
1.1.26.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
1.1.26.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.26.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/selftake?operator_id=string
1.1.27. 确认自提
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/selftake/confirm
1.1.27.1. 说明
确认自提,支持货到付款和非货到付款自提
1.1.27.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
detail |
自提详情 |
1.1.27.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.27.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/selftake/confirm?operator_id=string
请求 body
{
"payments" : [ {
"name" : "支付宝",
"amount" : 12.03,
"card_number" : "22121",
"store_pay" : false,
"need_cash" : false
} ]
}
1.1.28. 门店拒绝配送指定的订单
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/station_refuse
1.1.28.1. 说明
门店拒绝配送指定的订单
1.1.28.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Query |
reason |
拒绝原因 |
string |
1.1.28.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.28.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/station_refuse?operator_id=string
1.1.29. 订单取消接单(冲账)
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/delisting
1.1.29.1. 说明
订单取消接单(冲账)
1.1.29.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
1.1.29.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.29.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/delisting?operator_id=string
1.1.30. 订单客户签收
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/delivered
1.1.30.1. 说明
订单客户签收
1.1.30.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
detail |
签收详情 |
1.1.30.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.30.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/delivered?operator_id=string
请求 body
{
"payments" : [ {
"name" : "支付宝",
"amount" : 12.03,
"card_number" : "22121",
"store_pay" : false,
"need_cash" : false
} ],
"deliver_id" : "22121",
"deliver_name" : "李某",
"on_duty_emps" : [ {
"id" : "string",
"name" : "string"
} ]
}
1.1.31. 订单投递失败
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/deliverfailed
1.1.31.1. 说明
订单投递失败
1.1.31.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
detail |
投递失败的原因 |
1.1.31.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.31.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/deliverfailed?operator_id=string
请求 body
{
"type" : "refused",
"reason" : "商品破损"
}
1.1.32. 订单送货登记
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/delivering
1.1.32.1. 说明
订单送货登记
1.1.32.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
1.1.32.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.32.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/delivering?operator_id=string
1.1.33. 订单备货(上架)
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/listing
1.1.33.1. 说明
订单备货(上架)
1.1.33.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
carrier_id |
承运商ID |
string |
Query |
carrier_name |
承运商名称 |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Query |
picking_operator_id |
备货人ID,长度不超过20 |
string |
Query |
picking_operator_name |
备货人姓名,长度不超过50 |
string |
1.1.33.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.33.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/listing?operator_id=string
1.1.34. 订单复核
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/recheck
1.1.34.1. 说明
订单复核
1.1.34.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
detail |
复核详情 |
1.1.34.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.34.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/recheck?operator_id=string
1.1.35. 订单申请
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/{action}/apply
1.1.35.1. 说明
订单申请
1.1.35.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
action |
动作:cancel,refund |
string |
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
request |
订单申请请求 |
1.1.35.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.35.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/string/apply?operator_id=string
请求 body
{
"reason" : "不要了",
"items" : [ {
"quantity" : 2.0,
"order_item_no" : "1",
"item_code" : "0001"
} ]
}
1.1.36. 获取订单的运单列表
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/carrierorders
1.1.36.1. 说明
获取订单的运单列表
1.1.36.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
order_id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.1.36.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.36.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/carrierorders
1.1.36.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string",
"order_id" : "123434354",
"waybill_id" : "123434354",
"carrier_orders" : [ {
"deliveryman" : "123434354",
"created" : "2022-08-30 00:00:00",
"modified" : "2022-08-30 00:00:00",
"details" : [ {
"time" : "2022-04-07 08:39:07",
"address" : "福建,厦门市",
"message" : "顺丰速运 已收取快件",
"status" : "在途"
} ],
"carrier_id" : "sf",
"carrier_name" : "顺丰速运",
"waybill_id" : "32332",
"deliveryman_phone" : "123434354",
"carrier_state" : "created",
"exception_remark" : "运力不足"
} ]
}
1.1.37. 订单解密
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/decrypt
1.1.37.1. 说明
订单解密
1.1.37.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
order_id |
订单Id |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户Id |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
request |
解密请求 |
1.1.37.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.37.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/decrypt?operator_id=string
1.1.37.5. HTTP响应示例
响应 200
{
"receiver_mobile" : "string",
"receiver_street" : "string",
"customer_info" : "string"
}
1.1.38. 修改订单盲盒明细
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/mod/blindboxs
1.1.38.1. 说明
修改订单盲盒明细
1.1.38.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
order_id |
订单Id |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户Id |
string |
Query |
operator_name |
string |
|
Body |
body |
1.1.38.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.38.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/mod/blindboxs
请求 body
{
"data" : [ {
"details" : [ {
"qty" : 1.0,
"sku_id" : "sku0001"
} ],
"sku_id" : "202214816_7"
} ]
}
1.1.38.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.39. 获取订单商品列表详情
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/orderItemDetail
1.1.39.1. 说明
获取订单列表详情
1.1.39.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.1.39.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.39.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/{order_id}/orderItemDetail
1.1.39.5. HTTP响应示例
响应 200
{
"items" : [ {
"item_no" : "string",
"sku_id" : "string",
"sku_name" : "string",
"upc" : "string",
"order_qty" : 0.0,
"inv_qty" : 0.0
} ]
}
1.1.40. 获取商品换货范围
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/skuchangerange
1.1.40.1. 说明
获取商品换货范围
1.1.40.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
order_id |
订单Id |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户Id |
string |
Query |
operator_name |
string |
|
Body |
body |
1.1.40.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.40.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/skuchangerange
请求 body
{
"keyword" : "1111",
"sku_id" : "202214816_7",
"barcode_start" : "1111"
}
1.1.40.5. HTTP响应示例
响应 200
{
"skus" : [ {
"name" : "string",
"barcode" : "string",
"stock" : 0.0,
"upc" : "string",
"weight" : 0.0,
"weightUnit" : "string",
"imageUrl" : "string",
"price" : 0.0,
"sku_id" : "string"
} ]
}
1.1.41. 门店转单
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/transferStores
1.1.41.1. 说明
门店转单
1.1.41.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
body |
1.1.41.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.41.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/{order_id}/transferStores?operator=string
请求 body
{
"store_id" : "string",
"store_name" : "string",
"all_transfer" : true,
"skus" : [ {
"item_no" : "string",
"sku_id" : "string"
} ]
}
1.1.41.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.1.42. 获取订单转单门店
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/transferStoresRange
1.1.42.1. 说明
获取订单转单门店范围
1.1.42.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
订单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
page |
分页 |
integer (int32) |
Query |
pageSize |
页面大小 |
integer (int32) |
Body |
body |
1.1.42.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.42.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/{order_id}/transferStoresRange?page=0&pageSize=0
请求 body
{
"transfer_store_id" : "121313 || 其它门店",
"region_code" : "string",
"key_like" : "string",
"region_name_like" : "string",
"sku_ids" : [ "string" ]
}
1.1.42.5. HTTP响应示例
响应 200
{
"page" : 0,
"page_size" : 0,
"total" : 0,
"order_transfer_store_ranges" : {
"first_transfer" : true,
"transfer_store_id" : "string",
"transfer_store_name" : "string",
"transfer_store_ranges" : [ {
"store_area" : "string",
"store_id" : "string",
"store_name" : "string",
"telephone" : "string",
"distance" : 0.0,
"inv_enough" : true,
"invs" : [ {
"item_no" : "string",
"sku_id" : "string",
"sku_name" : "string",
"upc" : "string",
"order_qty" : 0.0,
"inv_qty" : 0.0
} ]
} ]
}
}
1.1.43. 分页查询异常订单
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/orders/exceptions
1.1.43.1. 说明
分页查询异常订单
1.1.43.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Query |
page |
页码,大于等于0 |
integer (int32) |
Query |
page_size |
分页大小,范围[0,100] |
integer (int32) |
Query |
type |
异常类型,取值是:redeliver-未妥投,refused-客户拒收,timeout-超期未提,stopped=发货后取消, listingexception=上架异常 不传则取全部异常类型的订单。 |
string |
1.1.43.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.43.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/orders/exceptions?operator_id=string&page=0&page_size=0
1.1.43.5. HTTP响应示例
响应 200
{
"paging" : {
"page" : 0,
"page_size" : 20,
"page_count" : 20,
"record_count" : 20,
"has_more" : false
},
"records" : [ {
"id" : "1001001",
"status" : "confirming",
"total" : 12.03,
"items" : [ {
"quantity" : 12.0,
"total" : 12.25,
"itemCustomField" : {
"sfield1" : "aaa",
"sfield2" : "bbb",
"sfield3" : "ccc",
"sfield4" : "ddd",
"sfield5" : "eee",
"sfield6" : "ggg",
"sfield7" : "eee",
"sfield8" : "fff",
"nfield1" : 23.0,
"nfield2" : 34.0,
"item_code" : "323231"
},
"weight" : 0.0,
"disp" : false,
"unit" : "瓶",
"front" : {
"spec" : "string",
"spec2" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ]
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"tags" : [ {
"name" : "首单"
} ],
"item_no" : "1",
"item_code" : "32323",
"item_name" : "可乐",
"spec" : "1*1",
"barcode" : "32323",
"product_id" : "32323",
"unit_price" : 32.05,
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"fav_price" : 12.54,
"fav_total" : 12.25,
"image_url" : "http://aaa/bbb.png",
"details" : [ {
"id" : "323231",
"title" : "aaa",
"quantity" : 12.0,
"ratio" : 0.25,
"disp" : false,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"fault_tolerant_info" : "string",
"real_quantity" : 12.54,
"rtn_quantity" : 12.0,
"barcode" : "32323",
"trace_codes" : [ "string" ],
"trace_code_details" : [ {
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"sku_shelf_position_code" : "string"
} ],
"orig_item" : {
"quantity" : 12.0,
"weight" : 12.0,
"item_code" : "32323",
"item_name" : "可乐",
"qpc" : "1*1",
"unit" : "份",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"fault_tolerant_info" : "string",
"item_id" : "string",
"real_weight" : 12.54,
"total_weight" : 12.54,
"real_quantity" : 12.54,
"category_id" : "10002",
"print_cup_sticker" : false,
"trace_codes" : [ "string" ],
"trace_code_details" : [ {
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"package_qty" : 125.0,
"package_total" : 205.44,
"discount_amount" : 12.02,
"sku_shelf_position_code" : "string"
} ],
"mobile" : "15855885589",
"salechannel" : "mdj",
"deliveryman" : "李三",
"quotas" : [ {
"action" : "expect_shipping",
"time" : "2021-09-26 16:40:19",
"remark" : "无",
"action_name" : "期望拣货完成时间"
} ],
"tags" : [ {
"name" : "首单"
} ],
"front" : {
"attribute" : {
"is_sqt_order" : true,
"is_sqt_invoice" : true
},
"station_order_no" : "1",
"order_id" : "1223654"
},
"store_id" : "0002",
"type_caption" : "一小时达",
"ship_location" : "store",
"ship_location_caption" : "上海",
"customer_info" : "string",
"private_customer_info" : "string",
"payment_type" : "货到付款",
"delivery_type" : "送货上门",
"pre_type" : "normal:正常,dsd:定时达,half_day:半日达",
"package_total" : 14.02,
"status_caption" : "已取消",
"create_time" : "2017-11-27 18:38:42",
"shipping_time" : "2017-11-27 18:38:42",
"ship_time" : "2017-11-27 18:38:42",
"sign_time" : "2017-11-27 18:38:42",
"exception_type" : "stopped",
"exception_info" : "string",
"has_exception" : false,
"exception_codes" : "sku(商品异常),amount(金额异常),shopAmount(货款金额异常),carrier(承运异常),invoice(开票异常),delivery.address(配送地址信息异常),traceCode(溯源码异常)",
"orig_total" : 12.03,
"invoice" : {
"required" : false,
"details" : [ {
"amount" : 12.02,
"content" : "某某公司",
"title" : "plain",
"title_type" : "person",
"taxer_id" : "1212345046600736XP"
} ],
"apply_qrcode" : "string"
},
"freight" : 12.03,
"freight_discount" : 33.33,
"order_store" : {
"id" : "string",
"name" : "string"
},
"expected_delivered_date" : "2014-02-03",
"expected_delivered_time_slot" : "11:00-12:00",
"payable_amount" : 12.02,
"customer_note" : "无",
"private_mobile" : "189389928893",
"private_street" : "脱敏地址**",
"salechannel_name" : "美到家",
"cancel_type" : "customerCancel",
"carrier_type" : "express",
"carrier_state" : "pickupFailed",
"deliveryman_mobile" : "15655895658",
"carrier_id" : "self",
"carrier_name" : "顺丰",
"waybill_id" : "123456",
"carrier_exception_remark" : "门店不存在",
"multi_store" : false,
"fault_tolerant_info" : "string",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"sku_quantity" : 1.0,
"real_total" : 120.01,
"discount_amount" : 0.0,
"item_total" : 0.0,
"allow_actions" : [ "string" ],
"extra_info" : {
"userStoredPromAmount" : "string",
"userRealPayAmount" : "string",
"userRealPromAmount" : "string",
"userPrepaidAmount" : "string"
},
"print_info" : {
"parameters" : [ {
"name" : "string",
"value" : "string"
} ]
},
"selftake_code" : "123456",
"member_info" : {
"member_id" : "12253",
"card_no" : "22323",
"member_gid" : "12253",
"outer_member_id" : "12253",
"mobile" : "12253"
}
} ]
}
1.1.44. 批量查询打印接口
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/orders/printdatas
operation.deprecated |
1.1.44.1. 说明
批量查询打印接口
1.1.44.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
ids |
订单号 |
< string > array(multi) |
Query |
names |
打印模版名称name:拣货单、外卖订单、运单,长度不超过40,打印多个用英文逗号隔开如:拣货单,外卖订单。不传表示打印全部 |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
1.1.44.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.44.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/orders/printdatas?ids=string&operator_id=string
1.1.44.5. HTTP响应示例
响应 200
{
"orders" : [ {
"parts" : [ "string" ],
"order_id" : "21212",
"time" : "2019-07-03 13:06:46"
} ]
}
1.1.45. 分页查询订单
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/orders/query
1.1.45.1. 说明
分页查询订单
1.1.45.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
definition |
查询定义 |
1.1.45.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.45.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/orders/query?operator_id=string
请求 body
{
"conditions" : [ {
"name" : "aaa",
"param" : "2018-05-04 14:25:25"
} ],
"orders" : [ {
"field" : "created",
"direction" : "asc"
} ],
"page" : 0,
"page_size" : 10,
"fetch_parts" : "items,invoiceDetails",
"quick_search_filters" : "0"
}
1.1.45.5. HTTP响应示例
响应 200
{
"paging" : {
"page" : 0,
"page_size" : 20,
"page_count" : 20,
"record_count" : 20,
"has_more" : false
},
"records" : [ {
"id" : "1001001",
"status" : "confirming",
"total" : 12.03,
"items" : [ {
"quantity" : 12.0,
"total" : 12.25,
"itemCustomField" : {
"sfield1" : "aaa",
"sfield2" : "bbb",
"sfield3" : "ccc",
"sfield4" : "ddd",
"sfield5" : "eee",
"sfield6" : "ggg",
"sfield7" : "eee",
"sfield8" : "fff",
"nfield1" : 23.0,
"nfield2" : 34.0,
"item_code" : "323231"
},
"weight" : 0.0,
"disp" : false,
"unit" : "瓶",
"front" : {
"spec" : "string",
"spec2" : "string",
"attributes" : [ {
"group" : "口味",
"values" : [ "string" ],
"price" : 0.0,
"qty" : 0.0
} ]
},
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"tags" : [ {
"name" : "首单"
} ],
"item_no" : "1",
"item_code" : "32323",
"item_name" : "可乐",
"spec" : "1*1",
"barcode" : "32323",
"product_id" : "32323",
"unit_price" : 32.05,
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0,
"fav_price" : 12.54,
"fav_total" : 12.25,
"image_url" : "http://aaa/bbb.png",
"details" : [ {
"id" : "323231",
"title" : "aaa",
"quantity" : 12.0,
"ratio" : 0.25,
"disp" : false,
"station" : {
"station_id" : "145",
"station_type" : "145",
"station_no" : "1"
},
"fault_tolerant_info" : "string",
"real_quantity" : 12.54,
"rtn_quantity" : 12.0,
"barcode" : "32323",
"trace_codes" : [ "string" ],
"trace_code_details" : [ {
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"sku_shelf_position_code" : "string"
} ],
"orig_item" : {
"quantity" : 12.0,
"weight" : 12.0,
"item_code" : "32323",
"item_name" : "可乐",
"qpc" : "1*1",
"unit" : "份",
"rtn_quantity" : 12.0,
"rtn_weight" : 12.0
},
"fault_tolerant_info" : "string",
"item_id" : "string",
"real_weight" : 12.54,
"total_weight" : 12.54,
"real_quantity" : 12.54,
"category_id" : "10002",
"print_cup_sticker" : false,
"trace_codes" : [ "string" ],
"trace_code_details" : [ {
"batch_no" : "string",
"code" : "string",
"valid_date" : "2020-06-17 10:00:00",
"production_date" : "2020-06-17 10:00:00",
"qty" : 0.0,
"qpc_str" : "string"
} ],
"package_qty" : 125.0,
"package_total" : 205.44,
"discount_amount" : 12.02,
"sku_shelf_position_code" : "string"
} ],
"mobile" : "15855885589",
"salechannel" : "mdj",
"deliveryman" : "李三",
"quotas" : [ {
"action" : "expect_shipping",
"time" : "2021-09-26 16:40:19",
"remark" : "无",
"action_name" : "期望拣货完成时间"
} ],
"tags" : [ {
"name" : "首单"
} ],
"front" : {
"attribute" : {
"is_sqt_order" : true,
"is_sqt_invoice" : true
},
"station_order_no" : "1",
"order_id" : "1223654"
},
"store_id" : "0002",
"type_caption" : "一小时达",
"ship_location" : "store",
"ship_location_caption" : "上海",
"customer_info" : "string",
"private_customer_info" : "string",
"payment_type" : "货到付款",
"delivery_type" : "送货上门",
"pre_type" : "normal:正常,dsd:定时达,half_day:半日达",
"package_total" : 14.02,
"status_caption" : "已取消",
"create_time" : "2017-11-27 18:38:42",
"shipping_time" : "2017-11-27 18:38:42",
"ship_time" : "2017-11-27 18:38:42",
"sign_time" : "2017-11-27 18:38:42",
"exception_type" : "stopped",
"exception_info" : "string",
"has_exception" : false,
"exception_codes" : "sku(商品异常),amount(金额异常),shopAmount(货款金额异常),carrier(承运异常),invoice(开票异常),delivery.address(配送地址信息异常),traceCode(溯源码异常)",
"orig_total" : 12.03,
"invoice" : {
"required" : false,
"details" : [ {
"amount" : 12.02,
"content" : "某某公司",
"title" : "plain",
"title_type" : "person",
"taxer_id" : "1212345046600736XP"
} ],
"apply_qrcode" : "string"
},
"freight" : 12.03,
"freight_discount" : 33.33,
"order_store" : {
"id" : "string",
"name" : "string"
},
"expected_delivered_date" : "2014-02-03",
"expected_delivered_time_slot" : "11:00-12:00",
"payable_amount" : 12.02,
"customer_note" : "无",
"private_mobile" : "189389928893",
"private_street" : "脱敏地址**",
"salechannel_name" : "美到家",
"cancel_type" : "customerCancel",
"carrier_type" : "express",
"carrier_state" : "pickupFailed",
"deliveryman_mobile" : "15655895658",
"carrier_id" : "self",
"carrier_name" : "顺丰",
"waybill_id" : "123456",
"carrier_exception_remark" : "门店不存在",
"multi_store" : false,
"fault_tolerant_info" : "string",
"package_info" : {
"required" : false,
"type" : "系统自动计算,order(订单)、refund(仅退款)、refundAndRtn(退款退货)",
"details" : "[]",
"package_type" : "保温袋"
},
"sku_quantity" : 1.0,
"real_total" : 120.01,
"discount_amount" : 0.0,
"item_total" : 0.0,
"allow_actions" : [ "string" ],
"extra_info" : {
"userStoredPromAmount" : "string",
"userRealPayAmount" : "string",
"userRealPromAmount" : "string",
"userPrepaidAmount" : "string"
},
"print_info" : {
"parameters" : [ {
"name" : "string",
"value" : "string"
} ]
},
"selftake_code" : "123456",
"member_info" : {
"member_id" : "12253",
"card_no" : "22323",
"member_gid" : "12253",
"outer_member_id" : "12253",
"mobile" : "12253"
}
} ]
}
1.1.46. 订单计数
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/orders/querycount
1.1.46.1. 说明
订单计数
1.1.46.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.1.46.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.46.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/orders/querycount
1.1.46.5. HTTP响应示例
响应 200
{
"new_order" : 4,
"wait_selftake" : 4,
"store_self" : 4,
"carrier_exception" : 4,
"wait_process_rtn" : 4,
"trace_code_exception" : 6
}
1.1.47. 查询快速搜索条件
POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/orders/quicksearchfilter
1.1.47.1. 说明
查询快速搜索条件
1.1.47.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.1.47.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.47.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/orders/quicksearchfilter
1.1.47.5. HTTP响应示例
响应 200
{
"quick_filters" : [ "string" ]
}
1.1.48. 退款(含退款详情)
PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/refund/{id}
1.1.48.1. 说明
退款(含退款详情)
1.1.48.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
退换货申请单ID |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
details |
退款支付方式详情 |
1.1.48.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.1.48.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/refund/string?operator_id=string
请求 body
{
"payments" : [ {
"name" : "支付宝",
"amount" : 12.03,
"card_number" : "22121",
"store_pay" : false,
"need_cash" : false
} ]
}
1.1.49. 取得可以用的销售渠道
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/salechannels
1.1.49.1. 说明
取得可以用的销售渠道
1.1.49.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.1.49.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.49.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/salechannels
1.1.49.5. HTTP响应示例
响应 200
{
"channels" : [ {
"id" : "string",
"name" : "string"
} ]
}
1.1.50. 自提检查
GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/selftake/check
1.1.50.1. 说明
自提检查
1.1.50.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Query |
salechannel |
订单来源:取值范围:mdj(美到家)、jdo2o(京东到家)、tbkb(淘宝口碑) |
string |
Query |
selftake_code |
自提码 |
string |
1.1.50.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.50.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/selftake/check?operator_id=string&salechannel=string&selftake_code=string
1.1.50.5. HTTP响应示例
响应 200
{
"accepted" : true,
"message" : "恭喜您,验证通过"
}
1.1.51. 获取外部呼叫的承运商
GET /{tenant_id}/storedelivery/deliverservice/thridparty/carriers
1.1.51.1. 说明
获取外部呼叫的承运商
1.1.51.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
1.1.51.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.51.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/thridparty/carriers
1.1.51.5. HTTP响应示例
响应 200
{
"carriers" : [ {
"id" : "string",
"name" : "string"
} ],
"store_carriers" : [ {
"uuid" : "string",
"carrier" : {
"id" : "string",
"name" : "string"
},
"proxy" : true,
"line_number" : 1,
"carrier_merchant" : {
"id" : "string",
"name" : "string"
},
"carrier_system" : {
"id" : "string",
"name" : "string"
},
"priority" : 1
} ]
}
1.2. 客户退货服务
1.2.1. 退单呼叫云打印
POST /{tenant_id}/storedelivery/rtnservice/rtn/call/cloud/print
1.2.1.1. 说明
退单呼叫云打印
1.2.1.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户 |
string |
Query |
operator |
操作人 |
string |
Body |
param |
参数 |
1.2.1.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.1.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/rtn/call/cloud/print?operator=string
请求 body
{
"printer" : "string",
"rtn_id" : "string",
"tpl_names" : [ "string" ]
}
1.2.1.5. HTTP响应示例
响应 200
{
"message" : "string",
"success" : true
}
1.2.2. 退货申请
POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/order/{id}/{action}/apply
1.2.2.1. 说明
退货申请
1.2.2.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
action |
操作类型,取值有partrefund(部分退款) |
string |
Path |
id |
订单号 |
string |
Path |
store_id |
门店代码 |
string |
Path |
tenant_id |
租户代码 |
string |
Query |
operator_id |
操作人 |
string |
Query |
operator_name |
操作人姓名 |
string |
Body |
request |
申请内容 |
1.2.2.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.2.2.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/order/string/string/apply?operator_id=string
请求 body
{
"reason" : "不想要了",
"items" : [ {
"order_item_no" : "2",
"item_code" : "32323",
"item_name" : "苹果",
"quantity" : 32.0
} ]
}
1.2.3. 获取退单收货失败原因
GET /{tenant_id}/storedelivery/rtnservice/store/{store_id}/receiverFailReason
1.2.3.1. 说明
获取退单收货失败原因
1.2.3.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店代码 |
string |
Path |
tenant_id |
租户ID |
string |
1.2.3.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.3.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/receiverFailReason
1.2.3.5. HTTP响应示例
响应 200
{
"values" : [ "string" ],
"empty" : true
}
1.2.4. 取单个退货订单
GET /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorder/{id}
1.2.4.1. 说明
取单个退货订单
1.2.4.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
退换货申请单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
fetch_parts |
需要取回的退货订单部件。如果传null表示只取退货订单头部,如果传items表示取订单的详情,refunds表示退款详情,如果传item.details表示取组合商品详情。 |
string |
1.2.4.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.4.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorder/string
1.2.4.5. HTTP响应示例
响应 200
{
"id" : "23232323",
"type" : "refund",
"salechannel" : "jdo2o",
"status" : "received",
"total" : 21.25,
"items" : [ {
"spec" : "1*1",
"unit" : "kg",
"quantity" : 56.0,
"total" : 59.36,
"order_item_id" : "string",
"item_no" : "1",
"item_code" : "0001",
"item_name" : "香蕉",
"unit_price" : 12.36,
"barcode" : "32323",
"order_quantity" : 56.0,
"details" : [ {
"id" : "032345",
"title" : "矿泉水",
"quantity" : 12.0,
"ratio" : 0.65
} ],
"orig_item" : {
"quantity" : 12.0,
"item_code" : "32323",
"item_name" : "可乐",
"qpc" : "1*1",
"order_quantity" : 12.0,
"unit" : "份"
}
} ],
"refunds" : [ {
"name" : "支付宝",
"amount" : 12.03,
"card_number" : "22121",
"store_pay" : false,
"need_cash" : false
} ],
"tags" : [ {
"name" : "首单"
} ],
"appeal" : false,
"sale_order_id" : "32443323",
"salechannel_name" : "京东到家",
"sale_payment_type" : "货到付款",
"sale_ship_location" : "dc",
"delivery_type" : "上门取件",
"status_caption" : "待审核",
"refund_status" : "refunding",
"refund_status_caption" : "已退款",
"customer_info" : "aaa",
"apply_time" : "2018-05-04 14:25:25",
"apply_reason" : "不想要了",
"customer_note" : "haha",
"voucher_urls" : [ "string" ],
"receive_time" : "2018-05-04 14:25:25",
"hint_info" : "hello",
"invoice_info" : "aaa",
"return_amount" : 25.36,
"waybill_id" : "1212121212",
"cancel_reason" : "又想要了",
"sku_quantity" : 0.0,
"order_info" : {
"id" : "1001001",
"status" : "confirming",
"deliveryman" : "李三",
"front_order_id" : "1001001",
"status_caption" : "已取消",
"create_time" : "2017-11-27 18:38:42",
"deliveryman_mobile" : "15655895658",
"carrier_id" : "self",
"carrier_name" : "顺丰",
"waybill_id" : "123456",
"carrier_type" : "express",
"carrier_state" : "pickupFailed",
"station_order_no" : "1",
"delivery_type" : "送货上门"
},
"allow_actions" : [ "string" ]
}
1.2.5. 审核退款
PUT /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorder/{id}/status/approve
1.2.5.1. 说明
审核退款
1.2.5.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
退换货申请单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
detail |
退货详情 |
1.2.5.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.2.5.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorder/string/status/approve?operator_id=string&operator_name=string
请求 body
{
"state" : "refuse",
"reason" : "已和客户联系,不退"
}
1.2.6. 确认收到退货
PUT /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorder/{id}/status/received
1.2.6.1. 说明
确认收到退货
1.2.6.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
退换货申请单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
detail |
退货详情 |
1.2.6.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.2.6.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorder/string/status/received?operator_id=string&operator_name=string
请求 body
{
"type" : "all(整单)、part(部分),默认all",
"items" : [ {
"item_no" : "1",
"item_code" : "0001",
"quantity" : 56.0
} ],
"payments" : [ {
"name" : "支付宝",
"amount" : 12.03,
"card_number" : "22121",
"store_pay" : false,
"need_cash" : false
} ]
}
1.2.7. 确认收货失败
POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorder/{id}/status/receivefail
1.2.7.1. 说明
确认收货失败
1.2.7.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
退换货申请单号 |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
Body |
fail |
失败详情 |
1.2.7.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.2.7.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorder/string/status/receivefail?operator_id=string&operator_name=string
请求 body
{
"reason" : "string",
"voucher_urls" : [ "string" ]
}
1.2.8. 退货单取消
POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorder/{rtn_id}/cancel
1.2.8.1. 说明
退货单取消
1.2.8.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
rtn_id |
退单号 |
string |
Path |
store_id |
门店代码 |
string |
Path |
tenant_id |
租户代码 |
string |
Query |
operator_id |
操作人 |
string |
Query |
operator_name |
操作人姓名 |
string |
Body |
request |
申请内容 |
1.2.8.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.2.8.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorder/string/cancel?operator_id=string
请求 body
{
"reason" : "收货失败",
"operator_role" : "platform",
"approve_state" : "serviceApproved"
}
1.2.9. 分页查询退货订单
POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorders/query
1.2.9.1. 说明
分页查询退货订单,只返回退货订单头,不返回详情。可查询条件列表conditions有:id.equals(退货申请单号等于)、status.equals(退货单状态等于)、saleOrderId.equals(原始订单等于)、returnerMobileNo.contains(客户手机号等于)、returnerName.contains(客户名字等于)、receiveTime.from(退货时间起始于)、receiveTime.to(退货时间结束于)、approving(退货单状态等于待审核)、returning(退货单状态等于待退货)、received(退货单状态等于已收货)、canceled(退货单状态等于已取消)、type.equals(退货单类型等于refundAndRtn(退款退货)、refund(仅退款))、refundStatus.equals(退款状态等于refunding(未退款)、refunded(已退款))
1.2.9.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Body |
definition |
查询条件 |
1.2.9.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.9.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorders/query
请求 body
{
"conditions" : [ {
"name" : "aaa",
"param" : "2018-05-04 14:25:25"
} ],
"orders" : [ {
"field" : "created",
"direction" : "asc"
} ],
"page" : 0,
"page_size" : 10,
"fetch_parts" : "items,invoiceDetails",
"quick_search_filters" : "0"
}
1.2.9.5. HTTP响应示例
响应 200
{
"paging" : {
"page" : 0,
"page_size" : 20,
"page_count" : 20,
"record_count" : 20,
"has_more" : false
},
"records" : [ {
"id" : "23232323",
"type" : "refund",
"salechannel" : "jdo2o",
"status" : "received",
"total" : 21.25,
"items" : [ {
"spec" : "1*1",
"unit" : "kg",
"quantity" : 56.0,
"total" : 59.36,
"order_item_id" : "string",
"item_no" : "1",
"item_code" : "0001",
"item_name" : "香蕉",
"unit_price" : 12.36,
"barcode" : "32323",
"order_quantity" : 56.0,
"details" : [ {
"id" : "032345",
"title" : "矿泉水",
"quantity" : 12.0,
"ratio" : 0.65
} ],
"orig_item" : {
"quantity" : 12.0,
"item_code" : "32323",
"item_name" : "可乐",
"qpc" : "1*1",
"order_quantity" : 12.0,
"unit" : "份"
}
} ],
"refunds" : [ {
"name" : "支付宝",
"amount" : 12.03,
"card_number" : "22121",
"store_pay" : false,
"need_cash" : false
} ],
"tags" : [ {
"name" : "首单"
} ],
"appeal" : false,
"sale_order_id" : "32443323",
"salechannel_name" : "京东到家",
"sale_payment_type" : "货到付款",
"sale_ship_location" : "dc",
"delivery_type" : "上门取件",
"status_caption" : "待审核",
"refund_status" : "refunding",
"refund_status_caption" : "已退款",
"customer_info" : "aaa",
"apply_time" : "2018-05-04 14:25:25",
"apply_reason" : "不想要了",
"customer_note" : "haha",
"voucher_urls" : [ "string" ],
"receive_time" : "2018-05-04 14:25:25",
"hint_info" : "hello",
"invoice_info" : "aaa",
"return_amount" : 25.36,
"waybill_id" : "1212121212",
"cancel_reason" : "又想要了",
"sku_quantity" : 0.0,
"order_info" : {
"id" : "1001001",
"status" : "confirming",
"deliveryman" : "李三",
"front_order_id" : "1001001",
"status_caption" : "已取消",
"create_time" : "2017-11-27 18:38:42",
"deliveryman_mobile" : "15655895658",
"carrier_id" : "self",
"carrier_name" : "顺丰",
"waybill_id" : "123456",
"carrier_type" : "express",
"carrier_state" : "pickupFailed",
"station_order_no" : "1",
"delivery_type" : "送货上门"
},
"allow_actions" : [ "string" ]
} ]
}
1.2.10. 查询快速搜索条件
POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorders/quicksearchfilter
1.2.10.1. 说明
查询快速搜索条件
1.2.10.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
1.2.10.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.10.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorders/quicksearchfilter
1.2.10.5. HTTP响应示例
响应 200
{
"quick_filters" : [ "string" ]
}
1.2.11. 批量查询退单打印接口
GET /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtns/printdatas
1.2.11.1. 说明
批量查询退单打印接口
1.2.11.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
ids |
退单号 |
< string > array(multi) |
Query |
names |
打印模版名称name:外卖退单,长度不超过40,打印多个用英文逗号隔开如:外卖退单。不传表示打印全部 |
string |
Query |
operator_id |
操作人ID,长度不超过20 |
string |
Query |
operator_name |
操作人姓名,长度不超过50 |
string |
1.2.11.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.11.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtns/printdatas?ids=string&operator_id=string
1.2.11.5. HTTP响应示例
响应 200
{
"rtns" : [ {
"parts" : [ "string" ],
"rtn_id" : "21212",
"time" : "2019-07-03 13:06:46"
} ]
}
1.3. 通知服务
1.3.1. 确认通知的状态
POST /{tenant_id}/storedelivery/noticeservice/store/{store_id}/confirm
1.3.1.1. 说明
确认通知的状态
1.3.1.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户Id |
string |
Body |
body |
1.3.1.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.3.1.4. HTTP请求示例
请求 path
/string/storedelivery/noticeservice/store/string/confirm
请求 body
{
"ids" : [ "string" ]
}
1.3.2. 消费通知
GET /{tenant_id}/storedelivery/noticeservice/store/{store_id}/consume
1.3.2.1. 说明
消费通知,请在消费后确认通知,否则将重复获得相同通知
1.3.2.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户Id |
string |
Query |
count |
一次性取的通知数,最多100条。 |
integer (int32) |
Query |
topic |
主题 |
string |
1.3.2.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.3.2.4. HTTP请求示例
请求 path
/string/storedelivery/noticeservice/store/string/consume?count=0
1.3.2.5. HTTP响应示例
响应 200
{
"notices" : [ {
"id" : "12212",
"topic" : "new.order",
"content" : "212123",
"content2" : "{\"order_id\":\"212123\",\"delivery_type\":\"deliver\"}",
"time" : "2018-06-22 14:25:13"
} ]
}
1.3.3. 新-确认通知的状态
POST /{tenant_id}/storedelivery/noticeservice/{app_id}/store/{store_id}/confirm
1.3.3.1. 说明
新-确认通知的状态
1.3.3.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
app_id |
appId |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户Id |
string |
Body |
body |
1.3.3.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
default |
successful operation |
无内容 |
1.3.3.4. HTTP请求示例
请求 path
/string/storedelivery/noticeservice/string/store/string/confirm
请求 body
{
"ids" : [ "string" ]
}
1.3.4. 新-消费通知
GET /{tenant_id}/storedelivery/noticeservice/{app_id}/store/{store_id}/consume
1.3.4.1. 说明
新-消费通知,请在消费后确认通知,否则将重复获得相同通知
1.3.4.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
app_id |
appId |
string |
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户Id |
string |
Query |
count |
一次性取的通知数,最多100条。 |
integer (int32) |
Query |
topic |
主题 |
string |
1.3.4.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.3.4.4. HTTP请求示例
请求 path
/string/storedelivery/noticeservice/string/store/string/consume?count=0
1.3.4.5. HTTP响应示例
响应 200
{
"notices" : [ {
"id" : "12212",
"topic" : "new.order",
"content" : "212123",
"content2" : "{\"order_id\":\"212123\",\"delivery_type\":\"deliver\"}",
"time" : "2018-06-22 14:25:13"
} ]
}
2. 定义
2.1. ActionResult
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
message |
样例 : |
string |
success |
默认值 : |
boolean |
2.2. ApproveDetail
审核详情
名称 | 说明 | 类型 |
---|---|---|
reason |
原因 |
string |
state |
审核状态:approved, refuse |
string |
2.4. CarrierDetail
承运商详情
名称 | 说明 | 类型 |
---|---|---|
action |
样例 : |
string |
carrier_id |
承运平台代码 |
string |
carrier_merchant_id |
承运商家编码 |
string |
carrier_merchant_name |
承运商家名称 |
string |
carrier_name |
承运平台名称 |
string |
carrier_type |
承运方式,self(商家自送)、thirdparty(第三方配送)、express(快递配送) |
string |
deliveryman |
配送员名称 |
string |
deliveryman_id |
配送员Id |
string |
deliveryman_mobile |
配送员电话 |
string |
freight |
运费 |
number |
waybill_id |
运单号 |
string |
2.5. CarrierDetailInfo
更新承运商
名称 | 说明 | 类型 |
---|---|---|
carrier_id |
承运商代码 |
string |
carrier_name |
承运商名称 |
string |
waybill_id |
运单号 |
string |
2.6. CarrierList
承运商列表
名称 | 说明 | 类型 |
---|---|---|
carriers |
承运商列表 |
< IdName > array |
store_carriers |
承运商列表(新) |
< StoreCarrier > array |
2.7. CarrierOrderInfo
承运单历史
名称 | 说明 | 类型 |
---|---|---|
carrier_id |
承运商代码 |
string |
carrier_name |
承运商名称 |
string |
carrier_state |
承运状态 |
string |
created |
创建时间 |
string (date-time) |
deliveryman |
配送员姓名 |
string |
deliveryman_phone |
配送员手机号 |
string |
details |
运单轨迹信息 |
< OrderKdTraceDetail > array |
exception_remark |
异常说明 |
string |
modified |
最后一次修改时间 |
string (date-time) |
waybill_id |
运单号 |
string |
2.8. CarrierOrderResponse
订单配送单信息
名称 | 说明 | 类型 |
---|---|---|
carrier_orders |
承运单列表 |
< CarrierOrderInfo > array |
code |
样例 : |
string |
message |
样例 : |
string |
order_id |
订单号 |
string |
success |
默认值 : |
boolean |
waybill_id |
运单号 |
string |
2.9. ChangeSku
换货商品
名称 | 说明 | 类型 |
---|---|---|
barcode |
样例 : |
string |
imageUrl |
样例 : |
string |
name |
样例 : |
string |
price |
样例 : |
number |
sku_id |
样例 : |
string |
stock |
样例 : |
number |
upc |
样例 : |
string |
weight |
样例 : |
number |
weightUnit |
样例 : |
string |
2.11. CheckResult
检查结果
名称 | 说明 | 类型 |
---|---|---|
accepted |
检查是否通过 |
boolean |
message |
提示信息 |
string |
2.12. CodeName
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
name |
样例 : |
string |
2.13. DeliverCountResponse
统计数返回
名称 | 说明 | 类型 |
---|---|---|
carrier_exception |
配送异常 |
integer (int32) |
new_order |
新订单数 |
integer (int32) |
store_self |
门店自送数 |
integer (int32) |
trace_code_exception |
溯源码异常数 |
integer (int32) |
wait_process_rtn |
待处理退单数 |
integer (int32) |
wait_selftake |
待自提数 |
integer (int32) |
2.14. DeliverDetail
签收详情
名称 | 说明 | 类型 |
---|---|---|
deliver_id |
送货人ID, 长度20字符 |
string |
deliver_name |
送货人姓名,长度32字符 |
string |
on_duty_emps |
当班的人员 |
< IdName > array |
payments |
付款方式详情 |
< DeliverPaymentDetail > array |
2.15. DeliverFailDetail
订单未投递成功详情
名称 | 说明 | 类型 |
---|---|---|
reason |
原因说明 |
string |
type |
原因类型,取值:refused(客户拒收),redeliver(未妥投) |
string |
2.16. DeliverFailReason
投递失败原因
名称 | 说明 | 类型 |
---|---|---|
reason |
原因说明 |
string |
type |
取值范围:refused(客户拒收)、redeliver(未妥投) |
string |
2.17. DeliverFailReasonList
原因列表对象
名称 | 说明 | 类型 |
---|---|---|
reasons |
原因列表 |
< DeliverFailReason > array |
2.18. DeliverFrontItemAttribute
平台商品行属性信息
名称 | 说明 | 类型 |
---|---|---|
group |
属性分组 |
string |
price |
属性售价 |
number |
qty |
属性数量 |
number |
values |
属性值 |
< string > array |
2.19. DeliverFrontOrder
平台订单信息
名称 | 说明 | 类型 |
---|---|---|
attribute |
平台属性 |
|
order_id |
平台订单号,第三方单号 |
string |
station_order_no |
平台门店订单序号,该平台下单门店的第几单,用于骑手到店取件 |
string |
2.20. DeliverFrontOrderAttribute
平台订单属性信息
名称 | 说明 | 类型 |
---|---|---|
is_sqt_invoice |
企业版订单是否给平台开票,餐道平台字段 |
boolean |
is_sqt_order |
是否企业版订单,餐道平台字段 |
boolean |
2.21. DeliverInvoice
发票
名称 | 说明 | 类型 |
---|---|---|
apply_qrcode |
开票二维码 |
string |
details |
发票详情 |
< DeliverInvoiceDetail > array |
required |
是否需要发票 |
boolean |
2.22. DeliverInvoiceDetail
发票详情
名称 | 说明 | 类型 |
---|---|---|
amount |
发票金额 |
number |
content |
发票内容 |
string |
taxer_id |
纳税人识别号(买家填写) |
string |
title |
发票抬头 |
string |
title_type |
抬头类型,取值范围:person(个人)、company(单位) |
string |
2.23. DeliverOrder
客户订单
名称 | 说明 | 类型 |
---|---|---|
allow_actions |
允许操作的动作,接单、拒绝、打印小票、确认备货、确认发货、确认妥投、客户拒收、确认自提、取消订单、申请赔付、缺重补差、复核、转门店自送、缺货登记、呼叫配送、退货退款、作废赔付 |
< string > array |
cancel_type |
取消类型,取值为stationRefuse(门店拒接)、customerCancel(客户取消) |
string |
carrier_exception_remark |
承运异常信息 |
string |
carrier_id |
承运商代码,取值为self(门店自送)、thirdparty(第三方配送)等其他第三方承运商ID |
string |
carrier_name |
承运商名称 |
string |
carrier_state |
承运状态取值为initial(初始状态)、created(已下单)、dispatched(已派单)、createdFailed(下单失败)、arrived(已到店)、delivering(配送中)、delivered(配送完成)、canceled(已取消)、pickup(已揽件)、pickupFailed(揽件失败) |
string |
carrier_type |
承运商类型,取值为self(门店自送)、thirdparty(第三方配送)、express(快递配送) |
string |
create_time |
下单时间,格式是:yyyy-MM-dd HH:mm:ss |
string |
customer_info |
客户信息(收件人信息) |
string |
customer_note |
客户备注 |
string |
delivery_type |
送货方式,取值:送货上门|到店自提 |
string |
deliveryman |
配送员 |
string |
deliveryman_mobile |
配送员电话 |
string |
discount_amount |
优惠金额 |
number |
exception_codes |
异常代码 |
< string > array |
exception_info |
异常信息 |
string |
exception_type |
异常类型:取值范围:redeliver(未妥投)、refused(客户拒收)、timeout(超期未提)、stopped(发货后取消)、listingException(上架异常) |
string |
expected_delivered_date |
期望送达日期 |
string |
expected_delivered_time_slot |
期望送达时间时间段 |
string |
extra_info |
||
fault_tolerant_info |
容错信息,json字符串 |
string |
freight |
运费 |
number |
freight_discount |
运费优惠金额 |
number |
front |
平台订单信息 |
|
has_exception |
订单是否有异常 |
boolean |
id |
订单号 |
string |
invoice |
发票 |
|
item_total |
商品原金额 |
number |
items |
商品详情 |
< DeliverOrderItem > array |
member_info |
||
mobile |
客户电话(收货人电话) |
string |
multi_store |
是否支持跨店调度配送,默认false |
boolean |
order_store |
下单门店 |
|
orig_total |
订单原金额 |
number |
package_info |
||
package_total |
商家包装费用 |
number |
payable_amount |
尾款 |
number |
payment_type |
支付方式的标题,取值:货到付款|在线支付 |
string |
pre_type |
订单预约类型 |
string |
print_info |
样例 : DeliverOrderPrint |
|
private_customer_info |
客户脱敏信息(收件人脱敏信息) |
string |
private_mobile |
隐私号 |
string |
private_street |
脱敏地址 |
string |
quotas |
订单限定 |
< DeliverOrderQuota > array |
real_total |
实际销售商品金额(扣除所有优惠),等于items中pay_amount之和,不包含运费等其他费用,系统会自动重算 |
number |
salechannel |
订单来源:取值范围:mdj(美到家)、jdo2o(京东到家)、tbkb(淘宝口碑) |
string |
salechannel_name |
平台名称:取值范围:美到家、京东到家、淘宝口碑 |
string |
selftake_code |
自提码 |
string |
ship_location |
发货地,取值范围,dc(库房发货)、store(门店直送) |
string |
ship_location_caption |
发货地显示标题 |
string |
ship_time |
发货时间,格式是:yyyy-MM-dd HH:mm:ss |
string |
shipping_time |
备货时间,格式是:yyyy-MM-dd HH:mm:ss |
string |
sign_time |
签收时间,格式是:yyyy-MM-dd HH:mm:ss |
string |
sku_quantity |
商品总数 |
number |
status |
订单状态,取值范围:confirming(待确认)、shipping(待发货)、storenotsigned(未签收)、storesigned(门店签收)、prepared(已上架)、delivering(已登记)、delivered(已妥投)、refused(客户拒收)、redeliver(未妥投)、canceled(已取消)、stopped(终止配送) |
string |
status_caption |
订单状态显示名称 |
string |
store_id |
门店ID |
string |
tags |
订单标签 |
< 订单标签 > array |
total |
订单实付金额 |
number |
type_caption |
订单类型说明,取值:一小时达|非一小时达 |
string |
waybill_id |
运单号 |
string |
2.24. DeliverOrderApplyRtnRequest
订单申请退款
名称 | 说明 | 类型 |
---|---|---|
apply_type |
申请类型:weight_diff(缺重退差),stock_none(缺货退款),amount(按金额退),all(整单退),part(部分退) |
string |
items |
申请明细 |
< DeliverOrderItemRtnApply > array |
policy |
策略 |
string |
reason |
原因 |
string |
rtn_id |
退单号,不传的话会自己生成 |
string |
type |
退单类型,不传的话会根据订单状态计算 |
string |
2.25. DeliverOrderApplyRtnResponse
名称 | 说明 | 类型 |
---|---|---|
apply_ids |
多个申请ID |
< string > array |
code |
样例 : |
string |
message |
样例 : |
string |
success |
默认值 : |
boolean |
2.26. DeliverOrderDecryptRequest
类型 : object
2.27. DeliverOrderDecryptResponse
名称 | 说明 | 类型 |
---|---|---|
customer_info |
客户信息(收件人信息) |
string |
receiver_mobile |
样例 : |
string |
receiver_street |
样例 : |
string |
2.28. DeliverOrderExtraInfo
名称 | 说明 | 类型 |
---|---|---|
userPrepaidAmount |
餐道平台商品券买券金额 |
string |
userRealPayAmount |
餐道用户实际支付金额 |
string |
userRealPromAmount |
餐道用户实际优惠金额 |
string |
userStoredPromAmount |
餐道用户储值赠送优惠 |
string |
2.29. DeliverOrderItem
客户订单商品明细
名称 | 说明 | 类型 |
---|---|---|
barcode |
条形码 |
string |
category_id |
线下类目代码 |
string |
details |
原料明细 |
< DeliverOrderItemDetail > array |
discount_amount |
商品优惠金额,如:商品立减优惠 |
number |
disp |
商品是否散装,默认false |
boolean |
fault_tolerant_info |
容错信息,json字符串 |
string |
fav_price |
优惠后单价 |
number |
fav_total |
优惠后金额 |
number |
front |
前台信息 |
|
image_url |
商品图片信息 |
string |
itemCustomField |
商品自定义属性 |
|
item_code |
货号 |
string |
item_id |
行唯一标识 |
string |
item_name |
品名 |
string |
item_no |
序号 |
string |
orig_item |
下单商品行明细 |
|
package_qty |
包装盒数量 |
number |
package_total |
包装费用 |
number |
print_cup_sticker |
是否打印杯贴 |
boolean |
product_id |
商品代码 |
string |
quantity |
数量 |
number |
real_quantity |
实际数量 |
number |
real_weight |
实际重量,明细总重量(单位g) |
number |
rtn_quantity |
退货数量 |
number |
rtn_weight |
退货重量 |
number |
sku_shelf_position_code |
货位代码,获取详情需要级联获取参数:items.skuShelfPosition |
string |
spec |
规格 |
string |
station |
站点信息,获取站点详情需要级联获取参数:items.station |
|
tags |
商品标签 |
< 订单标签 > array |
total |
金额 |
number |
total_weight |
总重量(单位g) |
number |
trace_code_details |
溯源码明细,与traceCodes(溯源码)字段相比,二者不能同时使用,优先使用traceCodeDetails,traceCodeDetails无值,在使用traceCodes |
< OrderItemTraceCodeDetail > array |
trace_codes |
溯源码 |
< string > array |
unit |
单位:个、份等 |
string |
unit_price |
单价 |
number |
weight |
样例 : |
number |
2.30. DeliverOrderItemDetail
原料明细
名称 | 说明 | 类型 |
---|---|---|
barcode |
条形码 |
string |
disp |
商品是否散装,默认false |
boolean |
fault_tolerant_info |
容错信息,json字符串 |
string |
id |
原料商品货号 |
string |
quantity |
原料商品数量 |
number |
ratio |
比例 |
number |
real_quantity |
实际数量 |
number |
rtn_quantity |
退货数量 |
number |
sku_shelf_position_code |
货位代码,获取详情需要级联获取参数:items.skuShelfPosition |
string |
station |
站点信息,获取站点详情需要级联获取参数:items.station |
|
title |
名称 |
string |
trace_code_details |
溯源码明细,与traceCodes(溯源码)字段相比,二者不能同时使用,优先使用traceCodeDetails,traceCodeDetails无值,在使用traceCodes |
< OrderItemTraceCodeDetail > array |
trace_codes |
溯源码 |
< string > array |
2.31. DeliverOrderItemFront
客户订单商品明细前台信息
名称 | 说明 | 类型 |
---|---|---|
attributes |
属性 |
< DeliverFrontItemAttribute > array |
spec |
销售规格 |
string |
spec2 |
销售规格2 |
string |
2.32. DeliverOrderItemMod
商品修改详情
名称 | 说明 | 类型 |
---|---|---|
items |
商品修改详情 |
< DeliverOrderModItem > array |
payments |
付款方式详情 |
< DeliverPaymentDetail > array |
reason |
调整原因 |
string |
type |
调整类型:weight_diff(称重差异),stock_none(缺货) |
string |
2.33. DeliverOrderItemRtnApply
退款申请明细对象
名称 | 说明 | 类型 |
---|---|---|
item_code |
订单商品行货号 |
string |
order_item_no |
订单商品行行号,帮助定位退货商品行 |
string |
quantity |
数量,按数量退时传入,缺少的数量 |
number |
real_total_weight |
实拣总重量,单位g |
number |
refund_amount |
退款金额,按金额退时传入 |
number |
weights |
缺重重量详情(缺了多少g),按重量退时传入,多个数量可以传多个重量,单位g |
< number > array |
2.34. DeliverOrderItemStation
客户订单商品明细站点
名称 | 说明 | 类型 |
---|---|---|
station_id |
站点ID |
string |
station_no |
站点序号 |
string |
station_type |
站点类型,如booth(摊位)、store(门店) |
string |
2.35. DeliverOrderMemberInfo
积分信息
名称 | 说明 | 类型 |
---|---|---|
card_no |
实体卡卡号,如果存在多个,以英文逗号隔开 |
string |
member_gid |
会员资料内码 |
string |
member_id |
会员ID |
string |
mobile |
会员电话 |
string |
outer_member_id |
外部会员id |
string |
2.36. DeliverOrderModItem
名称 | 说明 | 类型 |
---|---|---|
details |
调整明细 |
< DeliverOrderModItemDetail > array |
item_code |
货号 |
string |
item_no |
序号 |
string |
quantity |
数量 |
number |
2.37. DeliverOrderModItemDetail
名称 | 说明 | 类型 |
---|---|---|
after |
调整后 |
string |
before |
调整前 |
string |
field |
调整字段 |
string |
2.38. DeliverOrderOrigItem
原商品行信息
名称 | 说明 | 类型 |
---|---|---|
item_code |
货号 |
string |
item_name |
品名 |
string |
qpc |
规格 |
string |
quantity |
数量 |
number |
rtn_quantity |
退货数量 |
number |
rtn_weight |
退货重量 |
number |
unit |
单位 |
string |
weight |
重量 |
number |
2.39. DeliverOrderPackageInfo
订单打包信息
名称 | 说明 | 类型 |
---|---|---|
details |
包装明细 |
< PackageDetail > array |
package_type |
指定打包袋类型:保温袋、纸袋、PLA环保袋 |
string |
required |
是否需要打包袋 |
boolean |
type |
单据类型 |
string |
2.40. DeliverOrderPaging
订单分页结果
名称 | 说明 | 类型 |
---|---|---|
paging |
分页对象 |
|
records |
客户订单列表 |
< DeliverOrder > array |
2.41. DeliverOrderPrint
名称 | 说明 | 类型 |
---|---|---|
parameters |
样例 : |
< 自定义参数 > array |
2.42. DeliverOrderPrintData
订单打印数据
名称 | 说明 | 类型 |
---|---|---|
order_id |
订单号 |
string |
parts |
每联的打印数据 |
< string > array |
time |
打印数据的生成时间,格式是:yyyy-MM-dd HH:mm:ss |
string |
2.43. DeliverOrderPrintDataList
订单打印数据列表
名称 | 说明 | 类型 |
---|---|---|
orders |
订单打印数据列表 |
< DeliverOrderPrintData > array |
2.44. DeliverOrderQuickSearchResponse
名称 | 说明 | 类型 |
---|---|---|
quick_filters |
支持的快速查询条件,条件有:预约单、有备注、到店自提 |
< string > array |
2.45. DeliverOrderQuota
订单限定
名称 | 说明 | 类型 |
---|---|---|
action |
操作:expect_shipping |
string |
action_name |
操作名称:期望拣货完成时间 |
string |
remark |
备注 |
string |
time |
日期 |
string (date-time) |
2.46. DeliverPaymentDetail
付款方式详情
名称 | 说明 | 类型 |
---|---|---|
amount |
金额 |
number |
card_number |
卡号 |
string |
name |
支付方式名称 |
string |
need_cash |
是否需要缴款 |
boolean |
store_pay |
是否门店收款/付款 |
boolean |
2.47. IdName
名称 | 说明 | 类型 |
---|---|---|
id |
样例 : |
string |
name |
样例 : |
string |
2.48. IdsWrapper
名称 | 说明 | 类型 |
---|---|---|
ids |
样例 : |
< string > array |
2.49. InvItem
库存信息
名称 | 说明 | 类型 |
---|---|---|
inv_qty |
库存数量 |
number |
item_no |
序号 |
string |
order_qty |
下单数量 |
number |
sku_id |
商品标识(货号) |
string |
sku_name |
商品名称 |
string |
upc |
UPC码 |
string |
2.51. ItemCustomField
商品自定义属性
名称 | 说明 | 类型 |
---|---|---|
item_code |
商品货号 |
string |
nfield1 |
数值自定义属性 |
number |
nfield2 |
数值自定义属性 |
number |
sfield1 |
字符换自定义属性 |
string |
sfield2 |
字符换自定义属性 |
string |
sfield3 |
字符换自定义属性 |
string |
sfield4 |
字符换自定义属性 |
string |
sfield5 |
字符换自定义属性 |
string |
sfield6 |
字符换自定义属性 |
string |
sfield7 |
字符换自定义属性 |
string |
sfield8 |
字符换自定义属性 |
string |
2.52. LAddress
地址信息
名称 | 说明 | 类型 |
---|---|---|
city |
市 |
string |
coordinate_type |
坐标类型,BD09:百度坐标, GCJ02:火星坐标,WGS84:WGS84坐标 |
string |
country |
国家 |
string |
district |
区 |
string |
latitude |
纬度 |
number |
longtitude |
经度 |
number |
postcode |
邮编 |
string |
private_street |
脱敏地址 |
string |
province |
省份 |
string |
street |
详细地址 |
string |
2.53. LCarrier
承运商
名称 | 说明 | 类型 |
---|---|---|
carrier |
承运平台 |
|
delivery_id |
配送活动标识 |
string |
delivery_name |
配送活动名称 |
string |
deliveryman |
送货员 |
|
deliveryman_mobile |
送货员手机 |
string |
exception_reason |
承运异常原因 |
string |
merchant |
承运商家 |
|
state |
承运状态,取值范围:initial(初始状态)、created(已下发)、createdFailed(下发失败)、dispatched(已派单)、pickup(已揽件)、pickupFailed(揽件失败)、delivering(配送中)、delivered(配送完成)、canceled(已取消) |
string |
type |
承运商类型,取值范围:self(门店自送)、thirdparty(第三方配送)、express(快递配送) |
string |
2.55. LDelivery
配送信息
名称 | 说明 | 类型 |
---|---|---|
carrier |
承运商 |
|
carrier_note |
承运商备注 |
string |
city_token |
同城令牌 |
string |
operation_state |
门店作业状态,none(空),accepted(已接单),shipping(已集货(已拣货)),rechecked(已复核),handover(已交接) |
string |
pickup_code |
取件码 |
string |
pre_end_delivery_time |
预计送达结束时间 |
string (date-time) |
pre_selftake_time |
预计自提时间 |
string |
pre_start_delivery_time |
预计送达开始时间 |
string (date-time) |
pre_type |
订单预约类型 |
string |
receiver |
收货人信息 |
|
remark |
配送说明 |
string |
selftake_code |
自提码 |
string |
selftake_confirmed |
自提确认 |
boolean |
ship_delivery_mode |
发货及配送方式,可选值:wrhShipCarrierDeli(仓库发货,快递配送)、wrhShipStationDeli(仓库发货,门店配送)、stationShipStationDeli(门店发货,门店配送)、stationShipCarrierDeli(门店发货,快递配送)、vendorShipCarrierDeli(供应商发货,快递配送) |
string |
ship_id |
发货码 |
string |
ship_mode |
发货方式,wrhShip(仓库发货),stationShip(门店发货),vendorShip(供应商发货) |
string |
state |
配送状态,默认取值为:none。取值范围:none(未配送)、shipped(已发货)、signed(已妥投)、refused(已拒收)、redeliver(重投) |
string |
station |
配送门店 |
|
type |
交付方式,默认取值:deliver。取值范围:selftake(到店自提)、deliver(送货上门) |
string |
vendor |
发货供应商 |
|
waybill_id |
运单号 |
string |
wrh |
发货仓库 |
|
wrh_order_id |
仓库单号 |
string |
2.56. LDiscountSettleDetail
优惠结算详情
名称 | 说明 | 类型 |
---|---|---|
discount |
承担优惠金额 |
number |
role |
优惠承担方 |
string |
2.57. LDiscountShareDetail
整合优惠结算详情
名称 | 说明 | 类型 |
---|---|---|
discount |
承担优惠金额 |
number |
type |
类型 |
string |
2.58. LExtraField
自定义字段
名称 | 说明 | 类型 |
---|---|---|
id |
自定义id |
string |
name |
自定义名称 |
string |
value |
自定义值 |
string |
2.59. LFavDetail
优惠详情
名称 | 说明 | 类型 |
---|---|---|
amount |
优惠金额 |
number |
batch_act_id |
批次维度的活动ID |
string |
child_type |
优惠子类型 |
string |
factor |
优惠参与信息 |
|
id |
优惠ID |
string |
merchant_act_id |
商家活动ID |
string |
name |
活动名称 |
string |
prom_cls |
促销来源类型 |
string |
remark |
优惠说明 |
string |
settle_details |
优惠结算分摊详情 |
< LDiscountSettleDetail > array |
share_details |
多方整合优惠分摊信息 |
< LDiscountShareDetail > array |
sku_act_id |
商品维度的活动ID |
string |
type |
优惠类型 |
string |
voucher_code |
凭证代码 |
string |
2.60. LFavFactor
优惠参与信息
名称 | 说明 | 类型 |
---|---|---|
qty |
本商品参与促销总数量 |
number |
sku_items |
来源商品参与优惠明细 |
< LFavFactorItem > array |
total |
本商品参与促销总金额 |
number |
2.61. LFavFactorItem
参与优惠商品明细
名称 | 说明 | 类型 |
---|---|---|
amount |
参与促销金额 |
number |
item_id |
行标识 |
string |
item_no |
行号 |
integer (int32) |
qty |
参与促销数量 |
number |
2.62. LFrontItem
平台商品行信息
名称 | 说明 | 类型 |
---|---|---|
attributes |
属性 |
< LFrontItemAttribute > array |
item_id |
平台订单行ID |
string |
sku_id |
平台SKU ID |
string |
spec |
平台商品属性(口味), 多个属性以;或者/分隔显示 |
string |
spec2 |
平台商品的规格,形如:500g、500ml |
string |
spu_id |
平台SPU ID |
string |
tags |
平台标签 |
< IdName > array |
unit |
单位 |
string |
2.63. LFrontItemAttribute
平台商品行属性信息
名称 | 说明 | 类型 |
---|---|---|
group |
属性分组 |
string |
price |
属性售价 |
number |
qty |
属性数量 |
number |
values |
属性值 |
< string > array |
2.64. LFrontOrder
平台订单信息
名称 | 说明 | 类型 |
---|---|---|
app |
平台应用 |
|
attribute |
属性信息 |
string |
created |
下单时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
dpt_station_time |
平台调度门店时间,用于存储平台分配门店时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
finished_time |
完成时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
inner_order_id |
平台内部单号 |
string |
main_order_id |
平台主订单号,如果平台存在拆单,可以填入拆单的主单号 |
string |
modified |
最后修改时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
order_id |
平台订单号,第三方单号 |
string |
order_type |
订单类型,默认为ECOM(普通订单):ECOM,普通订单;ShareGroup,拼团订单;POINTS_REDEEM,积分换购订单;ENLIST_REDEEM,预约兑换订单;PRESALE,预售订单;COMPENSATION,赔付订单 |
|
platform |
平台,其中:自接入平台需要提供约定平台id,申请在鼎力云开通。 |
|
state |
状态 |
string |
station_id |
平台侧的门店编码 |
string |
station_name |
平台侧的门店名称 |
string |
station_order_no |
平台门店订单序号,该平台下单门店的第几单,用于骑手到店取件 |
string |
wrh_id |
平台发货仓库编码 |
string |
2.65. LInvoice
发票信息
名称 | 说明 | 类型 |
---|---|---|
apply_qrcode |
开票二维码 |
string |
details |
发票详情 |
< LInvoiceDetail > array |
error_reason |
开票失败原因 |
string |
required |
是否需要发票 |
boolean |
result |
开票结果:开票成功、开票失败,申请开票时不传 |
string |
2.66. LInvoiceDetail
发票详情
名称 | 说明 | 类型 |
---|---|---|
account |
银行编号/账号 |
string |
address |
地址 |
string |
amount |
发票金额 |
number |
bank |
开户行 |
string |
buyer_tax_code |
购买方税号,废弃,建议使用taxerId字段 |
string |
check_code |
校验码 |
string |
content |
发票内容 |
string |
email |
发票接收邮箱 |
string |
kind |
发票种类,取值范围:e-invoice(电子)、paper(纸质) |
string |
print_number |
打印单号 |
string |
remark |
发票备注 |
string |
securaty_code |
密码 |
string |
serial_no |
流水号 |
string |
tax |
税费 |
number |
taxer_id |
纳税人识别号(买家填写) |
string |
telephone |
电话 |
string |
time |
开票日期 |
string (date-time) |
title |
发票抬头 |
string |
title_type |
抬头类型,取值范围:person(个人)、company(单位) |
string |
type |
发票类型,取值范围:plain(普通发票)、VAT(增值税专用发票) |
string |
url |
电子发票图片地址 |
string |
2.67. LItemPromotion
商品行促销信息
名称 | 说明 | 类型 |
---|---|---|
apported_discount_amount |
整单优惠分摊金额 |
number |
discount_amount |
商品优惠金额 |
number |
favs |
优惠详情 |
< LFavDetail > array |
2.68. LOrder
订单
名称 | 说明 | 类型 |
---|---|---|
address_change_fee |
地址变更费 |
number |
allow_actions |
允许操作的动作 |
< string > array |
approve_state |
审核子状态,取值范围:none(未审核)、serviceApproved(客服已审核)、financeApproved(财务已审核)、warehouseApproved(物流已审核)、carrierApproved(承运商已审核) |
string |
calc_data |
是否需要反算金额,默认true |
boolean |
cancel_reason |
取消原因 |
string |
cancel_type |
取消类型,取值为stationRefuse(门店拒接)、customerCancel(客户取消) |
string |
created |
样例 : |
string (date-time) |
creator |
样例 : |
string |
customer |
客户信息 |
|
customer_note |
客户备注 |
string |
delivery |
配送信息 |
|
exception_codes |
异常代码,sku(商品异常)、amount(金额异常)、shopAmount(货款金额异常)、carrier(承运异常) |
string |
exception_remark |
异常说明 |
string |
extra_info |
扩展信息,json字符串 |
string |
fault_tolerant_info |
容错信息,json字符串 |
string |
freight_discount |
运费优惠金额 |
number |
front |
平台订单信息 |
|
has_exception |
是否异常 |
boolean |
id |
订单Id,由系统自动生成,不需要填写 |
string |
invoice |
发票信息 |
|
invoice_take_code |
发票提取码,32位 |
string |
is_private |
是否是隐私号,true:小票显示的顾客手机号格式为138*8888,false:原手机号显示 |
boolean |
item_change_records |
换货明细 |
< LOrderItemChange > array |
item_count |
商品明细数 |
integer (int32) |
items |
商品行 |
< LOrderItem > array |
modified |
样例 : |
string (date-time) |
modifier |
样例 : |
string |
order_store |
客户下单门店 |
|
orig_total |
订单原金额(优惠之前) |
number |
package_discount |
包装优惠金额 |
number |
payment |
支付信息 |
|
performance_service_fee |
履约服务费 |
number |
pick_info |
订单拣货信息 |
|
print_count |
打印次数,需要级联打印信息字段print.record返回 |
integer (int32) |
promotion |
订单促销 |
|
real_total |
实际销售商品金额(扣除所有优惠),等于items中pay_amount之和,不包含运费等其他费用,系统会自动重算 |
number |
reissue_reason |
补发原因 |
string |
responsible_party |
补发责任方 |
string |
sale_order_id |
销售订单号,不存储,记录在关联信息 |
string |
seller_note |
商家备注 |
string |
selttle_commission |
平台佣金 ,弃用,请使用settle_commission |
number |
settle_amount |
平台的结算金额,平台结算金额=客户实付金额+平台优惠补贴, 为空等于amount |
number |
settle_commission |
平台佣金 |
number |
settle_freight |
平台结算运费 |
number |
shop |
平台商家,平台侧的商家,非门店 |
|
shop_amount |
商品货款金额=商品原金额-商家商品优惠金额 |
number |
sku_quantity |
商品总数 |
number |
source |
来源 |
string |
source_order_id |
来源订单号 |
string |
state |
订单状态,新建可不填,默认取值为:confirmed。取值范围:confirmed(已确认)、prepared(已预处理)、approved(已审核)、delivering( 配送中)、delivered(配送完成)、canceled(已取消) |
string |
suspend_info |
挂起信息 |
|
tags |
订单标签 |
< LOrderTag > array |
user_number |
使用人数,餐具数量 |
integer (int32) |
weight |
订单重量,单位:g |
number |
wrh_id |
发货仓库编号 |
string |
wrh_state |
仓库状态 |
string |
2.69. LOrderDbFilter
订单过滤器(数据库查询)
名称 | 说明 | 类型 |
---|---|---|
created_end |
创建时间截止于 |
string (date-time) |
created_start |
创建时间起始于 |
string (date-time) |
fetch_parts |
级联字段 |
string |
front_created_end |
下单时间截止于 |
string (date-time) |
front_created_start |
下单时间起始于 |
string (date-time) |
need_count_total |
是否计算总数 |
boolean |
operation_state_in |
门店作业状态范围 |
< string > array |
order_id_eq |
订单号等于 |
string |
order_id_or_front_station_order_no_eq |
订单号或门店订单号等于 |
string |
pick_info_operator_id_eq |
拣货Id人等于 |
string |
pick_info_operator_id_in |
订单拣货信息-拣货员ID,若传is null则查询没有这个字段或字段为空的订单 |
< string > array |
state_in |
状态范围 |
< string > array |
station_id_in |
门店代码范围,最多200个 |
< string > array |
2.70. LOrderFilter
订单过滤器
名称 | 说明 | 类型 |
---|---|---|
address_contains |
地址包含 |
string |
app_id_eq |
平台应用代码等于 |
string |
approve_states |
审核状态,取值:none(未审核)、serviceApproved(客服已审核)、financeApproved(财务已审核)、warehouseApproved(物流已审核)、carrierApproved(承运商已审核) |
< string > array |
bill_id_eq |
凭证单号等于 |
string |
bill_id_like |
凭证单号类似 |
string |
cancel_type |
取消类型,取值为stationRefuse(门店拒接)、customerCancel(客户取消) |
string |
carrier_id |
承运商号 |
string |
carrier_states |
承运状态,取值范围:initial(初始状态)、created(已下发)、createdFailed(下发失败)、pickup(已揽件)、pickupFailed(揽件失败)、delivering(配送中)、delivered(配送完成)、canceled(已取消) |
< string > array |
carrier_types |
承运类型,取值范围:self(商家自送)、thirdparty(第三方配送)、express(快递配送) |
< string > array |
created_end |
创建结束时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
created_start |
创建起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
custom_order_state |
自定义订单状态 |
< string > array |
customer_id |
客户代码 |
string |
customer_mobile |
客户手机号 |
string |
customer_mobile_end_with |
顾客手机号码截止于 |
string |
customer_name |
客户姓名 |
string |
deliver_shipped_operator |
发货人 |
string |
delivered_time_end |
妥投结束时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
delivered_time_start |
妥投起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
delivering_time_end |
发货起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
delivering_time_start |
发货起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
delivery_id |
配送ID |
string |
delivery_states |
配送状态,取值:none(未配送)、shipped(已发货)、signed(已妥投)、refused(已拒收)、redeliver(重投) |
< string > array |
delivery_types |
配送类型,取值:selftake(到店自提)、deliver(送货上门) |
< string > array |
deliveryman_name |
配送人姓名 |
string |
exception_code_contains |
异常代码 |
string |
fetch_parts |
级联参数,返回多个部分用英文,隔开。需要返回的部分,items(商品详情)、item.details(商品组合详情),、item.details(商品组合详情)、item.change.records(换货记录)、paymentDetails(支付详情)、invoiceDetails(发票详情)、printBills(打印数据)、prom(促销详情)、crm(营销详情)、logs(日志详情)、waybill.printinfo(运单打印信息) |
string |
front_created_end |
下单时间终止时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
front_created_start |
下单时间起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
front_main_order_id_eq |
平台主订单号等于 |
string |
front_main_order_id_in |
平台主订单号在……之中 |
< string > array |
front_main_order_id_start_with |
平台主订单号起始于 |
string |
front_order_id |
平台订单号 |
string |
front_order_id_prefix |
平台订单号起始搜索 |
string |
front_order_ids |
平台订单号 |
< string > array |
front_sku_id |
样例 : |
string |
front_station_order_no_eq |
平台门店订单序号等于 |
string |
handover_operator |
交接人 |
string |
hasInvoice |
是否拥有发票 |
boolean |
has_billing |
是否有凭证信息,false搜索没有、true搜索有 |
boolean |
has_customer_note |
是否有顾客信息,false搜索没有、true搜索有 |
boolean |
has_delivery_exception |
是否配送异常 |
boolean |
has_exception |
是否异常 |
boolean |
have_return |
存在退货但未签收 |
boolean |
index_modified_end |
索引最后修改时间结束于,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
index_modified_start |
索引最后修改时间起始于,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
modified_end |
修改结束时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
modified_start |
修改起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
operation_handover_time_end |
交接终止时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
operation_handover_time_start |
交接起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
operation_shipping_time_end |
集货终止时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
operation_shipping_time_start |
集货起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
operation_state |
门店作业状态,取值范围:none(空)、shipping(已集货)、handover(已交接) |
string |
operation_states |
门店作业状态,取值范围:none(空)、shipping(已集货)、handover(已交接) |
< string > array |
order_id |
订单号 |
string |
order_id_or_front_station_order_no_eq |
订单id或平台门店订单序号等于 |
string |
order_ids |
订单号 |
< string > array |
payment_out_pay_id |
第三方支付流水号(商户订单号) |
string |
payment_states |
付款状态,取值范围:notPay(未付款)、earnest(已付定金)、paid(已付全款) |
< string > array |
payment_types |
付款类型,取值范围:cod(货到付款)、online(在线支付)、earnest(预售) |
< string > array |
pick_info_is_auto_picked_finish |
订单拣货信息-是否自动拣货完成 |
boolean |
pick_info_operator_id_eq |
订单拣货信息-拣货员ID,若传is null则查询没有这个字段或字段为空的订单 |
string |
pick_info_operator_id_in |
订单拣货信息-拣货员ID,若传is null则查询没有这个字段或字段为空的订单 |
< string > array |
pick_info_operator_name_like |
订单拣货信息-拣货员名称 |
string |
pick_info_source_eq |
订单拣货信息-记录来源 |
string |
pick_info_time_end |
订单拣货信息-拣货时间 |
string (date-time) |
pick_info_time_start |
订单拣货信息-拣货时间 |
string (date-time) |
platform_id |
平台ID |
string |
platform_ids |
平台ID |
< string > array |
prePage |
上一页 |
integer (int32) |
pre_type |
预处理类型:normal:正常,dsd:定时达 |
string |
product_contains |
商品包括 |
string |
prom_id |
优惠ID等于 |
string |
prom_id_in |
优惠ID在……之中 |
< string > array |
prom_key |
优惠Key等于 |
string |
prom_key_in |
优惠Key在……之中 |
< string > array |
prom_name_like |
优惠名称类似于 |
string |
receiver_mobile |
收货人手机号码 |
string |
receiver_mobile_end_with |
收货人手机号码截止于 |
string |
receiver_mobile_like |
收货人手机号码模糊搜索 |
string |
receiver_name |
收货人 |
string |
receiver_private_mobile_end_with |
收货人隐私号结束于 |
string |
refund_state |
退款状态,取值范围:none(未退款)、refunded(已退款) |
string |
salesman_id_eq |
分销员代码等于 |
string |
selftake_code |
提货码 |
string |
ship_mode |
发货方式,wrhShip(仓库发货),stationShip(门店发货),vendorShip(供应商发货) |
string |
shipping_operator |
集货人 |
string |
shop_id |
商家ID |
string |
sku_id |
商品编码 |
string |
sku_id_in |
订单明细货号在……之中,最多指定100个货号 |
< string > array |
sku_title |
商品标题 |
string |
source |
订单来源 |
string |
source_order_id_eq |
源订单号等于 |
string |
source_order_id_in |
源订单号集合 |
< string > array |
states |
订单状态,取值:confirmed(已确认)、prepared(已预处理)、approved(已审核)、delivering(配送中)、delivered(配送完成)、canceled(已取消) |
< string > array |
station_ids |
门店ID |
< string > array |
suspended |
是否挂起 |
boolean |
type_eq |
订单类型 |
string |
vendor_code_eq |
供应商代码等于 |
string |
vendor_code_in |
供应商代码集合 |
< string > array |
vendor_code_start_with |
供应商代码起始于 |
string |
waybill_id |
运单号 |
string |
wrh_id_in |
发货仓库ID集合 |
< string > array |
wrh_id_start_with |
发货仓库ID起始于 |
string |
2.71. LOrderItem
商品行
名称 | 说明 | 类型 |
---|---|---|
apported_discount_amount |
整单优惠分摊金额,如:订单满减,整单分摊到明细 |
number |
barcode |
商品条码 |
string |
consume_scores |
消费积分 |
number |
cost_price |
成本价 |
number |
details |
原料商品明细 |
< LOrderItemDetail > array |
discount_amount |
商品优惠金额,如:商品立减优惠 |
number |
extra_info |
扩展信息,json格式。如果存在 inv_mgr = false 的话,表示该商品为非库存管理商品 |
string |
fault_tolerant_info |
容错信息,json字符串 |
string |
front |
前端商品信息 |
|
image_url |
商品图片信息 |
string |
is_collocation |
是否搭配商品(加料),如奶茶+珍珠,珍珠是奶茶的加料商品 |
boolean |
is_gift |
默认值 : |
boolean |
item_id |
订单商品行唯一标识 |
string |
item_no |
订单行号 |
string |
item_title |
商品标题 |
string |
orig_barcode |
转换前商品条码 |
string |
orig_extra_info |
原商品行扩展信息 |
|
orig_image_url |
转换前商品图片信息 |
string |
orig_item |
定制:订单原商品信息,用于多规格、组合商品场景,记录用户下单时的商品信息 |
|
orig_item_title |
转换前的商品名称:用于多规格、组合商品转换标品场景 |
string |
orig_mas_sku_id |
样例 : |
string |
orig_price |
转换前的商品售价:用于多规格、组合商品转换标品场景 |
number |
orig_qty |
转换前的商品数量:用于多规格、组合商品转换标品场景 |
number |
orig_sku_id |
转换前的货号:用于多规格转换场景 |
string |
orig_weight |
转换前商品重量,单位g |
number |
package_qty |
包装盒数量 |
number |
package_total |
包装费用 |
number |
pay_amount |
实付金额,等于total - apported_discount_amount - discount_amount |
number |
price |
售价(促销价),为空等于pay_amount/quantity |
number |
product_id |
商品代码 |
string |
promotion |
商品促销 |
|
purchase_price |
采购价 |
number |
quantity |
数量 |
number |
real_quantity |
实际拣货商品数量 |
number |
real_weight |
实际称重,明细总重量,单位g |
number |
relation_item_id |
关联商品行号,如奶茶+珍珠,记录关联的奶茶的item_id |
string |
relation_sku_id |
关联商品货号,如奶茶+珍珠,记录关联的奶茶的sku_id |
string |
rtn_quantity |
退货数量 |
number |
rtn_weight |
退货重量 |
number |
salesman |
推销员 |
|
service_options |
服务项目, 多个项目以/分隔显示 |
string |
settle_discountAmount |
平台优惠金额 |
number |
settle_price |
平台结算价格,为空等于售价 |
number |
settle_total |
平台结算金额 |
number |
shop_price |
商家货款价格 |
number |
shop_total |
商家货款金额=商品原金额-商家商品优惠 |
number |
sku_id |
商品标识(货号) |
string |
sku_shelf_position_code |
货位代码,获取详情需要级联获取参数:items.skuShelfPosition |
string |
spec |
商品规格 |
string |
station |
站点信息,获取站点详情需要级联获取参数:items.station |
|
tags |
标签 |
< LOrderItemTag > array |
total |
商品金额,等于unit_price * quantity |
number |
trace_codes |
溯源码 |
< string > array |
unit |
单位:个、份等 |
string |
unit_price |
商品销售价格(扣除优惠券前的价格) |
number |
uuid |
样例 : |
string |
weight |
单个商品重量,单位g |
number |
2.72. LOrderItemChange
换货明细
名称 | 说明 | 类型 |
---|---|---|
change_items |
目标商品行 |
< LOrderItem > array |
created |
样例 : |
string (date-time) |
creator |
样例 : |
string |
items |
来源商品行 |
< LOrderItem > array |
modified |
样例 : |
string (date-time) |
modifier |
样例 : |
string |
reason |
原因 |
string |
2.73. LOrderItemDetail
原料商品信息
名称 | 说明 | 类型 |
---|---|---|
fault_tolerant_info |
容错信息,json字符串 |
string |
front_spec |
平台属性 |
string |
id |
原料商品货号 |
string |
package_info |
包装信息 |
|
quantity |
需要原料商品数量,C=2A+3B,原料商品数量=组合商品数量*基数,2C时,A:2*2,B:2*3 |
number |
ratio |
原料商品基数,C=2A+3B,A:2,B:3 |
number |
real_quantity |
实际拣货商品数量 |
number |
rtn_quantity |
退货数量 |
number |
sku_shelf_position_code |
货位代码,获取详情需要级联获取参数:items.skuShelfPosition |
string |
station |
站点信息,获取站点详情需要级联获取参数:items.station |
|
title |
名称 |
string |
trace_codes |
溯源码 |
< string > array |
2.75. LOrderOrigItem
原商品行信息
名称 | 说明 | 类型 |
---|---|---|
barcode |
转换前条码 |
string |
combined_id |
如果是组合商品,需要传组合标识ID,可以用组合商品ID作为标识 |
string |
image_url |
转换前图片地址 |
string |
item_title |
转换前的商品名称:用于多规格、组合商品转换标品场景 |
string |
price |
转换前的商品售价:用于多规格、组合商品转换标品场景 |
number |
quantity |
转换前的商品数量:用于多规格、组合商品转换标品场景 |
number |
rtn_quantity |
退货数量 |
number |
rtn_weight |
退货重量 |
number |
sku_id |
转换前的货号:用于多规格、组合商品转换标品场景 |
string |
type |
类型,多规格multi、组合combined |
string |
weight |
重量 |
number |
2.76. LOrderPaging
订单分页对象
名称 | 说明 | 类型 |
---|---|---|
orders |
订单列表 |
< LOrder > array |
page |
页码 |
integer (int32) |
page_count |
总页数 |
integer (int32) |
page_size |
分页大小 |
integer (int32) |
total |
总条数 |
integer (int64) |
2.77. LOrderPickInfo
名称 | 说明 | 类型 |
---|---|---|
auto_picked_finish |
自动拣货完成 |
boolean |
operator_id |
拣货员ID |
string |
operator_name |
拣货员名称 |
string |
source |
记录来源 |
string |
time |
拣货时间 |
string (date-time) |
2.81. LPackageInfo
商品打包信息
名称 | 说明 | 类型 |
---|---|---|
packageName |
打包袋名称 |
string |
quantity |
包装盒数量 |
number |
thermosphere |
温层 |
string |
total |
包装费用 |
number |
2.82. LPayment
支付信息
名称 | 说明 | 类型 |
---|---|---|
amount |
订单应付总金额(包含商品、运费、包装费等) |
number |
cod_amount |
货到付款金额 |
number |
details |
支付详情 |
< LPaymentDetail > array |
earnest_amount |
预售订金金额 |
number |
extra |
支付费用扩展信息 |
< LExtraField > array |
freight |
运费(优惠后) |
number |
other_fee |
其他费用 |
number |
package_total |
商家包装费用 |
number |
pay_bill_id |
支付账单号 |
string |
pay_time |
付款时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
payee |
付款人 |
|
state |
付款状态,默认取值:notPay。取值范围:notPay(未付款)、earnest(已付定金)、paid(已付全款) |
string |
type |
付款类型,默认取值:online。取值范围:cod(货到付款)、online(在线支付)、earnest(预付) |
string |
2.83. LPaymentDetail
支付详情
名称 | 说明 | 类型 |
---|---|---|
account_name |
账号名称 |
string |
account_no |
账号 |
string |
amount |
金额 |
number |
cashier |
是否缴款 ,此字段用于刻画收款人收的钱是否需要上缴,如收的是现金就需要上缴,刷卡则就不需要上缴 |
boolean |
code |
支付方式代码 |
string |
discount_amount |
支付优惠金额 |
number |
extra_info |
扩展信息,json字符串 |
string |
flowno |
业务流水号 |
string |
name |
支付方式名称 |
string |
out_pay_id |
第三方支付流水号 |
string |
pay_id |
支付id |
string |
score |
积分数量 |
number |
type |
支付方式类型 |
string |
2.85. LSuspendInfo
挂起信息
名称 | 说明 | 类型 |
---|---|---|
caption |
挂起原因标题,显示用 |
string |
code |
挂起原因代码,每一种挂起原因用代码表示 |
string |
suspended |
是否挂起 |
boolean |
time |
挂起时间 |
string (date-time) |
2.87. Notice
通知对象
名称 | 说明 | 类型 |
---|---|---|
content |
通知内容 |
string |
content2 |
当topic=new.order,消息内容:{"order_id":"212123","delivery_type":"deliver"};当topic=print.order,消息内容:{"names":"摘果单,外卖订单","order_id":"83031581163384949"};当topic=new.compensation,消息内容:{"id":45454545,"order_id":768678978987}; |
string |
id |
通知ID |
string |
time |
通知发出时间,格式是:yyyy-MM-dd HH:mm:ss |
string |
topic |
通知主题 |
string |
2.89. OrderActionApplyItem
订单申请明细对象
名称 | 说明 | 类型 |
---|---|---|
item_code |
订单商品行货号 |
string |
order_item_no |
订单商品行行号,帮助定位退货商品行 |
string |
quantity |
订单商品行数量 |
number |
2.90. OrderActionApplyRequest
订单申请请求对象
名称 | 说明 | 类型 |
---|---|---|
items |
申请明细 |
< OrderActionApplyItem > array |
reason |
取消原因 |
string |
2.91. OrderItemChangeReq
商品换货详情
名称 | 说明 | 类型 |
---|---|---|
adjust_item_code |
调整后货号 |
string |
item_code |
调整前货号,如果是原商品时,传入原商品货号 |
string |
item_no |
序号 |
string |
policy |
策略 |
string |
reason |
样例 : |
string |
2.92. OrderItemDetailTraceCodeSave
订单明细溯源码保存对象
名称 | 说明 | 类型 |
---|---|---|
item_code |
原料货号 |
string |
trace_code_details |
溯源码明细,与traceCodes(溯源码)字段相比,二者不能同时使用,优先使用traceCodeDetails,traceCodeDetails无值,在使用traceCodes |
< OrderItemTraceCodeDetail > array |
trace_codes |
溯源码列表 |
< string > array |
2.93. OrderItemRealQty
订单明细复核详情
名称 | 说明 | 类型 |
---|---|---|
item_code |
货号,如果是组合商品,传对应的原料货号 |
string |
item_no |
序号 |
string |
real_quantity |
实际数量 |
number |
real_weight |
实际总重量(单位g) |
number |
2.94. OrderItemTraceCodeDetail
溯源码
名称 | 说明 | 类型 |
---|---|---|
batch_no |
批号 |
string |
code |
溯源码 |
string |
production_date |
生产日期 |
string (date-time) |
qpc_str |
规格 |
string |
qty |
数量 |
number |
valid_date |
有效期 |
string (date-time) |
2.95. OrderItemTraceCodeSave
订单明细溯源码保存对象
名称 | 说明 | 类型 |
---|---|---|
details |
原料明细 |
< OrderItemDetailTraceCodeSave > array |
item_code |
货号 |
string |
item_no |
序号 |
string |
trace_code_details |
溯源码明细,与traceCodes(溯源码)字段相比,二者不能同时使用,优先使用traceCodeDetails,traceCodeDetails无值,在使用traceCodes |
< OrderItemTraceCodeDetail > array |
trace_codes |
溯源码列表 |
< string > array |
2.96. OrderItemTraceCodeSaveRequest
订单明细溯源码保存请求
名称 | 说明 | 类型 |
---|---|---|
items |
样例 : |
< OrderItemTraceCodeSave > array |
2.97. OrderKdTraceDetail
订单快递跟踪详情
名称 | 说明 | 类型 |
---|---|---|
address |
地点 |
string |
message |
内容 |
string |
status |
状态 |
string |
time |
时间 |
string (date-time) |
2.98. OrderPartRefundItem
退货商品详情
名称 | 说明 | 类型 |
---|---|---|
item_code |
编码 |
string |
item_name |
品名 |
string |
order_item_no |
行号 |
string |
quantity |
数量 |
number |
2.99. OrderRealQtyRequest
商品实际数量请求
名称 | 说明 | 类型 |
---|---|---|
items |
样例 : |
< OrderItemRealQty > array |
2.100. OrderRefund
退款申请
名称 | 说明 | 类型 |
---|---|---|
order_id |
订单号 |
string |
payment_details |
退款付款明细 |
< DeliverPaymentDetail > array |
products |
退款商品行 |
< RefundProduct > array |
refundReq_id |
申请单号 |
string |
refund_total |
退款金额 |
number |
2.101. OrderRefundList
退款申请列表(财务同意,未退款的仅退款申请列表)
名称 | 说明 | 类型 |
---|---|---|
values |
退款申请列表 |
< OrderRefund > array |
2.102. OrderTransferStore
转单门店
名称 | 说明 | 类型 |
---|---|---|
distance |
距离 |
number |
inv_enough |
库存是否足够 |
boolean |
invs |
商品库存 |
< InvItem > array |
store_area |
门店区域 |
string |
store_id |
门店代码 |
string |
store_name |
门店名称 |
string |
telephone |
联系电话 |
string |
2.103. OrderTransferStoreParam
门店转单请求
名称 | 说明 | 类型 |
---|---|---|
all_transfer |
是否全单转单 |
boolean |
skus |
商品标识(货号)明细 |
< OrderTransferStoreSkuItemParam > array |
store_id |
转单门店Id |
string |
store_name |
转单门店名称 |
string |
2.104. OrderTransferStoreRangeParam
转单门店范围请求
名称 | 说明 | 类型 |
---|---|---|
key_like |
门店代码/名称 |
string |
region_code |
门店区域 |
string |
region_name_like |
门店区域类似 |
string |
sku_ids |
商品标识(货号),不传为整单转 |
< string > array |
transfer_store_id |
转单门店:原下单门店/其它门店 |
string |
2.105. OrderTransferStoreRangeResponse
转单门店范围返回列表
名称 | 说明 | 类型 |
---|---|---|
order_transfer_store_ranges |
返回结果 |
|
page |
当前页面 |
integer (int32) |
page_size |
页面大小 |
integer (int32) |
total |
总数 |
integer (int64) |
2.106. OrderTransferStoreRanges
转单门店范围返回列表
名称 | 说明 | 类型 |
---|---|---|
first_transfer |
是否首次转单 |
boolean |
transfer_store_id |
转单门店ID:非首次转单取原下单门店ID |
string |
transfer_store_name |
转单门店:非首次转单取原下单门店名称 |
string |
transfer_store_ranges |
转单门店范围列表 |
< OrderTransferStore > array |
2.107. OrderTransferStoreSkuItemParam
转单请求明细
名称 | 说明 | 类型 |
---|---|---|
item_no |
订单行号 |
string |
sku_id |
商品标识(货号) |
string |
2.108. PackageDetail
打包商品明细
名称 | 说明 | 类型 |
---|---|---|
amount |
打包袋金额 |
number |
qty |
打包袋数量 |
number |
skuId |
打包袋ID |
string |
skuName |
打包袋名称 |
string |
2.109. PackageDetailModReq
打包商品明细请求
名称 | 说明 | 类型 |
---|---|---|
details |
打包商品明细 |
< PackageDetail > array |
2.110. Paging
分页对象
名称 | 说明 | 类型 |
---|---|---|
has_more |
是否还有更多数据未被发现 |
boolean |
page |
页码 |
integer (int32) |
page_count |
页数 |
integer (int32) |
page_size |
分页大小 |
integer (int32) |
record_count |
查询结果集总记录数 |
integer (int64) |
2.111. QueryCondition
查询条件
名称 | 说明 | 类型 |
---|---|---|
name |
查询条件名 |
string |
param |
查询条件参数,日期类型使用格式:yyyy-MM-dd HH:mm:ss |
string |
2.112. QueryDefinition
查询定义对象
名称 | 说明 | 类型 |
---|---|---|
conditions |
条件列表 |
< QueryCondition > array |
fetch_parts |
级联返回,订单查询目前支持返回items(明细行)、item.details(原料明细)、logs(订单日志)、invoiceDetails(发票详情),退单查询支持返回order(订单信息)、items(退单明细行)、item.details(退单明细行原料)多个级联返回用,分割 |
string |
orders |
排序列表 |
< QueryOrder > array |
page |
当前页码,必须大于等于0 |
integer (int32) |
page_size |
分页大小,范围是[0,100] |
integer (int32) |
quick_search_filters |
快速搜索条件,多个搜索用,分割 |
string |
2.113. QueryOrder
排序条件对象
名称 | 说明 | 类型 |
---|---|---|
direction |
排序条件,取值范围:asc(升序)、desc(降序) |
enum (asc, desc) |
field |
排序字段 |
string |
2.114. ReasonList
原因列表
名称 | 说明 | 类型 |
---|---|---|
empty |
默认值 : |
boolean |
values |
原因列表 |
< string > array |
2.115. ReceiveDetail
退货成功详情
名称 | 说明 | 类型 |
---|---|---|
items |
收货商品明细,部分收货时需要传明细 |
< ReceiveDetailItem > array |
payments |
退款详情 |
< DeliverPaymentDetail > array |
type |
收货商品明细 |
string |
2.116. ReceiveDetailItem
退货成功详情
名称 | 说明 | 类型 |
---|---|---|
item_code |
编码 |
string |
item_no |
序号 |
string |
quantity |
数量 |
number |
2.117. ReceiveFail
收货失败信息
名称 | 说明 | 类型 |
---|---|---|
reason |
失败原因 |
string |
voucher_urls |
凭证Url(图片) |
< string > array |
2.119. RefundPaymentDetail
退款支付方式详情
名称 | 说明 | 类型 |
---|---|---|
payments |
退款详情列表 |
< DeliverPaymentDetail > array |
2.120. RefundProduct
退款商品
名称 | 说明 | 类型 |
---|---|---|
qty |
数量 |
number |
skuId |
货号 |
string |
total |
金额 |
number |
2.121. RtnActionApplyRequest
退货申请
名称 | 说明 | 类型 |
---|---|---|
items |
退货商品明细 |
< OrderPartRefundItem > array |
reason |
取消原因 |
string |
2.122. RtnActionCancelRequest
退货申请
名称 | 说明 | 类型 |
---|---|---|
approve_state |
审核状态:none(未审核),serviceApproved(客服已审核),serviceRefuse(客服已拒绝),financeApproved(财务已审核),financeRefuse(财务已拒绝) |
string |
operator_role |
操作角色 |
string |
reason |
取消原因 |
string |
2.123. RtnOrder
退货订单
名称 | 说明 | 类型 |
---|---|---|
allow_actions |
允许操作的动作,拒绝申请、同意申请、确认收货、拒绝收货、打印小票 |
< string > array |
appeal |
是否申诉 |
boolean |
apply_reason |
申请原因 |
string |
apply_time |
申请退货时间,格式是:yyyy-MM-dd HH:mm:ss |
string |
cancel_reason |
取消申请原因 |
string |
customer_info |
客户信息 |
string |
customer_note |
客户留言 |
string |
delivery_type |
退货订单收货方式,取值:上门取件|到店退货 |
string |
hint_info |
提示信息 |
string |
id |
退货订单ID |
string |
invoice_info |
发票信息 |
string |
items |
退货商品 |
< RtnOrderItem > array |
order_info |
订单信息,需要级联参数order返回 |
|
receive_time |
退货时间,格式是:yyyy-MM-dd HH:mm:ss |
string |
refund_status |
退款状态,取值范围:refunding(未退款)、refunded(已退款) |
string |
refund_status_caption |
退款状态描述 |
string |
refunds |
退款详情 |
< DeliverPaymentDetail > array |
return_amount |
退款金额 |
number |
sale_order_id |
对应的订单ID |
string |
sale_payment_type |
订单支付方式, 取值:货到付款|在线支付 |
string |
sale_ship_location |
对应订单的发货地,取值范围:dc(库房发货)、store(门店直送) |
string |
salechannel |
订单来源 |
string |
salechannel_name |
平台名称 |
string |
sku_quantity |
样例 : |
number |
status |
退货状态,取值范围:approving(待审核)、returning(待退货)、received(已退货)、canceled(已取消) |
string |
status_caption |
退货状态描述 |
string |
tags |
退单标签 |
< 订单标签 > array |
total |
退货金额 |
number |
type |
退货单类型,取值范围:refund(仅退款)、refundAndRtn(退款退货) |
string |
voucher_urls |
凭证Url(图片) |
< string > array |
waybill_id |
退回物流单号 |
string |
2.124. RtnOrderItem
退货商品
名称 | 说明 | 类型 |
---|---|---|
barcode |
条形码 |
string |
details |
商品原料 |
< RtnOrderItemDetail > array |
item_code |
编码 |
string |
item_name |
品名 |
string |
item_no |
序号 |
string |
order_item_id |
样例 : |
string |
order_quantity |
订单数量 |
number |
orig_item |
下单商品行明细 |
|
quantity |
数量 |
number |
spec |
规格 |
string |
total |
金额 |
number |
unit |
计量单位 |
string |
unit_price |
单价 |
number |
2.125. RtnOrderItemDetail
商品原料
名称 | 说明 | 类型 |
---|---|---|
id |
原料商品货号 |
string |
quantity |
原料商品数量 |
number |
ratio |
原料商品比率 |
number |
title |
名称 |
string |
2.126. RtnOrderOrderInfo
退货订单订单信息
名称 | 说明 | 类型 |
---|---|---|
carrier_id |
承运商代码,取值为self(门店自送)、thirdparty(第三方配送)等其他第三方承运商ID |
string |
carrier_name |
承运商名称 |
string |
carrier_state |
承运状态取值为initial(初始状态)、created(已下单)、dispatched(已派单)、createdFailed(下单失败)、delivering(配送中)、delivered(配送完成)、canceled(已取消)、pickup(已揽件)、pickupFailed(揽件失败) |
string |
carrier_type |
承运商类型,取值为self(门店自送)、thirdparty(第三方配送)、express(快递配送) |
string |
create_time |
下单时间,格式是:yyyy-MM-dd HH:mm:ss |
string |
delivery_type |
送货方式,取值:送货上门|到店自提 |
string |
deliveryman |
配送员 |
string |
deliveryman_mobile |
配送员电话 |
string |
front_order_id |
平台订单号 |
string |
id |
订单号 |
string |
station_order_no |
平台门店订单序号,该平台下单门店的第几单,用于骑手到店取件 |
string |
status |
订单状态,取值范围:confirming(待确认)、shipping(待发货)、storenotsigned(未签收)、storesigned(门店签收)、prepared(已上架)、delivering(已登记)、delivered(已妥投)、refused(客户拒收)、redeliver(未妥投)、canceled(已取消)、stopped(终止配送) |
string |
status_caption |
订单状态显示名称 |
string |
waybill_id |
运单号 |
string |
2.127. RtnOrderOrigItem
原商品行信息
名称 | 说明 | 类型 |
---|---|---|
item_code |
货号 |
string |
item_name |
品名 |
string |
order_quantity |
订单数量 |
number |
qpc |
规格 |
string |
quantity |
数量 |
number |
unit |
单位 |
string |
2.128. RtnOrderPaging
退货订单分页查询结果
名称 | 说明 | 类型 |
---|---|---|
paging |
分页对象 |
|
records |
退货订单记录 |
< RtnOrder > array |
2.129. RtnOrderPrintData
退单打印数据
名称 | 说明 | 类型 |
---|---|---|
parts |
每联的打印数据 |
< string > array |
rtn_id |
退单号 |
string |
time |
打印数据的生成时间,格式是:yyyy-MM-dd HH:mm:ss |
string |
2.130. RtnOrderPrintDataList
退单打印数据列表
名称 | 说明 | 类型 |
---|---|---|
rtns |
退单打印数据列表 |
< RtnOrderPrintData > array |
2.131. RtnOrderQuickSearchResponse
名称 | 说明 | 类型 |
---|---|---|
quick_filters |
支持的快速查询条件,条件有:仅退款,退款退货,顾客申诉 |
< string > array |
2.133. SelftakeConfirmDetail
自提确认详情
名称 | 说明 | 类型 |
---|---|---|
payments |
付款方式详情 |
< DeliverPaymentDetail > array |
2.134. StoreCarrier
门店承运商对象
名称 | 说明 | 类型 |
---|---|---|
carrier |
承运平台 |
|
carrier_merchant |
承运商家 |
|
carrier_system |
样例 : IdName |
|
line_number |
行号 |
integer (int32) |
priority |
优先级 |
integer (int32) |
proxy |
默认值 : |
boolean |
uuid |
样例 : |
string |
2.135. 商品换货范围请求
名称 | 说明 | 类型 |
---|---|---|
barcode_start |
条码起始搜索 |
string |
keyword |
货号、名称、条码 |
string |
sku_id |
要换货的商品货号,每个订单上这个值是唯一的 |
string |
2.136. 打印结果
名称 | 说明 | 类型 |
---|---|---|
business_key |
打印主键 |
string |
business_type |
打印主键类型 |
string |
id |
打印ID,唯一值 |
string |
message |
样例 : |
string |
printer |
打印方 |
string |
success |
默认值 : |
boolean |
time |
打印时间 |
string (date-time) |
tmpl_names |
模板名称集合,不指定则是印所有模板 |
< string > array |
2.137. 盲盒
名称 | 说明 | 类型 |
---|---|---|
details |
盲盒的商品详情 |
< 盲盒商品详情 > array |
sku_id |
盲盒的skuId,每个订单上这个值是唯一的 |
string |
2.138. 盲盒商品详情
名称 | 说明 | 类型 |
---|---|---|
qty |
商品的购买数量 |
number |
sku_id |
盲盒内的商品货号 |
string |
2.139. 联系方式(soms)
联系方式
名称 | 说明 | 类型 |
---|---|---|
email |
邮箱 |
string |
fax |
传真 |
string |
mobile |
手机(mobile和telephone建议给值mobile) |
string |
name |
姓名 |
string |
private_mobile |
隐私号 |
string |
private_name |
脱敏名称 |
string |
telephone |
电话 |
string |
2.140. 自定义参数
名称 | 说明 | 类型 |
---|---|---|
name |
名称 |
string |
value |
值 |
string |
2.141. 订单呼叫云打印参数
名称 | 说明 | 类型 |
---|---|---|
order_id |
订单号 |
string |
printer |
打印方 |
string |
tpl_names |
模板名称 |
< string > array |
2.142. 订单呼叫云打印结果
名称 | 说明 | 类型 |
---|---|---|
message |
信息 |
string |
success |
是否成功 |
boolean |
2.143. 订单标签
名称 | 说明 | 类型 |
---|---|---|
name |
名称 |
string |
2.144. 订单盲盒列表
名称 | 说明 | 类型 |
---|---|---|
data |
对象列表 |
< 盲盒 > array |
2.145. 退单呼叫云打印参数
名称 | 说明 | 类型 |
---|---|---|
printer |
打印方 |
string |
rtn_id |
退单号 |
string |
tpl_names |
模板名称 |
< string > array |
2.146. 退单呼叫云打印结果
名称 | 说明 | 类型 |
---|---|---|
message |
信息 |
string |
success |
是否成功 |
boolean |