{"info":{"_postman_id":"8f1722ba-fa71-4a05-abf1-0ba6b2884615","name":"Capture API","description":"<html><head></head><body><p>The Capture API is for customers to integrate their systems to retrieve product and image data via RESTful APIs. </p>\n<h1 id=\"getting-started\">Getting Started</h1>\n<h1 id=\"access-keys\">Access Keys</h1>\n<p><strong>Access Keys</strong><br>You will need one key to access the API. The key will be provided to you by your Customer Success contact. \nAuthentication is accomplished by setting the <code>x-api-key</code> in the request header. The API is not accessible without these keys.  </p>\n<p><strong>CORS</strong><br>The API currently doesn’t support CORS requests.</p>\n<p><strong>HTTP Methods</strong><br>The API currently supports the GET method. The GET method is used to retrieve product data.</p>\n<p><em><strong>Serialization Formats</strong></em><br>The API supports JSON data. </p>\n<h1 id=\"api-responses\">API Responses</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Response Codes</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>Success</td>\n</tr>\n<tr>\n<td>403</td>\n<td>Invalid API key, missing x-api-key header, or invalid URL</td>\n</tr>\n<tr>\n<td>404</td>\n<td>There is no user associated with the api key provided</td>\n</tr>\n</tbody>\n</table>\n</div></body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Access Keys","slug":"access-keys"},{"content":"API Responses","slug":"api-responses"}],"owner":"1621635","collectionId":"8f1722ba-fa71-4a05-abf1-0ba6b2884615","publishedId":"RW83Qsfw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-05-15T17:22:34.000Z"},"item":[{"name":"Paged Product Search","id":"c1804140-3f0f-46f6-9c20-567ea7549a4f","request":{"method":"GET","header":[{"key":"x-api-key","value":"string","description":"<p>Authentication identifying your organization</p>\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capture-api.labelinsight.com/products?variantId=String&providedUpc=String&providedBrandName=String&providedCategory=String&page=integer&size=integer&sort=String","description":"<p>Search for products</p>\n","urlObject":{"protocol":"https","path":["products"],"host":["capture-api","labelinsight","com"],"query":[{"description":{"content":"<p>Case insensitive Variant ID contains text filter</p>\n","type":"text/plain"},"key":"variantId","value":"String"},{"description":{"content":"<p>Case insensitive Provided UPC contains text filt</p>\n","type":"text/plain"},"key":"providedUpc","value":"String"},{"description":{"content":"<p>Case insensitive Provided Brand Name contains text filter</p>\n","type":"text/plain"},"key":"providedBrandName","value":"String"},{"description":{"content":"<p>Case insensitive Provided Category contains text filter</p>\n","type":"text/plain"},"key":"providedCategory","value":"String"},{"description":{"content":"<p>Page number starting at 0</p>\n","type":"text/plain"},"key":"page","value":"integer"},{"description":{"content":"<p>Page size (max 100)</p>\n","type":"text/plain"},"key":"size","value":"integer"},{"description":{"content":"<p>Sorting on any of the filterable fields, with either <code>asc</code> or <code>desc</code> order</p>\n","type":"text/plain"},"key":"sort","value":"String"}],"variable":[]}},"response":[{"id":"8256c629-1ba6-467e-8322-68f1b75244a9","name":"Paged Product Search","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"string","description":"Authentication identifying your organization"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://capture-api.labelinsight.com/products?variantId=String&providedUpc=String&providedBrandName=String&providedCategory=String&page=integer&size=integer&sort=String","protocol":"https","host":["capture-api","labelinsight","com"],"path":["products"],"query":[{"key":"variantId","value":"String","description":"Case insensitive Variant ID contains text filter"},{"key":"providedUpc","value":"String","description":"Case insensitive Provided UPC contains text filt"},{"key":"providedBrandName","value":"String","description":"Case insensitive Provided Brand Name contains text filter"},{"key":"providedCategory","value":"String","description":"Case insensitive Provided Category contains text filter"},{"key":"page","value":"integer","description":"Page number starting at 0"},{"key":"size","value":"integer","description":"Page size (max 100)"},{"key":"sort","value":"String","description":"Sorting on any of the filterable fields, with either 'asc' or 'desc' order"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\n  \"currentPage\": 0,\n  \"elementsInCurrentPage\": 0,\n  \"totalElements\": 0,\n  \"totalPages\": 0,\n  \"results\": [\n    {\n      \"variantId\": \"string\",\n      \"ingestionDate\": \"2018-05-10T14:56:28Z\",\n      \"marketingImages\": [\n        {\n          \"url\": \"string\",\n          \"sizeInBytes\": null,\n          \"format\": \"PNG\",\n          \"faceIndicator\": \"string\",\n          \"colorSpace\": \"SRGB\",\n          \"ecommerceImages\": [\n            {\n              \"heightAndWidthResolution\": 0,\n              \"url\": \"string\",\n              \"sizeInBytes\": null,\n              \"format\": \"JPG\",\n              \"faceIndicator\": \"string\",\n              \"colorSpace\": \"SRGB\"\n            }\n          ]\n        }\n      ],\n      \"planogramImages\": [\n        {\n          \"url\": \"string\",\n          \"sizeInBytes\": null,\n          \"format\": \"PNG\",\n          \"faceIndicator\": \"string\",\n          \"colorSpace\": \"SRGB\",\n          \"ecommerceImages\": [\n            {\n              \"heightAndWidthResolution\": 0,\n              \"url\": \"string\",\n              \"sizeInBytes\": null,\n              \"format\": \"JPG\",\n              \"faceIndicator\": \"string\",\n              \"colorSpace\": \"SRGB\"\n            }\n          ]\n        }\n      ],\n      \"spinImages\": [\n        {\n          \"url\": \"string\",\n          \"sizeInBytes\": null,\n          \"format\": \"JPG\",\n          \"faceIndicator\": \"string\",\n          \"colorSpace\": \"SRGB\",\n          \"ecommerceImages\": [\n            {\n              \"heightAndWidthResolution\": 0,\n              \"url\": \"string\",\n              \"sizeInBytes\": null,\n              \"format\": \"JPG\",\n              \"faceIndicator\": \"string\",\n              \"colorSpace\": \"SRGB\"\n            }\n          ]\n        }\n      ],\n      \"barcodeImages\": [\n        {\n          \"url\": \"string\",\n          \"sizeInBytes\": null,\n          \"format\": \"PNG\",\n          \"faceIndicator\": \"string\",\n          \"colorSpace\": \"SRGB\",\n          \"ecommerceImages\": [\n            {\n              \"heightAndWidthResolution\": 0,\n              \"url\": \"string\",\n              \"sizeInBytes\": null,\n              \"format\": \"JPG\",\n              \"faceIndicator\": \"string\",\n              \"colorSpace\": \"SRGB\"\n            }\n          ]\n        }\n      ],\n      \"providedProductFields\": {\n        \"upc\": \"string\",\n        \"division\": \"string\",\n        \"subDivision\": \"string\",\n        \"category\": \"string\",\n        \"subCategory\": \"string\",\n        \"segment\": \"string\",\n        \"brandTier\": \"string\",\n        \"materialGroup\": \"string\",\n        \"brandName\": \"string\",\n        \"startDate\": \"2018-05-10T14:56:28Z\",\n        \"endDate\": \"2018-05-10T14:56:28Z\"\n      },\n      \"weightAndDimensions\": {\n        \"weight\": null,\n        \"height\": null,\n        \"width\": null,\n        \"depth\": null\n      }\n    }\n  ]\n}"}],"_postman_id":"c1804140-3f0f-46f6-9c20-567ea7549a4f"}],"event":[{"listen":"prerequest","script":{"id":"0aae675d-128f-4943-886a-0f3b582106fa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"483923b4-ef90-435e-9405-993441590137","type":"text/javascript","exec":[""]}}]}