文档中心 > API类目 > 奇门POS接口

qimen.taobao.pos.deliveryorder.get (门店发货单获取接口)

由POS机定时增量获取ERP下发到门店的发货单

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
page Number 必须 1 当前页
pageSize Number 必须 20 每页条数
storeCode String 可选 hz0001
  • 最大长度:50
  • 门店编码
    transportMode String 可选 ZT=自提 KD=快递
  • 最大长度:50
  • 提货方式
    orderStatus String 必须 NEW=新增 ACCEPT=门店接单 PICKED=已自提 DELIVERED=已发货 REJECT=门店拒单 CANCELED=已取消
  • 最大长度:50
  • 单据状态
    startTime String 可选 YYYY-MM-DD hh:mm:ss
  • 最大长度:19
  • 门店发货单创建时间
    endTime String 可选 YYYY-MM-DD hh:mm:ss
  • 最大长度:19
  • 门店发发货单创建结束时间
    customerid String 必须 A12345
  • 最大长度:50
  • 指定路由参数
    orderid String 可选 20180101 订单号
    num String 可选 13011111111 收货人手机号
    extendProps String 可选 扩展信息 扩展字段

    响应参数

    名称 类型 示例值 描述
    flag String success|failure 响应结果
    code String errorcode 响应码
    message String msg 响应信息
    total Number 1000 所有的总条数
    order Order [] 发货单信息
    • └ orderCode
    • String
    • 123456789
    • 门店发货单编码
    • └ sourcePlatformCode
    • String
    • TB
    • 订单来源平台编码
    • └ orderSourceCode
    • String
    • 123456789
    • 平台交易订单编码
    • └ createTime
    • String
    • YYYY-MM-DD hh:mm:ss
    • 门店发货单创建时间
    • └ modifiedTime
    • String
    • YYYY-MM-DD hh:mm:ss
    • 门店发货单最后修改时间
    • └ transportMode
    • String
    • ZT=自提 KD=快递
    • 提货方式
    • └ logisticsCode
    • String
    • YTO
    • 物流公司编码
    • └ logisticsName
    • String
    • 杭州圆通公司
    • 物流公司名称
    • └ orderStatus
    • String
    • NEW=新增ACCEPT=门店接单PICKED=已自提DELIVERED=已发货REJECT=门店拒单CANCELED=已取消
    • 单据状态
    • └ identifyCode
    • String
    • whrrsg
    • 验证码
    • receiverInfo
    • ReceiverInfo []
    • 收件人信息
    • └ name
    • String
    • 张三
    • 收件人姓名
    • └ zipCode
    • String
    • 132000
    • 邮编
    • └ tel
    • String
    • 0571-85022088
    • 固定电话(门店)
    • └ mobile
    • String
    • 13542088088
    • 移动电话
    • └ province
    • String
    • 浙江省
    • 省份(门店地址)
    • └ city
    • String
    • 杭州市
    • 城市
    • └ area
    • String
    • 西湖区
    • 区域(门店地址)
    • └ town
    • String
    • 光明村
    • 村镇(门店地址)
    • └ detailAddress
    • String
    • 延安路2001号
    • 详细地址(门店地址)
    • item
    • Item []
    • 详情
    • └ itemCode
    • String
    • code201847748
    • 商品编码
    • └ extCode
    • String
    • 123456789
    • 交易平台商品编码
    • └ planQty
    • Number
    • 10
    • 应发商品数量
    • └ batchCode
    • String
    • 2480284
    • 批次编号
    • └ productDate
    • String
    • YYYY-MM-DD
    • 生产日期
    • └ expireDate
    • String
    • YYYY-MM-DD
    • 过期日期
    • └ produceCode
    • String
    • 209470585
    • 生产批号
    • └ extendProps
    • String
    • 扩展信息
    • 扩展字段
    extendProps String 扩展信息 扩展字段

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
    TaobaoPosDeliveryorderGetRequest req = new TaobaoPosDeliveryorderGetRequest();
    req.setPage(1L);
    req.setPageSize(20L);
    req.setStoreCode("hz0001");
    req.setTransportMode("ZT=自提 KD=快递");
    req.setOrderStatus("NEW=新增 ACCEPT=门店接单 PICKED=已自提 DELIVERED=已发货 REJECT=门店拒单 CANCELED=已取消");
    req.setStartTime("YYYY-MM-DD hh:mm:ss");
    req.setEndTime("YYYY-MM-DD hh:mm:ss");
    req.setCustomerid("A12345");
    req.setOrderid("20180101");
    req.setNum("13011111111");
    req.setExtendProps("扩展信息");
    TaobaoPosDeliveryorderGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <flag>success|failure</flag>
    <code>errorcode</code>
    <message>msg</message>
    <total>1000</total>
    <order>
        <order>
            <orderCode>123456789</orderCode>
            <sourcePlatformCode>TB</sourcePlatformCode>
            <orderSourceCode>123456789</orderSourceCode>
            <createTime>YYYY-MM-DD hh:mm:ss</createTime>
            <modifiedTime>YYYY-MM-DD hh:mm:ss</modifiedTime>
            <transportMode>ZT=自提 KD=快递</transportMode>
            <logisticsCode>YTO</logisticsCode>
            <logisticsName>杭州圆通公司</logisticsName>
            <orderStatus>NEW=新增ACCEPT=门店接单PICKED=已自提DELIVERED=已发货REJECT=门店拒单CANCELED=已取消</orderStatus>
            <identifyCode>whrrsg</identifyCode>
            <receiverInfo>
                <receiver_info>
                    <name>张三</name>
                    <zipCode>132000</zipCode>
                    <tel>0571-85022088</tel>
                    <mobile>13542088088</mobile>
                    <province>浙江省</province>
                    <city>杭州市</city>
                    <area>西湖区</area>
                    <town>光明村</town>
                    <detailAddress>延安路2001号</detailAddress>
                </receiver_info>
            </receiverInfo>
            <item>
                <item>
                    <itemCode>code201847748</itemCode>
                    <extCode>123456789</extCode>
                    <planQty>10</planQty>
                    <batchCode>2480284</batchCode>
                    <productDate>YYYY-MM-DD</productDate>
                    <expireDate>YYYY-MM-DD</expireDate>
                    <produceCode>209470585</produceCode>
                </item>
            </item>
            <extendProps>扩展信息</extendProps>
        </order>
    </order>
    <extendProps>扩展信息</extendProps>
    

    异常示例

    • 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

    FAQ

    返回
    顶部