Query all local shipping information

Requires read_shipping access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20260301/local_delivery/list.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 .

Get all local delivery info

Query Parameters

language string

Language

Example: Zh-hans-cn

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

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

local_delivery_listobject[]

Local shipping list
local_deliveryobject

Local shipping configuration
type integer

Local delivery type , 1- zip code
update_at string

Update time
Example: 2019-12-18T06:06:24.942Z
create_at string

Creation time
Example: 2019-12-18T06:06:24.942Z
local_delivery_seq string

Local configuration id
Example: LD5505526999799042803
location_seq string

Address code
Example: 5431421851439468254
plansobject[]

Regional plan
description string

Local shipping description
Example: The south district will be delivered within an hour
intervalsobject[]

Conditions zones
order_amount_to long

The order amount is end range , the unit is divided , such as $ 100 , and the return is 10000
delivery_amount long

The shipping amount , the unit is divided , such as $ 100 , the return is 10000
order_amount_from long

The order amount starts in the range , the unit is divided , such as $ 100 , and the return is 10000
local_delivery_plan_seq string

Local delivery program plan id
Example: LDP5656698158002475446
local_delivery_seq string

Local shipping configuration id
Example: LD5505526999799042803
name string

Name
Example: South district
store_id string

store ID
Example: 1635143945022
zips array

Postal code
Example: ["34244,23443,4324"]
store_id string

store ID
Example: 1635143945022
support boolean

Support local delivery , true or not /false
location_addressobject

Address information
district_code string

District county code
Example: 440111
town string

Street town name
Example: New pond town
town_code string

Street town
Example: 200031
country_code string

Country code
Example: CN
update_at string

Update time
Example: 2019-12-18T06:06:24.942Z
address2 string

Detailed address 2
Example: Zhihuiyuan b ;
province_code string

Province code
Example: 440000
province string

Province
Example: Guangdong
location_seq string

Address code
Example: 5431421851439468254
city string

City
Example: Guangzhou
create_at string

Creation time
Example: 2019-12-18T06:06:24.942Z
district string

District
Example: Upper-class
location_name string

Address name
Example: Upper store
priority integer

Address priority
Example: 1
address1 string

Detailed address
Example: 93 yuangang road in the open city of the ihan district
country string

Country Name
Example: China
zip string

Postal code
Example: 34453
active boolean

The address enables the status , and the current local delivery will only return the status activated address , that is , status is true
city_code string

City code
Example: 440100
phone string

Phone number
Example: 18520474762

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

language — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/local_delivery/list.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