ERP单据

查询支付方式

获取已经开通了的所有支付方式

接口名称

cmd = "QueryAllPay"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	QueryAllPay	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID

请求示例

{
    "cmd":"QueryAllPay",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	list json	否		返回的数据列表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
paycode	string	是	301	支付编码
payname	string	是	支付宝	支付名称

返回示例

{
  "code": 0,
  "seq": "123123-abc12",
  "msg": "",
  "items": [
    {
      "paycode": "301",
      "payname": "支付宝"
    }
  ]
}

推送门店报货单

openAPI收到门店终端的报货单后，即时向第三方平台推送

接口名称

cmd = "PushStoreDeclareGoods"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	PushStoreDeclareGoods	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
items	json list	是		单据列表，详见下表

注解

• 报货单为已上传非作废状态

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
billno	string	是	XS20161010001	单据号
rdate	string	是	2016-02-01	单据日期，格式： yyyy-mm-dd
billingdate	string	是	2016-02-01 12:02:34	制单时间，格式： yyyy-mm-dd HH:mi:ss
refertime	string	是	2016-02-01 12:02:35	提交时间，格式： yyyy-mm-dd HH:mi:ss
extdeliverywhid	string	否	1	出库仓库ID(第三方)
deliverywhid	integer	是	1	出库仓库ID
deliverywhcode	string	是	001	出库仓库编码
deliverywhname	string	是	湘阴一店	出库仓库名称
extstoreuid	string	否	1	报货门店ID(第三方)
storeuid	integer	是	1	报货门店ID
storecode	string	是	001	报货门店编码
storename	string	是	湘阴一店	报货门店名称
amounttotal	BigDecimal	是	9.9	报货商品总数量
dealtotal	BigDecimal	是	1.00	报货总金额
remarks	string	否		单据备注
billitems	json list	是		单据明细信息，详见下表
payitems	json list	否		单据支付信息，详见下表

上面表格中的字段 billitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
extproduid	string	否	1	商品ID(第三方)
produid	integer	是	1	商品ID
prodcode	string	是	001	商品编码
prodname	string	是	BooK	商品名称
unit	string	是	本	单位
dealpri	BigDecimal	是	9.9	单价
amount	BigDecimal	是	1.0	数量
trademoney	BigDecimal	是	9.9	金额
additionalunit	string	否	盒	辅单位
additionalunit_amount	BigDecimal	是	1	辅单位数量
remark	string	否		备注

上面表格中的字段 payitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
paycode	string	是	1	支付编码
payname	string	是	现金	支付名称
paymoney	BigDecimal	是	9.9	支付金额

请求示例

{
  "cmd": "PushStoreDeclareGoods",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "billno": "XS20161010001",
      "rdate": "2016-02-01",
      "billingdate": "2016-02-01 12:02:34",
      "refertime": "2016-02-01 12:02:35",
      "outstoreuid": 1,
      "outstorecode": "001",
      "outstorename": "湘阴一店",
      "instoreuid": 1,
      "instorecode": "001",
      "instorename": "湘阴一店",
      "amounttotal": 9.9,
      "dealtotal": 1.00,
      "reamrks": "",
      "billitems": [
        {
          "produid": 1,
          "prodcode": "001",
          "prodname": "BooK",
          "unit": "本",
          "dealpri": 9.9,
          "amount": 1.0,
          "trademoney": 9.9,
          "additionalunit": "盒",
          "additionalunit_amount": 1,
          "remark": ""
        }
      ],
      "payitems": [
        {
          "paycode": "1",
          "payname": "现金",
          "paymoney": 200
        }
      ]
    }
  ]
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息

返回示例

{
    "code":0,
    "msg":"",
    "seq":"123123-abc12"
}

下载门店报货单

指定时间点，下载门店报货单

接口名称

cmd = "DownloadStoreDeclareGoodsByBatch"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	DownloadStoreDeclareGoodsByBatch	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
storetype	integer	是	0	门店类型：0–全部、1–自营、2–加盟、3–联营
startday	string	是	2018-01-10	结束日期，格式yyyy-mm-dd
endday	string	是	2018-01-10	结束日期，格式yyyy-mm-dd
storeuid	integer	否	101	门店ID，非空时，下载本门店。为空时，下载全部门店
sumbatch	string	否	123456	指定下载批次，为空时生成新批次，非空时，下载前面未下载完成的批次

