订单中心-订单服务-门店作业规则服务接口文档

接口

1. 接口定义

1.1. 门店作业规则服务

1.1.1. 查询门店作业规则服务

POST /{tenant_id}/soms/storeoperationruleservice/rule

1.1.1.1. 说明

查询门店作业规则服务

1.1.1.2. 参数

类型	名称	说明	类型
Path	tenant_id 必填	租户Id	string
Query	desc 必填	升序、降序	boolean
Query	page 必填	页码	integer (int32)
Query	page_size 必填	每页条数	integer (int32)
Query	sort_key 必填	排序字段	string
Body	store_operation_rule_filter 必填	过滤条件	StoreOperationRuleFilter

类型

名称

说明

类型

Path

tenant_id
必填

租户Id

string

Query

desc
必填

升序、降序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

每页条数

integer (int32)

Query

sort_key
必填

排序字段

string

Body

store_operation_rule_filter
必填

过滤条件

StoreOperationRuleFilter

1.1.1.3. 响应

HTTP代码	说明	类型
200	successful operation	< StoreOperationRule > array

HTTP代码

说明

类型

200

successful operation

< StoreOperationRule > array

1.1.1.4. HTTP请求示例

请求 path

/string/soms/storeoperationruleservice/rule?desc=true&page=0&page_size=0&sort_key=string

请求 body

{
  "typeEq" : "string",
  "platformIdEq" : "string",
  "shopIdEq" : "string",
  "storeIdEq" : "string",
  "storeIdIn" : [ "string" ],
  "stateEq" : "string"
}

1.1.1.5. HTTP响应示例

响应 200

[ {
  "type" : "string",
  "platform_id" : "33454",
  "shop_id" : "33454",
  "store_id" : "33454",
  "state" : "applying",
  "def" : {
    "rtn_rule" : {
      "limtRtnApproveTimeRange" : "string",
      "allow_part_refund" : true,
      "allow_float" : true,
      "manual_receive" : true
    },
    "pick_rule" : {
      "allow_pick_time" : 0.0
    }
  },
  "source" : "string"
} ]

1.1.2. 获取门店作业规则

GET /{tenant_id}/soms/storeoperationruleservice/rule

1.1.2.1. 说明

获取门店作业规则

1.1.2.2. 参数

类型	名称	说明	类型
Path	tenant_id 必填	租户Id	string
Query	platform_id 必填	平台ID	string
Query	shop_id 必填	商家代码	string
Query	store_id 必填	门店代码	string
Query	type 必填	规则：storeRtnRule（门店退单规则）	string

类型

名称

说明

类型

Path

tenant_id
必填

租户Id

string

Query

platform_id
必填

平台ID

string

Query

shop_id
必填

商家代码

string

Query

store_id
必填

门店代码

string

Query

type
必填

规则：storeRtnRule（门店退单规则）

string

1.1.2.3. 响应

HTTP代码	说明	类型
200	successful operation	StoreOperationRule

HTTP代码

说明

类型

200

successful operation

StoreOperationRule

1.1.2.4. HTTP请求示例

请求 path

/string/soms/storeoperationruleservice/rule?platform_id=string&shop_id=string&store_id=string&type=string

1.1.2.5. HTTP响应示例

响应 200

{
  "type" : "string",
  "platform_id" : "33454",
  "shop_id" : "33454",
  "store_id" : "33454",
  "state" : "applying",
  "def" : {
    "rtn_rule" : {
      "limtRtnApproveTimeRange" : "string",
      "allow_part_refund" : true,
      "allow_float" : true,
      "manual_receive" : true
    },
    "pick_rule" : {
      "allow_pick_time" : 0.0
    }
  },
  "source" : "string"
}

1.1.3. 删除门店作业规则

DELETE /{tenant_id}/soms/storeoperationruleservice/rule/delete

1.1.3.1. 说明

删除门店作业规则

1.1.3.2. 参数

类型	名称	说明	类型
Path	tenant_id 必填	租户Id	string
Query	platform_id 必填	平台ID	string
Query	shop_id 必填	商家代码	string
Query	store_id 必填	门店代码	string
Query	type 必填	规则：storeRtnRule（门店退单规则）	string

