版权所有©，上海海鼎信息工程股份有限公司，2016-2025，保留所有权利。

接口

1. 接口定义

1.1. 数据交互记录

1.1.1. 创建数据交换记录

POST /{tenant_id}/invc/syssyncrecordservice/record
1.1.1.1. 说明

创建数据交换记录

1.1.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

record
必填

数据交换记录

SysSyncRecord
1.1.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.1.4. HTTP请求示例
请求 path
/string/invc/syssyncrecordservice/record?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "402880ef51af7b970151af7cd5cc0002",
  "type" : "storeskuprice.sync",
  "reason" : "manual update",
  "remark" : "test remark",
  "dimension_type" : "store",
  "dimension_id" : "0001",
  "source_system_id" : "UP",
  "target_system_id" : "DLY",
  "last_sync_time" : "2025-01-13 10:00:00",
  "extra_data" : "{}"
}
1.1.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.2. 查找指定数据交换记录ID信息

GET /{tenant_id}/invc/syssyncrecordservice/record/{id}
1.1.2.1. 说明

查找指定数据交换记录ID信息

1.1.2.2. 参数
类型 名称 说明 类型

Path

id
必填

数据交换记录ID

string

Path

tenant_id
必填

租户ID

string
1.1.2.3. 响应
HTTP代码 说明 类型

200

successful operation

SysSyncRecord
1.1.2.4. HTTP请求示例
请求 path
/string/invc/syssyncrecordservice/record/string
1.1.2.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "402880ef51af7b970151af7cd5cc0002",
  "type" : "storeskuprice.sync",
  "reason" : "manual update",
  "remark" : "test remark",
  "dimension_type" : "store",
  "dimension_id" : "0001",
  "source_system_id" : "UP",
  "target_system_id" : "DLY",
  "last_sync_time" : "2025-01-13 10:00:00",
  "extra_data" : "{}"
}

1.1.3. 删除指定id的数据交换记录信息

POST /{tenant_id}/invc/syssyncrecordservice/record/{id}/delete
1.1.3.1. 说明

删除指定id的数据交换记录信息

1.1.3.2. 参数
类型 名称 说明 类型

Path

id
必填

数据交换记录ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string
1.1.3.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.3.4. HTTP请求示例
请求 path
/string/invc/syssyncrecordservice/record/string/delete?operator=string
1.1.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.4. 批量取得数据交换记录

POST /{tenant_id}/invc/syssyncrecordservice/records
1.1.4.1. 说明

批量取得数据交换记录

1.1.4.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Body

ids
必填

数据交换记录ID集合，最多100条

IdsWrapper
1.1.4.3. 响应
HTTP代码 说明 类型

200

successful operation

SysSyncRecordList
1.1.4.4. HTTP请求示例
请求 path
/string/invc/syssyncrecordservice/records
请求 body
{
  "ids" : [ "string" ]
}
1.1.4.5. HTTP响应示例
响应 200
{
  "records" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "402880ef51af7b970151af7cd5cc0002",
    "type" : "storeskuprice.sync",
    "reason" : "manual update",
    "remark" : "test remark",
    "dimension_type" : "store",
    "dimension_id" : "0001",
    "source_system_id" : "UP",
    "target_system_id" : "DLY",
    "last_sync_time" : "2025-01-13 10:00:00",
    "extra_data" : "{}"
  } ]
}

1.1.5. 分页查询数据交换记录

POST /{tenant_id}/invc/syssyncrecordservice/records/query
1.1.5.1. 说明

分页查询数据交换记录

1.1.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
必填

页码，必须>=0

integer (int32)

Query

page_size
必填

分页大小，范围是[1,1000]

integer (int32)

Query

sort_key
可选

排序字段

string

Body

filter
必填

过滤器

SysSyncRecordFilter
1.1.5.3. 响应
HTTP代码 说明 类型

200

successful operation

SysSyncRecordPaging
1.1.5.4. HTTP请求示例
请求 path
/string/invc/syssyncrecordservice/records/query?desc=true&page=0&page_size=0
请求 body
{
  "id_in" : [ "string" ],
  "type_eq" : "string",
  "dimension_type_eq" : "string",
  "dimension_id_eq" : "string",
  "source_system_id_eq" : "string",
  "source_system_id_in" : [ "string" ],
  "target_system_id_eq" : "string"
}
1.1.5.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "page_count" : 10,
  "page_size" : 10,
  "record" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "402880ef51af7b970151af7cd5cc0002",
    "type" : "storeskuprice.sync",
    "reason" : "manual update",
    "remark" : "test remark",
    "dimension_type" : "store",
    "dimension_id" : "0001",
    "source_system_id" : "UP",
    "target_system_id" : "DLY",
    "last_sync_time" : "2025-01-13 10:00:00",
    "extra_data" : "{}"
  } ]
}