注解

• 每次请求返回提交时间大于条件时间三天内的报货单
• 如果条件时间小于系统中最小单据提交时间，则返回最小提交时间之后三天内的所有单据

请求示例

{
  "cmd": "DownloadStoreDeclareGoodsByBatch",
  "msg": "",
  "seq": "123123-abc12",
  "storetype": 0,
  "startday": "2018-01-10",
  "endday": "2018-01-10",
  "storeuid": 101,
  "sumbatch": "123456"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的单据数据列表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
billno	string	是	XS20161010001	单据号
rdate	string	是	2016-02-01	单据日期，格式： yyyy-mm-dd
billingdate	string	是	2016-02-01 12:02:34	制单时间，格式： yyyy-mm-dd HH:mi:ss
refertime	string	是	2016-02-01 12:02:35	提交时间，格式： yyyy-mm-dd HH:mi:ss
extdeliverywhid	string	否	1	出库仓库ID(第三方)
deliverywhid	integer	是	1	出库仓库ID
deliverywhcode	string	是	001	出库仓库编码
deliverywhname	string	是	湘阴一店	出库仓库名称
extstoreuid	string	否	1	报货门店ID(第三方)
storeuid	integer	是	1	报货门店ID
storecode	string	是	001	报货门店编码
storename	string	是	湘阴一店	报货门店名称
amounttotal	BigDecimal	是	9.9	报货商品总数量
dealtotal	BigDecimal	是	1.00	报货总金额
remarks	string	否		单据备注
billitems	json list	是		单据明细信息，详见下表
payitems	json list	否		单据支付信息，详见下表

上面表格中的字段 billitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
extproduid	string	否	1	商品ID(第三方)
produid	integer	是	1	商品ID
prodcode	string	是	001	商品编码
prodname	string	是	BooK	商品名称
unit	string	是	本	单位
dealpri	BigDecimal	是	9.9	单价
amount	BigDecimal	是	1.0	数量
trademoney	BigDecimal	是	9.9	金额
additionalunit	string	否	盒	辅单位
additionalunit_amount	BigDecimal	是	1	辅单位数量
remark	string	否		备注

上面表格中的字段 payitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
paycode	string	是	1	支付编码
payname	string	是	现金	支付名称
paymoney	BigDecimal	是	9.9	支付金额

返回示例

{
  "code": 0,
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "msg": "",
  "items": [
    {
      "billno": "XS20161010001",
      "rdate": "2016-02-01",
      "billingdate": "2016-02-01 12:02:34",
      "refertime": "2016-02-01 12:02:35",
      "outstoreuid": 1,
      "outstorecode": "001",
      "outstorename": "湘阴一店",
      "instoreuid": 1,
      "instorecode": "001",
      "instorename": "湘阴一店",
      "amounttotal": 9.9,
      "dealtotal": 1.00,
      "reamrks": "",
      "billitems": [
        {
          "produid": 1,
          "prodcode": "001",
          "prodname": "BooK",
          "unit": "本",
          "dealpri": 9.9,
          "amount": 1.0,
          "trademoney": 9.9,
          "additionalunit": "盒",
          "additionalunit_amount": 1,
          "remark": ""
        }
      ],
      "payitems": [
        {
          "paycode": "1",
          "payname": "现金",
          "paymoney": 200
        }
      ]
    }
  ]
}

新增出库单

ERP系统向甩手掌柜系统新增配送出库单

接口名称

cmd = "AddSTOBill"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	AddSTOBill	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
items	Object	是		单据信息结构，详见下表

上面表格中的字段items对应的值是个 单据信息 结构数据，字段如下

参数名	类型	是否必须	示例值	描述
tbillno	string	是	XS20161010001	第三方单据号
parebillno	string	否	BH20161010001	父单号（报货单号）
rdate	string	是	2016-02-01	单据日期，格式： yyyy-mm-dd
billingdate	string	是	2016-02-01 12:02:34	制单时间，格式： yyyy-mm-dd HH:mi:ss
refertime	string	是	2016-02-01 12:02:35	提交时间，格式： yyyy-mm-dd HH:mi:ss
outstoreuid	integer	否	1	出库仓库ID
outstorecode	string	是	001	出库仓库编码
outstorename	string	否	湘阴一店	出库仓库名称
instoreuid	integer	否	1	收货门店ID
instorecode	string	是	001	收货门店编码
instorename	string	否	湘阴一店	收货门店名称
amounttotal	BigDecimal	是	9.9	商品总数量
dealtotal	BigDecimal	是	1.00	总金额
remarks	string	否		单据备注
billitems	json list	是		单据明细信息，详见下表
payitems	json list	否		单据支付信息，详见下表

上面表格中的字段 billitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
produid	integer	否	1	商品ID
prodcode	string	是	001	商品编码
prodname	string	是	BooK	商品名称
unit	string	是	本	单位
dealpri	BigDecimal	是	9.9	单价
amount	BigDecimal	是	1.0	数量
trademoney	BigDecimal	是	9.9	金额
additionalunit	string	否	盒	辅单位
additionalunit_amount	BigDecimal	是	1	辅单位数量
remark	string	否		备注

请求示例

{
  "cmd": "AddSTOBill",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": {
    "tbillno": "XS20161010001",
    "rdate": "2016-02-01",
    "billingdate": "2016-02-01 12:02:34",
    "refertime": "2016-02-01 12:02:35",
    "outstoreuid": 1,
    "outstorecode": "001",
    "outstorename": "湘阴一店",
    "instoreuid": 1,
    "instorecode": "001",
    "instorename": "湘阴一店",
    "amounttotal": 9.9,
    "dealtotal": 1.00,
    "reamrks": "",
    "billitems": [
      {
        "produid": 1,
        "prodcode": "001",
        "prodname": "BooK",
        "unit": "本",
        "dealpri": 9.9,
        "amount": 1.0,
        "trademoney": 9.9,
        "additionalunit": "盒",
        "additionalunit_amount": 1,
        "remark": ""
      }
    ]
  }
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	Object	否		返回的单据数据列表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
tbillno	string	是	XS20161010001	第三方单据号
billno	string	是	XS20161010001	甩手掌柜单据号

返回示例

{
    "code":0,
    "msg":"",
    "seq":"123123-abc12",
    "items":{
        "tbillno":"XS20161010001",
        "billno":"XS20161010001"
    }
}

推送收货差异单

门店收到的货物数量与配送单不一致时，填写收货差异单。openAPI将此单据推送到第三方ERP系统。 例如，某商品发货单发货10件，实际收货8件，那收货差异单数量为10-8=2件

接口名称

cmd = "PushRECBill"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	PushRECBill	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
items	json list	是		单据列表，详见下表

注解

• 单据为已提交状态

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
billno	string	是	XS20161010001	单据号
rdate	string	是	2016-02-01	单据日期，格式： yyyy-mm-dd
billingdate	string	是	2016-02-01 12:02:34	制单时间，格式： yyyy-mm-dd HH:mi:ss
refertime	string	是	2016-02-01 12:02:35	提交时间，格式： yyyy-mm-dd HH:mi:ss
outstoreuid	string	否	1	出库仓库ID(第三方)
outstoreuid	integer	是	1	出库仓库ID
outstorecode	string	是	001	出库仓库编码
outstorename	string	是	湘阴一店	出库仓库名称
extinstoreuid	string	否	1	收货门店ID(第三方)
instoreuid	integer	是	1	收货门店ID
instorecode	string	是	001	收货门店编码
instorename	string	是	湘阴一店	收货门店名称
amounttotal	BigDecimal	是	9.9	商品总数量
dealtotal	BigDecimal	是	1.00	总金额
remarks	string	否		单据备注
billitems	json list	是		单据明细信息，详见下表

上面表格中的字段 billitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
extproduid	string	否	1	商品ID(第三方)
produid	integer	是	1	商品ID
prodcode	string	是	001	商品编码
prodname	string	是	BooK	商品名称
unit	string	是	本	单位
dealpri	BigDecimal	是	9.9	单价
amount	BigDecimal	是	1.0	数量
trademoney	BigDecimal	是	9.9	金额
remark	string	否		备注

请求示例

{
  "cmd": "PushRECBill",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "tbillno": "XS20161010001",
      "stobillno": "FHD20161010001",
      "rdate": "2016-02-01 ",
      "billingdate": "2016-02-01 12:02:34",
      "outstorecode": "001",
      "instorecode": "001",
      "outstorename": "湘阴一店",
      "instorename": "湘阴一店",
      "remark": "",
      "billno": "XS20161010001",
      "refertime": "2016-02-01 12:02:35",
      "outstoreuid": 1,
      "instoreuid": 1,
      "amounttotal": 9.9,
      "dealtotal": 1.00,
      "reamrks": "",
      "billitems": [
        {
          "produid": 1,
          "prodcode": "001",
          "prodname": "BooK",
          "unit": "本",
          "dealpri": 9.9,
          "amount": 1.0,
          "trademoney": 9.9,
          "remark": ""
        }
      ]
    }
  ]
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息

