Product tagging process automatically starts as soon as the products are registered through API endpoint or product feed.
\nAlternatively, uploading product feed(.csv or .json format) to specific S3/SFTP location can trigger tagging process. Please contact support@yesplz.ai for how to setup product tagging through product feed. Product feed can be either full producct feed or updated product feed only.
\nContact Support:
Email: support@yesplz.ai
Check example request for the necessary fields.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Token 12345678abcdedf"}]},"isInherited":true,"source":{"_postman_id":"c20a73f7-f4e8-4224-8495-e865a82d585f","id":"c20a73f7-f4e8-4224-8495-e865a82d585f","name":"YesPlz API Product Tagging Reference","type":"collection"}},"urlObject":{"path":["products"],"host":["https://api.yesplz.ai/api/v1/retailer/example"],"query":[],"variable":[]}},"response":[{"id":"9b59ee03-7f81-4d34-ad2a-1c43774747fc","name":"Register multiple products","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Token 12345678abcdedf"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"products\": \n [\n {\n \"product_id\": \"710460385\",\n \"retailer_category\": [\n \"Women/Clothing/Tops\"\n ],\n \"brand_name\": \"RRACE\",\n \"product_name\": \"Summer Cotton Knit_Off White\",\n \"product_url\": \"https://www.example.com/summer-cotton-knit-off-white-710460385.html\",\n \"description\": \"This RRACE half-sleeve top is impeccably knitted in a honeycomb pattern from durable cotton blend yarn in a cropped length. It features a half zip-up closure and a wide collar.\",\n \"release_date\": \"2021-11-20\",\n \"product_status\": \"AVAIL\",\n \"original_price\": 145.00,\n \"sale_price\": 105.00,\n \"gender\": \"F\",\n \"variants\": [\n {\n \"variant_id\": \"IVORY\",\n \"variant_name\": \"IVORY\",\n \"variant_url\": \"https://www.example.com/summer-cotton-knit-off-white-710460385.html?color=IVORY\",\n \"is_default\": true,\n \"images\": [\n {\n \"src_uri\": \"https://www.example.com/media/385/DU72289.jpg\"\n }\n ]\n }\n ]\n },\n {\n \"product_id\": \"710485852\",\n \"retailer_category\": [\n \"Women/Clothing/Knitwear\"\n ],\n \"brand_name\": \"MOHAN\",\n \"product_name\": \"TWR Two Tone Netting Knit\",\n \"product_url\": \"https://www.example.com/twr-two-tone-netting-knit-2-colors-710485852.html\",\n \"description\": \"This knit is unique for its crew neckline that can portray a feminine design and is made of a blend of rayon, linen, and polyester. It can be styled in jeans or a mini skirt for a retro stylish look.\",\n \"tag\": \"LOW_STOCK,NEW\",\n \"materials\": \"- Shell: 70% Rayon 15% Linen 15% Polyester\\n- Dry Cleaning\",\n \"release_date\": \"2021-11-20\",\n \"product_status\": \"AVAIL\",\n \"original_price\": 128.00,\n \"sale_price\": 119.00,\n \"gender\": \"F\",\n \"custom_fields\": {\n \"sticker\": \"back in stock\"\n },\n \"variants\": [\n {\n \"variant_id\": \"101634\",\n \"variant_name\": \"Multi Grey\",\n \"variant_url\": \"https://www.example.com/twr-two-tone-netting-knit-2-colors-710485852.html?color=101634\",\n \"is_default\": true,\n \"sizes\": {\n \"SMALL\": {\n \"original_price\": 128.00,\n \"sale_price\": 119.00\n },\n \"MEDIUM\": {\n \"original_price\": 128.00,\n \"sale_price\": 119.00\n }\n },\n \"images\": [\n {\n \"src_uri\": \"https://www.example.com/media/852/YS24960_0.jpg\"\n },\n {\n \"src_uri\": \"https://www.example.com/media/852/YS24960_1.jpg\"\n }\n ]\n },\n {\n \"variant_id\": \"232174\",\n \"variant_name\": \"MULTI SKY\",\n \"variant_url\": \"https://www.example.com/twr-two-tone-netting-knit-2-colors-710485852.html?color=232174\",\n \"is_default\": false,\n \"sizes\": {\n \"SMALL\": {\n \"original_price\": 128.00,\n \"sale_price\": 119.00\n },\n \"MEDIUM\": {\n \"original_price\": 128.00,\n \"sale_price\": 119.00\n }\n },\n \"images\": [\n {\n \"src_uri\": \"https://www.example.com/media/852/CT97940_0.jpg\"\n },\n {\n \"src_uri\": \"https://www.example.com/media/852/CT97940_1.jpg\"\n }\n ]\n }\n ]\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.yesplz.ai/api/v1/retailer/example/products"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c05cf2e7-85d6-49be-b615-a997cd4005ff"},{"name":"Get product information by product","id":"d7514d6e-8650-4460-8bbc-165b31c63dcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.yesplz.ai/api/v1/retailer/example/products/:productId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Token 12345678abcdedf"}]},"isInherited":true,"source":{"_postman_id":"c20a73f7-f4e8-4224-8495-e865a82d585f","id":"c20a73f7-f4e8-4224-8495-e865a82d585f","name":"YesPlz API Product Tagging Reference","type":"collection"}},"urlObject":{"path":["products",":productId"],"host":["https://api.yesplz.ai/api/v1/retailer/example"],"query":[],"variable":[{"description":{"content":"(Required) Product ID to return
\n","type":"text/plain"},"type":"any","value":":product_id","key":"productId"}]}},"response":[{"id":"6bb45167-6cfb-4f77-8f9d-7722176e992f","name":"successful operation","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Token 12345678abcdedf"}],"url":{"raw":"https://api.yesplz.ai/api/v1/retailer/example/products/:productId","host":["https://api.yesplz.ai/api/v1/retailer/example"],"path":["products",":productId"],"variable":[{"key":"productId","value":"710485852"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"product_id\": \"710485852\",\n \"retailer_category\": [\n \"Women/Clothing/Knitwear\"\n ],\n \"brand_name\": \"MOHAN\",\n \"product_name\": \"TWR Two Tone Netting Knit (2 Colors)\",\n \"product_url\": \"https://www.example.com/twr-two-tone-netting-knit-2-colors-710485852.html\",\n \"description\": \"This knit is unique for its crew neckline that can portray a feminine design and is made of a blend of rayon, linen, and polyester. It can be styled in jeans or a mini skirt for a retro stylish look.\",\n \"tag\": \"LOW_STOCK,NEW\",\n \"materials\": \"- Shell: 70% Rayon 15% Linen 15% Polyester\\n- Dry Cleaning\",\n \"release_date\": \"2021-11-20 18:20:22\",\n \"product_status\": \"AVAIL\",\n \"original_price\": 128.00,\n \"sale_price\": 119.00,\n \"gender\": \"F\",\n \"download_status\": \"AVAIL\",\n \"prediction_status\": \"DONE\",\n \"variants\": [\n {\n \"variant_id\": \"101634\",\n \"variant_name\": \"Multi Grey\",\n \"variant_url\": \"https://wwww.example.com/twr-two-tone-netting-knit-2-colors-710485852.html\",\n \"is_default\": true,\n \"sizes\": [\n {\n \"SMALL\": {\n \"original_price\": 128.00,\n \"sale_price\": 119.00\n }\n },\n {\n \"MEDIUM\": {\n \"original_price\": 128.00,\n \"sale_price\": 119.00\n }\n }\n ],\n \"images\": [\n {\n \"src_uri\": \"https://www.example.com/media/852/YS24960_0.jpg\"\n },\n {\n \"src_uri\": \"https://www.example.com/media/852/YS24960_1.jpg\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"d7514d6e-8650-4460-8bbc-165b31c63dcd"},{"name":"Remove a product","id":"445e06eb-fed7-4e33-b4d0-0889e1cb6c99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.yesplz.ai/api/v1/retailer/example/products/:productId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Token 12345678abcdedf"}]},"isInherited":true,"source":{"_postman_id":"c20a73f7-f4e8-4224-8495-e865a82d585f","id":"c20a73f7-f4e8-4224-8495-e865a82d585f","name":"YesPlz API Product Tagging Reference","type":"collection"}},"urlObject":{"path":["products",":productId"],"host":["https://api.yesplz.ai/api/v1/retailer/example"],"query":[],"variable":[{"description":{"content":"(Required) Product ID to delete
\n","type":"text/plain"},"type":"any","value":":productId","key":"productId"}]}},"response":[{"id":"ac3e3e65-e49f-42a2-b0e8-02fcfb8ad01a","name":"successful operation","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Token 12345678abcdedf"}],"url":{"raw":"https://api.yesplz.ai/api/v1/retailer/example/products/:productId","host":["https://api.yesplz.ai/api/v1/retailer/example"],"path":["products",":productId"],"variable":[{"key":"productId","value":"710485852","description":"(Required) Product ID to delete"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"445e06eb-fed7-4e33-b4d0-0889e1cb6c99"},{"name":"Getting product taggings","id":"f51ca2a5-ca6d-4adf-a94c-c954d34b2ffa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.yesplz.ai/api/v1/retailer/example/tags/?product_ids={{product_ids}}&since={{datetime}}&ordering={{order}}&limit={{limit}}&offset={{offset}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Token 12345678abcdedf"}]},"isInherited":true,"source":{"_postman_id":"c20a73f7-f4e8-4224-8495-e865a82d585f","id":"c20a73f7-f4e8-4224-8495-e865a82d585f","name":"YesPlz API Product Tagging Reference","type":"collection"}},"urlObject":{"path":["tags",""],"host":["https://api.yesplz.ai/api/v1/retailer/example"],"query":[{"description":{"content":"Comma separated from product IDs
\n","type":"text/plain"},"key":"product_ids","value":"{{product_ids}}"},{"description":{"content":"Get product tagging that are updated after given time in UTC. Time format is ISO date time format yyyy-MM-ddTHH:mm:ss, for example 2022-05-18T01:00:00
\n","type":"text/plain"},"key":"since","value":"{{datetime}}"},{"description":{"content":"Order result by updated time. Can be desc or asc.
\n","type":"text/plain"},"key":"ordering","value":"{{order}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"}],"variable":[]}},"response":[{"id":"44e32ca8-3ff5-46a5-931c-404aeea28eae","name":"Get tags by product_ids","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.yesplz.ai/api/v1/retailer/example/tags/?product_ids=YS2C3TTS014NPD,O22BBTTO598W","host":["https://api.yesplz.ai/api/v1/retailer/example"],"path":["tags",""],"query":[{"key":"product_ids","value":"YS2C3TTS014NPD,O22BBTTO598W"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"vibe\": \"casual\",\n \"sleeve_length\": \"overhand\",\n \"length\": \"short\",\n \"detail\": \"none\",\n \"shoulder\": \"closed\",\n \"necktype\": \"hoodie\",\n \"waist\": \"wide\",\n \"variants\": [\n {\n \"color\": \"grey\",\n \"pattern\": \"graphic,pattern\",\n \"variant_id\": \"GY\"\n },\n {\n \"color\": \"blue\",\n \"pattern\": \"graphic,pattern\",\n \"variant_id\": \"NY\"\n }\n ],\n \"product_id\": \"YS2C3TTS014NPD\",\n \"date_updated\": \"2022-10-01T00:50:01.452070Z\"\n },\n {\n \"vibe\": \"casual\",\n \"sleeve_length\": \"overhand\",\n \"length\": \"short\",\n \"detail\": \"none\",\n \"shoulder\": \"closed\",\n \"necktype\": \"round\",\n \"waist\": \"wide\",\n \"variants\": [\n {\n \"color\": \"black\",\n \"pattern\": \"graphic,pattern\",\n \"variant_id\": \"BK\"\n },\n {\n \"color\": \"blue\",\n \"pattern\": \"graphic,pattern\",\n \"variant_id\": \"LB\"\n }\n ],\n \"product_id\": \"O22BBTTO598W\",\n \"date_updated\": \"2022-10-08T12:33:26.369785Z\"\n }\n ]\n}"},{"id":"d9c773c6-099c-47b2-a89a-a8f03f4831c4","name":"Get recently updated tagging information","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.yesplz.ai/api/v1/retailer/example/tags/?since=2022-05-18T01:00:00&ordering=desc&limit=10&offset=0","host":["https://api.yesplz.ai/api/v1/retailer/example"],"path":["tags",""],"query":[{"key":"since","value":"2022-05-18T01:00:00"},{"key":"ordering","value":"desc"},{"key":"limit","value":"10"},{"key":"offset","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"previous\" : null,\n \"count\" : 10,\n \"next\" : \"https://api.yesplz.ai/api/v1/retailer/example/tags?limit=10&offset=10&ordering=desc&since=2022-05-18T08%3A30%3A00\",\n \"results\" : [\n {\n \"length\" : \"short\",\n \"shoulder\" : \"closed\",\n \"date_updated\" : \"2022-06-20T05:15:56.803866Z\",\n \"detail\" : \"none\",\n \"waist\" : \"wide\",\n \"variants\" : [\n {\n \"color\" : \"grey\",\n \"variant_id\" : \"GY\",\n \"pattern\" : \"logo,pattern\"\n },\n {\n \"pattern\" : \"logo,pattern\",\n \"variant_id\" : \"NY\",\n \"color\" : \"blue\"\n }\n ],\n \"necktype\" : \"hoodie\",\n \"product_id\" : \"YS2C3TTS014NPD\",\n \"sleeve length\" : \"long\"\n },\n {\n \"detail\" : \"none\",\n \"length\" : \"short\",\n \"shoulder\" : \"closed\",\n \"date_updated\" : \"2022-06-20T05:15:56.801667Z\",\n \"product_id\" : \"O22BBTTO598W\",\n \"sleeve length\" : \"long\",\n \"waist\" : \"wide\",\n \"variants\" : [\n {\n \"pattern\" : \"graphic,pattern\",\n \"variant_id\" : \"BK\",\n \"color\" : \"black\"\n },\n {\n \"color\" : \"blue\",\n \"variant_id\" : \"LB\",\n \"pattern\" : \"graphic,pattern\"\n }\n ],\n \"necktype\" : \"round\"\n },\n {\n \"product_id\" : \"O22A9ABG194W\",\n \"closure\" : \"flap\",\n \"size\" : \"medium\",\n \"handle\" : \"long\",\n \"detail\" : \"none\",\n \"variants\" : [\n {\n \"variant_id\" : \"BK\",\n \"color\" : \"black\",\n \"pattern\" : \"solid\"\n }\n ],\n \"date_updated\" : \"2022-05-19T19:28:47.579438Z\"\n },\n {\n \"variants\" : [\n {\n \"pattern\" : \"solid\",\n \"color\" : \"blue\",\n \"variant_id\" : \"NY\"\n }\n ],\n \"date_updated\" : \"2022-05-19T19:28:47.576825Z\",\n \"size\" : \"medium\",\n \"detail\" : \"none\",\n \"handle\" : \"long\",\n \"product_id\" : \"MN2B1ABG112WM\",\n \"closure\" : \"zipup\"\n },\n {\n \"variants\" : [\n {\n \"variant_id\" : \"BG\",\n \"color\" : \"beige\",\n \"pattern\" : \"solid\"\n },\n {\n \"pattern\" : \"pattern\",\n \"variant_id\" : \"NY\",\n \"color\" : \"blue\"\n }\n ],\n \"date_updated\" : \"2022-05-19T19:28:47.571628Z\",\n \"product_id\" : \"MN2B1ABG112W\",\n \"closure\" : \"flap\",\n \"size\" : \"medium\",\n \"handle\" : \"long\",\n \"detail\" : \"none\"\n },\n {\n \"detail\" : \"none\",\n \"handle\" : \"long\",\n \"size\" : \"medium\",\n \"closure\" : \"flap\",\n \"product_id\" : \"LC2C1ABG113W\",\n \"date_updated\" : \"2022-05-19T19:28:47.564967Z\",\n \"variants\" : [\n {\n \"variant_id\" : \"BK\",\n \"color\" : \"black\",\n \"pattern\" : \"solid\"\n },\n {\n \"variant_id\" : \"CM\",\n \"color\" : \"brown\",\n \"pattern\" : \"solid\"\n }\n ]\n },\n {\n \"closure\" : \"flap\",\n \"product_id\" : \"LC2B9ABG195WP\",\n \"handle\" : \"long\",\n \"detail\" : \"none\",\n \"size\" : \"medium\",\n \"date_updated\" : \"2022-05-19T19:28:47.557849Z\",\n \"variants\" : [\n {\n \"color\" : \"brown\",\n \"variant_id\" : \"WN\",\n \"pattern\" : \"solid\"\n }\n ]\n },\n {\n \"date_updated\" : \"2022-05-19T19:28:47.555792Z\",\n \"variants\" : [\n {\n \"color\" : \"blue\",\n \"variant_id\" : \"NY\",\n \"pattern\" : \"solid\"\n },\n {\n \"pattern\" : \"solid\",\n \"color\" : \"pastel\",\n \"variant_id\" : \"RP\"\n }\n ],\n \"closure\" : \"zipup\",\n \"product_id\" : \"MN2A8ASZ080W\",\n \"handle\" : \"none\",\n \"detail\" : \"none\",\n \"size\" : \"medium\"\n },\n {\n \"size\" : \"small\",\n \"detail\" : \"none\",\n \"handle\" : \"long\",\n \"product_id\" : \"LC2B7ABG173WM1\",\n \"closure\" : \"flap\",\n \"variants\" : [\n {\n \"color\" : \"black\",\n \"variant_id\" : \"BK\",\n \"pattern\" : \"solid\"\n },\n {\n \"pattern\" : \"solid\",\n \"color\" : \"green\",\n \"variant_id\" : \"DR\"\n }\n ],\n \"date_updated\" : \"2022-05-19T19:28:47.553567Z\"\n },\n {\n \"variants\" : [\n {\n \"color\" : \"black\",\n \"variant_id\" : \"BK\",\n \"pattern\" : \"solid\"\n },\n {\n \"color\" : \"brown\",\n \"variant_id\" : \"KK\",\n \"pattern\" : \"solid\"\n }\n ],\n \"date_updated\" : \"2022-05-19T19:28:47.551255Z\",\n \"size\" : \"medium\",\n \"detail\" : \"none\",\n \"handle\" : \"long\",\n \"product_id\" : \"LC2B1ABG121N\",\n \"closure\" : \"zipup\"\n }\n ]\n}"}],"_postman_id":"f51ca2a5-ca6d-4adf-a94c-c954d34b2ffa"}],"id":"1d823e7b-b065-472f-9abf-e4f084a3a629","_postman_id":"1d823e7b-b065-472f-9abf-e4f084a3a629","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Token 12345678abcdedf"}]},"isInherited":true,"source":{"_postman_id":"c20a73f7-f4e8-4224-8495-e865a82d585f","id":"c20a73f7-f4e8-4224-8495-e865a82d585f","name":"YesPlz API Product Tagging Reference","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Token 12345678abcdedf"}]}},"event":[{"listen":"prerequest","script":{"id":"a8f235fd-61dd-4a66-a622-984dab43ae3c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f7e2b1e1-8a2f-438b-b0d5-8570d8fd15f8","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.yesplz.ai/api/v1/retailer/example","type":"string"},{"key":"apiKey","value":"Token 12345678abcdedf","type":"string"}]}