Skip to main content
Version: 202607

Create customer

POST 
/openapi/2026-07/customers

Create a new customer with the provided details.

Request​

Bodyrequired

    customer objectrequired

    Customer

    contact_typestringrequired

    Should be phone or email. If phone, the phone parameter is required; otherwise, email is required

    first_namestring

    Customer's first name

    last_namestring

    Customer's last name

    passwordstring

    Customer's password

    password_confirmationstring

    Confirmation of the password

    tagsstring[]

    Tags assigned to the customer

    registered_atstring

    The registered_at field records the creation time in UTC (0 timezone), formatted as ISO-8601

    addresses object[]

    A list of address objects under the customer object

  • Array [
    • 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"

  • ]
    • emailstring

    Email address, required when contact_type is email

    phonestring

    Phone number with area code, required when contact_type is phone

    accepts_marketingboolean

    Whether to subscribe to marketing email campaigns. Defaults to true

    Default value: true
    accepts_sms_marketingboolean

    Whether to subscribe to SMS marketing campaigns. Defaults to true

    Default value: true

Responses​

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    customer object

    Customer object containing customer details

    idstring

    Customer ID

    emailstring

    Customer's email address

    created_atstring

    Timestamp when the customer was created, in ISO8601 format

    updated_atstring

    Timestamp when the customer was last updated, in ISO8601 format

    first_namestring

    Customer's first name

    last_namestring

    Customer's last name

    phonestring

    Customer's phone number

    tagsstring[]

    Tags associated with the customer

    namestring

    Full name of the customer

    phone_area_codestring

    Area code of the phone number

    contact_typestring

    Contact type, either email or phone

    sms_subscribed_flagint32

    Customer's SMS subscription status flag

    addresses object[]

    List of all customer addresses

  • Array [
    • 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

  • ]
    • accepts_marketingboolean

    Indicates if the customer is subscribed to marketing emails

    sourcestring

    Source of the customer data

    free_taxboolean

    Indicates if the customer is exempt from taxes

    registeredboolean

    Indicates if the customer is registered

    orders_countint32

    Number of orders placed by the customer

    first_order_atstring

    First order timestamp

    last_order_atstring

    Timestamp of the customer's last order

    total_spentstring

    Total amount spent by the customer

    subscribed_flagint32

    Customer's marketing subscription status flag

    accepts_sms_marketingboolean

    Indicates if the customer is subscribed to SMS marketing campaigns