返回示例

{
    "code":0,
    "msg":"",
    "seq":"123123-abc12"
}

下载收货差异单

指定时间点，下载门收货差异单

接口名称

cmd = "DownloadRECBill"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	DownloadRECBill	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
storetype	integer	是	0	门店类型：0–全部、1–自营、2–加盟、3–联营
startday	string	是	2018-01-10	结束日期，格式yyyy-mm-dd
endday	string	是	2018-01-10	结束日期，格式yyyy-mm-dd
storeuid	integer	否	101	门店ID，非空时，下载本门店。为空时，下载全部门店
businessid	integer	否	0	投诉类型 0-数量投诉，1-质量投诉，为空时，下载全部类型
sumbatch	string	否	123456	指定下载批次，为空时生成新批次，非空时，下载前面未下载完成的批次

注解

• 每次请求返回提交时间大于条件时间三天内的收货差异单
• 如果条件时间小于系统中最小单据提交时间，则返回最小提交时间之后三天内的所有单据

请求示例

{
  "cmd": "DownloadRECBill",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "storetype": 0,
  "startday": "2018-01-10",
  "endday": "2018-01-10",
  "storeuid": 101,
  "sumbatch": "123456"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的单据数据列表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
billno	string	是	XS20161010001	单据号
rdate	string	是	2016-02-01	单据日期，格式： yyyy-mm-dd
billingdate	string	是	2016-02-01 12:02:34	制单时间，格式： yyyy-mm-dd HH:mi:ss
refertime	string	是	2016-02-01 12:02:35	提交时间，格式： yyyy-mm-dd HH:mi:ss
outstoreuid	string	否	1	出库仓库ID(第三方)
outstoreuid	integer	是	1	出库仓库ID
outstorecode	string	是	001	出库仓库编码
outstorename	string	是	湘阴一店	出库仓库名称
extinstoreuid	string	否	1	收货门店ID (第三方)
instoreuid	integer	是	1	收货门店ID
instorecode	string	是	001	收货门店编码
instorename	string	是	湘阴一店	收货门店名称
amounttotal	BigDecimal	是	9.9	商品总数量
dealtotal	BigDecimal	是	1.00	总金额
remarks	string	否		单据备注
billitems	json list	是		单据明细信息，详见下表

上面表格中的字段 billitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
extproduid	string	否	1	商品ID(第三方)
produid	integer	是	1	商品ID
prodcode	string	是	001	商品编码
prodname	string	是	BooK	商品名称
unit	string	是	本	单位
dealpri	BigDecimal	是	9.9	单价
amount	BigDecimal	是	1.0	数量
trademoney	BigDecimal	是	9.9	金额
remark	string	否		备注

返回示例

{
  "code": 0,
  "msg": "",
  "seq": "123123-abc12",
  "items": [
    {
      "tbillno": "XS20161010001",
      "stobillno": "FHD20161010001",
      "rdate": "2016-02-01 ",
      "billingdate": "2016-02-01 12:02:34",
      "outstoreuid": 1,
      "outstorecode": "001",
      "outstorename": "湘阴一店",
      "instoreuid": 1,
      "instorecode": "001",
      "instorename": "湘阴一店",
      "remark": "",
      "billno": "XS20161010001",
      "refertime": "2016-02-01 12:02:35",
      "amounttotal": 9.9,
      "dealtotal": 1.00,
      "reamrks": "",
      "billitems": [
        {
          "produid": 1,
          "prodcode": "001",
          "prodname": "BooK",
          "unit": "本",
          "dealpri": 9.9,
          "amount": 1.0,
          "trademoney": 9.9,
          "remark": ""
        }
      ]
    }
  ]
}

推送退仓单

门店收到的货物存在质量差异的情况处理。填写资料退仓单。 例如，某商品发货单发货10件，实际配送到店货物10件，但1件包装存在问题，需要退货处理，那退仓数量1件

接口名称

cmd = "PushREQBill"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	PushREQBill	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
items	json list	是		单据列表，详见下表

注解

• 单据为已提交状态

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
billno	string	是	XS20161010001	单据号
rdate	string	是	2016-02-01	单据日期，格式： yyyy-mm-dd
billingdate	string	是	2016-02-01 12:02:34	制单时间，格式： yyyy-mm-dd HH:mi:ss
refertime	string	是	2016-02-01 12:02:35	提交时间，格式： yyyy-mm-dd HH:mi:ss
extoutstoreuid	string	否	1	出库仓库ID(第三方)
outstoreuid	integer	是	1	出库仓库ID
outstorecode	string	是	001	出库仓库编码
outstorename	string	是	湘阴一店	出库仓库名称
extinstoreuid	string	否	1	收货门店ID(第三方)
instoreuid	integer	是	1	收货门店ID
instorecode	string	是	001	收货门店编码
instorename	string	是	湘阴一店	收货门店名称
amounttotal	BigDecimal	是	9.9	商品总数量
dealtotal	BigDecimal	是	1.00	总金额
remarks	string	否		单据备注
billitems	json list	是		单据明细信息，详见下表

上面表格中的字段 billitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
extproduid	string	否	1	商品ID(第三方)
produid	integer	是	1	商品ID
prodcode	string	是	001	商品编码
prodname	string	是	BooK	商品名称
unit	string	是	本	单位
dealpri	BigDecimal	是	9.9	单价
amount	BigDecimal	是	1.0	数量
trademoney	BigDecimal	是	9.9	金额
remark	string	否		备注

请求示例

{
  "cmd": "PushREQBill",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "billno": "XS20161010001",
      "rdate": "2016-02-01",
      "billingdate": "2016-02-01 12:02:34",
      "refertime": "2016-02-01 12:02:35",
      "outstoreuid": 1,
      "outstorecode": "001",
      "outstorename": "湘阴一店",
      "instoreuid": 1,
      "instorecode": "001",
      "instorename": "湘阴一店",
      "remark": "",
      "amounttotal": 9.9,
      "dealtotal": 1.00,
      "reamrks": "",
      "billitems": [
        {
          "produid": 1,
          "prodcode": "001",
          "prodname": "BooK",
          "unit": "本",
          "dealpri": 9.9,
          "amount": 1.0,
          "trademoney": 9.9,
          "remark": ""
        }
      ]
    }
  ]
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息

