关于客户

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

客户模块旨在帮助商家维护和分析客户关系。Genstore 提供了一组 RESTful 接口，用于管理在线商店的客户信息。通过这些接口，商家可以高效处理客户信息，包括联系方式、订单历史记录以及营销邮件订阅等。

核心功能

创建客户：创建新的客户记录。
删除客户：移除已有的客户记录。
查询客户：获取特定客户详情。
查询客户列表：获取店铺客户列表。

TIP

在使用客户 API 之前，请确保您确保您的帐户具有足够的权限来执行接口操作。

应用场景

客户资料同步：CRM 系统可通过查询客户详情接口，实现客户信息变更的实时同步更新。
营销人群分层：营销平台可通过获取客户列表接口，基于客户属性和偏好创建精准的营销活动。

接口

POST /api/202412/customers: 创建客户

POST /api/202412/customers/search: 检索客户

PUT /api/202412/customers/{customerId}: 修改客户信息

DELETE /api/202412/customers/{customerId}: 删除客户

GET /api/202412/customers/{customerId}: 获取客户详情

GET /api/202412/customers: 查询客户列表

客户对象

创建与管理客户

属性

customerobject

表示客户的个人信息。

- 收起属性

idnumber

客户的唯一标识符。

emailstring

客户的邮箱。

createTimestring

客户的创建时间（ISO 8601格式）。

updateTimestring

客户的更新时间（ISO 8601格式）。

phonestring

客户的手机号。

verifiedEmailboolean

客户是否验证邮箱。

statestring

客户在商店的帐户状态。枚举值： DECLINED - 用户拒绝成为客户；DISABLED - 无效账户；ENABLED - 活跃客户；INVITED - 邀请中的客户。

firstNamestring

客户的名称。

lastNamestring

客户的姓。

notesstring

关于客户的备注。

ordersCountobject

客户在商店下的总订单数量。

totalSpentobject

客户在商店下的总消费金额。

taxExemptboolean

客户的订单是否可以免税。

taxExemptionsobject

适用于客户的免税清单。

+ 展开属性

smsMarketingConsentobject

客户手机号当前的短信营销状态。

+ 展开属性

tagsarray

客户的标签列表。

emailMarketingConsentobject

客户邮箱地址当前的邮件营销状态。

+ 展开属性

defaultAddressobject

与客户关联的默认地址。

+ 展开属性

addressesarray

与客户关联的地址。

+ 展开属性

客户对象

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": "[email protected]",
    "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` 创建客户

创建一个客户。

访问范围

需要以下任意访问权限: write_customers

接口

POST /api/202412/customers

请求参数

customerobject

表示客户的个人信息。

- 收起属性

idnumber

客户的唯一标识符。

emailstring

客户的邮箱。

createTimestring

客户的创建时间（ISO 8601格式）。

updateTimestring

客户的更新时间（ISO 8601格式）。

phonestring

客户的手机号。

verifiedEmailboolean

客户是否验证邮箱。

statestring

客户在商店的帐户状态。枚举值： DECLINED - 用户拒绝成为客户；DISABLED - 无效账户；ENABLED - 活跃客户；INVITED - 邀请中的客户。

firstNamestring

客户的名称。

lastNamestring

客户的姓。

notesstring

关于客户的备注。

ordersCountobject

客户在商店下的总订单数量。

totalSpentobject

客户在商店下的总消费金额。

taxExemptboolean

客户的订单是否可以免税。

taxExemptionsobject

适用于客户的免税清单。

+ 展开属性

smsMarketingConsentobject

客户手机号当前的短信营销状态。

+ 展开属性

tagsarray

客户的标签列表。

emailMarketingConsentobject

客户邮箱地址当前的邮件营销状态。

+ 展开属性

defaultAddressobject

与客户关联的默认地址。

+ 展开属性

addressesarray

与客户关联的地址。

+ 展开属性

响应数据

customerobject

表示客户的个人信息。

