English

简体中文

English

简体中文

About Customer ​

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

The customer module helps merchants maintain and analyze customer relationships. Genstore provides RESTful interfaces for managing online store customer information. Through these interfaces, merchants can efficiently handle customer information, including contact details, order history, and email marketing preferences.

Core Features

  • Create Customer: Create new customer records.
  • Delete Customer: Remove existing customer records.
  • Query Customer: Retrieve specific customer details.
  • List Customers: Get a list of store customers.

TIP

Before using the Customer APIs, please ensure your account has sufficient permissions to perform interface operations.

Use Cases

  • Customer Profile Sync: CRM systems can sync customer data changes in real-time using the query interface.
  • Marketing Segmentation: Marketing platforms can create targeted campaigns using customer attributes from the list interface.

Endpoints

POST /api/202412/customers: Create customer

PUT /api/202412/customers/{customerId}: Update customer

DELETE /api/202412/customers/{customerId}: Delete customer

GET /api/202412/customers/{customerId}: Get customer details

GET /api/202412/customers/search: Search customers

GET /api/202412/customers: Get customer list

Customer Object ​

Create and manage customers.

Properties ​

customerobject
Represents the personal information of a customer.
- Hide child properties
idnumberrequired
Customer's unique identifier.
emailstringrequired
The customer's email address.
createTimestringrequired
Customer creation time (ISO 8601 format).
updateTimestringrequired
Customer update time (ISO 8601 format).
phonestring
Customer's phone number.
verifiedEmailboolean
Whether the customer verifies the email address.
statestring
The state of the customer's account with the shop. Enumeration values: DECLINED - user declined to become a customer; DISABLED - invalid account; ENABLED - active customer; INVITED - customer under invitation.
firstNamestring
The customer's first name.
lastNamestring
The customer's last name.
notesstring
A note about the customer.
ordersCountobject
The number of orders that the customer has made at the store in their lifetime.
totalSpentobject
The total amount that the customer has spent on orders in their lifetime.
taxExemptboolean
Whether the customer is exempt from being charged taxes on their orders.
taxExemptionsobject
The list of tax exemptions applied to the customer.
+ Show child properties
smsMarketingConsentobject
The current SMS marketing state for the customer's phone number.
+ Show child properties
tagsarray
A list of tags that have been added to the customer.
emailMarketingConsentobject
The current email marketing state for the customer.
+ Show child properties
defaultAddressobject
The default address associated with the customer.
+ Show child properties
addressesarray
The addresses associated with the customer.
+ Show child properties
bash
{
  "customer": {
    "lastName": "li",
    "addresses": [
      {
        "zip": "23456",
        "firstName": "heihei",
        "lastName": "du",
        "address2": "上海闵行",
        "city": "上海",
        "phone": "2345653464",
        "address1": "上海嘉定",
        "countryCode": "CN",
        "provinceCode": "SH",
        "company": "公司地址",
        "isDefaultAddress": "false",
        "id": "879"
      }
    ],
    "notes": "this is new customer",
    "totalSpent": "13",
    "taxExempt": "true",
    "taxExemptions": {
      "applyToAllRegion": "true",
      "taxExemptionRegions": [
        {
          "country": "US",
          "applyToAllSubdivision": "false",
          "subdivisions": "["NYC"]"
        }
      ]
    },
    "updateTime": "2024-18-12T08:18:49",
    "smsMarketingConsent": {
      "state": "SUBSCRIBED",
      "consentUpdateTime": "2024-11-12T08:18:49.125"
    },
    "tags": "[ "xinsheng",          "human" ]",
    "emailMarketingConsent": {
      "state": "SUBSCRIBED",
      "consentUpdateTime": "2024-11-12T08:18:49.125"
    },
    "firstName": "test23",
    "ordersCount": "2",
    "createTime": "2024-18-12T08:18:49",
    "phone": "13315034487",
    "id": "1020000013062",
    "state": "DECLINED",
    "email": "1731399528@qq.com",
    "verifiedEmail": "true",
    "defaultAddress": {
      "zip": "20000",
      "firstName": "heihei",
      "lastName": "chen",
      "address2": "cao he jing",
      "city": "shanghai",
      "phone": "13315035578",
      "address1": "xu hui",
      "countryCode": "CN",
      "provinceCode": "FJ",
      "company": "demo",
      "isDefaultAddress": "true",
      "id": "878"
    }
  }
}