返回示例

{
    "code":0,
    "msg":"",
    "seq":"123123-abc12"
}

下载退仓单

指定时间点，下载门店退仓单

接口名称

cmd = "DownloadREQBill"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	DownloadREQBill	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
storetype	integer	是	0	门店类型：0–全部、1–自营、2–加盟、3–联营
startday	string	是	2018-01-10	结束日期，格式yyyy-mm-dd
endday	string	是	2018-01-10	结束日期，格式yyyy-mm-dd
storeuid	integer	否	101	门店ID，非空时，下载本门店。为空时，下载全部门店
sumbatch	string	否	123456	指定下载批次，为空时生成新批次，非空时，下载前面未下载完成的批次

注解

• 每次请求返回提交时间大于条件时间三天内的收货差异单
• 如果条件时间小于系统中最小单据提交时间，则返回最小提交时间之后三天内的所有单据

请求示例

{
  "cmd": "DownloadRECBill",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "storetype": 0,
  "startday": "2018-01-10",
  "endday": "2018-01-10",
  "storeuid": 101,
  "sumbatch": "123456"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的单据数据列表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
billno	string	是	XS20161010001	单据号
rdate	string	是	2016-02-01	单据日期，格式： yyyy-mm-dd
billingdate	string	是	2016-02-01 12:02:34	制单时间，格式： yyyy-mm-dd HH:mi:ss
refertime	string	是	2016-02-01 12:02:35	提交时间，格式： yyyy-mm-dd HH:mi:ss
extoutstoreuid	string	否	1	出库仓库ID(第三方)
outstoreuid	integer	是	1	出库仓库ID
outstorecode	string	是	001	出库仓库编码
outstorename	string	是	湘阴一店	出库仓库名称
extinstoreuid	string	否	1	收货门店ID(第三方)
instoreuid	integer	是	1	收货门店ID
instorecode	string	是	001	收货门店编码
instorename	string	是	湘阴一店	收货门店名称
amounttotal	BigDecimal	是	9.9	商品总数量
dealtotal	BigDecimal	是	1.00	总金额
remarks	string	否		单据备注
billitems	json list	是		单据明细信息，详见下表

上面表格中的字段 billitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
extproduid	string	否	1	商品ID(第三方)
produid	integer	是	1	商品ID
prodcode	string	是	001	商品编码
prodname	string	是	BooK	商品名称
unit	string	是	本	单位
dealpri	BigDecimal	是	9.9	单价
amount	BigDecimal	是	1.0	数量
trademoney	BigDecimal	是	9.9	金额
remark	string	否		备注

返回示例

{
  "code": 0,
  "msg": "",
  "seq": "123123-abc12",
  "items": [
    {
      "billno": "XS20161010001",
      "rdate": "2016-02-01",
      "billingdate": "2016-02-01 12:02:34",
      "refertime": "2016-02-01 12:02:35",
      "outstoreuid": 1,
      "outstorecode": "001",
      "outstorename": "湘阴一店",
      "instoreuid": 1,
      "instorecode": "001",
      "instorename": "湘阴一店",
      "amounttotal": 9.9,
      "dealtotal": 1.00,
      "reamrks": "",
      "billitems": [
        {
          "produid": 1,
          "prodcode": "001",
          "prodname": "BooK",
          "unit": "本",
          "dealpri": 9.9,
          "amount": 1.0,
          "trademoney": 9.9,
          "additionalunit": "盒",
          "additionalunit_amount": 1,
          "remark": ""
        }
      ]
    }
  ]
}

查询出库单门店

根据日期段获取指定的出库单所对应的门店ID列表

接口名称

cmd = "GetTransferringStores"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	GetTransferringStores	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
startday	string	是	2018-01-01	起始日期，格式yyyy-mm-dd
endday	string	是	2018-01-10	结束日期，格式yyyy-mm-dd
stock	int	是	101	仓库ID

注解

• 每次请求返回日期段内单据所对应的门店ID列表。
• 可用此门店ID列表来下载出库单据。

请求示例

{
  "cmd": "GetTransferringStores",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "startday": "2018-01-01",
  "endday": "2018-01-10",
  "stock": 202
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的门店ID列表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
storeuid	string	是	101	门店ID

返回示例

{
  "cmd": "GetTransferringStoresResp",
  "code": 0,
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "msg": "成功",
  "items": [
    38503,
    38485,
    38552,
    38489
  ]
}

查询出库单

接口名称

cmd = "QueryTransferringOrderInfo"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	QueryTransferringOrderInfo	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
startday	string	是	2018-01-01	起始日期，格式yyyy-mm-dd
endday	string	是	2018-01-10	结束日期，格式yyyy-mm-dd
stock	int	是	101	仓库ID
sumbatch	string	否	343345	指定下载批次，为空时生成新批次，非空时，下载前面未下载完成的批次
dluiditems	json list	否	35	配送线路
storeuiditems	json list	否	342	门店id

上面表格中的字段dluiditems对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
dluid	json list	否	35	配送线路

上面表格中的字段storeuiditems对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
storeuiditems	json list	否	342	门店id

dluiditems,storeuiditems三个参数须选择一个作为请求参数

请求示例

{
  "cmd": "QueryTransferringOrderInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "startday": "2018-01-01",
  "endday": "2018-01-01",
  "stock":102,
  "sumbatch": "2018-01-01",
  "dluiditems": [
    3432,
    454
  ],
  "areauiditems": [
    34,
    755
  ],
  "storeuiditems": [
    234,
    467
  ]
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
sumbatch	string	否	123456	AchieveQueryTransferringOrderInfo协议使用
billnoitmes	int	否		单据

上面表格中的字段billnoitmes对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
billno	string	是	ZFH201612090001	单据编码
buid	int	是	121451	单据ID
rdate	string	是	2018-02-01	发生日期
billingdate	string	是	2018-02-01 08:00:00	制单时间
amount	BigDecimal	是	250.000	合计数量（出货）
dealtotal	BigDecimal	是	250.000	合计金（出货）
cname	string	是	张三	制单人
shopid	int	是	2445	收货门店ID
shopname	string	是	劳动广场店	收货门店名称
storeid	int	是	1014	出库仓库ID
storename	string	是	华东中心仓库	出库仓库名称
remarks	string	否	已拣货	备注
billnoproductsitems	json list	否		单据明细

上面表格中的字段billnoproductsitems对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
ibiuid	int	是	201	流水ID
produid	int	是	001	商品ID
prodcode	string	是	992	商品编码
prodname	string	是	黄小鸭	商品名称
unit	string	是	盒	单位码
standard	string	是	1000*10	规格
amount	BigDecimal	是	20.00	数量
dealpri	BigDecimal	是	17.00	交易价
trademoney	BigDecimal	是	15.00	交易金额
additionalunit_amount	BigDecimal	是	13.00	辅单位数量

返回示例

{
  "code": 0,
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "msg": "",
  "billnoitems": [
    {
      "billno": "ZFH201612090001",
      "buid": 121451,
      "rdate": "2018-02-01",
      "cdate": "2018-02-01 08:00：00",
      "tnum": 250,
      "cname": "张三",
      "shopid": 2445,
      "shopname": "劳动广场店",
      "storeid": 1014,
      "storename": "华东中心仓库",
      "billnoproductsitems": [
        {
          "ibiuid": 201,
          "produid": 1,
          "prodname": "黄小鸭",
          "unit": "盒",
          "standard": "1000*10",
          "amount": 20,
          "dealpri": 17,
          "trademoney": 15,
          "additionalunit_amount": 1
        }
      ]
    }
  ]
}

完成出库单查询

接口名称

cmd = "AchieveQueryTransferringOrderInfo"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	AchieveQueryTransferringOrderInfo	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
sumbatch	string	是	123456	前次查询批次（由服务端在QueryTransferringOrderInfo提供）

请求示例

{
  "cmd": "AchieveQueryTransferringOrderInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "sumbatch": "123456"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信

返回示例

{
  "code": 0,
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "msg": ""
}

取消出库单查询

接口名称

cmd = "AchieveRetQueryTransferringOrderInfo"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	AchieveRetQueryTransferringOrderInfo	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
buid	json list	否	[123939,2343,4544]	单据ID

请求示例

{
  "cmd": "AchieveRetQueryTransferringOrderInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "buid":[123,124,243]
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信

返回示例

{
  "code": 0,
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "msg": ""
}

修改出库单

接口名称

cmd = "UpdateTransferringOrderInfo"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	UpdateTransferringOrderInfo	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
buid	int	是	121451	单据ID
cbill	string	是	龙龙	制单人
billnoitems	json list	是		返回的商品基本信息

上面表格中的字段billnoitems对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
ibiuid	int	是	201	流水id
produid	int	是	001	商品id
prodname	string	是	黄小鸭	商品名称
unit	string	是	盒	单位
amount	BigDecimal	是	20	数量
tamount	BigDecimal	是	21.2	实际出库数量
additional_unit	string	是	包	辅单位
additionalunit_amount	BigDecimal	是	10	辅单位数量
additionalunit_tamount	BigDecimal	是	10.01	辅单实际出库数量

有辅单位必须填辅单位与主单位换算比例 1辅单位 = 辅单位与主单位换算比例 * 主单位

请求示例

{
  "cmd": "UpdateTransferringOrderInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "buid": "ZFH201612090001",
  "cbill":"龙龙",
  "billnoitems": [
    {
      "ibiuid": 201,
      "produid": 1,
      "prodname": "黄小鸭",
      "unit": "盒",
      "amount": 1,
      "tamount": 1.1,
      "additional_unit": "包",
      "additionalunit_amount": 10,
      "additionalunit_tamount": 10.01
    },
    {
      "ibiuid": 202,
      "produid": 2,
      "prodname": "黄鸭",
      "unit": "盒",
      "amount": 1.1,
      "tamount": 1.1,
      "additional_unit": "包",
      "additionalunit_amount": 10.1,
      "additionalunit_tamount": 10.01
    }
  ]
}

接口名称

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息

返回示例

{
  "code": 0,
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "msg": "成功"
}

查询销售单

接口名称

cmd = "QuerySaleOrderInfo"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	QuerySaleOrderInfo	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
date	string	是	2018-01-01	销售单据日期
starttime	string	是	08:00:00	起始时间，格式hh24:ss:mm
endtime	string	是	2018-01-10	结束时间，格式hh24:ss:mm
sumbatch	string	否	343345	指定下载批次，为空时生成新批次，非空时，下载前面未下载完成的批次
storeuid	int	是	342	门店id

请求示例

{
  "cmd": "QuerySaleOrderInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "date": "2018-05-01",
  "startday": "08:00:00",
  "endday": "23:00:00",
  "storeuid": 102,
  "sumbatch": "1423454"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
sumbatch	string	否	123456	AchieveQueryTransferringOrderInfo协议使用
billnoitmes	int	否		单据

上面表格中的字段billnoitmes对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
billno	string	是	ZFH201612090001	单据编码
buid	int	是	121451	单据ID
rdate	string	是	2018-02-01	发生日期
billingdate	string	是	2018-02-01 08:00:00	制单时间
storeuid	int	是	121451	门店ID
storecode	string	是	0382	门店编码
storename	string	是	天马1店	门店名称
amounttotal	BigDecimal	是	250.000	合计数量
dealtotal	BigDecimal	是	250.000	合计金
cname	string	是	张三	制单人
remarks	string	否	已拣货	备注
billnoproductsitems	json list	否		单据明细
billnopyaitems	json list	否		单据支付明细

上面表格中的字段billnoproductsitems对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
ibiuid	int	是	201	流水ID
produid	int	是	001	商品ID
prodcode	string	是	992	商品编码
prodname	string	是	黄小鸭	商品名称
unit	string	是	盒	单位码
standard	string	是	1000*10	规格
amount	BigDecimal	是	20.00	数量
dealpri	BigDecimal	是	17.00	交易价
trademoney	BigDecimal	是	15.00	交易金额

上面表格中的字段billnopyaitems对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
paycode	string	是	101	支付编码
payname	string	是	支付宝	支付名称
paymoney	BigDecimal	是	9.5	收款金额

返回示例

{
  "code": 0,
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "msg": "",
  "billnoitems": [
    {
      "billno": "XS1454-2018050100002",
      "buid": 121451,
      "rdate": "2018-02-01",
      "cdate": "2018-02-01 08:00：00",
      "tnum": 250,
      "cname": "张三",
      "shopid": 2445,
      "shopname": "劳动广场店",
      "billnoproductsitems": [
        {
          "ibiuid": 201,
          "produid": 1,
          "prodname": "黄小鸭",
          "unit": "盒",
          "standard": "1000*10",
          "amount": 20,
          "dealpri": 17,
          "trademoney": 15
        }
      ],
      "billnoPayitems": [
        {
          "paycode": "101",
          "payname": "支付宝",
          "discsum": 5.5,
          "ordersum": 15,
          "paymoney": 9.5
        }
      ]
    }
  ]
}