- 收起属性

idnumber

客户的唯一标识符。

emailstring

客户的邮箱。

createTimestring

客户的创建时间（ISO 8601格式）。

updateTimestring

客户的更新时间（ISO 8601格式）。

phonestring

客户的手机号。

verifiedEmailboolean

客户是否验证邮箱。

statestring

客户在商店的帐户状态。枚举值： DECLINED - 用户拒绝成为客户；DISABLED - 无效账户；ENABLED - 活跃客户；INVITED - 邀请中的客户。

firstNamestring

客户的名称。

lastNamestring

客户的姓。

notesstring

关于客户的备注。

ordersCountobject

客户在商店下的总订单数量。

totalSpentobject

客户在商店下的总消费金额。

taxExemptboolean

客户的订单是否可以免税。

taxExemptionsobject

适用于客户的免税清单。

+ 展开属性

smsMarketingConsentobject

客户手机号当前的短信营销状态。

+ 展开属性

tagsarray

客户的标签列表。

emailMarketingConsentobject

客户邮箱地址当前的邮件营销状态。

+ 展开属性

defaultAddressobject

与客户关联的默认地址。

+ 展开属性

addressesarray

与客户关联的地址。

+ 展开属性

POST /api/202412/customers

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":{
		"lastName":"li",
		"addresses":[
			{
				"zip":"23456",
				"firstName":"heihei",
				"lastName":"du",
				"address2":"shanghai",
				"city":"xuhui",
				"phone":"2345653464",
				"address1":"caohejing",
				"countryCode":"CN",
				"provinceCode":"SH",
				"company":"demo",
				"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":"[email protected]",
		"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"
		}
	}
}'

响应

json

