汇总报表

下载门店ID

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

接口名称

cmd = "GetStoreListSummaryByBatch"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string GetStoreListSummaryByBatch 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
storetype string 0 门店类型:0–全部、1–自营、2–加盟、3–联营
billtype int 1 下载的单据类型 1:销售 2:销退 3:入库 4:退货 5:盘存盈亏 6:报损
startday string 2018-01-01 起始日期,格式yyyy-mm-dd
endday string 2018-01-10 结束日期,格式yyyy-mm-dd

注解

  • 每次请求返回日期段内单据所对应的门店ID列表。
  • 可用此门店ID列表来下载单据数据汇总。
  • 在门店数量以及商品种类较多时,可用此接口先获取门店ID列表,然后再逐一下载门店的汇总数据。

请求示例

{
    "cmd":"GetStoreListSummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0",
    "billtype":"1",
    "startday":"2018-01-01",
    "endday":"2018-01-10"
}

返回参数

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

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

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

返回示例

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

下载门店收入汇总

根据日期段获取指定类型的门店的销售,储值汇总数据,包括日期、门店、收入类型(销售收入-包括线销售,储值收入,)金额,以及支付信息

接口名称

cmd = "DownloadReceivingAccountByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品销售(正)与销退(负数),储值(正)与退卡(负数)的汇总数。
  • 销售,储值数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

{
  "cmd": "DownloadReceivingAccountByBatch",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "storetype": "0",
  "startday": "2018-04-01",
  "endday": "2018-04-02",
  "sumbatch": 2323
}

返回参数

表1

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
startday string 2018-01-01 起始日期,格式yyyy-mm-dd
endday string 2018-01-10 结束日期,格式yyyy-mm-dd
items json list    

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

表2

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storename string 天马店 门店名称
dealtotal BigDecimal 10.0 收入总金额
saletotal BigDecimal 10.0 线下收入总金额
ictotal BigDecimal 10.0 储值收入总金额
o2ototal BigDecimal 30.00 订单总金额
activitytotal BigDecimal 10.00 优惠总金额=商家承担优惠+平台承担优惠
merchanttotal BigDecimal 5.00 商家承担总优惠
tptotal BigDecimal 5.00 平台承担总优惠
actualfeetotal BigDecimal 28.00 实收总金额(客户支付金额)
commisiontotal BigDecimal 2.00 抽佣总金额
shippingtotal BigDecimal 1.00 总配送费
settletotal BigDecimal 30.00 结算总金额(平台实付商家金额)
rdateitems json list   分收入信息
payment json list   支付类型信息(所有支付方式,金额)

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

表3.1

参数名 类型 是否必须 示例值 描述
rdate string 2018-01-01 日期
rdealtotal BigDecimal 10.0 按日期区分总金额
rsaletotal BigDecimal 10.0 按日期区分线下收入总金额
rictotal BigDecimal 10.0 按日期区分储值收入总金额
ro2ototal BigDecimal 30.00 按日期区分订单总金额
ractivitytotal BigDecimal 10.00 按日期区分优惠总金额=商家承担优惠+平台承担优惠
rmerchanttotal BigDecimal 5.00 按日期区分商家承担总优惠
rtptotal BigDecimal 5.00 按日期区分平台承担总优惠
ractualfeetotal BigDecimal 28.00 按日期区分实收总金额(客户支付金额)
rcommisiontotal BigDecimal 2.00 按日期区分抽佣总金额
rshippingtotal BigDecimal 1.00 按日期区分配送费
rsettletotal BigDecimal 30.00 按日期区分结算总金额(平台实付商家金额)
rpay json list   按日期区分区分支付信息
payitems json list   线下收入支付信息
icitems json list   储值收入支付信息
o2otems json list   线上收入支付信息

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

表3.2

参数名 类型 是否必须 示例值 描述
paycode string 101 支付编码
payname string   支付名称
paymoney BigDecimal 天马店 支付金额

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

表4.1

参数名 类型 是否必须 示例值 描述
paycode string 101 支付编码
payname string   支付名称
paymoney BigDecimal 天马店 支付金额

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

表4.2

参数名 类型 是否必须 示例值 描述
paycode string 101 支付编码
payname string   支付名称
paymoney BigDecimal 天马店 支付金额

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

表4.3

参数名 类型 是否必须 示例值 描述
paycode string 101 支付编码
payname string   支付名称
paymoney BigDecimal 天马店 支付金额

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

表4.4

