{"_id":"58112e73ded0340f0085d061","category":{"_id":"58112e72ded0340f0085d034","project":"551e85be610f400d00837db7","version":"58112e71ded0340f0085d02a","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-18T15:57:19.874Z","from_sync":false,"order":9,"slug":"api-subresources","title":"Merchant API Subresources"},"project":"551e85be610f400d00837db7","version":{"_id":"58112e71ded0340f0085d02a","project":"551e85be610f400d00837db7","__v":4,"createdAt":"2016-10-26T22:30:09.862Z","releaseDate":"2016-10-26T22:30:09.862Z","categories":["58112e72ded0340f0085d02b","58112e72ded0340f0085d02c","58112e72ded0340f0085d02d","58112e72ded0340f0085d02e","58112e72ded0340f0085d02f","58112e72ded0340f0085d030","58112e72ded0340f0085d031","58112e72ded0340f0085d032","58112e72ded0340f0085d033","58112e72ded0340f0085d034","581137cc604d3c230048b7e4","58dc367221742d0f00a73f98","590768e54669da0f00db5c0b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"new designer","version_clean":"2.0.0","version":"2.0"},"__v":0,"parentDoc":null,"user":"56439928549c4d0d00d7e910","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-02T14:54:40.414Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"Metadata lets you attach non-variant customer preference or metrics data to a subscription, cart, customer, or shipment, which can then be viewed on the customer’s subscription details page, shipment exports, or via either the Store or Merchant API.\n\nFor example, you may want to track the advertising campaign that brought a customer to your site. By adding metadata for the campaign, you could calculate lifetime value of customers correlated to advertising campaigns.\n\nMetadata can be added to a customer’s subscription via either the [Store API](doc:introduction) from JavaScript on the store's website or the [Merchant API](doc:introduction-1) from an external process.\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"In Spring 2016 we added a new [survey builder](https://cratejoy.zendesk.com/hc/en-us/articles/203402339-Add-a-customer-survey-to-your-subscribe-flow). While metadata still exists and can be added to objects, custom-coded forms that collect information from subscribers is not recommended.\",\n  \"title\": \"Metadata should not be used for surveys\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Using Marketplace?\",\n  \"body\": \"Collecting metadata will **not** be reflected on your marketplace listing. If you need to collect additional information from your subscribers, you should use the [survey builder](https://cratejoy.zendesk.com/hc/en-us/articles/203402339-Add-a-customer-survey-to-your-subscribe-flow) on the subscription product page.\"\n}\n[/block]","excerpt":"","slug":"metadata","type":"basic","title":"Metadata"}
Metadata lets you attach non-variant customer preference or metrics data to a subscription, cart, customer, or shipment, which can then be viewed on the customer’s subscription details page, shipment exports, or via either the Store or Merchant API. For example, you may want to track the advertising campaign that brought a customer to your site. By adding metadata for the campaign, you could calculate lifetime value of customers correlated to advertising campaigns. Metadata can be added to a customer’s subscription via either the [Store API](doc:introduction) from JavaScript on the store's website or the [Merchant API](doc:introduction-1) from an external process. [block:callout] { "type": "danger", "body": "In Spring 2016 we added a new [survey builder](https://cratejoy.zendesk.com/hc/en-us/articles/203402339-Add-a-customer-survey-to-your-subscribe-flow). While metadata still exists and can be added to objects, custom-coded forms that collect information from subscribers is not recommended.", "title": "Metadata should not be used for surveys" } [/block] [block:callout] { "type": "warning", "title": "Using Marketplace?", "body": "Collecting metadata will **not** be reflected on your marketplace listing. If you need to collect additional information from your subscribers, you should use the [survey builder](https://cratejoy.zendesk.com/hc/en-us/articles/203402339-Add-a-customer-survey-to-your-subscribe-flow) on the subscription product page." } [/block]