POST /Images

GENERAL INFORMATION

Purpose

This endpoint is used for sharing product images in base64 format. If you prefer sending an image by giving us the URL, you can also use the following endpoint POST /Images/urls

How the data is used

Wallie analyzes the images to recognize visual elements such as edges, textures, shapes, and printed patterns, greatly improving the accuracy of the predictions. The images are also used as thumbnails in our cuctumer portml portml  the usersportml  the usersportal, the users giving the users a visual repWhich mesesation of thWhich m pesucts they aWhich me esking with. Which makes this a highly recommended dataset to send.

Common pitfalls

1. A common pitfall for this API is not making the correct Base64 code, which you can test yourself, by downloading the HTML below and replacing the existing base64 code with your own bas64 code and an image should appear when opening it in the browser:

   testBase64

   5.70 KB

2. Another thing to double check is to make sure the itemId/colorId are consistent with the ones you are sending to to the POST /Items and POST /Colors endpoints

Best practices

1. Make sure to update the images on a regular basis, recommended minimum once a day, to ensure the all products have the correct images.

2. When implementing, make sure to send us all images, even for older products,  model training and having a corresponding image with the products in the historical sales will have a benefit thebecause historical sal model training and having a corresponding image with the products in the historical sales will have a benefit thees data is part of our model training and having a corresponding image with the products in the historical sales will have a benefit the model training.

3. We have a type field in the API (explained below), the image of type 0 will be shown in our customer portal as thumbnail. If you cannot indicate a type, we will display the image you send first as thumbnail.

4. When you have a product in multiple colors, use the colorId to assign the image to a specific color variation of the product

TECHNICAL INFORMATION

Authentication

Bearer token, information on page POST /Token

Headers

QueryParameters:

No query parameters required

Body example:

