{"info":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","description":"

This API allows developers to interact with the app Customer Fields for Shopify.

We're excited you're interested in using the Customer Fields' API! Review these docs and examples and feel free to reach out to us if you need any help getting things set up. Be sure to visit our full developer docs, which covers in detail other aspects of developing with Customer Fields.

About Customer Fields

What does Customer Fields do?

Customer Fields allows merchants on Shopify to extend their customer data by creating custom fields within the app and getting this data via forms on their storefront. Let's say you'd like to collect a customer's birthday on registrations, that's us. How about a tax ID? Also us. What about the middle name of the customer's grandma's cat? Yep, us.

Who makes Customer Fields?

Helium does! We're a small (but energetic) team based in the Seattle area.

What is this API for?

It's our goal to make the data we collect as accessible as possible. We've created this so that other apps, platforms, and private agencies can easily create unique experiences and data collection for merchants. If you have questions about using the API, feel free to reach out to our support at support@heliumdev.com.

Since you must send an access token in your request, you should never send requests client side. For example, don't fetch customer data from a merchant's theme. This will expose your token to the world and thus all your customer data.

You should only be making these requests from behind a secure backend server. If you're wanting to interact with a customer in the browser, you should use our JavaScript API.

Can I use the Shopify API instead?

That depends. If all you require is to get and set custom data on a customer's record, you can use two-way metafield syncing while only using Shopify's API. If you'd like additional functionality, you'll need to consult this API.

Rate limits

We currently limit the rate of API calls for any app to 250 requests per 100 seconds. If you exceed this rate, we'll respond with a 429 Too Many Requests and you should backoff your requests until more quota becomes available.

At any point if we receive a 429 Too Many Requests from Shopify, we'll respond in kind.

Authentication

Public apps

If you'd like to create an app that integrates with Customer Fields that works with a variety of merchants, please reach out to support@heliumdev.com. We'll set you up with your own app credentials so that your merchants can authenticate via OAuth2.

Private apps

If you're wanting to integrate with a specific shop, you'll want to create a private access token. You can do this under your Account page within the app.

Using an access token

Once you've obtained an access token (through OAuth or private access), use this token in the header of each request, following standard OAuth format:

Authorization: Bearer YOUR_API_TOKEN\n\n

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"About Customer Fields","slug":"about-customer-fields"},{"content":"Rate limits","slug":"rate-limits"},{"content":"Authentication","slug":"authentication"}],"owner":"843214","collectionId":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","publishedId":"T17Nc5vV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"160A2C","highlight":"40A5FF"},"publishDate":"2020-07-14T21:48:28.000Z"},"item":[{"name":"Data columns","item":[{"name":"List data columns","id":"ba736acc-af53-422b-9e50-a3ef59fce20f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseURL}}/api/v2/data_columns.json?form_id=Zbbt6Z&ignore_read_only=true","description":"

Get a list of data columns.

The ID of the form to filter data columns by

\n","type":"text/plain"},"key":"form_id","value":"Zbbt6Z"},{"description":{"content":"

If read only fields should be returned

\n","type":"text/plain"},"key":"ignore_read_only","value":"true"}],"variable":[]}},"response":[{"id":"8905eaac-7f50-48e0-9b6a-7240e2c3f538","name":"List data columns","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{baseURL}}/api/v2/data_columns.json?form_id=Zbbt6Z&ignore_read_only=true","host":["{{baseURL}}"],"path":["api","v2","data_columns.json"],"query":[{"key":"form_id","value":"Zbbt6Z","description":"The ID of the form to filter data columns by"},{"key":"ignore_read_only","value":"true","description":"If read only fields should be returned"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"P3P","value":"CP=\"Not used\""},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"3e67162e9e57f29ca76917210c971991\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"957b5f7d-cd82-4219-9620-14a87a54c6a2"},{"key":"X-Runtime","value":"0.018660"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data_columns\": [\n {\n \"id\": null,\n \"key\": \"accepts_marketing\",\n \"label\": \"Accepts marketing\",\n \"expanded_label\": \"Accepts marketing\",\n \"data_type\": \"boolean\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses\",\n \"label\": \"Addresses\",\n \"expanded_label\": \"Addresses\",\n \"data_type\": \"group_list\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.address1\",\n \"label\": \"Address line 1\",\n \"expanded_label\": \"Address line 1\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.address2\",\n \"label\": \"Address line 2\",\n \"expanded_label\": \"Address line 2\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.city\",\n \"label\": \"City\",\n \"expanded_label\": \"City\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.company\",\n \"label\": \"Company\",\n \"expanded_label\": \"Company\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.country\",\n \"label\": \"Country\",\n \"expanded_label\": \"Country\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.country_code\",\n \"label\": \"Country code\",\n \"expanded_label\": \"Country code\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.first_name\",\n \"label\": \"Address first name\",\n \"expanded_label\": \"Address first name\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.last_name\",\n \"label\": \"Address last name\",\n \"expanded_label\": \"Address last name\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.phone\",\n \"label\": \"Address phone\",\n \"expanded_label\": \"Address phone\",\n \"data_type\": \"phone\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.province\",\n \"label\": \"Province\",\n \"expanded_label\": \"Province\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.province_code\",\n \"label\": \"Province code\",\n \"expanded_label\": \"Province code\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"addresses.zip\",\n \"label\": \"Postal code\",\n \"expanded_label\": \"Postal code\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": \"bvJFld\",\n \"key\": \"avatar\",\n \"label\": \"Avatar\",\n \"expanded_label\": \"Avatar\",\n \"data_type\": \"file\",\n \"dedicated\": false,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": \"2020-03-24T19:15:30.869Z\"\n },\n {\n \"id\": \"bvJFMb\",\n \"key\": \"birthday\",\n \"label\": \"Birthday\",\n \"expanded_label\": \"Birthday\",\n \"data_type\": \"date\",\n \"dedicated\": false,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": \"2019-11-27T03:38:06.600Z\"\n },\n {\n \"id\": \"WkEFz8\",\n \"key\": \"breakfast.lunch\",\n \"label\": \"Lunch\",\n \"expanded_label\": \"Lunch\",\n \"data_type\": \"text\",\n \"dedicated\": false,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": \"2020-07-13T17:25:07.502Z\"\n },\n {\n \"id\": null,\n \"key\": \"default_address.address1\",\n \"label\": \"Address line 1\",\n \"expanded_label\": \"Address line 1\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.address2\",\n \"label\": \"Address line 2\",\n \"expanded_label\": \"Address line 2\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.city\",\n \"label\": \"City\",\n \"expanded_label\": \"City\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.company\",\n \"label\": \"Company\",\n \"expanded_label\": \"Company\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.country\",\n \"label\": \"Country\",\n \"expanded_label\": \"Country\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.country_code\",\n \"label\": \"Country code\",\n \"expanded_label\": \"Country code\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.first_name\",\n \"label\": \"Address first name\",\n \"expanded_label\": \"Address first name\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.last_name\",\n \"label\": \"Address last name\",\n \"expanded_label\": \"Address last name\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.phone\",\n \"label\": \"Address phone\",\n \"expanded_label\": \"Address phone\",\n \"data_type\": \"phone\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.province\",\n \"label\": \"Province\",\n \"expanded_label\": \"Province\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.province_code\",\n \"label\": \"Province code\",\n \"expanded_label\": \"Province code\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"default_address.zip\",\n \"label\": \"Postal code\",\n \"expanded_label\": \"Postal code\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"email\",\n \"label\": \"Email\",\n \"expanded_label\": \"Email\",\n \"data_type\": \"email\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"first_name\",\n \"label\": \"First name\",\n \"expanded_label\": \"First name\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"last_name\",\n \"label\": \"Last name\",\n \"expanded_label\": \"Last name\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": \"1OaFBR\",\n \"key\": \"meals\",\n \"label\": \"Meals\",\n \"expanded_label\": \"Meals\",\n \"data_type\": \"text\",\n \"dedicated\": false,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": \"2020-07-13T17:24:42.105Z\"\n },\n {\n \"id\": \"1nlFzN\",\n \"key\": \"meals.breakfast\",\n \"label\": \"Breakfast\",\n \"expanded_label\": \"Breakfast\",\n \"data_type\": \"text\",\n \"dedicated\": false,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": \"2020-07-13T17:24:57.873Z\"\n },\n {\n \"id\": \"bekF2B\",\n \"key\": \"meals.dinner\",\n \"label\": \"Dinner\",\n \"expanded_label\": \"Dinner\",\n \"data_type\": \"text\",\n \"dedicated\": false,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": \"2020-07-13T17:25:14.981Z\"\n },\n {\n \"id\": \"b2LFXL\",\n \"key\": \"my_custom_column\",\n \"label\": \"My custom column\",\n \"expanded_label\": \"My custom column\",\n \"data_type\": \"text\",\n \"dedicated\": false,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": \"2020-07-13T17:20:24.499Z\"\n },\n {\n \"id\": null,\n \"key\": \"note\",\n \"label\": \"Note\",\n \"expanded_label\": \"Note\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"password\",\n \"label\": \"Password\",\n \"expanded_label\": \"Password\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"password_confirmation\",\n \"label\": \"Password confirmation\",\n \"expanded_label\": \"Password confirmation\",\n \"data_type\": \"text\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"phone\",\n \"label\": \"Phone\",\n \"expanded_label\": \"Phone\",\n \"data_type\": \"phone\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"tags\",\n \"label\": \"Tags\",\n \"expanded_label\": \"Tags\",\n \"data_type\": \"list\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": null,\n \"key\": \"tax_exempt\",\n \"label\": \"Tax exempt\",\n \"expanded_label\": \"Tax exempt\",\n \"data_type\": \"boolean\",\n \"dedicated\": true,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": null\n },\n {\n \"id\": \"WxVF2o\",\n \"key\": \"tax_id_number\",\n \"label\": \"Tax ID Number\",\n \"expanded_label\": \"Tax ID Number\",\n \"data_type\": \"integer\",\n \"dedicated\": false,\n \"read_only\": false,\n \"archived_at\": null,\n \"created_at\": \"2020-07-13T17:20:08.522Z\"\n }\n ]\n}"}],"_postman_id":"ba736acc-af53-422b-9e50-a3ef59fce20f"}],"id":"b70dead4-1a18-41de-a3ef-043a9e20ef4e","description":"