POST Create customer ​

Create a customer.

Access scope

Requires ANY of the following access scopes: write_customers

Endpoint

POST /api/202412/customers 

Request Params

customerobject
Represent the personal information of a customer.
- Hide child properties
emailstringrequired
The customer's email address. Value can be up to 128 characters.
phonestring
Customer's phone number.
firstNamestring
The customer's first name. Value can be up to 200 characters.
lastNamestring
The customer's last name. Value can be up to 200 characters.
notesstring
A note about the customer. Value can be up to 1000 characters.
taxExemptboolean
Whether the customer is exempt from being charged taxes on their orders.
taxExemptionsobject
The list of tax exemptions applied to the customer.
+ Show child properties
smsMarketingConsentobject
The current SMS marketing state for the customer's phone number.
+ Show child properties
tagsarray
A list of tags that have been added to the customer.The maximum input of a single tag is no more than 100 characters, and a maximum of 120 tags are associated with a customer.
emailMarketingConsentobject
The current email marketing state for the customer.
+ Show child properties
addressesarray
The addresses associated with the customer.
+ Show child properties

Response Data

customerobject
Represent the personal information of a customer.
- Hide child properties
idnumberrequired
Customer's unique identifier.
emailstringrequired
The customer's email address.
createTimestringrequired
Customer creation time (ISO 8601 format).
updateTimestringrequired
Customer update time (ISO 8601 format).
phonestring
Customer's phone number.
verifiedEmailboolean
Whether the customer verifies the email address.
statestring
The state of the customer's account with the shop. Enumeration values: DECLINED - user declined to become a customer; DISABLED - invalid account; ENABLED - active customer; INVITED - customer under invitation.
firstNamestring
The customer's first name.
lastNamestring
The customer's last name.
notesstring
A note about the customer.
ordersCountnumber
The number of orders that the customer has made at the store in their lifetime.
totalSpentnumber
The total amount that the customer has spent on orders in their lifetime.
taxExemptboolean
Whether the customer is exempt from being charged taxes on their orders.
taxExemptionsobject
The list of tax exemptions applied to the customer.
+ Show child properties
smsMarketingConsentobject
The current SMS marketing state for the customer's phone number.
+ Show child properties
tagsarray
A list of tags that have been added to the customer.
emailMarketingConsentobject
The current email marketing state for the customer.
+ Show child properties
defaultAddressobject
The default address associated with the customer.
+ Show child properties
addressesarray
The addresses associated with the customer.
+ Show child properties
bash
curl -X POST \ 
https://{shop}.genmystore.com/api/202412/customers" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"customer":{
		"emailMarketingConsent":{
			"state":"SUBSCRIBED",
			"consentUpdateTime":"2024-11-12T08:18:49.125"
		},
		"firstName":"test23",
		"lastName":"li",
		"addresses":[
			{
				"zip":"23456",
				"firstName":"heihei",
				"lastName":"du",
				"address2":"shanghai",
				"city":"xuhui",
				"phone":"+14255550100",
				"address1":"caohejing",
				"countryCode":"CN",
				"provinceCode":"SH",
				"company":"demo",
				"isDefaultAddress":"false"
			}
		],
		"notes":"this is new customer",
		"taxExempt":"true",
		"phone":"+14255550100",
		"taxExemptions":{
			"applyToAllRegion":"true",
			"taxExemptionRegions":[
				{
					"country":"US",
					"applyToAllSubdivision":"false",
					"subdivisions":[
						"NYC"
					]
				}
			]
		},
		"smsMarketingConsent":{
			"state":"SUBSCRIBED",
			"consentUpdateTime":"2024-11-12T08:18:49.125"
		},
		"email":"1731399528@qq.com",
		"tags":[
			"xinsheng",
			"human"
		]
	}
}'
json
HTTP/1.1 200 OK
{
  "customer": {
    "lastName": "li",
    "addresses": [
      {
        "zip": "23456",
        "firstName": "heihei",
        "lastName": "du",
        "address2": "caohejing",
        "city": "shanghai",
        "phone": "+14255550100",
        "address1": "xuhui",
        "countryCode": "CN",
        "provinceCode": "SH",
        "company": "demo",
        "isDefaultAddress": "false",
        "id": "879"
      }
    ],
    "notes": "this is new customer",
    "totalSpent": "13.1",
    "taxExempt": "true",
    "taxExemptions": {
      "applyToAllRegion": "true",
      "taxExemptionRegions": [
        {
          "country": "US",
          "applyToAllSubdivision": "false",
          "subdivisions": [
            "NYC"
          ]
        }
      ]
    },
    "updateTime": "2024-18-12T08:18:49",
    "smsMarketingConsent": {
      "state": "SUBSCRIBED",
      "consentUpdateTime": "2024-11-12T08:18:49.125"
    },
    "tags": [
      "xinsheng",
      "human"
    ],
    "emailMarketingConsent": {
      "state": "SUBSCRIBED",
      "consentUpdateTime": "2024-11-12T08:18:49.125"
    },
    "firstName": "test23",
    "ordersCount": "2",
    "createTime": "2024-18-12T08:18:49",
    "phone": "+14255550100",
    "id": "1020000013062",
    "state": "DECLINED",
    "email": "1731399528@qq.com",
    "verifiedEmail": "true",
    "defaultAddress": {
      "zip": "20000",
      "firstName": "heihei",
      "lastName": "chen",
      "address2": "cao he jing",
      "city": "shanghai",
      "phone": "+14255550100",
      "address1": "xu hui",
      "countryCode": "CN",
      "provinceCode": "FJ",
      "company": "demo",
      "isDefaultAddress": "true",
      "id": "878"
    }
  }
}