HTTP/1.1 200 OK
{
  "customer": {
    "lastName": "li",
    "addresses": [
      {
        "zip": "23456",
        "firstName": "heihei",
        "lastName": "du",
        "address2": "caohejing",
        "city": "shanghai",
        "phone": "2345653464",
        "address1": "xuhui",
        "countryCode": "CN",
        "provinceCode": "SH",
        "company": "demo",
        "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": "[email protected]",
    "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` 检索客户

根据条件检索客户。

访问范围

需要以下任意访问权限: write_customers

接口

POST /api/202412/customers/search

请求参数

orderstring

设置检索结果的排列顺序。

limitnumber

查询数量限制，默认 50，不能超过 250。

querystring

在商店的客户数据中进行搜索时，可以使用以下字段：email、firstName、customerId、lastName。不同字段之间请用分号“;”隔开，字段与字段值之间用冒号“: ”分隔。

pageTokenstring

加密后的请求参数，用于上一页、下一页，直接取该字段解析访问。

响应数据

customersarray

表示客户的个人信息。

POST /api/202412/customers/search

bash

curl -X POST \ 
https://{shop}.genmystore.com/api/202412/customers/search" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"query":"customer_id:1;orders_count:2",
	"limit":"10",
	"pageToken":"< url?pageToken=eyJwYWdlTnVtIjoxLCJwYWdlU2l6ZSI6MX0=&limit=1 >; rel=previous,< url?pageToken=eyJwYWdlTnVtIjozLCJwYWdlU2l6ZSI6MX0=&limit=1 >; rel=next",
	"order":"createTime DESC"
}'

响应

json

HTTP/1.1 200 OK
{
  "customers": "cusomer"
}

`PUT` 修改客户信息

修改客户信息。

访问范围

需要以下任意访问权限: write_customers

接口

PUT /api/202412/customers/{customerId}

请求参数

customerobject

表示客户的个人信息。

- 收起属性

emailstring

客户的邮箱。

createTimestring

客户的创建时间（ISO 8601格式）。

updateTimestring

客户的更新时间（ISO 8601格式）。

phonestring

客户的手机号。

verifiedEmailboolean

客户是否验证邮箱。

statestring

客户在商店的帐户状态。枚举值： DECLINED - 用户拒绝成为客户；DISABLED - 无效账户；ENABLED - 活跃客户；INVITED - 邀请中的客户。

firstNamestring

客户的名称。

lastNamestring

客户的姓。

notesstring

关于客户的备注。

ordersCountobject

客户在商店下的总订单数量。

totalSpentobject

客户在商店下的总消费金额。

taxExemptboolean

客户的订单是否可以免税。

taxExemptionsobject

适用于客户的免税清单。

+ 展开属性

smsMarketingConsentobject

客户手机号当前的短信营销状态。

+ 展开属性

tagsarray

客户的标签列表。

emailMarketingConsentobject

客户邮箱地址当前的邮件营销状态。

+ 展开属性

defaultAddressobject

与客户关联的默认地址。

+ 展开属性

addressesarray

与客户关联的地址。

+ 展开属性

响应数据

customerobject

表示客户的个人信息。

- 收起属性

idnumber

客户的唯一标识符。

emailstring

客户的邮箱。

createTimestring

客户的创建时间（ISO 8601格式）。

updateTimestring

客户的更新时间（ISO 8601格式）。

phonestring

客户的手机号。

verifiedEmailboolean

客户是否验证邮箱。

statestring

客户在商店的帐户状态。枚举值： DECLINED - 用户拒绝成为客户；DISABLED - 无效账户；ENABLED - 活跃客户；INVITED - 邀请中的客户。

firstNamestring

客户的名称。

lastNamestring

客户的姓。

notesstring

关于客户的备注。

ordersCountobject

客户在商店下的总订单数量。

totalSpentobject

客户在商店下的总消费金额。

taxExemptboolean

客户的订单是否可以免税。

taxExemptionsobject

适用于客户的免税清单。

+ 展开属性

smsMarketingConsentobject

客户手机号当前的短信营销状态。

+ 展开属性

tagsarray

客户的标签列表。

emailMarketingConsentobject

客户邮箱地址当前的邮件营销状态。

+ 展开属性

defaultAddressobject

与客户关联的默认地址。

+ 展开属性

addressesarray

与客户关联的地址。

+ 展开属性

PUT /api/202412/customers/{customerId}

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":{
		"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",
		"state":"DECLINED",
		"email":"[email protected]",
		"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"
		}
	}
}'

响应

json

HTTP/1.1 200 OK
{
  "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": "[email protected]",
    "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"
    }
  }
}

`DELETE` 删除客户

删除客户。注意：如果客户有现有订单，则无法删除。

访问范围

需要以下任意访问权限: write_customers

接口

DELETE /api/202412/customers/{customerId}

请求参数

customerIdnumber

客户的唯一 ID。

响应数据

customerobject

表示客户的个人信息。

- 收起属性

idnumber

客户的唯一标识符。

emailstring

客户的邮箱。

createTimestring

客户的创建时间（ISO 8601格式）。

updateTimestring

客户的更新时间（ISO 8601格式）。

phonestring

客户的手机号。

firstNamestring

客户的名称。

lastNamestring

客户的姓。

DELETE /api/202412/customers/{customerId}

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": "13315034487",
    "updateTime": "2024-18-12T08:18:49",
    "id": "1020000013062",
    "email": "[email protected]"
  }
}

`GET` 获取客户详情

获取客户详情。

访问范围

需要以下任意访问权限: write_customers read_customers

接口

GET /api/202412/customers/{customerId}

请求参数

customerIdnumber

客户的唯一标识符。

响应数据

customerobject

表示客户的个人信息。

- 收起属性

idnumber

客户的唯一标识符。

emailstring

客户的邮箱。

createTimestring

客户的创建时间（ISO 8601格式）。

updateTimestring

客户的更新时间（ISO 8601格式）。

phonestring

客户的手机号。

verifiedEmailboolean

客户是否验证邮箱。

statestring