Data columns are used to serve data for each customer record. These data columns allow the app to filter, format and import/export customer data in a reliable fashion. Read more

\n","_postman_id":"b70dead4-1a18-41de-a3ef-043a9e20ef4e","auth":{"type":"oauth2","oauth2":{"accessToken":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","type":"collection"}}},{"name":"Customers","item":[{"name":"Create customer","id":"8a70d5ee-da8f-4ef0-8b08-9c1882b4da04","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"form_id\": \"Zw6tnQ\",\n\t\"customer\": {\n\t\t\"first_name\": \"Samwise\",\n\t \t\"last_name\": \"Gamgee\",\n\t\t\"email\": \"samy@gmail.com\",\n\t\t\"note\": \"Boil em, mash em, stick em in a stew.\",\n\t\t\"tags\": [\"strong\", \"supporter\"],\n\t\t\"my_custom_column\": \"submitted\",\n\t\t\"tax_id_number\": \"102303\",\n\t\t\"birthday\": \"02/15/1851\",\n\t\t\"meals\": {\n\t\t\t\"breakfast\": \"Eggs and bacon\",\n\t\t\t\"lunch\": \"Sandwhich\",\n\t\t\t\"dinner\": \"Pohtaytoes\"\n\t\t},\n\t\t\"avatar\": \"https://go.theshireriddles.net/uploads/samwise.jpg\",\n\t\t\"default_address\": {\n\t\t\t\"address1\": \"4563 Grass Ln\",\n\t\t\t\"province\": \"Alabama\",\n\t\t\t\"zip\": 852156,\n\t\t\t\"country\": \"United States\"\n\t\t},\n\t\t\"_$form_ids\": [\"Zw6tnQ\"]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/v2/customers","description":"

Create a new customer in Customer Fields and Shopify.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`customer`	Provide an object of key value pairs that relate to data column keys. Any keys that do not belong to a data column will be ignored.
`form_id`	(Optional) The form ID that will be attached to the customer. Note that any settings will be applied to the customer from the form. For example, if the form requires account approval, the customer will be submitted as a pending status.

","auth":{"type":"oauth2","oauth2":{"accessToken":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","type":"collection"}},"urlObject":{"path":["api","v2","customers"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"03509f68-7027-4063-8754-dbc18c1ac54b","name":"Create customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"customer\": {\n\t\t\"first_name\": \"Samwise\",\n\t \t\"last_name\": \"Gamgee\",\n\t\t\"email\": \"samthewise@theshire.com\",\n\t\t\"note\": \"Boil em, mash em, stick em in a stew.\",\n\t\t\"tags\": [\"strong\", \"supporter\"],\n\t\t\"my_custom_column\": \"submitted\",\n\t\t\"tax_id_number\": \"102303\",\n\t\t\"birthday\": \"02/15/1851\",\n\t\t\"meals\": {\n\t\t\t\"breakfast\": \"Eggs and bacon\",\n\t\t\t\"lunch\": \"Sandwhich\",\n\t\t\t\"dinner\": \"Pohtaytoes\"\n\t\t},\n\t\t\"avatar\": \"https://go.theshireriddles.net/uploads/samwise.jpg\",\n\t\t\"default_address\": {\n\t\t\t\"address1\": \"4563 Grass Ln\",\n\t\t\t\"province\": \"Alabama\",\n\t\t\t\"zip\": 852156,\n\t\t\t\"country\": \"United States\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/v2/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"1ed54ccd829ac02dad90eeff2f2a33f2\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"}],"cookie":[],"responseTime":null,"body":"{\n \"customer\": {\n \"id\": \"5f0c9c5bed16b0eef6fcc067\",\n \"shopify_id\": 3186494275631,\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"email\": \"samthewise@theshire.com\",\n \"phone\": \"\",\n \"created_at\": \"2020-07-13T12:39:39-05:00\",\n \"updated_at\": \"2020-07-13T12:39:39-05:00\",\n \"note\": \"Boil em, mash em, stick em in a stew.\",\n \"tags\": [\n \"strong\",\n \"supporter\"\n ],\n \"accepts_marketing\": false,\n \"accepts_marketing_updated_at\": null,\n \"currency\": null,\n \"last_order_id\": null,\n \"last_order_name\": null,\n \"marketing_opt_in_level\": null,\n \"multipass_identifier\": null,\n \"orders_count\": 0,\n \"total_spent\": 0,\n \"average_order_amount\": null,\n \"state\": \"disabled\",\n \"tax_exempt\": false,\n \"tax_exemptions\": [],\n \"verified_email\": null,\n \"admin_graphql_api_id\": null,\n \"addresses\": [\n {\n \"id\": \"3386804371503\",\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"company\": null,\n \"address1\": \"4563 Grass Ln\",\n \"address2\": null,\n \"city\": null,\n \"province\": \"Alabama\",\n \"country\": \"United States\",\n \"zip\": \"852156\",\n \"phone\": \"\",\n \"name\": \"Samwise Gamgee\",\n \"province_code\": \"AL\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"default\": true\n }\n ],\n \"default_address\": {\n \"id\": \"3386804371503\",\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"company\": null,\n \"name\": \"Samwise Gamgee\",\n \"address1\": \"4563 Grass Ln\",\n \"address2\": null,\n \"city\": null,\n \"province\": \"Alabama\",\n \"province_code\": \"AL\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"zip\": \"852156\",\n \"phone\": \"\",\n \"default\": true\n },\n \"has_note\": null,\n \"display_name\": null,\n \"locale\": null,\n \"image\": {},\n \"birthday\": null,\n \"avatar\": {\n \"external\": true,\n \"url\": \"https://go.theshireriddles.net/uploads/samwise.jpg\",\n \"extension\": \"jpg\",\n \"name\": \"samwise.jpg\",\n \"size\": null,\n \"type\": null\n },\n \"tax_id_number\": 102303,\n \"my_custom_column\": \"submitted\",\n \"meals\": {\n \"breakfast\": \"Eggs and bacon\",\n \"dinner\": \"Pohtaytoes\",\n \"lunch\": \"Sandwhich\"\n },\n \"form_ids\": []\n }\n}"}],"_postman_id":"8a70d5ee-da8f-4ef0-8b08-9c1882b4da04"},{"name":"Send account invite","id":"ddfe2f2f-abc3-4410-ab3d-7373b9fda162","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/v2/customers/:id/invite","description":"

Send an account invite to the customer's email.

The customer must have a shopify_id and state must not equal enabled.

\n","auth":{"type":"oauth2","oauth2":{"accessToken":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","type":"collection"}},"urlObject":{"path":["api","v2","customers",":id","invite"],"host":["{{baseURL}}"],"query":[],"variable":[{"type":"string","value":"5f7d044aed16b0587d5380f9","key":"id"}]}},"response":[{"id":"274abf87-e0b5-4719-b85c-3d67121eb15e","name":"Send account invite","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseURL}}/api/v2/customers/:id/invite","host":["{{baseURL}}"],"path":["api","v2","customers",":id","invite"],"variable":[{"key":"id","value":"3035645968431"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"P3P","value":"CP=\"Not used\""},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"07229837d743fd5eef2ee72b72eafd4b\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_customr_session=FvIE%2FgHdvXjYzettl8VLlAEjjD2ABN6nh5dZ7890Y%2Ft97Cr8h3OJBJjlVJWJasjBq%2FmGNXI9dK7Gcz%2BUdmZz3fCRJ%2FhC4eY4KuMwvfl4nHWFuRt7cYeySq7KpvAWVLdDZMb2z%2FmcxQi6J0jgvxeZmm%2F%2FSDPO3vZwNfw1RQ5DtCKnssIXWayZ3TJqHWHUR8arabSWOpSQqgdA6I%2BotnGculrlZYKcnCUT6R3nvgr4uJt3mACbu4HB%2Fo9RO1kLBSwdwk%2FwzdWe8csv%2BQWR1HnHAbSU0qZzdzmPM%2FZigiavN7oWFPlEYGjQj%2FeqXqVk%2FRuHcpbMaYyaP2rBEffoXH5J2K0MelAzL%2BeAPb%2B3looE5PBEP%2FU8K4whaBP6m91EDGHmrqh63BUNWRWz0k529p8aXFCbeyHP8H9pd%2BoipF%2BogAGqWcl7EaAz3KPFE2fb%2FSHrM56IsrGtjpLDIuAY5kG%2BZFrIzvJn6fg4QRnDe6GHqVyYVcJmkdykSAT2lbQydJz7oTgz6RuSRMQt3lBumsyoYs8aForJMGBh%2B%2BDqdMFJIv1d8onfdRj6bm%2Fa637KYjkGq5FT2S5vP%2BsGFfddzOOSrKEn7PKM10M7O6DEHq%2FWZkqbqGH5AZgVSwzqbTC7sBnc5fP6%2Bi%2B5Ofc5qAkTu45xaGmjeXXF%2FM9hZSFVtC76xNyxpSVRwN46uhsRJt3VRl6ywgsyDl4OjUNsp7aiLOoZ4lMli839u5XkUDxj%2FtBBTN3hDCpkaGnm51oLT0CpvCbYdWADwAFOdhNuV1rgXAxzZjenumtf2D231%2FP1042oVrf29rk0T6txvZcFYA62izKM9gGtfztn3KDR3MsBNclhLCGbpK9ihe0KZOeTELBhkfYXaVWJ2ut6nlcEo3ubPBehxha5YlZ%2FvdkZKC407NEfNqGho8LgSgNkFESQO0H0e8DXHFpNtwxnM7nnaU5V%2FtPSBSFtJy6RABnMQ9vc%2Bi46FtDVctsPpH1sdgQ%3D--Bsw19TP0mT2%2FUisn--umXIzji8tuqPx8dohUKJ6g%3D%3D; path=/; expires=Wed, 02 Dec 2020 00:24:07 GMT; HttpOnly"},{"key":"X-Request-Id","value":"2bf560be-02f9-4f78-8322-c7832f049fe4"},{"key":"X-Runtime","value":"0.811552"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"customer_invite\": {\n \"to\": \"john@example.com\",\n \"from\": \"support@yourstore.com\",\n \"subject\": \"Customer account activation\",\n \"custom_message\": \"\",\n \"bcc\": []\n }\n}"}],"_postman_id":"ddfe2f2f-abc3-4410-ab3d-7373b9fda162"},{"name":"Update customer","id":"26b4ad8d-2503-4ac9-bc7f-e8eeeaf89947","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"form_id\": \"gJmtAE\",\n\t\"customer\": {\n\t\t\"note\": \"That there's some good in this world, Mr. Frodo... and it's worth fighting for.\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/v2/customers/:id","description":"

Update an existing customer in Customer Fields and Shopify.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`customer`	Provide an object of key value pairs that relate to data column keys. Any keys that do not belong to a data column will be ignored.
`form_id`	(Optional) Attach as though the customer has submitted a specific form.

The ID or Shopify ID of the customer

\n","type":"text/plain"},"type":"string","value":"5f7e3ce31f5007e341b725f9","key":"id"}]}},"response":[{"id":"1f8fe162-5e11-4316-9349-36e6c75b8958","name":"Update customer by Shopify ID","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"customer\": {\n\t\t\"note\": \"That there's some good in this world, Mr. Frodo... and it's worth fighting for.\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseURL}}/api/v2/customers/:id","host":["{{baseURL}}"],"path":["api","v2","customers",":id"],"variable":[{"key":"id","value":"3186494275631"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"38f48960048fda9fbbdfa6bcaeb81e50\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"}],"cookie":[],"responseTime":null,"body":"{\n \"customer\": {\n \"id\": \"5f0c9c5bed16b0eef6fcc067\",\n \"shopify_id\": 3186494275631,\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"email\": \"samthewise@theshire.com\",\n \"phone\": \"+13605402030\",\n \"created_at\": \"2020-07-13T12:39:39-05:00\",\n \"updated_at\": \"2020-07-13T12:44:14-05:00\",\n \"note\": \"That there's some good in this world, Mr. Frodo... and it's worth fighting for.\",\n \"tags\": [\n \"friendly\"\n ],\n \"accepts_marketing\": false,\n \"accepts_marketing_updated_at\": null,\n \"currency\": null,\n \"last_order_id\": null,\n \"last_order_name\": null,\n \"marketing_opt_in_level\": null,\n \"multipass_identifier\": null,\n \"orders_count\": 0,\n \"total_spent\": 0,\n \"average_order_amount\": null,\n \"state\": \"disabled\",\n \"tax_exempt\": false,\n \"tax_exemptions\": [],\n \"verified_email\": null,\n \"admin_graphql_api_id\": null,\n \"addresses\": [\n {\n \"id\": \"3386804371503\",\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"company\": null,\n \"address1\": \"4563 Grass Ln\",\n \"address2\": null,\n \"city\": null,\n \"province\": \"Alabama\",\n \"country\": \"United States\",\n \"zip\": \"852156\",\n \"phone\": \"\",\n \"name\": \"Samwise Gamgee\",\n \"province_code\": \"AL\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"default\": true\n }\n ],\n \"default_address\": {\n \"id\": \"3386804371503\",\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"company\": null,\n \"name\": \"Samwise Gamgee\",\n \"address1\": \"4563 Grass Ln\",\n \"address2\": null,\n \"city\": null,\n \"province\": \"Alabama\",\n \"province_code\": \"AL\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"zip\": \"852156\",\n \"phone\": \"\",\n \"default\": true\n },\n \"has_note\": null,\n \"display_name\": null,\n \"locale\": null,\n \"image\": {},\n \"birthday\": null,\n \"avatar\": {\n \"external\": true,\n \"url\": \"https://go.theshireriddles.net/uploads/samwise.jpg\",\n \"extension\": \"jpg\",\n \"name\": \"samwise.jpg\",\n \"size\": null,\n \"type\": null\n },\n \"tax_id_number\": 102303,\n \"my_custom_column\": \"submitted\",\n \"meals\": {\n \"breakfast\": \"Eggs and bacon\",\n \"dinner\": \"Pohtaytoes\",\n \"lunch\": \"Chicken roast\"\n },\n \"form_ids\": []\n }\n}"},{"id":"8105a915-217f-44d5-928b-df8dcc998c77","name":"Update customer","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"customer\": {\n\t\t\"phone\": \"+13605402030\",\n\t\t\"meals\": {\n\t\t\t\"lunch\": \"Chicken roast\"\n\t\t},\n\t\t\"tags\": [\"friendly\"]\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseURL}}/api/v2/customers/:id","host":["{{baseURL}}"],"path":["api","v2","customers",":id"],"variable":[{"key":"id","value":"5f0c9c5bed16b0eef6fcc067"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"6014322781baaa345ea153f4f7c56e8d\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"}],"cookie":[],"responseTime":null,"body":"{\n \"customer\": {\n \"id\": \"5f0c9c5bed16b0eef6fcc067\",\n \"shopify_id\": 3186494275631,\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"email\": \"samthewise@theshire.com\",\n \"phone\": \"+13605402030\",\n \"created_at\": \"2020-07-13T12:39:39-05:00\",\n \"updated_at\": \"2020-07-13T12:43:02-05:00\",\n \"note\": \"Boil em, mash em, stick em in a stew.\",\n \"tags\": [\n \"friendly\"\n ],\n \"accepts_marketing\": false,\n \"accepts_marketing_updated_at\": null,\n \"currency\": null,\n \"last_order_id\": null,\n \"last_order_name\": null,\n \"marketing_opt_in_level\": null,\n \"multipass_identifier\": null,\n \"orders_count\": 0,\n \"total_spent\": 0,\n \"average_order_amount\": null,\n \"state\": \"disabled\",\n \"tax_exempt\": false,\n \"tax_exemptions\": [],\n \"verified_email\": null,\n \"admin_graphql_api_id\": null,\n \"addresses\": [\n {\n \"id\": \"3386804371503\",\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"company\": null,\n \"address1\": \"4563 Grass Ln\",\n \"address2\": null,\n \"city\": null,\n \"province\": \"Alabama\",\n \"country\": \"United States\",\n \"zip\": \"852156\",\n \"phone\": \"\",\n \"name\": \"Samwise Gamgee\",\n \"province_code\": \"AL\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"default\": true\n }\n ],\n \"default_address\": {\n \"id\": \"3386804371503\",\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"company\": null,\n \"name\": \"Samwise Gamgee\",\n \"address1\": \"4563 Grass Ln\",\n \"address2\": null,\n \"city\": null,\n \"province\": \"Alabama\",\n \"province_code\": \"AL\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"zip\": \"852156\",\n \"phone\": \"\",\n \"default\": true\n },\n \"has_note\": null,\n \"display_name\": null,\n \"locale\": null,\n \"image\": {},\n \"birthday\": null,\n \"avatar\": {\n \"external\": true,\n \"url\": \"https://go.theshireriddles.net/uploads/samwise.jpg\",\n \"extension\": \"jpg\",\n \"name\": \"samwise.jpg\",\n \"size\": null,\n \"type\": null\n },\n \"tax_id_number\": 102303,\n \"my_custom_column\": \"submitted\",\n \"meals\": {\n \"breakfast\": \"Eggs and bacon\",\n \"dinner\": \"Pohtaytoes\",\n \"lunch\": \"Chicken roast\"\n },\n \"form_ids\": []\n }\n}"}],"_postman_id":"26b4ad8d-2503-4ac9-bc7f-e8eeeaf89947"},{"name":"Show customer","id":"872b62d2-1a31-4262-8ba0-0d0d49297397","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseURL}}/api/v2/customers/:id","description":"

Get a customer by ID (unique to our app) or Shopify ID.

The ID or Shopify ID of the customer

\n","type":"text/plain"},"type":"string","value":"3186494275631","key":"id"}]}},"response":[{"id":"cc123707-db8d-4133-8179-0fd3a142b204","name":"Show customer","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{baseURL}}/api/v2/customers/:id","host":["{{baseURL}}"],"path":["api","v2","customers",":id"],"variable":[{"key":"id","value":"3186494275631"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"38f48960048fda9fbbdfa6bcaeb81e50\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"}],"cookie":[],"responseTime":null,"body":"{\n \"customer\": {\n \"id\": \"5f0c9c5bed16b0eef6fcc067\",\n \"shopify_id\": 3186494275631,\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"email\": \"samthewise@theshire.com\",\n \"phone\": \"+13605402030\",\n \"created_at\": \"2020-07-13T12:39:39-05:00\",\n \"updated_at\": \"2020-07-13T12:44:14-05:00\",\n \"note\": \"That there's some good in this world, Mr. Frodo... and it's worth fighting for.\",\n \"tags\": [\n \"friendly\"\n ],\n \"accepts_marketing\": false,\n \"accepts_marketing_updated_at\": null,\n \"currency\": null,\n \"last_order_id\": null,\n \"last_order_name\": null,\n \"marketing_opt_in_level\": null,\n \"multipass_identifier\": null,\n \"orders_count\": 0,\n \"total_spent\": 0,\n \"average_order_amount\": null,\n \"state\": \"disabled\",\n \"tax_exempt\": false,\n \"tax_exemptions\": [],\n \"verified_email\": null,\n \"admin_graphql_api_id\": null,\n \"addresses\": [\n {\n \"id\": \"3386804371503\",\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"company\": null,\n \"address1\": \"4563 Grass Ln\",\n \"address2\": null,\n \"city\": null,\n \"province\": \"Alabama\",\n \"country\": \"United States\",\n \"zip\": \"852156\",\n \"phone\": \"\",\n \"name\": \"Samwise Gamgee\",\n \"province_code\": \"AL\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"default\": true\n }\n ],\n \"default_address\": {\n \"id\": \"3386804371503\",\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"company\": null,\n \"name\": \"Samwise Gamgee\",\n \"address1\": \"4563 Grass Ln\",\n \"address2\": null,\n \"city\": null,\n \"province\": \"Alabama\",\n \"province_code\": \"AL\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"zip\": \"852156\",\n \"phone\": \"\",\n \"default\": true\n },\n \"has_note\": null,\n \"display_name\": null,\n \"locale\": null,\n \"image\": {},\n \"birthday\": null,\n \"avatar\": {\n \"external\": true,\n \"url\": \"https://go.theshireriddles.net/uploads/samwise.jpg\",\n \"extension\": \"jpg\",\n \"name\": \"samwise.jpg\",\n \"size\": null,\n \"type\": null\n },\n \"tax_id_number\": 102303,\n \"my_custom_column\": \"submitted\",\n \"meals\": {\n \"breakfast\": \"Eggs and bacon\",\n \"dinner\": \"Pohtaytoes\",\n \"lunch\": \"Chicken roast\"\n },\n \"form_ids\": []\n }\n}"}],"_postman_id":"872b62d2-1a31-4262-8ba0-0d0d49297397"},{"name":"Search customers","id":"91aeb44a-7cfa-4e1f-ace3-ed0acbbdfb1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"{{baseURL}}/api/v2/customers/search.json?page=1&limit=50&sort_by=updated_at&sort_order=desc&form_id=Z70tao&id=5e3d7b09ed16b065c8b0e5cb&shopify_id=898586116143&email=test@example.com&phone=+12345467994","description":"

Search all customers.

The page to view

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The total amount of customers to display per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

How to sort the customers, acceptable values are \"updated_at\", \"created_at\", and \"email\"

\n","type":"text/plain"},"key":"sort_by","value":"updated_at"},{"description":{"content":"

\"desc\" or \"asc\"

\n","type":"text/plain"},"key":"sort_order","value":"desc"},{"description":{"content":"

The ID of the form to filter by

\n","type":"text/plain"},"key":"form_id","value":"Z70tao"},{"description":{"content":"

The ID of a customer

\n","type":"text/plain"},"key":"id","value":"5e3d7b09ed16b065c8b0e5cb"},{"description":{"content":"

The Shopify ID of a customer

\n","type":"text/plain"},"key":"shopify_id","value":"898586116143"},{"description":{"content":"

The email of a customer

\n","type":"text/plain"},"key":"email","value":"test@example.com"},{"description":{"content":"

The phone number of a customer (international format)

\n","type":"text/plain"},"key":"phone","value":"+12345467994"}],"variable":[]}},"response":[{"id":"a01d1b44-d4aa-4b8c-88f1-ed22947f0593","name":"Search customers by email","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":{"raw":"{{baseURL}}/api/v2/customers/search.json?page=1&limit=50&sort_by=updated_at&sort_order=desc&email=samthewise@theshire.com","host":["{{baseURL}}"],"path":["api","v2","customers","search.json"],"query":[{"key":"page","value":"1","description":"The page to view"},{"key":"limit","value":"50","description":"The total amount of customers to display per page"},{"key":"sort_by","value":"updated_at","description":"How to sort the customers, acceptable values are \"updated_at\", \"created_at\", and \"email\""},{"key":"sort_order","value":"desc","description":"\"desc\" or \"asc\""},{"key":"form_id","value":"Z70tao","description":"The ID of the form to filter by","disabled":true},{"key":"id","value":"5e3d7b09ed16b065c8b0e5cb","description":"The ID of a customer","disabled":true},{"key":"shopify_id","value":"898586116143","description":"The Shopify ID of a customer","disabled":true},{"key":"email","value":"samthewise@theshire.com","description":"The email of a customer"},{"key":"phone","value":"+12345467994","description":"The phone number of a customer (international format)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"de37e64892b22899b0751028a47e3e6b\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"}],"cookie":[],"responseTime":null,"body":"{\n \"customers\": [\n {\n \"id\": \"5f0c9c5bed16b0eef6fcc067\",\n \"shopify_id\": 3186494275631,\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"email\": \"samthewise@theshire.com\",\n \"phone\": \"+13605402030\",\n \"created_at\": \"2020-07-13T12:39:39-05:00\",\n \"updated_at\": \"2020-07-13T12:44:14-05:00\",\n \"note\": \"That there's some good in this world, Mr. Frodo... and it's worth fighting for.\",\n \"tags\": [\n \"friendly\"\n ],\n \"accepts_marketing\": false,\n \"accepts_marketing_updated_at\": null,\n \"currency\": null,\n \"last_order_id\": null,\n \"last_order_name\": null,\n \"marketing_opt_in_level\": null,\n \"multipass_identifier\": null,\n \"orders_count\": 0,\n \"total_spent\": 0,\n \"average_order_amount\": null,\n \"state\": \"disabled\",\n \"tax_exempt\": false,\n \"tax_exemptions\": [],\n \"verified_email\": null,\n \"admin_graphql_api_id\": null,\n \"addresses\": [\n {\n \"id\": \"3386804371503\",\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"company\": null,\n \"address1\": \"4563 Grass Ln\",\n \"address2\": null,\n \"city\": null,\n \"province\": \"Alabama\",\n \"country\": \"United States\",\n \"zip\": \"852156\",\n \"phone\": \"\",\n \"name\": \"Samwise Gamgee\",\n \"province_code\": \"AL\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"default\": true\n }\n ],\n \"default_address\": {\n \"id\": \"3386804371503\",\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"company\": null,\n \"name\": \"Samwise Gamgee\",\n \"address1\": \"4563 Grass Ln\",\n \"address2\": null,\n \"city\": null,\n \"province\": \"Alabama\",\n \"province_code\": \"AL\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"zip\": \"852156\",\n \"phone\": \"\",\n \"default\": true\n },\n \"has_note\": null,\n \"display_name\": null,\n \"locale\": null,\n \"image\": {},\n \"birthday\": null,\n \"avatar\": {\n \"external\": true,\n \"url\": \"https://go.theshireriddles.net/uploads/samwise.jpg\",\n \"extension\": \"jpg\",\n \"name\": \"samwise.jpg\",\n \"size\": null,\n \"type\": null\n },\n \"tax_id_number\": 102303,\n \"my_custom_column\": \"submitted\",\n \"meals\": {\n \"breakfast\": \"Eggs and bacon\",\n \"dinner\": \"Pohtaytoes\",\n \"lunch\": \"Chicken roast\"\n },\n \"form_ids\": []\n }\n ]\n}"}],"_postman_id":"91aeb44a-7cfa-4e1f-ace3-ed0acbbdfb1e"}],"id":"063da16c-a04f-4303-910b-cd4b5241e587","description":"

Find, add, and update customers with custom data. We'll save any Shopify data columns directly to Shopify along with a custom metafield.

Account approval

In addition to Shopify's state values, we provide the following additional state values:\ncf:pending and cf:denied. These states are used specifically for account approval forms. If you submit a customer via a form that has this setting enabled, the customer's state will be set to cf:pending. Whenever a customer is in either of these states, the customer won't be saved to Shopify until they've been approved.

\n","event":[{"listen":"prerequest","script":{"id":"e1fa049e-e48c-4583-8a61-eeeb12c97474","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e3bd36e7-bc19-4126-9ed6-ee189dff4a24","type":"text/javascript","exec":[""]}}],"_postman_id":"063da16c-a04f-4303-910b-cd4b5241e587","auth":{"type":"oauth2","oauth2":{"accessToken":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","type":"collection"}}},{"name":"Forms","item":[{"name":"List forms","id":"133780bc-a076-4aab-acb1-4bb72a30a707","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseURL}}/api/v2/forms","description":"

Get a list of non-archived forms.

Forms provide a way for merchants to gather data from their customers using our form builder tool.

\n","_postman_id":"fefaf1d9-0ee4-4959-90e0-db3765a279b0","auth":{"type":"oauth2","oauth2":{"accessToken":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","type":"collection"}}},{"name":"Segments","item":[{"name":"List segments","id":"d12f6f7a-4882-41e2-aeb4-68d57c0946e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseURL}}/api/v2/segments.json","description":"

Get a list of segments. Note, each segment has a allow_subscriptions field, which indicates whether or not a webhook can be subscribe to that segment.

Get a segment by ID.

The ID of the segment

\n","type":"text/plain"},"type":"string","value":"5f0c9ff3ed16b0eef6fcc296","key":"id.json"}]}},"response":[{"id":"5df088b9-e618-448b-b0c9-107435a35417","name":"Show segment","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{baseURL}}/api/v2/segments/:id.json","host":["{{baseURL}}"],"path":["api","v2","segments",":id.json"],"variable":[{"key":"id.json","value":"5f0c9ff3ed16b0eef6fcc296"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"ETag","value":"W/\"8d12eeeacb6ea438372211acc4efc38b\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"}],"cookie":[],"responseTime":null,"body":"{\n \"segment\": {\n \"id\": \"5f0c9ff3ed16b0eef6fcc296\",\n \"name\": \"The Shire\",\n \"created_at\": \"2020-07-13T17:54:59.816Z\",\n \"updated_at\": \"2020-07-13T17:55:26.678Z\",\n \"processing\": false,\n \"reference_version\": 1,\n \"search\": {\n \"chaining\": \"all\",\n \"sort_key\": \"updated_at\",\n \"sort_direction\": -1,\n \"data_column_keys\": [\n \"first_name\",\n \"last_name\",\n \"email\",\n \"updated_at\",\n \"avatar\"\n ],\n \"filter_groups\": [\n {\n \"chaining\": \"all\",\n \"filters\": [\n {\n \"type\": \"data_column\",\n \"key\": \"email\",\n \"dataType\": \"email\",\n \"operator\": \"email_domain_equals\",\n \"term\": {\n \"value\": \"theshire.com\"\n }\n }\n ]\n }\n ]\n }\n }\n}"}],"_postman_id":"2ed300ab-81d7-4214-b9a0-5071d536fd25"},{"name":"List segment customers","id":"12b8df31-b4ba-4cb8-a175-a96f9b73c09f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseURL}}/api/v2/segments/:id/customers.json?page=1&limit=50&sort_by=updated_at&sort_order=desc","description":"

Get a list of customers associated with a segment.

The page to view

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The total amount of customers to display per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

How to sort the customers, acceptable values are \"updated_at\" and \"created_at\"

\n","type":"text/plain"},"key":"sort_by","value":"updated_at"},{"description":{"content":"

\"desc\" or \"asc\"

\n","type":"text/plain"},"key":"sort_order","value":"desc"}],"variable":[{"id":"631e1c49-4745-4334-b7db-976c7c6748c8","description":{"content":"

The ID of the segment

\n","type":"text/plain"},"type":"string","value":"5f0c9ff3ed16b0eef6fcc296","key":"id"}]}},"response":[{"id":"94098ecd-a0cd-4b99-895b-65660ed4f6b0","name":"List segment customers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{baseURL}}/api/v2/segments/:id/customers.json?page=1&limit=50&sort_by=updated_at&sort_order=desc","host":["{{baseURL}}"],"path":["api","v2","segments",":id","customers.json"],"query":[{"key":"page","value":"1","description":"The page to view"},{"key":"limit","value":"50","description":"The total amount of customers to display per page"},{"key":"sort_by","value":"updated_at","description":"How to sort the customers, acceptable values are \"updated_at\" and \"created_at\""},{"key":"sort_order","value":"desc","description":"\"desc\" or \"asc\""}],"variable":[{"key":"id","value":"5f0c9ff3ed16b0eef6fcc296"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"ETag","value":"W/\"1cf7c4e9a23ff858024d0a265a010c0e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"}],"cookie":[],"responseTime":null,"body":"{\n \"customers\": [\n {\n \"id\": \"5f0c9c5bed16b0eef6fcc067\",\n \"shopify_id\": 3186494275631,\n \"first_name\": \"Samwise\",\n \"last_name\": \"Gamgee\",\n \"email\": \"samthewise@theshire.com\",\n \"updated_at\": \"2020-07-13T12:55:26-05:00\",\n \"avatar\": {\n \"name\": null,\n \"url\": null,\n \"extension\": null,\n \"size\": null,\n \"type\": null\n },\n \"addresses\": [],\n \"tags\": [],\n \"created_at\": \"2020-07-13T12:39:39-05:00\",\n \"form_ids\": [],\n \"accepts_marketing\": null,\n \"last_order_id\": null,\n \"last_order_name\": null,\n \"note\": null,\n \"orders_count\": null,\n \"phone\": null,\n \"state\": null,\n \"tax_exempt\": null,\n \"total_spent\": null,\n \"default_address\": null\n }\n ]\n}"}],"_postman_id":"12b8df31-b4ba-4cb8-a175-a96f9b73c09f"}],"id":"84df03e2-4501-4069-9c1a-9f8799d7b726","description":"

Segments allow merchants to group customers by a list of filters.

\n","_postman_id":"84df03e2-4501-4069-9c1a-9f8799d7b726","auth":{"type":"oauth2","oauth2":{"accessToken":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Create webhook","id":"0824dffa-8d67-4b90-828b-289f7fd46899","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"topic\": \"customers/form_submit\",\n \"resource_id\": \"k8Mks2\",\n \"url\": \"https://example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/v2/webhooks.json","description":"

Subscribe to a new webhook.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`topic`	A topic to subscribe to, see available topics above.
`url`	The URL to deliver to the webhook to
`resource_id`	Depending on the topic, supply the ID of the resource you're subscribing to. Required depending on the topic.
`reference_id` (optional)	A unique string to uniquely identify this hook. This is helpful if you need multiple hooks for different purposes. If you do not provide this for the same topic, the existing webhook will be returned.

","auth":{"type":"oauth2","oauth2":{"accessToken":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","type":"collection"}},"urlObject":{"path":["api","v2","webhooks.json"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"9f69c711-2e91-4166-b2fd-a008f413bd22","name":"One webhook per topic without a reference ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"topic\": \"customers/create\",\n\t\"url\": \"https://hooks.yourapp.com/customers/create\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/v2/webhooks.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"P3P","value":"CP=\"Not used\""},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"4d4688cdc705f3810af5533c0e6c9b3a\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"afa76b60-5f74-48f7-8d65-969bf3d5c6f8"},{"key":"X-Runtime","value":"0.015633"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"webhook\": {\n \"id\": \"1M8fNj\",\n \"topic\": \"customers/create\",\n \"url\": \"https://hooks.yourapp.com/customers/create\",\n \"resource_id\": null,\n \"reference_id\": null,\n \"created_at\": \"2020-07-13T18:00:56.068Z\",\n \"updated_at\": \"2020-07-13T18:00:56.068Z\"\n }\n}"},{"id":"e04d575d-e9fc-49e7-b668-03d298ddfc80","name":"Create form submit webhook","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"topic\": \"customers/form_submit\",\n\t\"url\": \"https://hooks.yourapp.com/customers/create\",\n\t\"reference_id\": \"my_reference_id\",\n\t\"resource_id\": \"Z70tao\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/v2/webhooks.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"dbb4d32a2c6db019fbf1be6511f63147\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"}],"cookie":[],"responseTime":null,"body":"{\n \"webhook\": {\n \"id\": \"kw8fro\",\n \"topic\": \"customers/form_submit\",\n \"url\": \"https://hooks.yourapp.com/customers/create\",\n \"resource_id\": \"Z70tao\",\n \"reference_id\": \"my_reference_id\",\n \"created_at\": \"2020-07-13T17:57:25.500Z\",\n \"updated_at\": \"2020-07-13T17:57:25.500Z\"\n }\n}"}],"_postman_id":"0824dffa-8d67-4b90-828b-289f7fd46899"},{"name":"List webhooks","id":"b737be4f-6e21-498d-8592-1f1c68d36251","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/api/v2/webhooks.json","description":"

Get a list of webhooks your app is subscribed to.

Unsubscribe to a webhook, by topic and reference_id.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`topic`	The topic to unsubscribe.
`reference_id`	The `reference_id` you provided when creating the webhook, which allows you to create multiple hooks for the same topic.

Webhooks allow you to subscribe to changes as they occur.

Verification

To verify the request is authentic, you may compare the X-Hmac-Signature header value with a digest of the response body. This is accomplished exactly how Shopify signs requests, refer to their docs for more info. We also provide a X-Shopify-Shop-Domain header, which is the myshopify domain associated with the account. If you're using a Personal Access token, a predefined (unchanging) signature will be generated for you which can be used for every request.

Retries

We'll attempt to send a request to the URL you provide. If we receive a non-200 response more than 40 times, we'll remove your webhook. This will happen over the course of around 7 days with exponential backoff.

Topics

You may subscribe to the following topics:

Topic	Description
`customers/create`	Triggers when a customer is created
`customers/update`	Triggers when a customer is updated
`customers/form_submit`	Triggers when a customer submits a form. Pass the form ID as the resource_id.
`customers/event_add`	Triggers when a customer event happens. Pass the event name as the resource_id.
`segments/customer_add`	Triggers when a customer is added to a segment. The segment must not contain relative date or event filters. Pass the segment ID as the resource_id.

","event":[{"listen":"prerequest","script":{"id":"c1ab3203-106a-4ffe-b49e-6d04050f086f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a480936c-ca40-44ca-bbf2-fe7166ffae06","type":"text/javascript","exec":[""]}}],"_postman_id":"85772d2d-5e78-442d-94b7-7cd16fc619c0","auth":{"type":"oauth2","oauth2":{"accessToken":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","type":"collection"}}},{"name":"Shop","item":[{"name":"Get shop","id":"5fa74c58-72f0-4943-8c05-3467f21fe2b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseURL}}/api/v2/shop.json","description":"

Get basic information about the authenticated shop.

Get a list of event names that have occurred.

Details about the shop

\n","_postman_id":"1a308bd6-b290-4e71-9b60-6f7f65457b27","auth":{"type":"oauth2","oauth2":{"accessToken":"{{accessToken}}"},"isInherited":true,"source":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"accessToken":"{{accessToken}}"}},"event":[{"listen":"prerequest","script":{"id":"2377708b-21b8-44cd-9a90-39f2fd1feb2e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3f3424e3-d45d-4bbf-adea-a036c95b80ae","type":"text/javascript","exec":[""]}}]}