PUT Update customer ​

Updates customer information.

Access scope

Requires ANY of the following access scopes: write_customers

Endpoint

PUT /api/202412/customers/{customerId} 

Request Params

customerobject
Represent the personal information of a customer.
- Hide child properties
emailstringrequired
The customer's email address. Value can be up to 128 characters.
phonestring
Customer's phone number.
firstNamestring
The customer's first name. Value can be up to 200 characters.
lastNamestring
The customer's last name. Value can be up to 200 characters.
notesstring
A note about the customer. Value can be up to 1000 characters.
taxExemptboolean
Whether the customer is exempt from being charged taxes on their orders.
taxExemptionsobject
The list of tax exemptions applied to the customer.
+ Show child properties
smsMarketingConsentobject
The current SMS marketing state for the customer's phone number.
+ Show child properties
tagsarray
A list of tags that have been added to the customer.The maximum input of a single tag is no more than 100 characters, and a maximum of 120 tags are associated with a customer.
emailMarketingConsentobject
The current email marketing state for the customer.
+ Show child properties
addressesarray
The addresses associated with the customer.
+ Show child properties

Response Data

customerobject
Represent the personal information of a customer.
- Hide child properties
idnumberrequired
Customer's unique identifier.
emailstringrequired
The customer's email address.
createTimestringrequired
Customer creation time (ISO 8601 format).
updateTimestringrequired
Customer update time (ISO 8601 format).
phonestring
Customer's phone number.
verifiedEmailboolean
Whether the customer verifies the email address.
statestring
The state of the customer's account with the shop. Enumeration values: DECLINED - user declined to become a customer; DISABLED - invalid account; ENABLED - active customer; INVITED - customer under invitation.
firstNamestring
The customer's first name.
lastNamestring
The customer's last name.
notesstring
A note about the customer.
ordersCountnumber
The number of orders that the customer has made at the store in their lifetime.
totalSpentnumber
The total amount that the customer has spent on orders in their lifetime.
taxExemptboolean
Whether the customer is exempt from being charged taxes on their orders.
taxExemptionsobject
The list of tax exemptions applied to the customer.
+ Show child properties
smsMarketingConsentobject
The current SMS marketing state for the customer's phone number.
+ Show child properties
tagsarray
A list of tags that have been added to the customer.
emailMarketingConsentobject
The current email marketing state for the customer.
+ Show child properties
defaultAddressobject
The default address associated with the customer.
+ Show child properties
addressesarray
The addresses associated with the customer.
+ Show child properties
bash
curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/customers/{customerId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"customer":{
		"emailMarketingConsent":{
			"state":"SUBSCRIBED",
			"consentUpdateTime":"2024-11-12T08:18:49.125"
		},
		"firstName":"test23",
		"lastName":"li",
		"addresses":[
			{
				"zip":"23456",
				"firstName":"heihei",
				"lastName":"du",
				"address2":"Guilin Rd.",
				"city":"xuhui",
				"phone":"+14255550100",
				"address1":"caohejing",
				"countryCode":"CN",
				"provinceCode":"SH",
				"company":"demo",
				"isDefaultAddress":"false",
				"id":"879"
			}
		],
		"notes":"this is new customer",
		"taxExempt":"true",
		"phone":"+14255550100",
		"taxExemptions":{
			"applyToAllRegion":"true",
			"taxExemptionRegions":[
				{
					"country":"US",
					"applyToAllSubdivision":"false",
					"subdivisions":[
						"NYC"
					]
				}
			]
		},
		"smsMarketingConsent":{
			"state":"SUBSCRIBED",
			"consentUpdateTime":"2024-11-12T08:18:49.125"
		},
		"email":"1731399528@qq.com",
		"tags":[
			"xinsheng",
			"human"
		]
	}
}'
json
HTTP/1.1 200 OK
{
  "customer": {
    "lastName": "li",
    "addresses": [
      {
        "zip": "23456",
        "firstName": "heihei",
        "lastName": "du",
        "address2": "cao he jing",
        "city": "shanghai",
        "phone": "+14255550100",
        "address1": "xu hui",
        "countryCode": "CN",
        "provinceCode": "SH",
        "company": "demo",
        "isDefaultAddress": "false",
        "id": "879"
      }
    ],
    "notes": "this is new customer",
    "totalSpent": "13.1",
    "taxExempt": "true",
    "taxExemptions": {
      "applyToAllRegion": "true",
      "taxExemptionRegions": [
        {
          "country": "US",
          "applyToAllSubdivision": "false",
          "subdivisions": [
            "NYC"
          ]
        }
      ]
    },
    "updateTime": "2024-18-12T08:18:49",
    "smsMarketingConsent": {
      "state": "SUBSCRIBED",
      "consentUpdateTime": "2024-11-12T08:18:49.125"
    },
    "tags": [
      "xinsheng",
      "human"
    ],
    "emailMarketingConsent": {
      "state": "SUBSCRIBED",
      "consentUpdateTime": "2024-11-12T08:18:49.125"
    },
    "firstName": "test23",
    "ordersCount": "2",
    "createTime": "2024-18-12T08:18:49",
    "phone": "+14255550100",
    "id": "1020000013062",
    "state": "DECLINED",
    "email": "1731399528@qq.com",
    "verifiedEmail": "true",
    "defaultAddress": {
      "zip": "20000",
      "firstName": "heihei",
      "lastName": "chen",
      "address2": "cao he jing",
      "city": "shanghai",
      "phone": "+14255550100",
      "address1": "xu hui",
      "countryCode": "CN",
      "provinceCode": "FJ",
      "company": "demo",
      "isDefaultAddress": "true",
      "id": "878"
    }
  }
}

