文档中心 > API类目 > 五道口API

alibaba.aelophy.order.get (翱象拉取订单接口)

翱象拉取订单接口

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
order_get_request	OrderGetRequest	必须			请求对象
└ store_id String 必须 S001 经营店编码 └ biz_order_id Number 必须 50003170001 五道口订单编码

响应参数

名称	类型	示例值	描述
api_result	TopBaseResult		响应对象
model OrderResponse 订单对象 └ merchant_code String CSSJ 商家编码 └ store_id String S001 经营店编码 └ shop_id String s001 渠道店编码 └ order_from Number 1 订单渠道, 31=淘鲜达等 └ biz_order_id Number 50003170001 订单编码 └ out_order_id String 10003170001 渠道订单编码 └ pay_time Date 2023-03-17 00:00:00 支付时间 └ original_fee Number 100 订单总价，分 └ discount_fee Number 100 订单总优惠，分 └ post_fee Number 100 配送费，分 └ package_fee Number 100 包装费，分 └ pay_fee Number 100 用户实际支付费用，分 └ order_status String PAID 订单状态 PAID = 订单支付完成 PACKAGED = 订单打包出库 SHIPPING = 订单配送揽收 SUCCESS = 交易完成 CLOSE = 订单取消 receive_info ReceiveInfo 收货人信息 └ receiver_name String 姓名收货人姓名, 格式: 刘; (商家自配送场景给出) └ receiver_phone String 13310004132,129 收货人联系方式, 虚拟小号; (商家自配送场景给出) └ receiver_address String 地址收货人地址信息; (商家自配送场景给出) └ receiver_memo String 备注收货人下单备注 └ receiver_poi String 120.03278,30.28523 收货人经纬度; (商家自配送场景给出) └ expect_arrive_time String 2023-04-04 22:00:00~2023-04-04 23:00:00 期望收货时间 └ receiver_privacy_phone String 187**6789 收货人手机号 sub_order_response_list SubOrderResponse [] 子订单列表 └ biz_sub_order_id Number 500031700011 子订单编码 └ out_sub_order_id String 100031700011 渠道子订单编码 └ sku_code String 098781 商品编码 └ sku_name String 商品名称商品名称 └ price Number 100 商品单价, 分 └ sale_unit String 件销售单位 └ stock_unit String 件库存单位 └ buy_stock_quantity BigDecimal 1.00 库存单位购买数量 └ buy_sale_quantity BigDecimal 1.00 销售单位购买数量 └ original_fee Number 1000 子订单原价 └ discount_fee Number 1000 子订单优惠金额 └ weight Number 1000 商品总重量, g └ barcode String S001201001 商品条码 └ discount_merchant_fee Number 100 商家优惠分摊 └ discount_platform_fee Number 100 平台优惠分摊 └ gift_flag String 0 是否赠品 0=普通品/1=赠品 └ weight_flag String 0 是否称重品 0=标品 / 1=称重品 └ order_status String PAID 子订单状态值枚举同主单状态 activitys OrderActivity [] 子单活动列表 └ channel_activity_id String 300123101001 渠道活动ID └ biz_activity_id String 100011 关联业务活动ID └ merchant_activity_id String S001001 关联商家ERP活动ID └ activity_name String 测试活动活动名称 └ discount_fee Number 100 活动优惠金额 └ discount_merchant_fee Number 50 活动优惠商家分摊 └ discount_platform_fee Number 50 活动优惠平台分摊 └ activity_type String itemTJ 活动类型 funds_discounts OrderFundsDiscount [] 资金优惠 └ discount_name String 红包活动名称 └ discount_type String VOUCHER 活动类型 └ discount_fee Number 40 优惠金额(分) └ discount_merchant_fee Number 40 商家优惠(分) └ discount_platform_fee Number 40 平台优惠(分) service_props SkuServiceProperty [] 服务属性 └ prop_name String 温度属性名称 └ prop_value String 常温属性细分项名称 voucher_infos OrderVoucherInfo [] 优惠券列表 └ voucher_id String 12345 券ID └ voucher_certificate String 12345 券凭证 promotion_infos PromotionInfo [] 优惠活动列表 └ active_id String 12345678 活动ID └ active_name String 买赠活动081401 活动名称 └ type String wdkShopMS 活动类型 └ txd_active_id String 88983045462 淘鲜达活动ID └ out_active_id String 12345678 外部商家活动ID └ discount_fee Number 1 折扣金额，单位：分 └ platform_expand_fee Number 100 购物金-平台承担膨胀金，单位：分 └ merchant_expand_fee Number 100 购物金-商家承担膨胀金，单位：分 └ platform_benefit_fee Number 100 购物金-平台承担购后权益，单位：分 └ merchant_benefit_fee Number 100 购物金-商家承担购后权益，单位：分 ext OrderInfoExt 订单扩展信息 └ subscribe_message String 祝福语祝福语 └ subscribe_phone String 13310004132,129 订购人电话, 虚拟小号; (商家自配送场景给出) └ member_card_num String 1000210019 会员卡号 └ stock_out_info_code String 1 1-缺货时电话与我沟通 2-缺货商品退款（其它商品继续配送） 3-整单取消并退款 └ ext_info String {\"scenarioGroup\":\"TXD_HALFDAY\",\"fulfillTag\":\"HALF_DAY\"} 标识订单来源和履约类型，目前仅个别商家该字段有值 └ out_shop_id String 1073252011 对接渠道的门店ID └ order_no String 1 渠道订单小号 └ open_uid String 123456 买家openId └ sku_discount_platform_fee Number 100 商品平台优惠分摊 └ sku_discount_merchant_fee Number 100 商品商家优惠分摊 └ post_discount_platform_fee Number 50 配送费平台优惠分摊 └ post_discount_merchant_fee Number 50 配送费商家优惠分摊 └ delivery_type Number 1 配送方式 1=定时配送/ 3=用户自提 pay_channels OrderPayChannel [] 支付渠道信息列表 └ pay_type String 1 支付方式 └ pay_channel String APP\|淘宝支付渠道名称 └ pay_fee Number 100 支付金额 activitys OrderActivity [] 主单活动列表 └ channel_activity_id String 300123101001 渠道活动ID └ biz_activity_id String 100011 关联业务活动ID └ merchant_activity_id String S001001 关联商家ERP活动ID └ activity_name String 测试活动活动名称 └ activity_type String itemTJ 活动类型 └ discount_fee Number 100 活动优惠金额 └ discount_merchant_fee Number 50 活动优惠商家分摊 └ discount_platform_fee String 50 活动优惠平台分摊 funds_discounts OrderFundsDiscount [] 资金优惠 └ discount_name String 红包活动名称 └ discount_type String VOUCHER 活动类型 └ discount_fee Number 40 优惠金额(分) └ discount_merchant_fee Number 40 商家优惠(分) └ discount_platform_fee Number 40 平台优惠(分) platform_deduction PlatformDeduction 平台扣费对象 └ technical_service_fee Number 10 技术服务费 └ pay_service_fee Number 10 支付服务费 └ base_logistics_fee Number 10 基础物流费 └ thirdpartnar_fee Number 10 代运营服务费 delivery_info DeliveryInfo 送货信息 └ delivery_name String 王师傅送货人名称 └ delivery_phone String 13588888888 送货人手机号 └ business_type String 0 订单业务类型 0=普通单 41=码上购订单 4=淘鲜达预售 └ voucher_order Number 1 订单是否是券订单 1 券订单 0 非券订单 └ voucher_type Number 2 券类型 1-提货券 2-代金券，仅voucher_order=1时有值 └ platform_expand_fee Number 100 购物金-平台承担膨胀金，单位：分 └ merchant_expand_fee Number 100 购物金-商家承担膨胀金，单位：分 └ platform_benefit_fee Number 100 购物金-平台承担购后权益，单位：分 └ merchant_benefit_fee Number 100 购物金-商家承担购后权益，单位：分 └ delivery_order_id String 123456 配送单号 └ success Boolean true 是否成功 └ err_code String CANCEL_FAIL 错误码 └ err_msg String 错误码备注说明错误码备注说明

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAelophyOrderGetRequest req = new AlibabaAelophyOrderGetRequest();
AlibabaAelophyOrderGetRequest.OrderGetRequest obj1 = new AlibabaAelophyOrderGetRequest.OrderGetRequest();
obj1.setStoreId("S001");
obj1.setBizOrderId(50003170001L);
req.setOrderGetRequest(obj1);
AlibabaAelophyOrderGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<alibaba_aelophy_order_get_response>
    <api_result>
        <model>
            <merchant_code>CSSJ</merchant_code>
            <store_id>S001</store_id>
            <shop_id>s001</shop_id>
            <order_from>1</order_from>
            <biz_order_id>50003170001</biz_order_id>
            <out_order_id>10003170001</out_order_id>
            <pay_time>2023-03-17 00:00:00</pay_time>
            <original_fee>100</original_fee>
            <discount_fee>100</discount_fee>
            <post_fee>100</post_fee>
            <package_fee>100</package_fee>
            <pay_fee>100</pay_fee>
            <order_status>PAID</order_status>
            <receive_info>
                <receiver_name>姓名</receiver_name>
                <receiver_phone>13310004132,129</receiver_phone>
                <receiver_address>地址</receiver_address>
                <receiver_memo>备注</receiver_memo>
                <receiver_poi>120.03278,30.28523</receiver_poi>
                <expect_arrive_time>2023-04-04 22:00:00~2023-04-04 23:00:00</expect_arrive_time>
                <receiver_privacy_phone>187****6789</receiver_privacy_phone>
            </receive_info>
            <sub_order_response_list>
                <sub_order_response>
                    <biz_sub_order_id>500031700011</biz_sub_order_id>
                    <out_sub_order_id>100031700011</out_sub_order_id>
                    <sku_code>098781</sku_code>
                    <sku_name>商品名称</sku_name>
                    <price>100</price>
                    <sale_unit>件</sale_unit>
                    <stock_unit>件</stock_unit>
                    <buy_stock_quantity>1.00</buy_stock_quantity>
                    <buy_sale_quantity>1.00</buy_sale_quantity>
                    <original_fee>1000</original_fee>
                    <discount_fee>1000</discount_fee>
                    <weight>1000</weight>
                    <barcode>S001201001</barcode>
                    <discount_merchant_fee>100</discount_merchant_fee>
                    <discount_platform_fee>100</discount_platform_fee>
                    <gift_flag>0</gift_flag>
                    <weight_flag>0</weight_flag>
                    <order_status>PAID</order_status>
                    <activitys>
                        <order_activity>
                            <channel_activity_id>300123101001</channel_activity_id>
                            <biz_activity_id>100011</biz_activity_id>
                            <merchant_activity_id>S001001</merchant_activity_id>
                            <activity_name>测试活动</activity_name>
                            <discount_fee>100</discount_fee>
                            <discount_merchant_fee>50</discount_merchant_fee>
                            <discount_platform_fee>50</discount_platform_fee>
                            <activity_type>itemTJ</activity_type>
                        </order_activity>
                    </activitys>
                    <funds_discounts>
                        <order_funds_discount>
                            <discount_name>红包</discount_name>
                            <discount_type>VOUCHER</discount_type>
                            <discount_fee>40</discount_fee>
                            <discount_merchant_fee>40</discount_merchant_fee>
                            <discount_platform_fee>40</discount_platform_fee>
                        </order_funds_discount>
                    </funds_discounts>
                    <service_props>
                        <sku_service_property>
                            <prop_name>温度</prop_name>
                            <prop_value>常温</prop_value>
                        </sku_service_property>
                    </service_props>
                    <voucher_infos>
                        <order_voucher_info>
                            <voucher_id>12345</voucher_id>
                            <voucher_certificate>12345</voucher_certificate>
                        </order_voucher_info>
                    </voucher_infos>
                    <promotion_infos>
                        <promotion_info>
                            <active_id>12345678</active_id>
                            <active_name>买赠活动081401</active_name>
                            <type>wdkShopMS</type>
                            <txd_active_id>88983045462</txd_active_id>
                            <out_active_id>12345678</out_active_id>
                            <discount_fee>1</discount_fee>
                        </promotion_info>
                    </promotion_infos>
                    <platform_expand_fee>100</platform_expand_fee>
                    <merchant_expand_fee>100</merchant_expand_fee>
                    <platform_benefit_fee>100</platform_benefit_fee>
                    <merchant_benefit_fee>100</merchant_benefit_fee>
                </sub_order_response>
            </sub_order_response_list>
            <ext>
                <subscribe_message>祝福语</subscribe_message>
                <subscribe_phone>13310004132,129</subscribe_phone>
                <member_card_num>1000210019</member_card_num>
                <stock_out_info_code>1</stock_out_info_code>
                <ext_info>{\&quot;scenarioGroup\&quot;:\&quot;TXD_HALFDAY\&quot;,\&quot;fulfillTag\&quot;:\&quot;HALF_DAY\&quot;}</ext_info>
            </ext>
            <out_shop_id>1073252011</out_shop_id>
            <order_no>1</order_no>
            <open_uid>123456</open_uid>
            <sku_discount_platform_fee>100</sku_discount_platform_fee>
            <sku_discount_merchant_fee>100</sku_discount_merchant_fee>
            <post_discount_platform_fee>50</post_discount_platform_fee>
            <post_discount_merchant_fee>50</post_discount_merchant_fee>
            <delivery_type>1</delivery_type>
            <pay_channels>
                <order_pay_channel>
                    <pay_type>1</pay_type>
                    <pay_channel>APP|淘宝</pay_channel>
                    <pay_fee>100</pay_fee>
                </order_pay_channel>
            </pay_channels>
            <activitys>
                <order_activity>
                    <channel_activity_id>300123101001</channel_activity_id>
                    <biz_activity_id>100011</biz_activity_id>
                    <merchant_activity_id>S001001</merchant_activity_id>
                    <activity_name>测试活动</activity_name>
                    <activity_type>itemTJ</activity_type>
                    <discount_fee>100</discount_fee>
                    <discount_merchant_fee>50</discount_merchant_fee>
                    <discount_platform_fee>50</discount_platform_fee>
                </order_activity>
            </activitys>
            <funds_discounts>
                <order_funds_discount>
                    <discount_name>红包</discount_name>
                    <discount_type>VOUCHER</discount_type>
                    <discount_fee>40</discount_fee>
                    <discount_merchant_fee>40</discount_merchant_fee>
                    <discount_platform_fee>40</discount_platform_fee>
                </order_funds_discount>
            </funds_discounts>
            <platform_deduction>
                <technical_service_fee>10</technical_service_fee>
                <pay_service_fee>10</pay_service_fee>
                <base_logistics_fee>10</base_logistics_fee>
                <thirdpartnar_fee>10</thirdpartnar_fee>
            </platform_deduction>
            <delivery_info>
                <delivery_name>王师傅</delivery_name>
                <delivery_phone>13588888888</delivery_phone>
            </delivery_info>
            <business_type>0</business_type>
            <voucher_order>1</voucher_order>
            <voucher_type>2</voucher_type>
            <platform_expand_fee>100</platform_expand_fee>
            <merchant_expand_fee>100</merchant_expand_fee>
            <platform_benefit_fee>100</platform_benefit_fee>
            <merchant_benefit_fee>100</merchant_benefit_fee>
            <delivery_order_id>123456</delivery_order_id>
        </model>
        <success>true</success>
        <err_code>CANCEL_FAIL</err_code>
        <err_msg>错误码备注说明</err_msg>
    </api_result>
</alibaba_aelophy_order_get_response>

{
    "alibaba_aelophy_order_get_response":{
        "api_result":{
            "model":{
                "merchant_code":"CSSJ",
                "store_id":"S001",
                "shop_id":"s001",
                "order_from":1,
                "biz_order_id":50003170001,
                "out_order_id":"10003170001",
                "pay_time":"2023-03-17 00:00:00",
                "original_fee":100,
                "discount_fee":100,
                "post_fee":100,
                "package_fee":100,
                "pay_fee":100,
                "order_status":"PAID",
                "receive_info":{
                    "receiver_name":"姓名",
                    "receiver_phone":"13310004132,129",
                    "receiver_address":"地址",
                    "receiver_memo":"备注",
                    "receiver_poi":"120.03278,30.28523",
                    "expect_arrive_time":"2023-04-04 22:00:00~2023-04-04 23:00:00",
                    "receiver_privacy_phone":"187****6789"
                },
                "sub_order_response_list":{
                    "sub_order_response":[
                        {
                            "biz_sub_order_id":500031700011,
                            "out_sub_order_id":"100031700011",
                            "sku_code":"098781",
                            "sku_name":"商品名称",
                            "price":100,
                            "sale_unit":"件",
                            "stock_unit":"件",
                            "buy_stock_quantity":"1.00",
                            "buy_sale_quantity":"1.00",
                            "original_fee":1000,
                            "discount_fee":1000,
                            "weight":1000,
                            "barcode":"S001201001",
                            "discount_merchant_fee":100,
                            "discount_platform_fee":100,
                            "gift_flag":"0",
                            "weight_flag":"0",
                            "order_status":"PAID",
                            "activitys":{
                                "order_activity":[
                                    {
                                        "channel_activity_id":"300123101001",
                                        "biz_activity_id":"100011",
                                        "merchant_activity_id":"S001001",
                                        "activity_name":"测试活动",
                                        "discount_fee":100,
                                        "discount_merchant_fee":50,
                                        "discount_platform_fee":50,
                                        "activity_type":"itemTJ"
                                    }
                                ]
                            },
                            "funds_discounts":{
                                "order_funds_discount":[
                                    {
                                        "discount_name":"红包",
                                        "discount_type":"VOUCHER",
                                        "discount_fee":40,
                                        "discount_merchant_fee":40,
                                        "discount_platform_fee":40
                                    }
                                ]
                            },
                            "service_props":{
                                "sku_service_property":[
                                    {
                                        "prop_name":"温度",
                                        "prop_value":"常温"
                                    }
                                ]
                            },
                            "voucher_infos":{
                                "order_voucher_info":[
                                    {
                                        "voucher_id":"12345",
                                        "voucher_certificate":"12345"
                                    }
                                ]
                            },
                            "promotion_infos":{
                                "promotion_info":[
                                    {
                                        "active_id":"12345678",
                                        "active_name":"买赠活动081401",
                                        "type":"wdkShopMS",
                                        "txd_active_id":"88983045462",
                                        "out_active_id":"12345678",
                                        "discount_fee":1
                                    }
                                ]
                            },
                            "platform_expand_fee":100,
                            "merchant_expand_fee":100,
                            "platform_benefit_fee":100,
                            "merchant_benefit_fee":100
                        }
                    ]
                },
                "ext":{
                    "subscribe_message":"祝福语",
                    "subscribe_phone":"13310004132,129",
                    "member_card_num":"1000210019",
                    "stock_out_info_code":"1",
                    "ext_info":"{\\\"scenarioGroup\\\":\\\"TXD_HALFDAY\\\",\\\"fulfillTag\\\":\\\"HALF_DAY\\\"}"
                },
                "out_shop_id":"1073252011",
                "order_no":"1",
                "open_uid":"123456",
                "sku_discount_platform_fee":100,
                "sku_discount_merchant_fee":100,
                "post_discount_platform_fee":50,
                "post_discount_merchant_fee":50,
                "delivery_type":1,
                "pay_channels":{
                    "order_pay_channel":[
                        {
                            "pay_type":"1",
                            "pay_channel":"APP|淘宝",
                            "pay_fee":100
                        }
                    ]
                },
                "activitys":{
                    "order_activity":[
                        {
                            "channel_activity_id":"300123101001",
                            "biz_activity_id":"100011",
                            "merchant_activity_id":"S001001",
                            "activity_name":"测试活动",
                            "activity_type":"itemTJ",
                            "discount_fee":100,
                            "discount_merchant_fee":50,
                            "discount_platform_fee":"50"
                        }
                    ]
                },
                "funds_discounts":{
                    "order_funds_discount":[
                        {
                            "discount_name":"红包",
                            "discount_type":"VOUCHER",
                            "discount_fee":40,
                            "discount_merchant_fee":40,
                            "discount_platform_fee":40
                        }
                    ]
                },
                "platform_deduction":{
                    "technical_service_fee":10,
                    "pay_service_fee":10,
                    "base_logistics_fee":10,
                    "thirdpartnar_fee":10
                },
                "delivery_info":{
                    "delivery_name":"王师傅",
                    "delivery_phone":"13588888888"
                },
                "business_type":"0",
                "voucher_order":1,
                "voucher_type":2,
                "platform_expand_fee":100,
                "merchant_expand_fee":100,
                "platform_benefit_fee":100,
                "merchant_benefit_fee":100,
                "delivery_order_id":"123456"
            },
            "success":true,
            "err_code":"CANCEL_FAIL",
            "err_msg":"错误码备注说明"
        }
    }
}

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

五道口API

alibaba.aelophy.order.get (翱象拉取订单接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