Skip to main content
Version: 202201

Create Address

POST 
/openapi/2022-01/customers/:customer_id/addresses

Create a new address with the provided details.

Request​

Path Parameters

    customer_id stringrequired

    Customer's ID

Body

    first_namestring

    First name of consignee.

    last_namestring

    Last name of consignee.

    genderstring

    Gender of consignee, acceptable value: female, male

    emailstring
    phonestring

    Phone number, for example: +86 150 1447 1143

    phone_area_codestring

    Area code, for example: +86

    address1string

    Street address, for example: 1 Rue des Carrieres

    address2string

    Apartment/floor/room number, for example: Suite 1234

    areastring

    Area, for example: Bay area

    citystring

    City, for example: SAN JOSE

    provincestring

    Province, for example: New Mexico

    province_codestring

    Province Code, for example: NM

    countrystringrequired

    Country, for example: United States

    country_codestringrequired

    Country code, for example: US

    zipstring

    ZIP code, for example: 87036

    companystring

    Company, for example: ABC Limited

    defaultboolean

    Default address or not

Responses​

200

Schema
    address object
    idstring
    Example: 2490dc6a-d511-4e5e-bbcb-d58e913243ad
    customer_idstring
    Example: 2dd957e3-2051-4cdf-8584-9c0046b4d1ae
    first_namestring
    Example: Ryan
    last_namestring
    Example: zhang
    companystring
    Example: ABC Limited
    citystring
    Example: SAN JOSE
    provincestring
    Example: New Mexico
    countrystring
    Example: United States
    zipstring
    Example: 87036
    province_codestring
    Example: NM
    country_codestring
    Example: US
    genderstring
    Example: male
    phonestring
    Example: +8615015570043
    phone_area_codestring
    Example: +86
    areastring
    Example: Bay area
    emailstring
    Example: [email protected]
    namestring
    Example: Ryan zhang
    address1string
    Example: 1 Rue des Carrieres
    address2string
    Example: Suite 1234
    country_namestring
    Example: United States
    defaultboolean
    Default value: true
    Example: true