Add address 2.0

Requires write_customers access scope.

For more info, refer to:

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

Path Parameters

id string required

Customer id

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

customer_addressobject required

Customer address information
province_code string

Provincial / state code length limited to : 50
Example: KY
address1 string

Detailed address length limited to : 255
Example: 7720 Cherokee Road
last_name string

Contact length limited to : 128
Example: joho
phone string

Phone number
Example: 001467326483
district string

Zone / county length limited to : 64
Example: dazhou
city string

City name length limited to : 64
Example: Hagerman
country_code string

National code length limited to : 50
Example: US
country string

Country name length limited to : 64
Example: United States
company string

Company
Example: Joy
district_code string

Zone / county encoding length limited to : 50
Example: DZ
province string

Province / state name length limited to : 64
Example: Kentucky
town string

Street town length limited to : 64
Example: luosiji
address2 string

Detailed address 2 length limited to : 255
Example: Apartment
city_code string

City code length limited to : 50
Example: NM
first_name string

Contact length limited to : 128
Example: maybe
zip string

Zip code length limited to : 10
Example: 90091
address_type integer

Address type
def boolean

Default address
Example: true

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

customer_addressobject

Customer address information
customer_id string

User ID
Example: 2277270272
district_code string

Zone / county code
Example: DZ
city string

City
Example: Hagerman
company string

Company
Example: Joy
country string

Country
Example: United States
city_code string

Urban code
Example: NM
province_code string

Province code
Example: KY
province string

Province
Example: Kentucky
phone string

Telephone number
Example: 001467326483
country_code string

National code
Example: US
zip string

Postal code
Example: 90091
district string

District/County
Example: dazhou
def boolean

Default address
Example: true
address1 string

Detail address 1
Example: 7720 Cherokee Road
address_type integer

Address type
first_name string

First name
Example: maybe
id string

Address ID
Example: SL201UA5006511321220969539
address2 string

Detailed address 2
Example: Apartment
town string

Street town
Example: luosiji
last_name string

Last name
Example: joho

API Explorer

Debugger

Base URL

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

ParamOptions

id — path required

Authorization — header required

Body

Body required

{
  "customer_address": {
    "province": "Kentucky",
    "address_type": 0,
    "zip": "90091",
    "town": "luosiji",
    "address1": "7720 Cherokee Road",
    "city": "Hagerman",
    "district": "dazhou",
    "district_code": "DZ",
    "phone": "001467326483",
    "address2": "Apartment",
    "last_name": "joho",
    "province_code": "KY",
    "company": "Joy",
    "country_code": "US",
    "def": true,
    "city_code": "NM",
    "first_name": "maybe",
    "country": "United States"
  }
}

Language

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