{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","name":"Rest API (V2)","description":"This API allows developers to interact with the app [Customer Fields](https://customerfields.com/) for [Shopify](https://www.shopify.com/).\n\nWe'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](https://developers.customerfields.com/), which covers in detail other aspects of developing with Customer Fields.\n\n# About Customer Fields\n\n#### What does Customer Fields do?\n\nCustomer 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.\n\n#### Who makes Customer Fields?\n\n[Helium](https://heliumdev.com) does! We're a small (but energetic) team based in the Seattle area.\n\n#### What is this API for?\n\nIt'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](mailto:support@heliumdev.com).\n\nSince 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.\n\nYou 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](https://developers.customerfields.com/customer-api/).\n\n#### Can I use the Shopify API instead?\n\nThat depends. If all you require is to get and set custom data on a customer's record, you can use [two-way metafield syncing](https://developers.customerfields.com/metafields/) while only using Shopify's API. If you'd like additional functionality, you'll need to consult this API.\n\n# Rate limits\n\nWe 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.\n\nAt any point if we receive a `429 Too Many Requests` from Shopify, we'll respond in kind.\n\n# Authentication\n\n#### Public apps\n\nIf 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](mailto:support@heliumdev.com). We'll set you up with your own app credentials so that your merchants can authenticate via OAuth2.\n\n#### Private apps\n\nIf 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.\n\n#### Using an access token\n\nOnce you've obtained an access token (through OAuth or private access), use this token in the header of each request, following standard OAuth format:\n\n```\nAuthorization: Bearer YOUR_API_TOKEN\n\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"843214","team":749490,"collectionId":"2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","publishedId":"T17Nc5vV","public":true,"publicUrl":"https://docs.customerfields.com","privateUrl":"https://go.postman.co/documentation/843214-2a5f0835-2c73-41d5-a2e4-ae3ad4ee1d07","customColor":{"top-bar":"FFFFFF","right-sidebar":"160A2C","highlight":"40A5FF"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-07-14T21:48:28.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Production","id":"846551a4-5faa-4121-b9b2-67f123c3d9ea","owner":"843214","values":[{"key":"baseURL","value":"https://app.customerfields.com","enabled":true},{"key":"accessToken","value":"__YOUR_ACCESS_TOKEN__","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d77a124c19034cda9ec644649b4c383363a6ceb15f95fde89bedce7ca4c38006","favicon":"https://customerfields.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"843214-846551a4-5faa-4121-b9b2-67f123c3d9ea"}],"canonicalUrl":"https://docs.customerfields.com/view/metadata/T17Nc5vV"}