DELETE Delete customer ​

Delete a customer. Note: The customer cannot be deleted if they have any existing orders.

Access scope

Requires ANY of the following access scopes: write_customers

Endpoint

DELETE /api/202412/customers/{customerId} 

Request Params

customerIdnumberrequired
Customer's unique ID.

Response Data

customerobject
Represent the personal information of a customer.
- Hide child properties
idnumberrequired
Customer's unique identifier.
emailstringrequired
The customer's email address.
createTimestringrequired
Customer creation time (ISO 8601 format).
updateTimestringrequired
Customer update time (ISO 8601 format).
phonestring
Customer's phone number.
firstNamestring
The customer's first name.
lastNamestring
The customer's last name.
bash
curl -X DELETE \ 
https://{shop}.genmystore.com/api/202412/customers/{customerId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "customer": {
    "firstName": "test23",
    "lastName": "li",
    "createTime": "2024-18-12T08:18:49",
    "phone": "+14255550100",
    "updateTime": "2024-18-12T08:18:49",
    "id": "1020000013062",
    "email": "1731399528@qq.com"
  }
}

GET Get customer details ​

Retrieve customer details.

Access scope

Requires ANY of the following access scopes: read_customers

Endpoint

GET /api/202412/customers/{customerId} 

Request Params

customerIdnumberrequired
Customer's unique identifier.

