Skip to main content
Version: 202607

Create address

POST 
/openapi/2026-07/customers/:customer_id/addresses

Create a new address with the provided details.

Request​

Path Parameters

    customer_id stringrequired

    Customer ID

Bodyrequired

    address objectrequired

    Address

    countrystringrequired

    Country name of the address, required at least 1 character. e.g "China"

    country_codestringrequired

    ISO country code, required at least 1 character, e.g "CN" for China

    first_namestring

    The first name of the person receiving the shipment or package

    last_namestring

    The last name of the person receiving the shipment or package

    address1string

    This field represents the main address line, such as the house number and street name. It is used to specify the primary location of the address

    address2string

    This field represents an additional address line, such as an apartment number or suite number. It is used to provide more specific information about the location of the address

    areastring

    Area or region of the address

    citystring

    City of the address. This field specifies the name of the city or town where the address is located

    provincestring

    Province or state of the address. This field specifies the administrative division or region within a country

    province_codestring

    Province code of the address. This field specifies the abbreviated or standardized code representing the province or state

    companystring

    Company name associated with the address

    phonestring

    Phone number associated with the consignee

    phone_area_codestring

    Area code for the phone number. This field specifies the code used to identify a specific geographic area for telephone calls

    zipstring

    Postal or ZIP code of the address. This field specifies the code used to identify a specific geographic area for mail delivery

    genderstring

    Gender of the person, optional field. Acceptable values are "male" and "female"

    emailstring

    Email address for the consignee. This field is used to specify the email address of the person receiving the shipment or package

    defaultboolean

    Indicates if this is the default address. "true" if this is the first address created for the user, otherwise "false"

Responses​

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    address object

    Address

    idstring

    Address ID

    customer_idstring

    ID of the customer this address belongs to

    first_namestring

    First name of the consignee

    last_namestring

    Last name of the consignee

    companystring

    Company name

    citystring

    City of the address

    provincestring

    Province or state of the address

    countrystring

    Country name of the address

    zipstring

    Postal or ZIP code

    province_codestring

    Province code

    country_codestring

    ISO country code

    genderstring

    Gender of the consignee

    phonestring

    Phone number associated with the address

    phone_area_codestring

    Area code of the phone number

    areastring

    Area or region of the address

    emailstring

    Email associated with the address

    namestring

    Full name of the consignee

    address1string

    Primary street address

    address2string

    Secondary street address

    country_namestring

    Full name of the country

    defaultboolean

    Indicates if this is the default address