参数名 类型 是否必须 示例值 描述
tpmechtype int 1 外卖平台 (2 ‘饿了么’,’百度’ ,4 ‘美团2.0’ ,5 有赞 ,20 饿了么2.0)
lo2ototal BigDecimal 30.00 订单金额
lactivitytotal BigDecimal 10.00 优惠金额=商家承担优惠+平台承担优惠
lmerchanttotal BigDecimal 5.00 商家承担优惠
ltptotal BigDecimal 5.00 平台承担优惠
lactualfeetotal BigDecimal 28.00 实收金额(客户支付金额)
lcommisiontotal BigDecimal 2.00 抽佣金额
lshippingtotal BigDecimal 1.00 配送费
lsettletotal BigDecimal 30.00 结算金额(平台实付商家金额)

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "区域|长沙|开福区",
      "storeuid": 1324,
      "storename": "天马店",
      "dealtotal": 39.6,
      "saletotal": 20.00,
      "ictotal": 20.00,
      "o2ototal": 30.00,
      "activitytotal": 10.00,
      "merchanttotal": 5.00,
      "tptotal": 5.00,
      "actualfeetotal": 28.00,
      "commisiontotal": 2.00,
      "shippingtotal": 1.00,
      "settletotal": 30.00,
      "payment": [
        {
          "paycode": "1",
          "paymoney": 9.90,
          "payname": "现金"
        }
      ],
      "rdateitems": [
        {
          "rdate": "2018-04-01",
          "rtotal": 19.80,
          "resaletotal": 10.00,
          "rictotal": 10.00,
          "rpay": [
            {
              "paycode": "1",
              "paymoney": 9.90,
              "payname": "现金"
            }
          ],
          "payitems": [
            {
              "paycode": "1",
              "paymoney": 9.90,
              "payname": "现金"
            }
          ],
          "icitems": [
            {
              "paycode": "1",
              "paymoney": 9.90,
              "payname": "现金"
            }
          ]
        },
        {
          "rdate": "2018-04-02",
          "rtotal": 19.80,
          "rsaletotal": 10.00,
          "rictotal": 10.00,
          "ro2ototal": 30.00,
          "ractivitytotal": 10.00,
          "rmerchanttotal": 5.00,
          "rtptotal": 5.00,
          "ractualfeetotal": 28.00,
          "rcommisiontotal": 2.00,
          "rshippingtotal": 1.00,
          "rsettletotal": 30.00,
          "rdatepay": [
            {
              "paycode": "1",
              "paymoney": 9.90,
              "payname": "现金"
            }
          ],
          "payitems": [
            {
              "paycode": "1",
              "paymoney": 9.90,
              "payname": "现金"
            }
          ],
          "icitems": [
            {
              "paycode": "1",
              "paymoney": 9.90,
              "payname": "现金"
            }
          ],
          "o2otems": [
            {
              "tpmechtype": 1,
              "lo2ototal": 30.00,
              "lactivitytotal": 10.00,
              "lmerchanttotal": 5.00,
              "ltptotal": 5.00,
              "lactualfeetotal": 28.00,
              "lcommisiontotal": 2.00,
              "lshippingtotal": 1.00,
              "lsettletotal": 30.00
            }
          ]
        }
      ]
    }
  ]
}

下载销售销退汇总

根据日期段获取指定类型的门店的销售汇总数据,包括日期、门店、商品、金额,以及支付信息

接口名称

cmd = "DownloadSalespinbackSummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品销售(正)与销退(负数)的汇总数。
  • 销售数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

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

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
items json list   返回的门店、日期及金额等数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 销售总金额
standardtotal BigDecimal 12.4 商品标准价金额(折前金额)
billitems json list   商品销售明细信息,详见下表
payitems json list   支付信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 销售数量
dealpri BigDecimal 9.9 交易单价
standardpri BigDecimal 12.4 标准单价(折前单价)
trademoney BigDecimal 9.9 交易金额

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

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

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "standardtotal": 12.4,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "standardpri": 12.4,
          "trademoney": 9.9
        }
      ],
      "payitems": [
        {
          "paycode": "1",
          "paymoney": 9.9,
          "payname": "现金"
        }
      ]
    }
  ]
}

下载销售汇总

根据日期段获取指定类型的门店的销售汇总数据,包括日期、门店、商品、金额,以及支付信息

接口名称