Response Data

customerobject
Represent the personal information of a customer.
- Hide child properties
idnumberrequired
Customer's unique identifier.
emailstringrequired
The customer's email address.
createTimestringrequired
Customer creation time (ISO 8601 format).
updateTimestringrequired
Customer update time (ISO 8601 format).
phonestring
Customer's phone number.
verifiedEmailboolean
Whether the customer verifies the email address.
statestring
The state of the customer's account with the shop. Enumeration values: DECLINED - user declined to become a customer; DISABLED - invalid account; ENABLED - active customer; INVITED - customer under invitation.
firstNamestring
The customer's first name.
lastNamestring
The customer's last name.
notesstring
A note about the customer.
ordersCountnumber
The number of orders that the customer has made at the store in their lifetime.
totalSpentnumber
The total amount that the customer has spent on orders in their lifetime.
taxExemptboolean
Whether the customer is exempt from being charged taxes on their orders.
taxExemptionsobject
The list of tax exemptions applied to the customer.
+ Show child properties
smsMarketingConsentobject
The current SMS marketing state for the customer's phone number.
+ Show child properties
tagsarray
A list of tags that have been added to the customer.
emailMarketingConsentobject
The current email marketing state for the customer.
+ Show child properties
defaultAddressobject
The default address associated with the customer.
+ Show child properties
addressesarray
The addresses associated with the customer.
+ Show child properties
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/customers/{customerId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "customer": {
    "lastName": "li",
    "addresses": [
      {
        "zip": "23456",
        "firstName": "heihei",
        "lastName": "du",
        "address2": "cao he jing",
        "city": "shanghai",
        "phone": "+14255550100",
        "address1": "xu hui",
        "countryCode": "CN",
        "provinceCode": "SH",
        "company": "demo",
        "isDefaultAddress": "false",
        "id": "879"
      }
    ],
    "notes": "this is new customer",
    "totalSpent": "13.1",
    "taxExempt": "true",
    "taxExemptions": {
      "applyToAllRegion": "true",
      "taxExemptionRegions": [
        {
          "country": "US",
          "applyToAllSubdivision": "false",
          "subdivisions": [
            "NYC"
          ]
        }
      ]
    },
    "updateTime": "2024-18-12T08:18:49",
    "smsMarketingConsent": {
      "state": "SUBSCRIBED",
      "consentUpdateTime": "2024-11-12T08:18:49.125"
    },
    "tags": [
      "xinsheng",
      "human"
    ],
    "emailMarketingConsent": {
      "state": "SUBSCRIBED",
      "consentUpdateTime": "2024-11-12T08:18:49.125"
    },
    "firstName": "test23",
    "ordersCount": "2",
    "createTime": "2024-18-12T08:18:49",
    "phone": "+14255550100",
    "id": "1020000013062",
    "state": "DECLINED",
    "email": "1731399528@qq.com",
    "verifiedEmail": "true",
    "defaultAddress": {
      "zip": "20000",
      "firstName": "heihei",
      "lastName": "chen",
      "address2": "cao he jing",
      "city": "shanghai",
      "phone": "+14255550100",
      "address1": "xu hui",
      "countryCode": "CN",
      "provinceCode": "FJ",
      "company": "demo",
      "isDefaultAddress": "true",
      "id": "878"
    }
  }
}