类型

名称

说明

类型

Path

tenant_id
必填

租户Id

string

Query

platform_id
必填

平台ID

string

Query

shop_id
必填

商家代码

string

Query

store_id
必填

门店代码

string

Query

type
必填

规则：storeRtnRule（门店退单规则）

string

1.1.3.3. 响应

HTTP代码	说明	类型
default	successful operation	无内容

HTTP代码

说明

类型

default

successful operation

无内容

1.1.3.4. HTTP请求示例

请求 path

/string/soms/storeoperationruleservice/rule/delete?platform_id=string&shop_id=string&store_id=string&type=string

1.1.4. 按参数获取门店作业规则服务

POST /{tenant_id}/soms/storeoperationruleservice/rule/fetch/by/param

1.1.4.1. 说明

按参数获取门店作业规则服务

1.1.4.2. 参数

类型	名称	说明	类型
Path	tenant_id 必填	租户Id	string
Body	param 必填	参数	门店运营规则获取参数

类型

名称

说明

类型

Path

tenant_id
必填

租户Id

string

Body

param
必填

参数

门店运营规则获取参数

1.1.4.3. 响应

HTTP代码	说明	类型
200	successful operation	StoreOperationRule

HTTP代码

说明

类型

200

successful operation

StoreOperationRule

1.1.4.4. HTTP请求示例

请求 path

/string/soms/storeoperationruleservice/rule/fetch/by/param

请求 body

{
  "type" : "string",
  "platform_id" : "string",
  "shop_id" : "string",
  "store_id" : "string",
  "fetch_by_ptm_store_ignore_shop" : true
}

1.1.4.5. HTTP响应示例

响应 200

{
  "type" : "string",
  "platform_id" : "33454",
  "shop_id" : "33454",
  "store_id" : "33454",
  "state" : "applying",
  "def" : {
    "rtn_rule" : {
      "limtRtnApproveTimeRange" : "string",
      "allow_part_refund" : true,
      "allow_float" : true,
      "manual_receive" : true
    },
    "pick_rule" : {
      "allow_pick_time" : 0.0
    }
  },
  "source" : "string"
}

1.1.5. 保存门店作业规则

POST /{tenant_id}/soms/storeoperationruleservice/rule/save

1.1.5.1. 说明

保存门店作业规则

1.1.5.2. 参数

类型	名称	说明	类型
Path	tenant_id 必填	租户Id	string
Query	operator 必填	操作人	string
Body	store_operation_rule_save 必填	自提规则	StoreOperationRuleSave

类型

名称

说明

类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

store_operation_rule_save
必填

自提规则

StoreOperationRuleSave

1.1.5.3. 响应

HTTP代码	说明	类型
default	successful operation	无内容

HTTP代码

说明

类型

default

successful operation

无内容

1.1.5.4. HTTP请求示例

请求 path

/string/soms/storeoperationruleservice/rule/save?operator=string

请求 body

{
  "platform_id" : "33454",
  "type" : "33454",
  "shop_id" : "storeRtnRule",
  "store_id" : "0001",
  "def" : {
    "rtn_rule" : {
      "limtRtnApproveTimeRange" : "string",
      "allow_part_refund" : true,
      "allow_float" : true,
      "manual_receive" : true
    },
    "pick_rule" : {
      "allow_pick_time" : 0.0
    }
  }
}

2. 定义

2.1. StoreOperationRtnRule

名称说明类型

名称	说明	类型
allow_float 可选	默认值 : `false` 样例 : `true`	boolean
allow_part_refund 可选	默认值 : `false` 样例 : `true`	boolean
limtRtnApproveTimeRange 可选	样例 : `"string"`	string
manual_receive 可选	默认值 : `false` 样例 : `true`	boolean

allow_float
可选

默认值 : false
样例 : true

boolean

allow_part_refund
可选

默认值 : false
样例 : true

boolean

limtRtnApproveTimeRange
可选

样例 : "string"

string

manual_receive
可选

默认值 : false
样例 : true

boolean

2.2. StoreOperationRule

