Batch query customer address 2.0

Requires read_customers access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20231201/customers/addresses/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 .

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

address_types array
[]
Address type
[]
Example: 0
uids array required
[]
User id list
[]
Example: [2220108415,2277270272]

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

user_addressobject[]
[]
User address list
addressesobject[]
[]
Address information
address1 string
[]
Detail address 1
[]
Example: 7720 Cherokee Road
address2 string
[]
Detail address 2
[]
Example: Apartment
address_type integer
[]
Address type
city string
[]
City
[]
Example: Hagerman
city_code string
[]
Urban code
[]
Example: NM
company string
[]
Company
[]
Example: Joy
country string
[]
Country
[]
Example: United States
country_code string
[]
National code
[]
Example: US
def boolean
[]
Default address
[]
Example: true
district string
[]
District/County
[]
Example: dashi
district_code string
[]
Zone / county code
[]
Example: DZ
first_name string
[]
First name
[]
Example: maybe
id string
[]
Address ID
[]
Example: SL201UA5006511321220969539
last_name string
[]
Last name
[]
Example: joho
phone string
[]
Phone number
[]
Example: 001467326483
province string
[]
Province
[]
Example: Kentucky
province_code string
[]
Province code
[]
Example: KY
town string
[]
Street town
[]
Example: luosiji
zip string
[]
Postal code
[]
Example: 90091
uid string
[]
User ID
[]
Example: 2277270272

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "address_types": [
    0
  ],
  "uids": [
    "[2220108415,2277270272]"
  ]
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20231201/customers/addresses/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

Error loading component.