The Client Onboarding API is for customers to integrate their systems upload images via RESTful APIs.
\nAccess Keys
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 x-api-key in the request header. The API is not accessible without these keys.
CORS
The API currently doesn’t support CORS requests.
HTTP Methods
The API currently supports the POST method. The POST method is used to upload images.
Serialization Formats
The API supports JSON and multipart form data.
The image file
\n","type":"file"}]},"url":"{{client-onboarding-api}}/rest/v1/api/image/upload","description":"Returns image id
\n","urlObject":{"path":["rest","v1","api","image","upload"],"host":["{{client-onboarding-api}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0dec751e-3faf-434a-ba65-3229201a3561"},{"name":"Upload an Image with data","id":"14a69084-ec07-4952-a912-1f6e2122d342","request":{"method":"POST","header":[{"key":"x-api-key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"file","value":null,"description":"The image file
\n","type":"file"},{"key":"metadata","value":"{ \"marketing\": true, \"upc\": \"12121212121212\", \"uid\": \"DQIFAwcJDA8\" }","description":"The image data
\n","type":"text"}]},"url":"{{client-onboarding-api}}/rest/v1/api/image/upload/custom","description":"Returns unique image id
\n","urlObject":{"path":["rest","v1","api","image","upload","custom"],"host":["{{client-onboarding-api}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"14a69084-ec07-4952-a912-1f6e2122d342"},{"name":"Upload a salsify payload","id":"c3f7af67-1c3d-4135-8687-f5bbe6579642","request":{"method":"POST","header":[{"key":"x-api-key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"file","value":null,"description":"The image file
\n","type":"file"},{"key":"metadata","value":"{ \"marketing\": true, \"upc\": \"12121212121212\", \"uid\": \"DQIFAwcJDA8\" }","description":"The image data
\n","type":"text"}]},"url":"{{client-onboarding-api}}/rest/v1/api/image/upload/custom","description":"Returns unique image id
\n","urlObject":{"path":["rest","v1","api","image","upload","custom"],"host":["{{client-onboarding-api}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3f7af67-1c3d-4135-8687-f5bbe6579642"},{"name":"Create Product","id":"ebdc6ff1-d2bf-44c4-9727-968e52c0b69f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"P3MaPrrwMr3ZkLKj"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"productMetadata\":{\n \"upc\":\"819077014359\",\n \"user\":\"wduuqedeestrada@labelinsight.com\",\n \"userId\":75,\n \"organization\":12165,\n \"submissionSource\":\"Daymon FTP\"\n }\n}"},"url":"{{client-onboarding-api}}/rest/v1/api/products","urlObject":{"path":["rest","v1","api","products"],"host":["{{client-onboarding-api}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ebdc6ff1-d2bf-44c4-9727-968e52c0b69f"},{"name":"Upload Product Image","id":"675d2fb3-043c-45a1-a15b-fff305b93332","request":{"method":"POST","header":[{"key":"x-api-key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"file","value":null,"type":"file"}]},"url":"{{client-onboarding-api}}/rest/v1/api/image/upload/Image provider endpoints for sending images with product data
\n","_postman_id":"58f0dbf3-a8cb-413b-b3ef-147c96b0d34d"},{"name":"Provided Product Fields","item":[{"name":"Find Provided Product Fields by Variant ID","id":"9d6f26da-fa47-48e3-94ff-46a65bc393ba","request":{"method":"GET","header":[{"key":"x-api-key","value":"apiKey"}],"body":{"mode":"formdata","formdata":[]},"url":"{{enterprise-api}}/organizations/topco/products/{variantId}","description":"Returns a single Product identified by the variant Id.
\n","urlObject":{"path":["organizations","topco","products","{variantId}"],"host":["{{enterprise-api}}"],"query":[],"variable":[]}},"response":[{"id":"ee2e68a5-c045-461e-91bf-441fde36773b","name":"Find Provided Product Fields by Variant ID","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"apiKey"}],"body":{"mode":"formdata","formdata":[]},"url":"https://enterprise-onboarding-api.labelinsight.com/organizations/topco/products/{variantId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"division\": \"string\",\n \"subDivision\": \"string\",\n \"category\": \"string\",\n \"subCategory\": \"string\",\n \"segment\": \"string\",\n \"brandTier\": \"string\",\n \"brandName\": \"string\",\n \"materialGroup\": \"string\",\n \"startDate\": \"2018-05-09T21:28:34Z\",\n \"endDate\": \"2018-05-09T21:28:34Z\"\n}"}],"_postman_id":"9d6f26da-fa47-48e3-94ff-46a65bc393ba"},{"name":"Set Provided Product Fields by Variant ID","id":"03db71e5-fecc-44fc-a511-c9979e9f459b","request":{"method":"PUT","header":[{"key":"x-api-key","value":"apiKey"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"division\": \"string\",\n \"subDivision\": \"string\",\n \"category\": \"string\",\n \"subCategory\": \"string\",\n \"segment\": \"string\",\n \"brandTier\": \"string\",\n \"brandName\": \"string\",\n \"materialGroup\": \"string\",\n \"startDate\": \"2018-05-09T21:28:34Z\",\n \"endDate\": \"2018-05-09T21:28:34Z\"\n}"},"url":"{{enterprise-api}}/organizations/topco/products/{variantId}","description":"Accepts product fields to update the product identified by the variant Id.
\n","urlObject":{"path":["organizations","topco","products","{variantId}"],"host":["{{enterprise-api}}"],"query":[],"variable":[]}},"response":[{"id":"70abb4ca-daff-42f5-880a-1bea56d5d623","name":"Set Provided Product Fields by Variant ID","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"apiKey"},{"key":"Content-Type","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"division\": \"string\",\n \"subDivision\": \"string\",\n \"category\": \"string\",\n \"subCategory\": \"string\",\n \"segment\": \"string\",\n \"brandTier\": \"string\",\n \"brandName\": \"string\",\n \"materialGroup\": \"string\",\n \"startDate\": \"2018-05-09T21:28:34Z\",\n \"endDate\": \"2018-05-09T21:28:34Z\"\n}"},"url":"https://enterprise-onboarding-api.labelinsight.com/organizations/topco/products/{variantId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"division\": \"string\",\n \"subDivision\": \"string\",\n \"category\": \"string\",\n \"subCategory\": \"string\",\n \"segment\": \"string\",\n \"brandTier\": \"string\",\n \"brandName\": \"string\",\n \"materialGroup\": \"string\",\n \"startDate\": \"2018-05-09T21:28:34Z\",\n \"endDate\": \"2018-05-09T21:28:34Z\"\n}"}],"_postman_id":"03db71e5-fecc-44fc-a511-c9979e9f459b"}],"id":"b35eb1d9-d12a-425c-be96-6d6575415727","_postman_id":"b35eb1d9-d12a-425c-be96-6d6575415727","description":""},{"name":"Product Upload","item":[{"name":"Upload a product with images and metadata","id":"e0eead86-3d51-4eca-bac9-ff48e8ccec63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{customer-gateway-key}}"}],"body":{"mode":"formdata","formdata":[{"description":"One or more image files
\n","key":"files","type":"file","src":["/Users/danieltopp/Desktop/image-two.pdf","/Users/danieltopp/Desktop/image-one.jpg"]},{"key":"json","type":"text","value":"{\"upc\": \"00000123456789\", \"brand\": \"Product Brand\", \"title\": \"Product Title\", \"metaData\": {\"key\": \"value\"}, \"ingredients\": \"ENRICHED FLOUR, WATER, SALT\", \"manufacturer\": \"1222345346347456184920384923084\"}"}]},"url":"{{client-onboarding-api}}/rest/v1/api/product/images","description":"Upload images and metadata associated to a single product.
\nThe body of this request is a multipart/form-data object with two parts: files and json.
One or more zipped image files
\n","key":"zipFile","type":"file","value":null},{"key":"json","type":"text","value":"{\"upc\": \"00000123456789\", \"brand\": \"Product Brand\", \"title\": \"Product Title\", \"metaData\": {\"key\": \"value\"}, \"ingredients\": \"ENRICHED FLOUR, WATER, SALT\", \"manufacturerId\": \"1222345346347456184920384923084\"}"}]},"url":"{{client-onboarding-api}}/rest/v1/api/product/images/zip","description":"The body of this request is a multipart/form-data object with two parts: files and json.
The image file
\n","type":"file","src":"/Users/kejo1001/Downloads/images/DE_0000030145535_NPPFN_C100_C_20220416122121838.jpg"},{"key":"json","value":"{\"upc\": \"038000312601\", \"brand\": \"\", \"title\": \"\", \"metaData\": null, \"ingredients\": \"\", \"manufacturer\": \"\"}","type":"text"}]},"url":"{{client-onboarding-api}}/rest/v1/api/product/images","urlObject":{"path":["rest","v1","api","product","images"],"host":["{{client-onboarding-api}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd08cd35-337a-4bc2-a9a1-9f78fb4ef8ef"}],"id":"a859a98d-fe31-4182-b65a-75a157fdc45a","description":"Requests that upload images for an entire product and create a new fe product id.
\n","event":[{"listen":"prerequest","script":{"id":"48bdc6a3-34ce-4673-885c-0fb15b86b700","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6ee04245-f72b-4fed-b7c1-1ecdcfe5f692","type":"text/javascript","exec":[""]}}],"_postman_id":"a859a98d-fe31-4182-b65a-75a157fdc45a"},{"name":"FDA Ingestion (Step Function)","item":[{"name":"Gladson","id":"8a7b9e46-2aa2-450f-bb3a-97cc342c1200","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-FDA-Organization-ID","value":"gladson","type":"text"},{"key":"source","value":"LI-POSTMAN","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"s3Key\": \"gladson/07-2022/06-ProductAttributes.mdb\",\n \"productIds\": [],\n \"feProdIds\": [],\n \"error\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{client-onboarding-api}}/rest/fda/gladson","urlObject":{"path":["rest","fda","gladson"],"host":["{{client-onboarding-api}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a7b9e46-2aa2-450f-bb3a-97cc342c1200"},{"name":"Mintel","id":"9ef03593-b6a8-4e9c-bb1a-5b49324354b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-FDA-Organization-ID","value":"mintel","type":"text"},{"key":"source","value":"LI-POSTMAN","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"s3Key\": \"mintel/food_essentials_2022-06-27_JBB1Y9HhJK.csv\",\n \"productIds\": [],\n \"feProdIds\": [],\n \"error\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{client-onboarding-api}}/rest/fda/mintel","urlObject":{"path":["rest","fda","mintel"],"host":["{{client-onboarding-api}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ef03593-b6a8-4e9c-bb1a-5b49324354b2"}],"id":"4e7945db-f038-467f-9f34-c56dfe1a6406","_postman_id":"4e7945db-f038-467f-9f34-c56dfe1a6406","description":""}],"event":[{"listen":"prerequest","script":{"id":"e29b325b-5666-4fca-ab1b-f322cd37a48b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6bd3614f-88c2-4a0d-b049-b7a9ef639aa0","type":"text/javascript","exec":[""]}}]}