Batch shipping plan V2

Requires write_shipping access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20260301/logistics/shipping_zones_v2.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Bulk setting of logistics freight plans is supported and can be set based on the shipping group dimension. This operation will serve as the latest logistics freight plan, and any previous freight plans will be completely overwritten.

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

shipping_zonesobject

Setting area plan object
product_group_infoobject

Item group information
product_group_seq string

Product grouped serial number , required during update , empty add
Example: "PG5938934496267609846"
product_ids array

Product serial number list , groupType is required for 2 custom grouping ( Product spu serial number )
Example: ["[\"18053690657964710749100412\",\"18055123775710848634010412\"]"]
product_group_name string

Product group name , groupType is required when 2 custom grouping ; groupType is default value when 1 general grouping : general grouping
Example: " custom shipping 01 "
delivery_location_group_listobject[] required

Multiple shipping schemes for multiple shipping sites object
default_tag boolean required

Default shipping location group or not
Example: true
delivery_plansobject[]

Multiple zone schemes object
shipping_plansobject[] required

Shipping information object
measure_unit string

Unit of measurement ( kg-kg , g-g , lb-lb , oz-oz , when chargeMode=1 , required ) eg. kg
Example: "kg"
incr_amount string

Amount of continued ( double type string for precision 2 ) eg. " 1.08 "
Example: "1.88"
incr_measure string

Continued ( double type string for precision 2 ) eg. " 2.01 "
Example: "1.00"
custom_amount string

Custom shipping amount ( double type string for accuracy 2 , when chargeMode=3 , for fixed shipping amount )
Example: "90.88"
first_amount string

Starting amount ( double type string for accuracy 2 ) eg. " 1.08 "
Example: "3.80"
charge_mode integer required

Charge mode ( 1- by weight , 3- by-item fee , 4- fixed shipping ) must be within the right range [ 1 , 4 ]
Example: 1
first_measure string

Starting volume ( double type string of precision 2 , when chargeMode=2 , must be whole number ) eg : " 1.08 "
Example: 3
intervalsobject[]

Range object ( when conditionalInterval equals 2、3、4 , must be transferred )
measure_unit string

Unit of measurement ( kg-kg , g-g , lb-lb , oz-oz , when chargeMode=1 , required ) eg. kg
Example: "kg"
start_interval string

Start zone ( double type string for accuracy 2 )
Example: "0"
custom_amount string

Custom shipping amount ( double type string for accuracy 2 , when chargeMode=3 , for fixed shipping amount )
Example: "90.88"
end_interval string

End zone ( double type string for accuracy 2 )
Example: "3"
first_amount string

Starting amount ( double type string for accuracy 2 ) eg. " 1.08 "
Example: "3.80"
first_measure string

Starting amount ( double type string for accuracy 2 ) eg. " 1.08 "
Example: 3
incr_amount string

Amount of continued ( double type string for precision 2 ) eg. " 1.08 "
Example: "1.88"
incr_measure string

Continued ( double type string for precision 2 ) eg. " 2.01 "
Example: "1.00"
conditional_interval integer required

Conditions range ( 1- none , 2- number of units per Product , 3- weight per order , 4- price per order ) must be within a suitable range [ 1 , 4] eg. 1
Example: 3
delivery_name string required

Shipping plan name , shipping name will be displayed to the user to see
Example: Shipping from china -01
area_name string required

Regional plan name
Example: China shipping
areasobject[]

Zones object
area_codes array

Country code
Example: ["12001"]
country_code string required

Non-country address encoding ( such as province , city )
Example: CN
group_name string

The name of the shipment place is classified , if it is the default delivery place group , the name can be empty
location_seq_list array

Shipping location list associated with the shipping group
Example: [""]
group_type integer

Shipping configuration type ( 1 : general grouping , 2 : custom grouping , default 1 general grouping if not transmitted )
Example: 1

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

shipping_zoneobject

Shipping plan settings return object
group_seq string

Grouping unique serial number
is_success boolean

Success ( true or not : success , false : failure )
ext_map map

Expand information
Example: {}

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

Body

Body required

{
  "shipping_zones": {
    "delivery_location_group_list": [
      {
        "delivery_plans": [
          {
            "areas": [
              {
                "area_codes": [
                  "12001"
                ],
                "country_code": "CN"
              }
            ],
            "shipping_plans": [
              {
                "first_measure": "3",
                "intervals": [
                  {
                    "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\""
                  }
                ],
                "measure_unit": "\"kg\"",
                "first_amount": " \"3.80\"",
                "conditional_interval": 3,
                "delivery_name": "Shipping from china -01",
                "incr_measure": "\"1.00\"",
                "incr_amount": "\"1.88\"",
                "charge_mode": 1,
                "custom_amount": "\"90.88\""
              }
            ],
            "area_name": "China shipping"
          }
        ],
        "group_name": "",
        "location_seq_list": [
          ""
        ],
        "default_tag": true
      }
    ],
    "group_type": 1,
    "product_group_info": {
      "product_group_seq": "\"PG5938934496267609846\"",
      "product_ids": [
        "[\"18053690657964710749100412\",\"18055123775710848634010412\"]"
      ],
      "product_group_name": "\" custom shipping 01 \""
    }
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/logistics/shipping_zones_v2.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal