- write_customers.
External DocumentationTo learn more, visit the Shopify documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Addresses | JSON array of address objects to set for the customer. All fields are optional. For example: Note: For more information regarding the Addresses parameter, visit Shopify API documentation |
| Email Address | Email address of the customer. |
| First Name | First name for the customer. |
| Last Name | Last name for the customer. |
| Phone Number | E.164 formatted phone number of the customer. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Email Marketing Consent | Information that describes when the customer consented to receiving marketing material by email. Note: The Email Address parameter is required when creating a customer with email marketing consent information. |
| Email Marketing Consent Opt In Level | The customer opt-in level at the time of subscribing to marketing material. Note: The Email Marketing Consent parameter must be provided when using this parameter. |
| Email Marketing Consent Updated Date | The latest date and time when the customer consented or objected to receiving marketing material by email.Note: The Email Marketing Consent parameter must be provided when using this parameter. |
| Locale | The customer’s locale. |
| Metafields | JSON array of additional Metafields to associate to the customer.For example: Note: For more information regarding the Metafields parameter, visit Shopify API documentation |
| Note | An note to save on the customer. For example: |
| SMS Marketing Consent | The marketing consent information when the customer consented to receiving marketing material by SMS. Note: The Phone Number parameter is required when creating a customer with SMS marketing consent information. |
| SMS Marketing Consent Updated Date | The latest date and time when the customer consented or objected to receiving marketing material by SMS. Note: The SMS Marketing Consent parameter must be provided when using this parameter. |
| SMS Marketing Opt In Level | The marketing subscription opt-in level that was set when the customer consented to receive marketing information. Note: The SMS Marketing Consent parameter must be provided when using this parameter. |
| Tags | A comma-separated list of tags to add to this customer. For example: |
| Tax Exempt | When checked, the customer is exempt from paying taxes on their order. |
| Tax Exemptions | The list of tax exemptions to apply to the customer. Note: For more information about the Tax Exemptions parameter, visit Shopify API documentation |
Example Output
{
"customerCreate": {
"userErrors": [],
"customer": {
"id": "gid://shopify/Customer/1073340090",
"email": "steve.lastnameson@example.com",
"phone": "+16465555555",
"taxExempt": false,
"emailMarketingConsent": {
"marketingState": "SUBSCRIBED",
"marketingOptInLevel": "CONFIRMED_OPT_IN",
"consentUpdatedAt": "2024-11-05T14:29:06Z"
},
"firstName": "Steve",
"lastName": "Lastname",
"amountSpent": {
"amount": "0.0",
"currencyCode": "USD"
},
"smsMarketingConsent": {
"marketingState": "NOT_SUBSCRIBED",
"marketingOptInLevel": "SINGLE_OPT_IN"
},
"addresses": [
{
"address1": "412 fake st",
"city": "Ottawa",
"country": "Canada",
"phone": "+16469999999",
"zip": "A1A 4A1"
}
]
}