名称说明类型

名称	说明	类型
def 可选	规则内容样例 : StoreOperationRuleDef	StoreOperationRuleDef
platform_id 可选	平台ID 样例 : `"33454"`	string
shop_id 可选	商家ID 样例 : `"33454"`	string
source 可选	样例 : `"string"`	string
state 可选	是否开通：applying（未开通）、opened（已开通）样例 : `"applying"`	enum (applying, opened)
store_id 可选	门店ID 样例 : `"33454"`	string
type 可选	样例 : `"string"`	string

def
可选

规则内容
样例 : StoreOperationRuleDef

StoreOperationRuleDef

platform_id
可选

平台ID
样例 : "33454"

string

shop_id
可选

商家ID
样例 : "33454"

string

source
可选

样例 : "string"

string

state
可选

是否开通：applying（未开通）、opened（已开通）
样例 : "applying"

enum (applying, opened)

store_id
可选

门店ID
样例 : "33454"

string

type
可选

样例 : "string"

string

2.3. StoreOperationRuleDef

名称	说明	类型
pick_rule 可选	样例 : 门店作业拣货规则	门店作业拣货规则
rtn_rule 可选	样例 : StoreOperationRtnRule	StoreOperationRtnRule

名称

说明

类型

pick_rule
可选

样例 : 门店作业拣货规则

门店作业拣货规则

rtn_rule
可选

样例 : StoreOperationRtnRule

StoreOperationRtnRule

2.4. StoreOperationRuleFilter

名称说明类型

名称	说明	类型
platformIdEq 可选	样例 : `"string"`	string
shopIdEq 可选	样例 : `"string"`	string
stateEq 可选	样例 : `"string"`	string
storeIdEq 可选	样例 : `"string"`	string
storeIdIn 可选	样例 : `[ "string" ]`	< string > array
typeEq 可选	样例 : `"string"`	string

platformIdEq
可选

样例 : "string"

string

shopIdEq
可选

样例 : "string"

string

stateEq
可选

样例 : "string"

string

storeIdEq
可选

样例 : "string"

string

storeIdIn
可选

样例 : [ "string" ]

< string > array

typeEq
可选

样例 : "string"

string

2.5. StoreOperationRuleSave

名称说明类型

名称	说明	类型
def 可选	def 样例 : StoreOperationRuleDef	StoreOperationRuleDef
platform_id 可选	平台ID 样例 : `"33454"`	string
shop_id 可选	商家代码样例 : `"storeRtnRule"`	string
store_id 可选	门店代码样例 : `"0001"`	string
type 可选	类型样例 : `"33454"`	string

def
可选

def
样例 : StoreOperationRuleDef

StoreOperationRuleDef

platform_id
可选

平台ID
样例 : "33454"

string

shop_id
可选

商家代码
样例 : "storeRtnRule"

string

store_id
可选

门店代码
样例 : "0001"

string

type
可选

类型
样例 : "33454"

string

2.6. 门店作业拣货规则

名称说明类型

名称	说明	类型
allow_pick_time 可选	限制拣货时间，允许提前多久分钟开始拣货,单位分钟样例 : `0.0`	number

allow_pick_time
可选

限制拣货时间，允许提前多久分钟开始拣货,单位分钟
样例 : 0.0

number

2.7. 门店运营规则获取参数

名称说明类型

名称	说明	类型
fetch_by_ptm_store_ignore_shop 可选	查平台门店的规则是否忽略商家默认值 : `false` 样例 : `true`	boolean
platform_id 可选	平台Id 样例 : `"string"`	string
shop_id 可选	平台商家Id 样例 : `"string"`	string
store_id 可选	门店Id 样例 : `"string"`	string
type 可选	类型样例 : `"string"`	string

fetch_by_ptm_store_ignore_shop
可选

查平台门店的规则是否忽略商家
默认值 : false
样例 : true

boolean

platform_id
可选

平台Id
样例 : "string"

string

shop_id
可选

平台商家Id
样例 : "string"

string

store_id
可选

门店Id
样例 : "string"

string

type
可选

类型
样例 : "string"

string