GET Search customers ​

Search customers matching a query.

Access scope

Requires ANY of the following access scopes: read_customers

Endpoint

GET /api/202412/customers/search 

Request Params

orderstring
Set the sorting field and direction.
limitnumber
The maximum number of results to show, with a limit of 50 by default and no more than 250.
querystring
When searching in the store's customer data, you can use the following fields: email, firstName, customerId, and lastName. Separate different fields with a semicolon ";" and use a colon ":" to separate the field from its value. Note:Please use urlencode encoding
pageTokenstring
A unique ID used to access a certain page of results. The page_info parameter can't be modified and must be used exactly as it appears in the link header URL.

Response Data

customersarray
Represent the personal information of a customer.
- Hide child properties
idnumberrequired
Customer's unique identifier.
emailstringrequired
The customer's email address.
createTimestringrequired
Customer creation time (ISO 8601 format).
updateTimestringrequired
Customer update time (ISO 8601 format).
phonestring
Customer's phone number.
verifiedEmailboolean
Whether the customer verifies the email address.
statestring
The state of the customer's account with the shop. Enumeration values: DECLINED - user declined to become a customer; DISABLED - invalid account; ENABLED - active customer; INVITED - customer under invitation.
firstNamestring
The customer's first name.
lastNamestring
The customer's last name.
notesstring
A note about the customer.
ordersCountnumber
The number of orders that the customer has made at the store in their lifetime.
totalSpentnumber
The total amount that the customer has spent on orders in their lifetime.
taxExemptboolean
Whether the customer is exempt from being charged taxes on their orders.
taxExemptionsobject
The list of tax exemptions applied to the customer.
+ Show child properties
smsMarketingConsentobject
The current SMS marketing state for the customer's phone number.
+ Show child properties
tagsarray
A list of tags that have been added to the customer.
emailMarketingConsentobject
The current email marketing state for the customer.
+ Show child properties
defaultAddressobject
The default address associated with the customer.
+ Show child properties
addressesarray
The addresses associated with the customer.
+ Show child properties
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/customers/search" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "customers": [
    {
      "lastName": "li",
      "addresses": [
        {
          "zip": "23456",
          "firstName": "heihei",
          "lastName": "du",
          "address2": "caohejing",
          "city": "ShangHai",
          "phone": "+14255550100",
          "address1": "xuhui",
          "countryCode": "CN",
          "provinceCode": "SH",
          "company": "demo",
          "isDefaultAddress": "false",
          "id": "879"
        }
      ],
      "notes": "this is new customer",
      "totalSpent": "13.1",
      "taxExempt": "true",
      "taxExemptions": {
        "applyToAllRegion": "true",
        "taxExemptionRegions": [
          {
            "country": "US",
            "applyToAllSubdivision": "false",
            "subdivisions": [
              "NYC"
            ]
          }
        ]
      },
      "updateTime": "2024-18-12T08:18:49",
      "smsMarketingConsent": {
        "state": "SUBSCRIBED",
        "consentUpdateTime": "2024-11-12T08:18:49.125"
      },
      "tags": [
        "xinsheng",
        "human"
      ],
      "emailMarketingConsent": {
        "state": "SUBSCRIBED",
        "consentUpdateTime": "2024-11-12T08:18:49.125"
      },
      "firstName": "test23",
      "ordersCount": "2",
      "createTime": "2024-18-12T08:18:49",
      "phone": "+14255550100",
      "id": "1020000013062",
      "state": "DECLINED",
      "email": "1731399528@qq.com",
      "verifiedEmail": "true",
      "defaultAddress": {
        "zip": "20000",
        "firstName": "heihei",
        "lastName": "chen",
        "address2": "cao he jing",
        "city": "shanghai",
        "phone": "+14255550100",
        "address1": "xu hui",
        "countryCode": "CN",
        "provinceCode": "FJ",
        "company": "demo",
        "isDefaultAddress": "true",
        "id": "878"
      }
    }
  ]
}

