{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"651edbbe-252f-4547-9899-7f7b61def37a","name":"Button Product API","description":"The Button Product API with support for:\n\n* Resolving a `product` from a retailer URL\n* Resolving a `product` from a retailer name & identifier\n* Searching for retailer `product`s with a GTIN\n\n## Notes\n* Product API keys are currrently limited to 1 QPS\n<br /><br />\n---\n<br /><br />\n# Authentication\nAuthentication to the Button Product API is done via the `key` query parameter.\n\nAll requests must contain `key`. If you do not have a Product API `key` and think you should - reach out to support@usebutton.com.\n<br /><br />\n---\n<br /><br />\n# API Location\nThe Button Product API is located at:\n\n`https://product-api.button-labs.com/preview/`\n\nAll endpoints are to support investigation of the Product API rather than their final integration point into the Button Product Suite.\n<br /><br />\n---\n<br /><br />\n# Product Object\nThe Product object represents a specific product at a specific retailer. Metadata is intentionally kept separate per-retailer (e.g. descriptions) to maintain merchandising.\n\n## Fields\n|Field|Value|\n|---|---|\n| `id` | The Button ID for this retailer product |\n| `retailer` | Retailer identifier (the root of the retailer domain, excluding tld & www) |\n| `product_id` | The retailer's internal ID for this product |\n| `url` | The public URL for this product |\n| `title` | The retailer's displayed name for the product |\n| `description` | The retailer's on-site description for the product |\n| `image_url` | Product display image |\n| `price` | Price (string) |\n| `currency` | Currency code for the price |\n| `gtin` | The GS1 GTIN for this product |\n| `mpn` | The manufacturer's unique ID for this product |\n| `in_stock` | Stock status - [\"Y\", \"N\", null] |\n| `sku` | The retailer's stock keeping unit for this product |\n| `category` | Retailer's unstructured category (_Note: Categories will likely change ahead of general availability_) |\n| `manufacturer` | The brand manufacturer of the product |\n\n<br /><br />\n## Example\n\n```\n{\n      \"id\": \"ed14bf7a4a0e8e2e897caa322b44acfcbaf96218\",\n      \"retailer\": \"target\",\n      \"product_id\": \"14709595\",\n      \"url\": \"https://www.target.com/p/justin-s-organic-dark-chocolate-peanut-butter-cups-1-4oz/-/A-14709595\",\n      \"title\": \"Justin's Organic Dark Chocolate Peanut Butter Cups - 1.4oz\",\n      \"description\": \"Dark Chocolate Peanut Butter Cup: If you’re reading this then you deserve a peanut butter cup.........\",\n      \"image_url\": \"https://target.scene7.com/is/image/Target/GUEST_5494b3b7-c074-439a-aee6-dbfa0a87b5ba?wid=1000&hei=1000\",\n      \"price\": \"2.19\",\n      \"currency\": \"USD\",\n      \"gtin\": \"894455000254\",\n      \"mpn\": \"14709595\",\n      \"in_stock\": \"Y\",\n      \"sku\": null,\n      \"category\": \"Food, Beverages & Tobacco > Food Items > Candy & Chocolate\",\n      \"manufacturer\": \"Justin's\"\n    }\n```\n\n<br /><br />\n---\n<br /><br />\n# Usage","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10028658","team":646067,"collectionId":"651edbbe-252f-4547-9899-7f7b61def37a","publishedId":"Szt7AqTj","public":true,"publicUrl":"https://developer.button-labs.com","privateUrl":"https://go.postman.co/documentation/10028658-651edbbe-252f-4547-9899-7f7b61def37a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0077FF"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.4","publishDate":"2020-05-21T19:31:03.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/239f857f08940f444b35f3cf94e900bf37dcd8b065ed5ced0514ce533badf3bf","favicon":"https://res.cloudinary.com/postman/image/upload/v1590160231/team/kwyzsfs7njzoqpwyhbdb.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"}],"canonicalUrl":"https://developer.button-labs.com/view/metadata/Szt7AqTj"}