{
  "image": {
    "imageId": "fcf2c6a6-1cc5-43b1-bd2d-b616f8b2acb8",
    "itemId": "100001",
    "colorId": "10",
    "type": 0,
    "base64": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKBwYHCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgr/wAARCACAAIADASIAAhEBAxEB/8QAHAABAAICAwEAAAAAAAAAAAAAAAcIBgkDBAUC/8QAPRAAAQMDAgQCCAMGBQUAAAAAAQIDBAAFBgcRCBIhMRNBCRQiQlFhcYEykaEVM1JigpIKI0SxwReissLh/8QAGwEBAAIDAQEAAAAAAAAAAAAAAAUGAQMEAgf/xAAyEQABAwIDBAkFAAMBAAAAAAABAAIDBBEFEiEGMUFxEzJRYYGRobHwFCLB0eFCUpJy/9oADAMBAAIRAxEAPwDf5SlKIlKV0cgybH8Vhpn5FeGIbS3A22p9wDnWeoSkd1K2BOw3PQ0Rd6lRvlXFZo5ialMy7rOkPJSFerxbW8XCCCdwFJTuNgevyrArn6STRG0uqbm4zlCAlW3MbagffqsVyy11JAbSPAXVDQ1c4vGwlWFpUFY76RfhjvzyWZGRXK2lR25rhalhI+6OYVJ+Gay6VahNpXheoNpuJWPZajzUeJ/YSFD8qzFW0k5tHICe4hJqKsgF5IyB3grJqU3pXSuVKUpREpSlESlKURKUpREqrXHnnM22an6bIxuEZdys2RPPsWsPOJXcPEjFpaG0oSoKKUO77q7HoASRtZ65TmrZb37g9+FlpSz89h2rXlxSSMnsPFgxkN/uc2ZYM9ZtcK5ttOqbFng2+4p9YdS6NvBS444vmWkhQ5e/bbnqH5WWG9b4G3fdcODa94Tf+Je15hqNcp9ieZTMhD1hapESG7IKOdS/E5VoTu2kBISEo5lbjY1cpeit5noEuNfLY+26kKbX4KiFJIGxBG+4I6/esY4teCHAeJDH3b9YUR7RlrLG8K8tp9iXsPZbk7fvEntz9VJ33BI9kwtwK8WGVaWZovhT4gi9DXDmGFa35y/agvg7CMtR7tq6ciu3UbHlUNoiOpqKKq6GssWv6rhoL9h7D85TElLT1tJ09FcOYPuadTbtHaPnOcrvwvy5pU45YcbkKV3KooBP3LdYzdOES5OL8WPp1ZFqH4VsLaQR99kkfnVlB1pUu6lp39ZoPgFENqqhnVcR4lQ3orpxq7g2RMRZ65Ue0Dfx47tz8dsDY7BKVLVy9du21TJSlbWMbG3K3ctL3ukdd29KUpXteUpSlESlKURKUr5eebjtKfdVslA3UaIsf1Qmqh4mtIP759ts/Qq3P+1V+1s4ddUtV7TNRiFlhzLddtM5VseZmzPB8Z924pleGhSVBSFqCR7ShyD4jrWXZBr8dQcrm4HGsPqrFteU54rrpLjikKKOo7JHUnbr5daxy3cbKsIuDmF3HGokpFrdVG2RMLLqgk7A+0Cknb6VHSVlIRnc7Q3HipCOjq8xa1uosfDgrG2C2MWWxw7PFZU21FiNsttrXzFKUoCQCfMgDv51T30qOgDP7PgcSuLweSVBW1ByNTQ2K2VK2YfO3mhZDZPfZaf4asjpTxHaY6uLFvsN1VGuQRzKtc8Bt4jzKOuzg+aSftWQal4JZ9T9P7zp7f2krh3m2vRH9078oWkpCh80khQ+YFKyCHE6B0bSDcaHsI3f1ZoqibC69sjgRY6jtB3qJuAniR/686UJtV/m+JkGPpRGuBWr2pDW2zb/AMyQCFfzJ386nWtX3AvnV90K4qIOOXx1TKJVwdsd5bUdgVFZbBP0dSk1tBFcuAV7q6gGfrNOU+HzzXVj9A2hrzk6rhmHj88kpSlTahEpSlESlKURKUpRErimx/W4bsXp/mNqT17dRtXLSiKAsn05bgZ67nEceDJejKjXOMU9FuApKXR8DsnY+SgQfjVTddkx29Xclw7JS8m03CUiQJEdbiHYbimklLwLakqW3ufba32UncjZQ67DNQLIxMiJuCGwHB7CyffSewP37H51UjiO0QnXfL38xx4l+W1AQuRbgAVPx0EpLrW3dSNxzJ8wQR26weJxz08IkpR9zXXPeLG+nf8ANVM4VJDNUGKpP2ublB7NRbXu+aKNMbtmZzEIsWTLMHI7csmyXaLKabbvrCBzNyI3Kvn8UIHMoJTykAkEkKIt3wl8RsjVCzHCs6kpGRW5ACnVAJ9dbHQObfxDsdvr51T+4YhN1BxSFiljnmNfLLNF0wa4eMpstSkAqXCUtPtJaeTuOnzTtsdj3dO9XLrdm42sVijpt+SY1cG42Y2gFKVRZJG6XFNpJLaHkbKLZ6o59j1G519MBGMQpxp/m33PMb+8arpdA4vNBPvHUd7Dkd3cdFiGuED9mcTWW3mz7JLWZynmFDyWJBVv/cDW0W2yFy7exKcA5nGUqVt23IBrXVnWmr87VOLerQ45Nt2ZTBPtchfVRU66PFaUR77biik/Ecp862MRWUxozcdPZCAkfYbVy7NxPZNUk7i4fk+xC37RyskhpgDezT+B7grkpSlWpVZKUpREpSlESlKURKUpRF5eabjGZSx3QgKT9QoVReXrzOt+vGUaHuSAjIMcyR27YA845sJrbraX37WsnvzpccLfxPs90pq9GakDF5YPm2B/3CtTXpBYsizcXN6udtfcYe9Utspp5pZStDngJ2WkjqCCgbHyIqv7Q1MlJTMlZ/sAeRB/hHeAp3Z+mjrKt8T+LSR3EEfi4PcSrOanYtZWjadWMOaU3YsmaRKZQkcpiSVDnA/l3IP0WlQ8xUaZTmmXtXK5qjPwYgurpXcTDtTDSpZI2KnVJRzOHbYbqJPQdalvhgv2Ua88La8e1DjQk3N6IqbapcJooRJYW84lt4p6hLqJLLyHAnZO4CgAHNqhbK3VyHS661yLT7LiT7qx0I/Peq/iUk1PG2SBxa2QX0uNeI+dqsGGMinkdFO0OdGba66cPncpm4Jr5YMov0TA8qIWq0XNN1sxJ6pc5ShaOvu7lCtv5auhWr/TbPJWnWf27LYyyPVJKS8ke82eix90k1svxLIYWV43DyC3vpcalMJWlaT0O47/APNTezNW2ekMZ6zfbh+lCbSUjoKwSDqu9+P7Xo0pSrKq6lKUoiUpSiJSlKIlKUoi8bPHfDxx1P8AG4hP67/8Vq69JRBSzxLPyeUDxscgK3A+Hip/9a2eajvFNsYjj33t/wAh/wDa1xekltQd19Zk8v48Yh79Pg5IFVragZsOPMKw7MOy4qP/ACfwpi9HHd03rhqs9xQ4fGxrLZ9mmJHlEm+E8gn6Ploj+r41gvEVZRi+p96tqUcjbsn1lkbdOVwc3/lzD7V2PRT3iRcbfqfpIjcuzLNHulvR8Hmitvcf1Fn8hWU8Ztsbvxx7U60pCo15taSVpHTqkOo/Rah9qiJx9Ts5G8b2/j7f0piE/T7RyM4P/NnftV7mP/5p27/I1bz0efEHGmW86MZNPCZDAK7QtxX71vzQPmn4fDb4Gqo2nD8iya4i22CyS50hR6MxGFOK+4SOn3qU9POD3W2Rco16enRsbcYdS6xIelcz7agehCG99j8iRUXgsldBWCSBhcNxtutz3KUxmOhnpDHO8NO8X335b1sJpUd2DLc1tOMRLTfLzHnz2Wgh+4pieH4xHvcnMQKxXU/WyxaeWdV71H1ARbYytwhL0jkU6fghCeqz8gDX0p07GMzv0HG/DmvnDYHvflbqeFuPJTdSqAZv6UfSnHJhRjmJ5FdEp/1QIYB+nOreuzpl6bnQdq8NWPPmLvamXFcpeubYWhv5+IgqIH1G3071GN2gwd0mTpm356ee5SbtnsZbHn6F1uWvlv8ARX2pXg6banYNq7icbNtPMjjXO2y2wtqRGcCh1G+x27GveqYa5rmgg3BUOWlpsRqlKUrKwlKUoirtxucYNk4Xr3Yk5nphk90sk6M6uRe7BC9YRDcCgAhxPTuOv4h9DWufjp9Izw46gaoQ79hreRz0HH2WFMmzBp1LqHXSUci17notPUdK3K3Ww2m9NFm5QkOpI2PMPKsIu3DFpHcparkxicGPKUNjJahNhz+4J3qJxHDpq9hj6SzTbhrp33Cl8NxCnoJBJ0ZLhfXNYHwsfdatfRQcTuSXHjVx42zRPLoOP3iDMgXW9z7etMeMhTRcbUtQQUgeK0gb83Tmq/Fh0xtEjTtvS7NbgxfWcfvcxuO4hBaLTPjuOR2Fcqtzyx3Wk83TnTsdhvWX3fhkkxHvWbFdlqCeqULWajbMME1j0tzA6k4jZXLr4kVEW/4+qSGk3RhBJbdacV7LcprmUEKVshxCi2spAQtHmkwuOhpeiP3i5vpwNr6a33X81msxOSvqulAyGwtrxF7a6W3n0upAsNlsmNQU2zH7XHgxx2ZitBCfvt3PzO9epHkIRtt+lQ07xtcOVok/s3Ps0lYbOGwcg5rZJNtUg9tvEWgsr6+8hxST5Gssw3XXRrUOQIeAav4re31bbR7VkUV9w79vYQsq/Sutj4OqwjkLey43xz9Z7TzIPusg1E1It2DWcSXC2uU/umIwtWwUrbuf5R5/lVbs9uasgXKmZXdbfdhNUFSY92gtyGiQNhypUN29gdhyEbV3NX+HHip4gdVJ2W2e8Wm14qw2iNYCLwrxXG0/jW434JSkqXzEELPshO4Brq2v0dmqUnYX/UmIUn8XJLW5+gQP96h69lTVOLMhyjdw8fnBTWHyUVKwPMgzHfxt3fOKrlrdbNKbVFdkN2xu3gA8wtktakfZDpVy/Y1RbiHUq83csacXKXJdUrZLarepW5+qT/xW4+P6L/TueoO5rfp1w2/E1GaDST/UoqNZ9p9wXaFaVrS/iWlNvRIT/rJbIee3+PMvfb7bVWjstVzT5tGDz9Bp6qzN2uoqeDKMzz5ep19FTH/D0ZlxW6cakXXR/WfSnJ7diV6t/rNivcy3uCA6+kcxCFn8BI91W25BI3rb1UOWm2R7W8FqKEcvuNkb/pXFmnENi2jkD9rZhmcK1xkqASm6zEt+MSeiEIUedaj2CUAqJOwBq74dTNw6kEOa4Hp/LqiYlWHEq0zBti7gOP8AbKaKVxQZbc+G1NaSoJebStIWgpUARvsQeoPyPWuWpNRyUpSiJSlKIlfD0diQgofZSsHuFDevulEWPXvS3CcgaUzcbI0pKu6Snoft2qNcx4AuGTN3C9f9KbBJc33Dr9lYUsH4hXJzA/MGprpXlzGPFnC69Me+M3abclWEei00Es7xlYEu9Yw7zcyXMYyWdb9lfHlZeCd/6a7TPA7qhZElrF+MLU6O2PwtzL6xOA+8qO4f1qylK0ikph1WgctPay3GrqXdZxPPX3uqyv8ACVxVMo8ODxr5VsOxfx+yuH8zCG9dNPCNxcuu7zONnK1tk9UM49Y2/wBfUiatNSs/TRd//Tv2sfUSdg/5b+lVd70fWa5S9zah8TepV1aUfbijMXILJHw5IKGOny3rM9JvR+6AaTXlvJ7DhUAXZs8ybu8yZE3f4+sPlboPz5qnWlehBCDfKL+Z81g1ExFsxt2DQeQXHEitw46YzRJSgbAk9a5KUratK//Z"
  }
}

Field information:

StatusCodes:

200 = OK

401 = Unauthorized, which means an expired/missing/invalid token

400 = Bad request, see body of the response to check which validation errors have occured

500 = System error, see body of the response to check which error has occured or contact integration support

Body Example:

No body in response