cmd = "DownloadStoreSaleSummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品销售的汇总数,销售冲票用负数体现。
  • 销售数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

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

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
items json list   返回的门店、日期及金额等数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 销售总金额
standardtotal BigDecimal 12.4 商品标准价金额(折前金额)
billitems json list   商品销售明细信息,详见下表
payitems json list   支付信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 销售数量
dealpri BigDecimal 9.9 交易单价
standardpri BigDecimal 12.4 标准单价(折前单价)
trademoney BigDecimal 9.9 交易金额

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

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

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "standardtotal": 12.4,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "standardpri": 12.4,
          "trademoney": 9.9
        }
      ],
      "payitems": [
        {
          "paycode": "1",
          "paymoney": 9.9,
          "payname": "现金"
        }
      ]
    }
  ]
}

下载销退汇总

根据日期段获取指定类型的门店的销退汇总数据,包括日期、门店、商品、金额,以及支付信息

接口名称

cmd = "DownloadStoreSaleRetSummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品销退的汇总数,销退冲票用负数体现。
  • 销退数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

{
    "cmd":"DownloadStoreSaleRetSummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0",
    "startday":"2018-01-01",
    "endday":"2018-01-10"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
items json list   返回的门店、日期及金额等数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 销退总金额
standardtotal BigDecimal 12.4 商品标准价金额(折前金额)
billitems json list   商品销退明细信息,详见下表
payitems json list   支付信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 销退数量
dealpri BigDecimal 9.9 交易单价
standardpri BigDecimal 12.4 标准单价(折前单价)
trademoney BigDecimal 9.9 交易金额

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

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

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "standardtotal": 12.4,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "standardpri": 12.4,
          "trademoney": 9.9
        }
      ],
      "payitems": [
        {
          "paycode": "1",
          "paymoney": 9.9,
          "payname": "现金"
        }
      ]
    }
  ]
}

下载入库汇总

根据日期段获取指定类型的门店的入库汇总数据,包括日期、门店、供应商、商品、金额

接口名称

cmd = "DownloadStoreReceiptSummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品入库汇总数,入库包含了总部配送到门店的商品,也包括了门店自采的商品。
  • 入库数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

{
    "cmd":"DownloadStoreReceiptSummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0",
    "startday":"2018-01-01",
    "endday":"2018-01-10"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
items json list   返回的门店、日期、货源类型以及金额数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
source string 配送 货物来源:自采、配送
deliverywhid string 1 发货仓库ID
deliverywhcode string 1001 发货仓库编码
deliverywhname string 上海仓 发货仓库名称
custuid string 101 供应商ID
custcode string 2001 供应商编码
custname string 徐家汇肉食批发部 供应商名称
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 入库总金额
billitems json list   商品入库明细信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 入库数量
dealpri BigDecimal 9.9 交易单价
trademoney BigDecimal 9.9 交易金额

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "source": "自采",
      "deliverywhid": "",
      "deliverywhcode": "",
      "deliverywhname": "",
      "custuid": "101",
      "custcode": "2001",
      "custname": "徐家汇肉食批发部",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "trademoney": 9.9
        }
      ]
    }
  ]
}

下载采购汇总

根据日期段获取指定类型的门店的采购汇总数据,包括日期、门店、供应商、商品、金额

接口名称

cmd = "DownloadStorePurchaseSummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品采购汇总数,门店自采的商品。
  • 采购数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

{
    "cmd":"DownloadStorePurchaseSummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0",
    "startday":"2018-01-01",
    "endday":"2018-01-10"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
items json list   返回的门店、日期、货源类型以及金额数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
custuid string 101 供应商ID
custcode string 2001 供应商编码
custname string 徐家汇肉食批发部 供应商名称
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 采购总金额
billitems json list   商品采购明细信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 采购数量
dealpri BigDecimal 9.9 交易单价
trademoney BigDecimal 9.9 交易金额

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "source": "自采",
      "deliverywhid": "",
      "deliverywhcode": "",
      "deliverywhname": "",
      "custuid": "101",
      "custcode": "2001",
      "custname": "徐家汇肉食批发部",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "trademoney": 9.9
        }
      ]
    }
  ]
}

下载配送汇总

根据日期段获取指定类型的门店的配送汇总数据,包括日期、门店、供应商、商品、金额

接口名称

cmd = "DownloadStoreAllotSummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品配送汇总数,总部配送到门店的商品。
  • 配送数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

{
    "cmd":"DownloadStoreAllotSummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0",
    "startday":"2018-01-01",
    "endday":"2018-01-10"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
items json list   返回的门店、日期、货源类型以及金额数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
deliverywhid string 1 发货仓库ID
deliverywhcode string 1001 发货仓库编码
deliverywhname string 上海仓 发货仓库名称
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 配送总金额
billitems json list   商品配送明细信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 配送数量
dealpri BigDecimal 9.9 交易单价
trademoney BigDecimal 9.9 交易金额

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "source": "自采",
      "deliverywhid": "",
      "deliverywhcode": "",
      "deliverywhname": "",
      "custuid": "101",
      "custcode": "2001",
      "custname": "徐家汇肉食批发部",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "trademoney": 9.9
        }
      ]
    }
  ]
}