客户在商店的帐户状态。枚举值： DECLINED - 用户拒绝成为客户；DISABLED - 无效账户；ENABLED - 活跃客户；INVITED - 邀请中的客户。

firstNamestring

客户的名称。

lastNamestring

客户的姓。

notesstring

关于客户的备注。

ordersCountobject

客户在商店下的总订单数量。

totalSpentobject

客户在商店下的总消费金额。

taxExemptboolean

客户的订单是否可以免税。

taxExemptionsobject

适用于客户的免税清单。

+ 展开属性

smsMarketingConsentobject

客户手机号当前的短信营销状态。

+ 展开属性

tagsarray

客户的标签列表。

emailMarketingConsentobject

客户邮箱地址当前的邮件营销状态。

+ 展开属性

defaultAddressobject

与客户关联的默认地址。

+ 展开属性

addressesarray

与客户关联的地址。

+ 展开属性

GET /api/202412/customers/{customerId}

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": "上海闵行",
        "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": "[email protected]",
    "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"
    }
  }
}

`GET` 查询客户列表

查询客户列表。

访问范围

需要以下任意访问权限: write_customers read_customers

接口

GET /api/202412/customers

请求参数

idsstring

客户的唯一标识符，不同的客户标识符用逗号隔开。

limitnumber

查询数量限制，默认 50，不能超过 250。

sinceIdstring

要查询的数据的起始位置（客户 ID 取值）。

pageTokenstring

加密后的请求参数，用于上一页、下一页，直接取该字段解析访问。

响应数据

customersarray

表示客户的个人信息。

- 收起属性

idnumber

客户的唯一标识符。

emailstring

客户的邮箱。

createTimestring

客户的创建时间（ISO 8601格式）。

updateTimestring

客户的更新时间（ISO 8601格式）。

phonestring

客户的手机号。

verifiedEmailboolean

客户是否验证邮箱。

statestring

客户在商店的帐户状态。枚举值： DECLINED - 用户拒绝成为客户；DISABLED - 无效账户；ENABLED - 活跃客户；INVITED - 邀请中的客户。

firstNamestring

客户的名称。

lastNamestring

客户的姓。

notesstring

关于客户的备注。

ordersCountobject

客户在商店下的总订单数量。

totalSpentobject

客户在商店下的总消费金额。

taxExemptboolean

客户的订单是否可以免税。

taxExemptionsobject

适用于客户的免税清单。

+ 展开属性

smsMarketingConsentobject

客户手机号当前的短信营销状态。

+ 展开属性

tagsarray

客户的标签列表。

emailMarketingConsentobject

客户邮箱地址当前的邮件营销状态。

+ 展开属性

defaultAddressobject

与客户关联的默认地址。

+ 展开属性

addressesarray

与客户关联的地址。

+ 展开属性

GET /api/202412/customers

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": "2345653464",
          "address1": "xuhui",
          "countryCode": "CN",
          "provinceCode": "SH",
          "company": "demo",
          "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": "[email protected]",
      "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 创建客户 ​

请求参数

响应数据

POST 检索客户 ​

请求参数

响应数据

PUT 修改客户信息 ​

请求参数

响应数据

DELETE 删除客户 ​

请求参数

响应数据

GET 获取客户详情 ​

请求参数

响应数据

GET 查询客户列表 ​

请求参数

响应数据

关于 客户 ​

客户 对象 ​

属性 ​

POST 创建客户 ​

POST 检索客户 ​

PUT 修改客户信息 ​

DELETE 删除客户 ​

GET 获取客户详情 ​

GET 查询客户列表 ​

关于客户

客户对象

属性

`POST` 创建客户

`POST` 检索客户

`PUT` 修改客户信息

`DELETE` 删除客户

`GET` 获取客户详情

`GET` 查询客户列表

关于客户

客户对象

属性

`POST` 创建客户

`POST` 检索客户

`PUT` 修改客户信息

`DELETE` 删除客户

`GET` 获取客户详情

`GET` 查询客户列表