--- title: "批量设置运费方案V2" description: "批量设置物流运费方案，支持以发货地组维度设置运费方案，本次操作作为最新的物流运费方案，之前的运费方案将会被完全覆盖掉" doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/zh-hans-cn/docs/admin-rest-api/order/shipping-and-fulfillment/batch-shipping-plan-v-2' md: 'https://developer.shopline.com/zh-hans-cn/docs/admin-rest-api/order/shipping-and-fulfillment/batch-shipping-plan-v-2.md' --- # 批量设置运费方案V2 批量设置物流运费方案，支持以发货地组维度设置运费方案，本次操作作为最新的物流运费方案，之前的运费方案将会被完全覆盖掉 - **Base URL:** `https://{handle}.myshopline.com/admin/openapi` - **Required Scopes:** `write_shipping` - **API Version:** v20270301 - **API Type:** Admin - **API Protocol:** RESTful ## Endpoint ```http POST /logistics/shipping_zones_v2.json ``` ## Base URL * `https://{handle}.myshopline.com/admin/openapi` * `{handle}`: `handle` ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 `open001.myshopline.com` 的店铺，其 `handle` 是 `open001` 。 ## Required Permissions * `write_shipping` ## Request ### Request Headers * `Content-Type` string (required) 字段值固定为 `application/json; charset=utf-8`。 * `Authorization` string (required) 资源的访问令牌。参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。 ### Request Body * `shipping_zones` object 设置区域方案对象 * `delivery_location_group_list` array 多个发货地组的运费方案数组对象 * `delivery_plans` array 多个区域方案数组对象 * `shipping_plans` array 运费信息对象 * `area_name` string 区域方案名称 * `areas` array 区域对象 * `group_name` string 发货地分组名称, 若为默认发货地组，名称可以为空 * `location_seq_list` array 发货地组关联的发货地点列表 * `default_tag` boolean 是否属于默认发货地组 * `group_type` integer 运费配置类型（1：通用分组，2：自定义分组，不传则默认为1通用分组） * `product_group_info` object 商品组信息 * `product_ids` array 商品序列号列表，groupType为2 自定义分组时必填(商品spu序列号) * `product_group_name` string 商品分组名称，groupType为2 自定义分组时必填；groupType为1 通用分组时为默认值：通用分组 * `product_group_seq` string 商品分组序列号，更新时必填，新增时为空 ## Response ### Status Codes * `200` 更多状态码信息，参考 [HTTP 状态码](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/http-status-code.md?lang=zh-hans-cn)。 * `401` * `429` ### Response Headers * `traceId` 请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。 ### Response Body #### 200 * `shipping_zone` object 运费方案设置返回对象 * `ext_map` map 扩展信息 * `group_seq` string 分组唯一序列号 * `is_success` boolean 是否成功（true：成功，false:失败） #### 401 * `errors` string 错误描述。 #### 429 * `errors` string 错误描述。 ## OpenAPI Definition ```json { "description": "批量设置物流运费方案，支持以发货地组维度设置运费方案，本次操作作为最新的物流运费方案，之前的运费方案将会被完全覆盖掉", "externalDocs": { "description": "接口使用的权限点: `write_shipping` ，更多权限点使用信息，请参考:", "url": "ec20/3cv5d7wpfgr6a8z5/xabczf5442284vkq?lang=zh-hans-cn", "errorTableDescription": "" }, "operationId": "8BWiyzm0", "parameters": [ { "name": "Content-Type", "in": "header", "description": "字段值固定为 `application/json; charset=utf-8`。", "required": true, "style": "string", "schema": { "name": "Content-Type", "type": "string", "example": "application/json; charset=utf-8" } }, { "name": "Authorization", "in": "header", "description": "资源的访问令牌。参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。", "required": true, "style": "string", "schema": { "name": "Authorization", "description": "资源的访问令牌。请参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入", "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" }, "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shipping_zones": { "name": "shipping_zones", "description": "设置区域方案对象", "type": "object", "properties": { "delivery_location_group_list": { "name": "delivery_location_group_list", "description": "多个发货地组的运费方案数组对象", "type": "array", "items": { "name": "delivery_location_group_list", "description": "多个发货地组的运费方案数组对象", "type": "object", "properties": { "delivery_plans": { "name": "delivery_plans", "description": "多个区域方案数组对象", "type": "array", "items": { "name": "delivery_plans", "description": "多个区域方案数组对象", "type": "object", "properties": { "shipping_plans": { "name": "shipping_plans", "description": "运费信息对象", "type": "array", "items": { "name": "shipping_plans", "description": "运费信息对象", "type": "object", "properties": { "charge_mode": { "name": "charge_mode", "description": "收费模式(1-按重量，3-按件计费,4-固定运费)必须在合适的范围内[1,4]", "type": "integer", "example": 1 }, "first_amount": { "name": "first_amount", "description": "起始金额(精度2的double类型字符串) eg. \"1.08\"", "type": "string", "example": " \"3.80\"" }, "incr_amount": { "name": "incr_amount", "description": "续量金额(精度2的double类型字符串) eg. \"1.08\"", "type": "string", "example": "\"1.88\"" }, "intervals": { "name": "intervals", "description": "区间范围对象(当conditionalInterval等于2、3、4时，必须传值)", "type": "array", "items": { "name": "intervals", "description": "区间范围对象(当conditionalInterval等于2、3、4时，必须传值)", "type": "object", "properties": { "measure_unit": { "name": "measure_unit", "description": "计量单位(kg-千克，g-克，lb-磅，oz-盎司，当chargeMode=1时，必填) eg. kg", "type": "string", "example": "\"kg\"" }, "start_interval": { "name": "start_interval", "description": "开始区间(精度2的double类型字符串)", "type": "string", "example": "\"0\"" }, "custom_amount": { "name": "custom_amount", "description": "自定义运费金额(精度2的double类型字符串，当chargeMode=3时，为固定运费金额)", "type": "string", "example": "\"90.88\"" }, "end_interval": { "name": "end_interval", "description": "结束区间(精度2的double类型字符串)", "type": "string", "example": "\"3\"" }, "first_amount": { "name": "first_amount", "description": "起始金额(精度2的double类型字符串) eg. \"1.08\"", "type": "string", "example": " \"3.80\"" }, "first_measure": { "name": "first_measure", "description": "起始金额(精度2的double类型字符串) eg. \"1.08\"", "type": "string", "example": "3" }, "incr_amount": { "name": "incr_amount", "description": "续量金额(精度2的double类型字符串) eg. \"1.08\"", "type": "string", "example": "\"1.88\"" }, "incr_measure": { "name": "incr_measure", "description": "续量(精度2的double类型字符串) eg. \"2.01\"", "type": "string", "example": "\"1.00\"" } }, "example": { "start_interval": "\"0\"", "custom_amount": "\"90.88\"", "end_interval": "\"3\"", "first_amount": " \"3.80\"", "first_measure": "3", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "measure_unit": "\"kg\"" } }, "example": [ { "start_interval": "\"0\"", "custom_amount": "\"90.88\"", "end_interval": "\"3\"", "first_amount": " \"3.80\"", "first_measure": "3", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "measure_unit": "\"kg\"" } ] }, "measure_unit": { "name": "measure_unit", "description": "计量单位(kg-千克，g-克，lb-磅，oz-盎司，当chargeMode=1时，必填) eg. kg", "type": "string", "example": "\"kg\"" }, "incr_measure": { "name": "incr_measure", "description": "续量(精度2的double类型字符串) eg. \"2.01\"", "type": "string", "example": "\"1.00\"" }, "conditional_interval": { "name": "conditional_interval", "description": "条件区间(1-无，2-按商品件数，3-按订单重量，4-按订单价格) 必须在合适的范围内[1, 4] eg. 1", "type": "integer", "example": 3 }, "custom_amount": { "name": "custom_amount", "description": "自定义运费金额(精度2的double类型字符串，当chargeMode=3时，为固定运费金额)", "type": "string", "example": "\"90.88\"" }, "first_measure": { "name": "first_measure", "description": "起始量（精度2的double类型字符串，当chargeMode=2时，必须为整数）eg:\"1.08\"", "type": "string", "example": "3" }, "delivery_name": { "name": "delivery_name", "description": "运费方案名称，运费名称会展示给到用户查看", "type": "string", "example": "中国运费-01" } }, "required": [ "charge_mode", "conditional_interval", "delivery_name" ], "example": { "incr_measure": "\"1.00\"", "intervals": [ { "first_amount": " \"3.80\"", "first_measure": "3", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "measure_unit": "\"kg\"", "start_interval": "\"0\"", "custom_amount": "\"90.88\"", "end_interval": "\"3\"" } ], "charge_mode": 1, "conditional_interval": 3, "delivery_name": "中国运费-01", "custom_amount": "\"90.88\"", "first_amount": " \"3.80\"", "first_measure": "3", "incr_amount": "\"1.88\"", "measure_unit": "\"kg\"" } }, "example": [ { "charge_mode": 1, "measure_unit": "\"kg\"", "delivery_name": "中国运费-01", "intervals": [ { "custom_amount": "\"90.88\"", "end_interval": "\"3\"", "first_amount": " \"3.80\"", "first_measure": "3", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "measure_unit": "\"kg\"", "start_interval": "\"0\"" } ], "first_amount": " \"3.80\"", "first_measure": "3", "custom_amount": "\"90.88\"", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "conditional_interval": 3 } ] }, "area_name": { "name": "area_name", "description": "区域方案名称", "type": "string", "example": "中国运费" }, "areas": { "name": "areas", "description": "区域对象", "type": "array", "items": { "name": "areas", "description": "区域对象", "type": "object", "properties": { "area_codes": { "name": "area_codes", "description": "国家编码", "type": "array", "items": { "name": "area_codes", "description": "国家编码", "type": "string", "example": "12001" }, "example": [ "12001" ] }, "country_code": { "name": "country_code", "description": "非国家区域地址编码（如省码、市码）", "type": "string", "example": "CN" } }, "required": [ "country_code" ], "example": { "area_codes": [ "12001" ], "country_code": "CN" } }, "example": [ { "area_codes": [ "12001" ], "country_code": "CN" } ] } }, "required": [ "area_name", "shipping_plans" ], "example": { "areas": [ { "country_code": "CN", "area_codes": [ "12001" ] } ], "shipping_plans": [ { "first_amount": " \"3.80\"", "incr_amount": "\"1.88\"", "intervals": [ { "custom_amount": "\"90.88\"", "end_interval": "\"3\"", "first_amount": " \"3.80\"", "first_measure": "3", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "measure_unit": "\"kg\"", "start_interval": "\"0\"" } ], "custom_amount": "\"90.88\"", "first_measure": "3", "incr_measure": "\"1.00\"", "charge_mode": 1, "measure_unit": "\"kg\"", "conditional_interval": 3, "delivery_name": "中国运费-01" } ], "area_name": "中国运费" } }, "example": [ { "area_name": "中国运费", "areas": [ { "country_code": "CN", "area_codes": [ "12001" ] } ], "shipping_plans": [ { "first_amount": " \"3.80\"", "incr_measure": "\"1.00\"", "intervals": [ { "first_measure": "3", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "measure_unit": "\"kg\"", "start_interval": "\"0\"", "custom_amount": "\"90.88\"", "end_interval": "\"3\"", "first_amount": " \"3.80\"" } ], "measure_unit": "\"kg\"", "custom_amount": "\"90.88\"", "conditional_interval": 3, "incr_amount": "\"1.88\"", "charge_mode": 1, "first_measure": "3", "delivery_name": "中国运费-01" } ] } ] }, "group_name": { "name": "group_name", "description": "发货地分组名称, 若为默认发货地组，名称可以为空", "type": "string", "example": "" }, "location_seq_list": { "name": "location_seq_list", "description": "发货地组关联的发货地点列表", "type": "array", "items": { "name": "location_seq_list", "description": "发货地组关联的发货地点列表", "type": "string", "example": "" }, "example": [ "" ] }, "default_tag": { "name": "default_tag", "description": "是否属于默认发货地组", "type": "boolean", "example": true } }, "required": [ "default_tag" ], "example": { "group_name": "", "location_seq_list": [ "" ], "default_tag": true, "delivery_plans": [ { "areas": [ { "country_code": "CN", "area_codes": [ "12001" ] } ], "shipping_plans": [ { "delivery_name": "中国运费-01", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "intervals": [ { "start_interval": "\"0\"", "custom_amount": "\"90.88\"", "end_interval": "\"3\"", "first_amount": " \"3.80\"", "first_measure": "3", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "measure_unit": "\"kg\"" } ], "measure_unit": "\"kg\"", "first_amount": " \"3.80\"", "first_measure": "3", "conditional_interval": 3, "charge_mode": 1, "custom_amount": "\"90.88\"" } ], "area_name": "中国运费" } ] } }, "example": [ { "delivery_plans": [ { "area_name": "中国运费", "areas": [ { "country_code": "CN", "area_codes": [ "12001" ] } ], "shipping_plans": [ { "measure_unit": "\"kg\"", "first_amount": " \"3.80\"", "first_measure": "3", "charge_mode": 1, "delivery_name": "中国运费-01", "intervals": [ { "custom_amount": "\"90.88\"", "end_interval": "\"3\"", "first_amount": " \"3.80\"", "first_measure": "3", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "measure_unit": "\"kg\"", "start_interval": "\"0\"" } ], "custom_amount": "\"90.88\"", "conditional_interval": 3, "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"" } ] } ], "group_name": "", "location_seq_list": [ "" ], "default_tag": true } ] }, "group_type": { "name": "group_type", "description": "运费配置类型（1：通用分组，2：自定义分组，不传则默认为1通用分组）", "type": "integer", "example": 1 }, "product_group_info": { "name": "product_group_info", "description": "商品组信息", "type": "object", "properties": { "product_ids": { "name": "product_ids", "description": "商品序列号列表，groupType为2 自定义分组时必填(商品spu序列号)", "type": "array", "items": { "name": "product_ids", "description": "商品序列号列表，groupType为2 自定义分组时必填(商品spu序列号)", "type": "string", "example": "[\"18053690657964710749100412\",\"18055123775710848634010412\"]" }, "example": [ "[\"18053690657964710749100412\",\"18055123775710848634010412\"]" ] }, "product_group_name": { "name": "product_group_name", "description": "商品分组名称，groupType为2 自定义分组时必填；groupType为1 通用分组时为默认值：通用分组", "type": "string", "example": "\"自定义运费01\"" }, "product_group_seq": { "name": "product_group_seq", "description": "商品分组序列号，更新时必填，新增时为空", "type": "string", "example": "\"PG5938934496267609846\"" } }, "example": { "product_group_name": "\"自定义运费01\"", "product_group_seq": "\"PG5938934496267609846\"", "product_ids": [ "[\"18053690657964710749100412\",\"18055123775710848634010412\"]" ] } } }, "required": [ "delivery_location_group_list" ], "example": { "delivery_location_group_list": [ { "delivery_plans": [ { "shipping_plans": [ { "first_amount": " \"3.80\"", "measure_unit": "\"kg\"", "conditional_interval": 3, "delivery_name": "中国运费-01", "incr_measure": "\"1.00\"", "first_measure": "3", "intervals": [ { "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "measure_unit": "\"kg\"", "start_interval": "\"0\"", "custom_amount": "\"90.88\"", "end_interval": "\"3\"", "first_amount": " \"3.80\"", "first_measure": "3" } ], "custom_amount": "\"90.88\"", "incr_amount": "\"1.88\"", "charge_mode": 1 } ], "area_name": "中国运费", "areas": [ { "area_codes": [ "12001" ], "country_code": "CN" } ] } ], "group_name": "", "location_seq_list": [ "" ], "default_tag": true } ], "group_type": 1, "product_group_info": { "product_ids": [ "[\"18053690657964710749100412\",\"18055123775710848634010412\"]" ], "product_group_name": "\"自定义运费01\"", "product_group_seq": "\"PG5938934496267609846\"" } } } }, "example": { "shipping_zones": { "product_group_info": { "product_ids": [ "[\"18053690657964710749100412\",\"18055123775710848634010412\"]" ], "product_group_name": "\"自定义运费01\"", "product_group_seq": "\"PG5938934496267609846\"" }, "delivery_location_group_list": [ { "delivery_plans": [ { "shipping_plans": [ { "measure_unit": "\"kg\"", "conditional_interval": 3, "charge_mode": 1, "incr_measure": "\"1.00\"", "intervals": [ { "first_amount": " \"3.80\"", "first_measure": "3", "incr_amount": "\"1.88\"", "incr_measure": "\"1.00\"", "measure_unit": "\"kg\"", "start_interval": "\"0\"", "custom_amount": "\"90.88\"", "end_interval": "\"3\"" } ], "custom_amount": "\"90.88\"", "first_amount": " \"3.80\"", "incr_amount": "\"1.88\"", "first_measure": "3", "delivery_name": "中国运费-01" } ], "area_name": "中国运费", "areas": [ { "area_codes": [ "12001" ], "country_code": "CN" } ] } ], "group_name": "", "location_seq_list": [ "" ], "default_tag": true } ], "group_type": 1 } } } } }, "required": true }, "responses": { "200": { "description": "更多状态码信息，参考 [HTTP 状态码](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/http-status-code.md?lang=zh-hans-cn)。", "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "shipping_zone": { "name": "shipping_zone", "description": "运费方案设置返回对象", "type": "object", "properties": { "ext_map": { "name": "ext_map", "description": "扩展信息", "type": "map", "example": {} }, "group_seq": { "name": "group_seq", "description": "分组唯一序列号", "type": "string", "example": "" }, "is_success": { "name": "is_success", "description": "是否成功（true：成功，false:失败）", "type": "boolean", "example": false } }, "example": { "ext_map": {}, "group_seq": "", "is_success": false } } }, "example": { "shipping_zone": { "group_seq": "", "is_success": false, "ext_map": {} } } } } } }, "401": { "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "错误描述。", "type": "string" } }, "required": [ "errors" ] } } } }, "429": { "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "错误描述。", "type": "string" } }, "required": [ "errors" ] } } } } }, "security": [ { "oauth2": [] } ], "method": "post", "path": "/logistics/shipping_zones_v2.json", "servers": [ { "url": "https://{handle}.myshopline.com/admin/openapi", "variables": { "handle": { "default": "openapiceshidianpu", "description": "`handle` ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 `open001.myshopline.com` 的店铺，其 `handle` 是 `open001` 。" } } } ], "info": { "title": "批量设置运费方案V2", "version": "v20270301" }, "authIndexes": [ "write_shipping" ] } ```