下载退货汇总

根据日期段获取指定类型的门店的退货汇总数据,包括日期、门店、供应商、商品、金额

接口名称

cmd = "DownloadStoreReturnSummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品退货汇总数,退货包含了总部配送到门店的商品,也包括了门店自采的商品。
  • 退货数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

{
    "cmd":"DownloadStoreReturnSummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0",
    "startday":"2018-01-01",
    "endday":"2018-01-10"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
items json list   返回的门店、日期、货源类型以及金额数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
source string 配送 货物来源:自采、配送
deliverywhid string 1 发货仓库ID
deliverywhcode string 1001 发货仓库编码
deliverywhname string 上海仓 发货仓库名称
custuid string 101 供应商ID
custcode string 2001 供应商编码
custname string 徐家汇肉食批发部 供应商名称
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 退货总金额
billitems json list   商品退货明细信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 退货数量
dealpri BigDecimal 9.9 交易单价
trademoney BigDecimal 9.9 交易金额

返回示例

{
  "code": 0,
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "source": "配送",
      "deliverywhid": "1",
      "deliverywhcode": "1001",
      "deliverywhname": "上海仓",
      "custuid": "",
      "custcode": "",
      "custname": "",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "trademoney": 9.9
        }
      ]
    }
  ]
}

下载购退汇总

根据日期段获取指定类型的门店的购退汇总数据,包括日期、门店、供应商、商品、金额

接口名称

cmd = "DownloadStorePurchaseRetSummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品购退汇总数,只包括了门店自采的商品。
  • 购退数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

{
    "cmd":"DownloadStorePurchaseRetSummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0",
    "startday":"2018-01-01",
    "endday":"2018-01-10"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
items json list   返回的门店、日期、货源类型以及金额数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
custuid string 101 供应商ID
custcode string 2001 供应商编码
custname string 徐家汇肉食批发部 供应商名称
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 购退总金额
billitems json list   商品购退明细信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 购退数量
dealpri BigDecimal 9.9 交易单价
trademoney BigDecimal 9.9 交易金额

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "source": "自采",
      "deliverywhid": "",
      "deliverywhcode": "",
      "deliverywhname": "",
      "custuid": "101",
      "custcode": "2001",
      "custname": "徐家汇肉食批发部",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "trademoney": 9.9
        }
      ]
    }
  ]
}

下载退仓汇总

根据日期段获取指定类型的门店的退仓汇总数据,包括日期、门店、供应商、商品、金额

接口名称

cmd = "DownloadStoreAllotRetSummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品退仓汇总数,门店退仓到总部的商。
  • 退仓数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

{
    "cmd":"DownloadStoreAllotRetSummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0",
    "startday":"2018-01-01",
    "endday":"2018-01-10"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
items json list   返回的门店、日期、货源类型以及金额数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 发货门店ID
storecode string 001 发货门店编码
storename string 万达店 发货门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
deliverywhid string 1 收货仓库ID
deliverywhcode string 1001 收货仓库编码
deliverywhname string 上海仓 收货仓库名称
custuid string 101 供应商ID
custcode string 2001 供应商编码
custname string 徐家汇肉食批发部 供应商名称
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 退仓总金额
billitems json list   商品退仓明细信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 退仓数量
dealpri BigDecimal 9.9 交易单价
trademoney BigDecimal 9.9 交易金额

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "source": "自采",
      "deliverywhid": "",
      "deliverywhcode": "",
      "deliverywhname": "",
      "custuid": "101",
      "custcode": "2001",
      "custname": "徐家汇肉食批发部",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "trademoney": 9.9
        }
      ]
    }
  ]
}

下载盘存盈亏汇总

根据日期段获取指定类型的门店的盘存盈亏汇总数据,包括日期、门店、商品、金额

接口名称

cmd = "DownloadStoreInventorySummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品盘存盈亏汇总数。
  • 盘盈数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