1.1.6. 上传数据交换记录

POST /{tenant_id}/invc/syssyncrecordservice/records/upload
1.1.6.1. 说明

批量更新数据交换记录，不存在则创建，存在则修改。

1.1.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

records
必填

数据交换记录列表，每次更新不超过100条

SysSyncRecordList
1.1.6.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.6.4. HTTP请求示例
请求 path
/string/invc/syssyncrecordservice/records/upload?operator=string
请求 body
{
  "records" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "402880ef51af7b970151af7cd5cc0002",
    "type" : "storeskuprice.sync",
    "reason" : "manual update",
    "remark" : "test remark",
    "dimension_type" : "store",
    "dimension_id" : "0001",
    "source_system_id" : "UP",
    "target_system_id" : "DLY",
    "last_sync_time" : "2025-01-13 10:00:00",
    "extra_data" : "{}"
  } ]
}
1.1.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.2. 组织服务

1.2.1. 创建组织信息

POST /{tenant_id}/invc/orgservice/orgSave
1.2.1.1. 说明

创建组织信息

1.2.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

组织信息

OrgRequest
1.2.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.2.1.4. HTTP请求示例
请求 path
/string/invc/orgservice/orgSave?operator=string
请求 body
{
  "org_list" : [ {
    "id" : "0001",
    "code" : "0001",
    "name" : "0001",
    "deleted" : false,
    "upper_id" : "001"
  } ]
}
1.2.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

2. 定义

2.1. ActionResult

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.2. IdsWrapper

名称 说明 类型

ids
可选

样例 : [ "string" ]

< string > array

2.3. Org

组织

名称 说明 类型

code
必填

对应线下组织code
样例 : "0001"

string

deleted
可选

是否删除，默认为false，为true时删除组织信息
默认值 : false
样例 : false

boolean

id
必填

对应线下组织gid
样例 : "0001"

string

name
可选

名称
样例 : "0001"

string

upper_id
可选

对应线下上级组织upperGid(为空时默认未-)
样例 : "001"

string

2.4. OrgRequest

组织信息请求

名称 说明 类型

org_list
可选

组织信息
样例 : [ "Org" ]

< Org > array

2.5. SysSyncRecord

数据交换记录

名称 说明 类型

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

dimension_id
必填

维度ID(如store_id)
样例 : "0001"

string

dimension_type
必填

同步维度(门店store、货号sku等)
样例 : "store"

string

extra_data
可选

扩展数据(json格式)
样例 : "{}"

string

id
可选

ID
样例 : "402880ef51af7b970151af7cd5cc0002"

string

last_sync_time
可选

上一次交互时间
样例 : "2025-01-13 10:00:00"

string (date-time)

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

reason
可选

原因
样例 : "manual update"

string

remark
可选

备注
样例 : "test remark"

string

source_system_id
必填

源系统ID，如UP
样例 : "UP"

string

target_system_id
必填

目标系统ID，如DLY
样例 : "DLY"

string

type
必填

交换类型(同步门店商品库存(storeskuinv.sync)、同步门店商品价格(storeskuprice.sync)等)
样例 : "storeskuprice.sync"

string

2.6. SysSyncRecordFilter

数据交换记录过滤器

名称 说明 类型

dimension_id_eq
可选

维度ID等于
样例 : "string"

string

dimension_type_eq
可选

同步维度等于
样例 : "string"

string

id_in
可选

id范围
样例 : [ "string" ]

< string > array

source_system_id_eq
可选

源系统ID等于
样例 : "string"

string

source_system_id_in
可选

源系统ID范围
样例 : [ "string" ]

< string > array

target_system_id_eq
可选

目标系统ID等于
样例 : "string"

string

type_eq
可选

交换类型等于
样例 : "string"

string

2.7. SysSyncRecordList

数据交换记录列表

名称 说明 类型

records
可选

样例 : [ "SysSyncRecord" ]

< SysSyncRecord > array

2.8. SysSyncRecordPaging

数据交换记录分页查询结果

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

分页数量
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

record
可选

样例 : [ "SysSyncRecord" ]

< SysSyncRecord > array

total
可选

记录总数
样例 : 100

integer (int64)