订单详情接口文档通常会定义接口的基本信息、请求方式、请求参数、响应参数以及返回的数据结构。下面是一个简化的订单详情接口文档示例,其中包含了JSON返回数据的参考格式。
接口文档示例
接口名称
获取订单详情
请求方式
GET
请求参数
- orderId (Path): 订单的唯一标识符,例如
"123456789"
。
响应参数(JSON格式)
{
"trades_sold_get_response":{
"total_results":100,
"trades":{
"trade":[
{
"seller_nick":"我在测试",
"buyer_open_uid":"AAHk5d-EAAeGwJedwSFu0XXX",
"title":"麦包包",
"type":"fixed(一口价)",
"created":"2000-01-01 00:00:00",
"tid":2231958349,
"acookie_id":"1a11a0987628772c002ec7d0eec2a352",
"sid":"NP1021246146",
"seller_rate":true,
"buyer_rate":true,
"status":"TRADE_NO_CREATE_PAY",
"payment":"200.07",
"discount_fee":"200.07",
"adjust_fee":"200.07",
"post_fee":"200.07",
"total_fee":"200.07",
"pay_time":"2000-01-01 00:00:00",
"end_time":"2000-01-01 00:00:00",
"modified":"2000-01-01 00:00:00",
"async_modified":"2000-01-01 00:00:00",
"consign_time":"2000-01-01 00:00:00",
"received_payment":"200.07",
"commission_fee":"200.07",
"alipay_no":"2009112081173831",
"alipay_id":2011082299567459,
"buyer_area":"浙江省杭州市",
"nut_feature":";buyernick:tester;card:123;buyerArea:杭州",
"pic_path":"http:\/\/img08.taobao.net\/bao\/uploaded\/i8\/T1jVXXXePbXXaoPB6a_091917.jpg",
"num_iid":3424234,
"price":"200.07",
"cod_fee":"12.07",
"cod_status":"EW_CREATED(订单已创建)",
"shipping_type":"free",
"num":1,
"point_fee":0,
"real_point_fee":0,
"buyer_obtain_point_fee":0,
"receiver_name":"****东方",
"receiver_state":"浙江省",
"receiver_city":"杭州市",
"receiver_district":"西湖区",
"receiver_town":"三墎镇",
"receiver_address":"****淘宝城",
"receiver_zip":"223700",
"receiver_mobile":"****1826",
"receiver_phone":"****5372",
"seller_flag":1,
"is_lgtype":true,
"lg_aging_type":"次日达",
"lg_aging":"2012-06-19 15:16:14",
"is_brand_sale":true,
"is_force_wlb":true,
"has_buyer_message":true,
"credit_card_fee":"30.5",
"trade_from":"WAP,JHS",
"step_trade_status":"FRONT_NOPAID_FINAL_NOPAID",
"step_paid_fee":"525.70",
"mark_desc":"该订单需要延长收货时间",
"has_yfx":true,
"yfx_fee":"0.50",
"yfx_id":"135751716473138",
"yfx_type":"taojinbi",
"trade_source":"ownshop",
"send_time":"2000-01-01",
"seller_can_rate":true,
"is_part_consign":true,
"is_wt":true,
"is_daixiao":true,
"o2o":"crm",
"o2o_guide_id":"123456",
"o2o_guide_name":"西湖门店导购员1",
"o2o_shop_id":"123456",
"o2o_shop_name":"西湖门店",
"o2o_delivery":"inshop",
"o2o_out_trade_id":"123456",
"orders":{
"order":[
{
"title":"山寨版测试机器",
"pic_path":"http:\/\/img08.taobao.net\/bao\/uploaded\/i8\/T1jVXXXePbXXaoPB6a_091917.jpg",
"price":"200.07",
"num_iid":2342344,
"sku_id":"5937146",
"outer_iid":"152e442aefe88dd41cb0879232c0dcb0",
"outer_sku_id":"81893848",
"refund_status":"SUCCESS(退款成功)",
"status":"TRADE_NO_CREATE_PAY",
"oid":2231958349,
"total_fee":"200.07",
"payment":"200.07",
"discount_fee":"200.07",
"adjust_fee":"1.01",
"divide_order_fee":"21.00",
"part_mjz_discount":"21.00",
"sku_properties_name":"颜色:桔色;尺码:M",
"item_meal_id":2564854632,
"item_meal_name":"M8原装电池:便携支架:M8专用座充:莫凡保护袋",
"num":1,
"buyer_rate":true,
"seller_rate":true,
"refund_id":"2231958349",
"seller_type":"B(商城商家)",
"cid":123456,
"end_time":"2012-04-07 00:00:00",
"consign_time":"2013-01-13 15:23:00",
"shipping_type":"post",
"logistics_company":"顺风快递",
"invoice_no":"05432465",
"bind_oid":23194074143138,
"is_daixiao":true,
"ticket_outer_id":"123456abcd",
"ticket_expdate_key":"100FFFFFF02374020000002001020304000A",
"is_www":true,
"store_code":"南京QDHEWL-0004",
"tmser_spu_code":"家装干支装服务",
"sub_order_tax_fee":"0",
"sub_order_tax_rate":"0",
"zhengji_status":"1",
"md_qualification":"true_access",
"md_fee":"999",
"sub_order_tax_promotion_fee":"0",
"tax_free":true,
"tax_coupon_discount":"0",
"special_refund_type":"priceProtect",
"is_devalue_fee":true,
"is_idle":"1",
"promise_collect_time":"2000-01-01 00:00:00",
"is_force_dc":true,
"shp_info":{
"ship_info":[
{
"transport_type":"express,seller,instant等"
}
]
}
}
]
},
"service_orders":{
"service_order":[
{
"oid":110770592823138,
"item_oid":110770592803138,
"service_id":2342344,
"service_detail_url":"http:\/\/wt.taobao.com\/plan.htm?plan_id=planId",
"num":1,
"price":"39.09",
"payment":"29.98",
"title":"滚筒洗衣机",
"total_fee":"39.09",
"buyer_nick":"小倩2005",
"refund_id":"2231958349",
"seller_nick":"麦包包",
"pic_path":"http:\/\/img08.taobao.com\/bao\/upload\/i8\/T1jVXXXePb_a0908.jpg",
"tmser_spu_code":"家装干支装服务"
}
]
},
"zero_purchase":true,
"receiver_country":"中国",
"order_tax_fee":"0",
"shop_pick":"1",
"rx_audit_status":"0",
"post_gate_declare":true,
"cross_bonded_declare":true,
"order_tax_promotion_fee":"0",
"service_type":"timedd,jiaju",
"is_o2o_passport":true,
"tmall_delivery":true,
"threepl_timing":true,
"cn_service":"84_50",
"cutoff_minutes":"660",
"es_time":"4",
"delivery_time":"2018-06-09 12:13:14",
"collect_time":"2018-06-09 12:13:14",
"dispatch_time":"2018-06-09 12:13:14",
"sign_time":"2018-06-09 12:13:14",
"delivery_cps":"STO",
"es_range":"09:00-12:00",
"es_date":"2018-06-09",
"os_range":"09:00-12:00",
"os_date":"2018-06-09",
"asdp_biz_type":"logistics_upgrade",
"asdp_ads":"201",
"drug_register":"1",
"promise_sign_time":"2000-01-01 00:00:00",
"oaid":"2w2RYE45iahnF4aiaJ7pHKCJ3Hwnbgnq2PH3AfpQVyWZNHKS9wNgAAOUfCVt9XZMetogNHwc",
"scenario_group":"TXD_B2C_FRESH_HALFDAY",
"is_force_dc":true,
"buyer_nick":"我在测试",
"logistics_agreement":{
"logistics_service_msg":"送货上门",
"asdp_biz_type":"logistics_upgrade",
"asdp_ads":"201",
"sign_time":"2019-04-12 16:00:00",
"promise_sign_time":"2019-04-12 16:00:00"
},
"logistics_infos":{
"logistics_info":[
{
"biz_delivery_type":0,
"unused_warehouse_error_msg":"当前订单在猫淘平台对消费者进行了服务承诺:当日发次日达,建议按照平台要求进行择仓,否则存在赔付风险",
"unused_delivery_error_msg":"当前订单在猫淘平台对消费者进行了服务承诺,建议按照平台要求进行择配,否则存在赔付风险”\/“平台建议当前线路您只能选择的配品牌,存在电子面单无法打印风险",
"used_black_delivery_error_msg":"平台建议当前线路不要使用您选择的配品牌,存在电子面单无法打印风险",
"promise_outbound_time":"2019-04-12 16:00:00",
"trade_id":1100070860172581613,
"sub_trade_id":1100070860173581613,
"promise_collect_time":"2000-01-01 00:00:00"
}
]
},
"receipt_type":"ITEM",
"seller_flag_tag":"红色旗子",
"seller_memo":"交易备注"
}
]
},
"has_next":true
}
}
注意事项
- 接口安全性:在实际开发中,应考虑接口的安全性,如使用HTTPS协议、身份验证(如OAuth、JWT等)、访问控制等。
- 错误处理:接口文档应明确描述各种可能的错误场景及对应的响应状态码和消息。
- 分页与排序:如果订单详情包含大量数据(如订单历史、订单项等),可能需要考虑分页和排序机制。
- 数据隐私:确保返回的数据符合隐私保护政策,不泄露敏感信息。
以上是一个基本的订单详情接口文档示例,具体实现时可能需要根据实际需求进行调整。