{
    "cmd":"DownloadStoreInventorySummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0",
    "startday":"2018-01-01",
    "endday":"2018-01-10"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
profititems json list   返回的门店、日期、盘盈数据的列表
lossesitems json list   返回的门店、日期、盘亏数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 盘盈总金额
profitbillitems json list   商品盘盈明细信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 盘盈数量
dealpri BigDecimal 9.9 交易单价
trademoney BigDecimal 9.9 交易金额

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 盘亏总金额
lossesbillitems json list   商品盘盈明细信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 盘盈数量
dealpri BigDecimal 9.9 交易单价
trademoney BigDecimal 9.9 交易金额

返回示例

{
  "code": 0,
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "profititems": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "trademoney": 9.9
        }
      ]
    }
  ],
  "lossesitems": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "amounttotal": 2,
      "dealtotal": 10,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "002",
          "prodname": "小笼包",
          "unit": "个",
          "amount": 2,
          "dealpri": 5,
          "trademoney": 5
        }
      ]
    }
  ]
}

下载报损汇总

根据日期段获取指定类型的门店的报损汇总数据,包括日期、门店、供应商、商品、金额

接口名称

cmd = "DownloadStoreDamagesSummaryByBatch"

请求参数

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

注解

  • 每次请求返回日期段内门店商品报损汇总数。
  • 报损数据为已经提交的,不可更改的数据。如果日期段内的单据已经提取,则无数据返回。
  • 每次数据下载完成后,需调用AchieveStoreSummaryByBatch协议,通知服务端数据已经下载。

请求示例

{
    "cmd":"DownloadStoreDamagesSummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0",
    "startday":"2018-01-01",
    "endday":"2018-01-10"
}

返回参数

参数名 类型 是否必须 示例值 描述
code int 0 返回状态码,详见 业务错误码说明
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
msg string   返回状态解释,错误为错误提示信息
sumbatch string 123456 本次汇总的批次,供AchieveStoreSummaryByBatch协议使用
items json list   返回的门店、日期、货源类型以及金额数据的列表

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

参数名 类型 是否必须 示例值 描述
fullareaname string 区域|长沙|开福区 区域全路径
storeuid string 101 门店ID
storecode string 001 门店编码
storename string 万达店 门店名称
storetype string 1 门店类型:1–自营、2–加盟、3–联营
rdate string 2016-02-01 单据日期,格式: yyyy-mm-dd
amounttotal BigDecimal 9.9 商品总数量
dealtotal BigDecimal 10.0 报损总金额
billitems json list   商品报损明细信息,详见下表

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

参数名 类型 是否必须 示例值 描述
fullclassname string 商品|饮料|奶 商品分类全路径
unitgroupcode string 100袋/箱 商品单位分组编码
unitgroupname string 100袋/箱 商品单位分组名称
produid string 1 商品ID
prodcode string 001 商品编码
prodname string BooK 商品名称
unit string 单位
amount BigDecimal 1.0 报损数量
dealpri BigDecimal 9.9 交易单价
trademoney BigDecimal 9.9 交易金额

返回示例

{
  "code": 0,
  "msg": "",
  "seq": "123123-abc12",
  "sumbatch": 123456,
  "items": [
    {
      "fullareaname": "湖南|长沙|芙蓉区",
      "storeuid": "101",
      "storecode": "001",
      "storename": "万达店",
      "storetype": 1,
      "rdate": "2016-10-10",
      "amounttotal": 9.9,
      "dealtotal": 10,
      "billitems": [
        {
          "fullclassname": "书|儿童文学",
          "unitgroupcode": "12",
          "produid": "1",
          "prodcode": "001",
          "prodname": "Book",
          "unit": "本",
          "amount": 1,
          "dealpri": 9.9,
          "trademoney": 9.9
        }
      ]
    }
  ]
}

下载完成

通知服务端,下载执行完成。服务端对已经下载的单据打下载完成标记。

接口名称

cmd = "AchieveStoreSummaryByBatch"

请求参数

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

请求示例

{
    "cmd":"AchieveStoreSummaryByBatch",
    "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 = "InitStoreSummaryByBatch"

请求参数

参数名 类型 是否必须 示例值 描述
cmd string InitStoreSummaryByBatch 请求的命令,即接口名称
seq string eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符,简称GUID
storetype string 0 门店类型:0–全部、1–自营、2–加盟、3–联营
billtype int 1 单据类型 1:销售 2:销退 3:入库 4:退货 5:盘存盈亏 6:报损 7:储值;为空时,全部单据类型
startday string 2018-01-01 起始日期,格式yyyy-mm-dd,>=该日期。
endday string 2018-01-10 结束日期,格式yyyy-mm-dd,<=该日期
sumbatch string 123456 下载批次,非空时,删除此批次对应的单据以便重新下载,为空时,删除所有符合条件汇总记录

请求示例

{
    "cmd":"InitStoreSummaryByBatch",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "storetype":"0"
    "billtype":"1"
}

返回参数

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

返回示例

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