GET Get customer list ​

Retrieve a list of customers.

Access scope

Requires ANY of the following access scopes: read_customers

Endpoint

GET /api/202412/customers 

Request Params

idsstring
Restrict results to customers specified by a comma-separated list of IDs.
limitnumber
The maximum number of results to show.
sinceIdstring
Restrict results to those after the specified ID.
pageTokenstring
A unique ID used to access a certain page of results. The page_info parameter can't be modified and must be used exactly as it appears in the link header URL.

Response Data

customersarray
Represent the personal information of a customer.
- Hide child properties
idnumberrequired
Customer's unique identifier.
emailstringrequired
The customer's email address.
createTimestringrequired
Customer creation time (ISO 8601 format).
updateTimestringrequired
Customer update time (ISO 8601 format).
phonestring
Customer's phone number.
verifiedEmailboolean
Whether the customer verifies the email address.
statestring
The state of the customer's account with the shop. Enumeration values: DECLINED - user declined to become a customer; DISABLED - invalid account; ENABLED - active customer; INVITED - customer under invitation.
firstNamestring
The customer's first name.
lastNamestring
The customer's last name.
notesstring
A note about the customer.
ordersCountnumber
The number of orders that the customer has made at the store in their lifetime.
totalSpentnumber
The total amount that the customer has spent on orders in their lifetime.
taxExemptboolean
Whether the customer is exempt from being charged taxes on their orders.
taxExemptionsobject
The list of tax exemptions applied to the customer.
+ Show child properties
smsMarketingConsentobject
The current SMS marketing state for the customer's phone number.
+ Show child properties
tagsarray
A list of tags that have been added to the customer.
emailMarketingConsentobject
The current email marketing state for the customer.
+ Show child properties
defaultAddressobject
The default address associated with the customer.
+ Show child properties
addressesarray
The addresses associated with the customer.
+ Show child properties
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/customers" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "customers": [
    {
      "lastName": "li",
      "addresses": [
        {
          "zip": "23456",
          "firstName": "heihei",
          "lastName": "du",
          "address2": "caohejing",
          "city": "ShangHai",
          "phone": "+14255550100",
          "address1": "xuhui",
          "countryCode": "CN",
          "provinceCode": "SH",
          "company": "demo",
          "isDefaultAddress": "false",
          "id": "879"
        }
      ],
      "notes": "this is new customer",
      "totalSpent": "13.1",
      "taxExempt": "true",
      "taxExemptions": {
        "applyToAllRegion": "true",
        "taxExemptionRegions": [
          {
            "country": "US",
            "applyToAllSubdivision": "false",
            "subdivisions": [
              "NYC"
            ]
          }
        ]
      },
      "updateTime": "2024-18-12T08:18:49",
      "smsMarketingConsent": {
        "state": "SUBSCRIBED",
        "consentUpdateTime": "2024-11-12T08:18:49.125"
      },
      "tags": [
        "xinsheng",
        "human"
      ],
      "emailMarketingConsent": {
        "state": "SUBSCRIBED",
        "consentUpdateTime": "2024-11-12T08:18:49.125"
      },
      "firstName": "test23",
      "ordersCount": "2",
      "createTime": "2024-18-12T08:18:49",
      "phone": "+14255550100",
      "id": "1020000013062",
      "state": "DECLINED",
      "email": "1731399528@qq.com",
      "verifiedEmail": "true",
      "defaultAddress": {
        "zip": "20000",
        "firstName": "heihei",
        "lastName": "chen",
        "address2": "cao he jing",
        "city": "shanghai",
        "phone": "+14255550100",
        "address1": "xu hui",
        "countryCode": "CN",
        "provinceCode": "FJ",
        "company": "demo",
        "isDefaultAddress": "true",
        "id": "878"
      }
    }
  ]
}