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

taobao.qimen.pos.receipt.synchronize (小票同步接口)

定期,ERP与POS之间将期间内的销售单进行同步

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request Request 可选
  • orderInfo
  • OrderInfo
  • 可选
  • 订单信息
  • └ orderCode
  • String
  • 必须
  • X123
  • 销售单编码
  • └ posCode
  • String
  • 必须
  • P123
  • POS终端编码
  • └ storeCode
  • String
  • 必须
  • M123
  • 门店编码
  • └ orgCode
  • String
  • 可选
  • Z123
  • 组织编码(门店所属的组织编码)
  • operators
  • Operators
  • 可选
  • 操作员信息
  • operator
  • Operator
  • 可选
  • 操作员信息
  • └ type
  • String
  • 可选
  • CJ
  • 操作员类型(CJ=创建人、SP =审批人、Z=终止人)
  • └ operatorCode
  • String
  • 可选
  • C123
  • 操作员编码
  • └ operatorName
  • String
  • 可选
  • N123
  • 操作员名称
  • └ operateTime
  • String
  • 可选
  • 2017-02-10 00:00:00
  • 操作时间(YYYY-MM-DD HH:MM:SS)
  • └ totalAmount
  • String
  • 必须
  • 12
  • 整单金额
  • └ totalQty
  • Number
  • 必须
  • 12
  • 整单的商品总数
  • └ orderCreateTime
  • String
  • 可选
  • 2017-02-10 00:00:00
  • 单据时间(YYYY-MM-DD HH:MM:SS)
  • orderLines
  • OrderLine []
  • 可选
  • 订单列表
  • └ orderLineNo
  • String
  • 可选
  • 12
  • 单据行号
  • └ productCode
  • String
  • 可选
  • SPU12
  • 商品spu编码
  • └ itemCode
  • String
  • 必须
  • SPU123
  • 商品sku编码
  • └ itemName
  • String
  • 可选
  • NN
  • 商品名称
  • └ skuProperty
  • String
  • 必须
  • XXL
  • 商品属性(如红色;XXL)
  • └ color
  • String
  • 可选
  • Y12
  • 颜色编码
  • └ size
  • String
  • 可选
  • C123
  • 尺码编码
  • └ standardPrice
  • String
  • 必须
  • 12
  • 标准价
  • └ referencePrice
  • String
  • 可选
  • 12
  • 参考价
  • └ retailPrice
  • String
  • 可选
  • 12
  • 零售价
  • └ discount
  • String
  • 可选
  • 1
  • 折扣(如9折为0.9000)
  • └ quantity
  • Number
  • 必须
  • 12
  • 销售数量
  • └ standardAmount
  • String
  • 必须
  • 12
  • 标准金额
  • └ settlementAmount
  • String
  • 可选
  • 12
  • 结算金额
  • payments
  • Payment []
  • 可选
  • 支付信息
  • └ paymentType
  • String
  • 必须
  • cache
  • 支付类型(CASH=现金、ALIPAY=支付宝、WECHATPAY=微信支付、UNIONPAY=银联、OTHER=其他)
  • └ amount
  • String
  • 必须
  • 12
  • 结算金额
  • └ paidAmount
  • String
  • 必须
  • 12
  • 收款金额
  • └ currency
  • String
  • 可选
  • RMB
  • 币制(RMB=人民币、USD=美元)
  • └ extendProps
  • Map
  • 可选
  • 扩展属性

响应参数

名称 类型 示例值 描述
response Response
  • └ flag
  • String
  • success
  • 响应结果:success|failure
  • └ code
  • String
  • 0
  • 响应码
  • └ message
  • String
  • invalid appkey
  • 响应信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
QimenClient client = new DefaultQimenClient(url, appkey, secret);
PosReceiptSynchronizeRequest req = new PosReceiptSynchronizeRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
OrderInfo obj1 = new OrderInfo();
obj1.setOrderCode("X123");
obj1.setPosCode("P123");
obj1.setStoreCode("M123");
obj1.setOrgCode("Z123");
Operators obj2 = new Operators();
Operator obj3 = new Operator();
obj3.setType("CJ");
obj3.setOperatorCode("C123");
obj3.setOperatorName("N123");
obj3.setOperateTime("2017-02-10 00:00:00");
obj2.setOperator(obj3);
obj1.setOperators(obj2);
obj1.setTotalAmount("12");
obj1.setTotalQty(12L);
obj1.setOrderCreateTime("2017-02-10 00:00:00");
req.setOrderInfo(obj1);
OrderLine obj4 = new OrderLine();
obj4.setOrderLineNo("12");
obj4.setProductCode("SPU12");
obj4.setItemCode("SPU123");
obj4.setItemName("NN");
obj4.setSkuProperty("XXL");
obj4.setColor("Y12");
obj4.setSize("C123");
obj4.setStandardPrice("12");
obj4.setReferencePrice("12");
obj4.setRetailPrice("12");
obj4.setDiscount("1");
obj4.setQuantity(12L);
obj4.setStandardAmount("12");
obj4.setSettlementAmount("12");
req.setOrderLines(obj4);
Payment obj5 = new Payment();
obj5.setPaymentType("cache");
obj5.setAmount("12");
obj5.setPaidAmount("12");
obj5.setCurrency("RMB");
req.setPayments(obj5);
PosReceiptSynchronizeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<response>
    <flag>success</flag>
    <code>0</code>
    <message>invalid appkey</message>
</response>

异常示例

  • 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

返回
顶部