Inventory
For any call on this page, you are required to set the merchant using the Merchant Header.
Index
Get a list of all inventory items. Returns up to 500 items in a single call, using Pagination.
GET
/inventory
Example Response
{
"current_page": 1,
"data": [
{
"id": 96,
"created_at": "2022-04-01T09:34:55.000000Z",
"updated_at": "2022-04-01T09:34:59.000000Z",
"team_id": 2,
"merchant_sku": "Synergist-163839",
"title": "Synergistic Leather Shoes",
"condition": "new",
"condition_note": null,
"bundle_id": null,
"length_mm": 91,
"width_mm": 286,
"height_mm": 174,
"weight_gm": 1076,
"actual_quantity": null,
"item_id": null,
"unsellable_quantity": null,
"outbound_quantity": null,
"order_quantity": null,
"negative_moves_quantity": null,
"positive_moves_quantity": null,
"bundle_shipments_quantity": null,
"root_item_id": null,
"bundle_order_items_quantity": null,
"quantity_in_stock": 0,
"fnsku": "X008VSER78",
"asin": "B014IA92I8",
"searchableIdentifiers": "B014IA92I8,X008VSER78,3495184061393",
"images": [
{
"id": 96,
"path": null,
"large_url": "https:\/\/source.unsplash.com\/collection\/345710\/1500x1500?sig=96",
"thumbnail_url": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAjVBMVEX\/\/\/8jHyAAAAAWEBJ7eXkTDA4QCAvp6OiLiYogHB0cFxgdGBkeGhsYExQJAADx8fHAv78MAAX5+fmTkZK\/vr7Hxsb09PRIRUbNzMxBPj9samva2dm4t7eYlpdPTE12dHXU1NRbWVlkYmIsKCmdnJw3NDXi4uKvrq4zMDGGhIVNSkqnpqZfXV1VU1NFQkOurYy8AAAJQUlEQVR4nO2da3uqOhCFJVRaBKF4r5ZqrbX3\/f9\/3ol6rBdmYTKCYJ9ZX7ey83bW5EYyNhoikUgkEolEIpFIJBKJRCKRSCQSiUSEOrPRrFN1I8rU4l0p9b6ouhllabBIIt9xHD+JFoOqG1OCBgtnzbeSH\/npX2PsLN5\/+TaML38rjgs\/2edbMyZB+lf6nMGiHR3zbeLYXMRVN64ADb5eSL4No3P1jJ0U8\/2fj1ft1c7Cy+RfhtFLrrZfHSzC3Pjt+px2eo1eHSxof7bpfLw+xtSh+HxPTZVH\/UPid6tuso0Gi4jKP98L7+LGoJsdHDfwVxPH\/fnZYZjuNghxF3wguApGkH++F3Vvfz8UpwnpVT121L1f7aQubcHm3WHTO12XZPSa3TozxgsX+LObtd8AdEaJR3y4Horp\/HOS1p4\/D76Q6mGCYgxrmY9gfqa7yJyQxCkYO5zaeTVOwfgQ3OU3tQPHjlp5ddCFw\/jpZsYoH93aMA7Sl4RIJ0d3i3T+HStO22QctVfrwNhJkc3uzJuHTOAFleej7ipoPt+yaYOuU8d8jNOAXP\/5r4xmgbmc41WXjwPQJMcJhzPOA3WHjMaOKhgH9NTyf0T1M+M8tNNt0\/kYXTwf47SZvz\/RUs8jzoPRXM5LLhpHPYSd3H9x2uqbxRinITX4rPrVSzF26G6PYIx+mIxg7PBPTJCKEfrv3RbB2FJPLEbwR7zE2BF326SFEufjR9GM3DiCscOzmEgw\/lv0p\/VW87P7TxUSbWqr5z7rP0vBGtkvjXGAluXRNj3uH8g4ttUnr1\/tevR\/6JaSj3HXZDjuPwGv8vIRTCpWk16zSb254m6L7D+T8Dj171E+cr0K8tF04WImu2lx\/5P2avTEZIRjR1H5iPzptVA6QK8OmWNHQDfAZoGGFXebjPV7n\/ZqoHhxxHO5s\/Nx+eGT82u4f\/ar\/jMaH5lebdFzudbHkvO8rZA\/lclUfzREXuXFEewDNKMz3ul0FRgfDF\/bjn4U9TItUA8sRjSXU2zEJfE8s\/2zX42eASOzXyXHRz\/hGjXNOt9LbLejRygfn+45bVrN5TIPS1LOo7TGmT+\/zzlWALzaUv94Xk0zj2qPOQ9qkIQfrM559A28OmTE8fajOMKpm3lWM7pheX40R\/loybj88JqZx7hTTpu0brKEmtGdsuI4o\/ucllUcb2+aTaI3dW84LWoAQr2aV1NWHGfIqw+GjMupovgKJ1w9kcs4jyjGUA17p7+8vFGwPYUTaq960wnnkTOUj5+P+V+cTIn8K5NQPzUas+I4QfmY59XlNMF8ZRGuNifGrDhO5hH14FC9Aq8ux9CfxRHSK3wu44xuckDm42RKfthPdlOlAgjdjzf6FKybMOM4RnOAx+MPkvnnR97bx6555xM27xqdr5eI3iycM70K4rjvVeDP1cnbTuPuF70YQq2vd7AhymQcJzTjQ2\/7ATLQfvTytZoel0Co4\/hOrRhX+ThjMU5JhHDtVZCsvnr52iy\/yyBcMQY0Y\/TNiuOSDpOey8092p\/u13Z5Uw5hI8erzzMeI+1ValEZan\/uvlkaoY7jK\/DqnMU4mZKM2fip16\/95Wl5hJrx7QUxsjZEwZB3xOe8HS6\/yyTU0oyFevUEYxg5X8ffKZlQM76qgGgL9wX+cupRj9vwqfe37DdKJ9SMD6RXW8wX+Msh5Yp1\/r1R20MXIGw0HoFXOS\/wZ98gfsf5t9VFCDXjK8lo\/cJwhjaPKX9udCHCtVdpRos4gk1VvaCCfBckbHQeUT4avoTp04tilH9bXY6wAfPRyKtgwziMVGZ8ONRFCTXjAxg7Tmxsj+gXxkGuPze6MKFmHJKMQZ5XwUvGUP07yVcBYaPRQ3EEG9t94E\/1fmLjbaMKCHMY\/2UZwYEG3X8a8VVEqBn\/gbw62izs0y+I9ecM+Soj1Iz04a9APe02YMChG51\/xnwVEq4Pf+V6FfvTYHN\/pwoJNSPyqmYAh99avxtQpqqUUHuVPjQUKh\/MDT4t+SonXB+MorxKze94L4MrJ9SMtFezfKYvEA9VA0J4wG1f3ANENSGE48KO78k6\/7aqCWFuHAN2\/FaqDaFeP8DDmGfw1YpwNcfOvMBvMQ9+7VQrwvWhof045q6pDFUzwtVafofY+jybr4aEjXh35M4r4vRy\/Qhv9wiLOGcvhAYSQksJoa2E0EBCaCkhtJUQGkgILSWEthJCAwmhpYTQVkJoICG0lBDaSggNJISWEkJbCaGBhNBSQmgrITSQEFqq1oQO8+L2gYolXI53tcALucvdVrwL+HsqkvDwLlhBt9Xd5Mw4Fke4PCo\/UNh9fFedxVgUYfb6M5swW2PoLK8WQ7gk7g4n3N+qmxB1\/d2IdwG\/UQzhZEzVY4jYf\/apyj6NXRCjAEJwZ1hxC\/BozUG1zjmH8VxCcO87UHPGw371OASXYRn5eB4huLsfWB3vJwUuiTDy8RzC5Zi8nm9+\/SRXPfrCbzuyLBbBJ1yS\/Yvx9SEDPdIHti0LYnAJYf6ZX68x0COqgmxREINHCO7q212vMVKPvgzrmnuVQ0iPf6urKUXzrQQrPRsy2hMa1bApVNqrZJ9j5lVbwtzaLqWpR18UdU0Y7QiBP8Ni+xdK\/LHDhhCMD0Fx40OeYD6eKMJjTrik69bZX29jq0df2jqRj6aEM3r8C0\/W5StU93Q+aq\/O4HfMCEG9uuBy8duqb+1VE8IJqqt4cb6VeqC6PCqmdJoQlC9rlTs+5Oke5SPJeIoQ5F\/AuF5aoMClZnKek08Ix7\/S5i+mAhdFiYJReYQg\/\/Jrfl5M4BJlxquYEPqTf\/2yYPXRfPV7tvcpRDhD4wNRaqI6Qa\/uMdKEE7q2MPf6c4lCv0yyy0eKcELXhyZLhVQvnI+bQkNZwvrn37H6YC638eoxIfBnWM\/4bQWKsqy9ekgI\/Vm7\/DsW9mpvF9\/WPZqf1daf++r\/0F7df5OVFPM7ApUJ5GO+uL\/NUpFGw8ik6MdO55YfqEDgF58Q38+1+HNfBoVNtv4s4np+JQK\/+HQcv6vKv2MRBTGO+a6m\/0QChQO3\/jy\/PEYNBIq3nFueplbSjFmvXuH4kKeMV690fMjTaH985P7uWs012u51hMzfI7sCjR6U226qB1a57ytR\/2Z881fjJxKJRCKRSCQSiUQikUgkEolEIpHoTP0HQMK6qG8e9HsAAAAASUVORK5CYII=",
"imageable_id": 96,
"imageable_type": "App\\Models\\Item"
}
],
"identifiers": [
{
"id": 191,
"created_at": "2022-04-01T09:34:57.000000Z",
"updated_at": "2022-04-01T09:34:57.000000Z",
"item_id": 96,
"identifier": "B014IA92I8",
"identifier_type": "ASIN"
},
{
"id": 192,
"created_at": "2022-04-01T09:34:57.000000Z",
"updated_at": "2022-04-01T09:34:57.000000Z",
"item_id": 96,
"identifier": "X008VSER78",
"identifier_type": "FNSKU"
},
{
"id": 296,
"created_at": "2022-04-01T09:34:59.000000Z",
"updated_at": "2022-04-01T09:34:59.000000Z",
"item_id": 96,
"identifier": "3495184061393",
"identifier_type": "EAN"
}
]
}
],
"first_page_url": "http:\/\/dashboard.domain.com\/api\/inventory?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http:\/\/dashboard.domain.com\/api\/inventory?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http:\/\/dashboard.domain.com\/api\/inventory?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "http:\/\/dashboard.domain.com\/api\/inventory",
"per_page": 500,
"prev_page_url": null,
"to": 37,
"total": 37
}View
See the details for a specific inventory item.
GET
/inventory/{ITEM_ID}
Example Response
{
"item": {
"id": 50,
"created_at": "2024-04-15T08:23:47.000000Z",
"updated_at": "2024-04-15T08:23:47.000000Z",
"team_id": 2,
"merchant_sku": "Recycled-Pa-443089",
"title": "Recycled Paper Notebooks",
"condition": "new",
"condition_note": null,
"bundle_id": null,
"length_mm": 68,
"width_mm": 140,
"height_mm": 120,
"weight_gm": 540,
"quantity_in_stock": 0,
"available_quantity": 0,
"allocated_quantity": 0,
"unavailable_quantity": 0,
"inbound_quantity": 0,
"fnsku": "X00HFKELAI",
"asin": "B07B6AEUH9",
"searchableIdentifiers": "4120401983452,B07B6AEUH9,X00HFKELAI",
"history": [],
"images": [
{
"id": 50,
"path": null,
"large_url": "https:\/\/source.unsplash.com\/collection\/345710\/1500x1500?sig=50",
"thumbnail_url": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAjVBMVEX\/\/\/8jHyAAAAAWEBJ7eXkTDA4QCAvp6OiLiYogHB0cFxgdGBkeGhsYExQJAADx8fHAv78MAAX5+fmTkZK\/vr7Hxsb09PRIRUbNzMxBPj9samva2dm4t7eYlpdPTE12dHXU1NRbWVlkYmIsKCmdnJw3NDXi4uKvrq4zMDGGhIVNSkqnpqZfXV1VU1NFQkOurYy8AAAJQUlEQVR4nO2da3uqOhCFJVRaBKF4r5ZqrbX3\/f9\/3ol6rBdmYTKCYJ9ZX7ey83bW5EYyNhoikUgkEolEIpFIJBKJRCKRSCQSiUSEOrPRrFN1I8rU4l0p9b6ouhllabBIIt9xHD+JFoOqG1OCBgtnzbeSH\/npX2PsLN5\/+TaML38rjgs\/2edbMyZB+lf6nMGiHR3zbeLYXMRVN64ADb5eSL4No3P1jJ0U8\/2fj1ft1c7Cy+RfhtFLrrZfHSzC3Pjt+px2eo1eHSxof7bpfLw+xtSh+HxPTZVH\/UPid6tuso0Gi4jKP98L7+LGoJsdHDfwVxPH\/fnZYZjuNghxF3wguApGkH++F3Vvfz8UpwnpVT121L1f7aQubcHm3WHTO12XZPSa3TozxgsX+LObtd8AdEaJR3y4Horp\/HOS1p4\/D76Q6mGCYgxrmY9gfqa7yJyQxCkYO5zaeTVOwfgQ3OU3tQPHjlp5ddCFw\/jpZsYoH93aMA7Sl4RIJ0d3i3T+HStO22QctVfrwNhJkc3uzJuHTOAFleej7ipoPt+yaYOuU8d8jNOAXP\/5r4xmgbmc41WXjwPQJMcJhzPOA3WHjMaOKhgH9NTyf0T1M+M8tNNt0\/kYXTwf47SZvz\/RUs8jzoPRXM5LLhpHPYSd3H9x2uqbxRinITX4rPrVSzF26G6PYIx+mIxg7PBPTJCKEfrv3RbB2FJPLEbwR7zE2BF326SFEufjR9GM3DiCscOzmEgw\/lv0p\/VW87P7TxUSbWqr5z7rP0vBGtkvjXGAluXRNj3uH8g4ttUnr1\/tevR\/6JaSj3HXZDjuPwGv8vIRTCpWk16zSb254m6L7D+T8Dj171E+cr0K8tF04WImu2lx\/5P2avTEZIRjR1H5iPzptVA6QK8OmWNHQDfAZoGGFXebjPV7n\/ZqoHhxxHO5s\/Nx+eGT82u4f\/ar\/jMaH5lebdFzudbHkvO8rZA\/lclUfzREXuXFEewDNKMz3ul0FRgfDF\/bjn4U9TItUA8sRjSXU2zEJfE8s\/2zX42eASOzXyXHRz\/hGjXNOt9LbLejRygfn+45bVrN5TIPS1LOo7TGmT+\/zzlWALzaUv94Xk0zj2qPOQ9qkIQfrM559A28OmTE8fajOMKpm3lWM7pheX40R\/loybj88JqZx7hTTpu0brKEmtGdsuI4o\/ucllUcb2+aTaI3dW84LWoAQr2aV1NWHGfIqw+GjMupovgKJ1w9kcs4jyjGUA17p7+8vFGwPYUTaq960wnnkTOUj5+P+V+cTIn8K5NQPzUas+I4QfmY59XlNMF8ZRGuNifGrDhO5hH14FC9Aq8ux9CfxRHSK3wu44xuckDm42RKfthPdlOlAgjdjzf6FKybMOM4RnOAx+MPkvnnR97bx6555xM27xqdr5eI3iycM70K4rjvVeDP1cnbTuPuF70YQq2vd7AhymQcJzTjQ2\/7ATLQfvTytZoel0Co4\/hOrRhX+ThjMU5JhHDtVZCsvnr52iy\/yyBcMQY0Y\/TNiuOSDpOey8092p\/u13Z5Uw5hI8erzzMeI+1ValEZan\/uvlkaoY7jK\/DqnMU4mZKM2fip16\/95Wl5hJrx7QUxsjZEwZB3xOe8HS6\/yyTU0oyFevUEYxg5X8ffKZlQM76qgGgL9wX+cupRj9vwqfe37DdKJ9SMD6RXW8wX+Msh5Yp1\/r1R20MXIGw0HoFXOS\/wZ98gfsf5t9VFCDXjK8lo\/cJwhjaPKX9udCHCtVdpRos4gk1VvaCCfBckbHQeUT4avoTp04tilH9bXY6wAfPRyKtgwziMVGZ8ONRFCTXjAxg7Tmxsj+gXxkGuPze6MKFmHJKMQZ5XwUvGUP07yVcBYaPRQ3EEG9t94E\/1fmLjbaMKCHMY\/2UZwYEG3X8a8VVEqBn\/gbw62izs0y+I9ecM+Soj1Iz04a9APe02YMChG51\/xnwVEq4Pf+V6FfvTYHN\/pwoJNSPyqmYAh99avxtQpqqUUHuVPjQUKh\/MDT4t+SonXB+MorxKze94L4MrJ9SMtFezfKYvEA9VA0J4wG1f3ANENSGE48KO78k6\/7aqCWFuHAN2\/FaqDaFeP8DDmGfw1YpwNcfOvMBvMQ9+7VQrwvWhof045q6pDFUzwtVafofY+jybr4aEjXh35M4r4vRy\/Qhv9wiLOGcvhAYSQksJoa2E0EBCaCkhtJUQGkgILSWEthJCAwmhpYTQVkJoICG0lBDaSggNJISWEkJbCaGBhNBSQmgrITSQEFqq1oQO8+L2gYolXI53tcALucvdVrwL+HsqkvDwLlhBt9Xd5Mw4Fke4PCo\/UNh9fFedxVgUYfb6M5swW2PoLK8WQ7gk7g4n3N+qmxB1\/d2IdwG\/UQzhZEzVY4jYf\/apyj6NXRCjAEJwZ1hxC\/BozUG1zjmH8VxCcO87UHPGw371OASXYRn5eB4huLsfWB3vJwUuiTDy8RzC5Zi8nm9+\/SRXPfrCbzuyLBbBJ1yS\/Yvx9SEDPdIHti0LYnAJYf6ZX68x0COqgmxREINHCO7q212vMVKPvgzrmnuVQ0iPf6urKUXzrQQrPRsy2hMa1bApVNqrZJ9j5lVbwtzaLqWpR18UdU0Y7QiBP8Ni+xdK\/LHDhhCMD0Fx40OeYD6eKMJjTrik69bZX29jq0df2jqRj6aEM3r8C0\/W5StU93Q+aq\/O4HfMCEG9uuBy8duqb+1VE8IJqqt4cb6VeqC6PCqmdJoQlC9rlTs+5Oke5SPJeIoQ5F\/AuF5aoMClZnKek08Ix7\/S5i+mAhdFiYJReYQg\/\/Jrfl5M4BJlxquYEPqTf\/2yYPXRfPV7tvcpRDhD4wNRaqI6Qa\/uMdKEE7q2MPf6c4lCv0yyy0eKcELXhyZLhVQvnI+bQkNZwvrn37H6YC638eoxIfBnWM\/4bQWKsqy9ekgI\/Vm7\/DsW9mpvF9\/WPZqf1daf++r\/0F7df5OVFPM7ApUJ5GO+uL\/NUpFGw8ik6MdO55YfqEDgF58Q38+1+HNfBoVNtv4s4np+JQK\/+HQcv6vKv2MRBTGO+a6m\/0QChQO3\/jy\/PEYNBIq3nFueplbSjFmvXuH4kKeMV690fMjTaH985P7uWs012u51hMzfI7sCjR6U226qB1a57ytR\/2Z881fjJxKJRCKRSCQSiUQikUgkEolEIpHoTP0HQMK6qG8e9HsAAAAASUVORK5CYII=",
"imageable_id": 50,
"imageable_type": "item"
}
],
"identifiers": [
{
"id": 152,
"created_at": "2024-04-15T08:23:47.000000Z",
"updated_at": "2024-04-15T08:23:47.000000Z",
"item_id": 50,
"identifier": "4120401983452",
"identifier_type": "EAN"
},
{
"id": 153,
"created_at": "2024-04-15T08:23:47.000000Z",
"updated_at": "2024-04-15T08:23:47.000000Z",
"item_id": 50,
"identifier": "B07B6AEUH9",
"identifier_type": "ASIN"
},
{
"id": 154,
"created_at": "2024-04-15T08:23:47.000000Z",
"updated_at": "2024-04-15T08:23:47.000000Z",
"item_id": 50,
"identifier": "X00HFKELAI",
"identifier_type": "FNSKU"
}
],
"bundle": null,
"containing_bundles": [],
"item_group_configurations": [
{
"id": 50,
"created_at": "2024-04-15T08:23:47.000000Z",
"updated_at": "2024-04-15T08:23:47.000000Z",
"item_id": 50,
"quantity": 10,
"type": "box",
"weight_gm": 1450,
"length_mm": 2780,
"width_mm": 3380,
"height_mm": 3030,
"contains": null,
"default": false
}
],
"listings": [
{
"id": 50,
"created_at": "2024-04-15T08:23:47.000000Z",
"updated_at": "2024-04-15T08:23:47.000000Z",
"channel_id": 2,
"channel_identifier": "Recycled-Pa-443089",
"item_id": 50,
"status": "synced",
"channel_data": [],
"channel": {
"id": 2,
"created_at": "2024-04-15T08:23:47.000000Z",
"updated_at": "2024-04-15T08:23:47.000000Z",
"team_id": 2,
"type": "amazon",
"nickname": "Amazon Store",
"channel_account_id": "23o-othvv-xkrxh-rlrw",
"connection_status": "active",
"connection_data": {
"country_id": "ATVPDKIKX0DER",
"lwa_refresh_token": "eyJpdiI6IkN0WHcwT3I2UDc4eDc3UnllZWZnekE9PSIsInZhbHVlIjoiZGljL0ppNGJKSHhqcWxCeW1Zb05LL1ZtYm8zZ2dSQVZpZGE5alcwRkQ4aXdqanc2WU9qRTEram4xSU92Q1VWdyIsIm1hYyI6ImQ3NGFjZjQ5ZWFjZmM5MDU5ZmQ5ZDFiZGIzNDIyMDNiNWFhY2Y2NWY3YTA4MGM3OGFiMzA0N2JjZDY3MWNmZDEiLCJ0YWciOiIifQ=="
}
}
},
{
"id": 151,
"created_at": "2024-04-16T07:06:08.000000Z",
"updated_at": "2024-04-16T07:06:08.000000Z",
"channel_id": 2,
"channel_identifier": "Recycled-Pa-4430892",
"item_id": 50,
"status": "checking",
"channel_data": [],
"channel": {
"id": 2,
"created_at": "2024-04-15T08:23:47.000000Z",
"updated_at": "2024-04-15T08:23:47.000000Z",
"team_id": 2,
"type": "amazon",
"nickname": "Amazon Store",
"channel_account_id": "23o-othvv-xkrxh-rlrw",
"connection_status": "active",
"connection_data": {
"country_id": "ATVPDKIKX0DER",
"lwa_refresh_token": "eyJpdiI6IkN0WHcwT3I2UDc4eDc3UnllZWZnekE9PSIsInZhbHVlIjoiZGljL0ppNGJKSHhqcWxCeW1Zb05LL1ZtYm8zZ2dSQVZpZGE5alcwRkQ4aXdqanc2WU9qRTEram4xSU92Q1VWdyIsIm1hYyI6ImQ3NGFjZjQ5ZWFjZmM5MDU5ZmQ5ZDFiZGIzNDIyMDNiNWFhY2Y2NWY3YTA4MGM3OGFiMzA0N2JjZDY3MWNmZDEiLCJ0YWciOiIifQ=="
}
}
}
],
"company_services": []
}
}Search
The inventory search API allows you to search for items with a single parameter that filters by title, SKU, and any identifiers that are attached to the item (such as FNSKU, ASIN, or EAN). 10 items or less matching the title or SKU plus any items with matching identifiers are returned in a single calls.
POST
/inventory/search
| Parameter | Type | Examples | Description |
|---|---|---|---|
q
| string | X00CGJI1G66 | Search query |
Example Response
{
"items": [
{
"id": 9,
"created_at": "2021-02-19T14:11:38.000000Z",
"updated_at": "2021-02-19T14:11:38.000000Z",
"team_id": 2,
"merchant_sku": "Heavy-Duty-979091",
"title": "Heavy Duty Wool Keyboard",
"condition": null,
"condition_note": null,
"bundle_id": null,
"length_mm": 589,
"width_mm": 212,
"height_mm": 509,
"weight_gm": 3602,
"fnsku": "X00U2E5ZYE",
"asin": "B07611F2KY",
"images": [
{
"id": 9,
"path": null,
"large_url": "https:\/\/source.unsplash.com\/collection\/345710\/1500x1500?sig=9",
"thumbnail_url": "https:\/\/source.unsplash.com\/collection\/345710\/100x100?sig=9",
"imageable_id": 9,
"imageable_type": "App\\Models\\Item"
}
],
"identifiers": [
{
"id": 17,
"created_at": "2021-02-19T14:11:39.000000Z",
"updated_at": "2021-02-19T14:11:39.000000Z",
"item_id": 9,
"identifier": "B07611F2KY",
"identifier_type": "ASIN"
},
{
"id": 18,
"created_at": "2021-02-19T14:11:39.000000Z",
"updated_at": "2021-02-19T14:11:39.000000Z",
"item_id": 9,
"identifier": "X00U2E5ZYE",
"identifier_type": "FNSKU"
},
{
"id": 109,
"created_at": "2021-02-19T14:11:40.000000Z",
"updated_at": "2021-02-19T14:11:40.000000Z",
"item_id": 9,
"identifier": "0386608654624",
"identifier_type": "EAN"
}
],
"company_services": []
}
]
}Create
The inventory create API allows to create a new item within a merchant's inventory.
POST
/inventory
| Parameter | Type | Examples | Description |
|---|---|---|---|
merchant_sku
| string | ABC-123 | (required) The SKU for the item. Min 3 characters, max 255 characters. The SKU must be unique for the merchant. |
title
| string | Brilliant Gemstone | (required) The title for the item. Min 3 characters, max 255 characters. |
condition
| string | new | The condition of the item. The list of possible conditions are the same as Amazon's values. |
condition_note
| string | new | Notes on the condition of the item |
asin
| string | B00X4WHP5E | The Amazon ASIN for the item. |
Example Response
{
"message": "Item created",
"item_details": {
"id": 151,
"created_at": "2024-04-03T11:19:35.000000Z",
"updated_at": "2024-04-03T11:19:35.000000Z",
"team_id": 2,
"merchant_sku": "3J-NO51-ICT7",
"title": "Test Title",
"condition": "new",
"condition_note": null,
"bundle_id": null,
"length_mm": null,
"width_mm": null,
"height_mm": null,
"weight_gm": null,
"fnsku": "",
"asin": "",
"searchableIdentifiers": "",
"images": [],
"identifiers": []
}
}Update
The inventory update API allows you to update an existing item.
PUT
/inventory/{ITEM_ID}
| Parameter | Type | Examples | Description |
|---|---|---|---|
length_mm
| integer | 140 | (required) The length of the item in millimeters. Min 1, max 500000. |
width_mm
| integer | 140 | (required) The width of the item in millimeters. Min 1, max 500000. |
height_mm
| integer | 140 | (required) The height of the item in millimeters. Min 1, max 500000. |
weight_gm
| integer | 240 | (required) The weight of the item in grams. Min 1, max 500000. |
Example Response
{
"message": "Item updated",
"item_details": {
"id": 151,
"created_at": "2024-04-03T11:19:35.000000Z",
"updated_at": "2024-04-03T11:19:35.000000Z",
"team_id": 2,
"merchant_sku": "3J-NO51-ICT7",
"title": "Test Title",
"condition": "new",
"condition_note": null,
"bundle_id": null,
"length_mm": 140,
"width_mm": 140,
"height_mm": 140,
"weight_gm": 240,
"fnsku": "",
"asin": "",
"searchableIdentifiers": "",
"images": [],
"identifiers": []
}
}Add Identifier
The add identifier endpoint allows you to add an identifier to an existing item.
POST
/inventory/{ITEM_ID}/identifier
| Parameter | Type | Examples | Description |
|---|---|---|---|
identifier
| string | 123456789012 | (required) The identifier for the item. The value should be the UPC, EAN, FNSKU, ASIN, or CUSTOM identifier for the item. The validation for each identifier is as follows: UPC: 12 digits, EAN: 13 digits, FNSKU: 10 characters, ASIN: 10 characters, CUSTOM: 1-255 characters. |
identifier_type
| string | UPC | (required) The type of identifier for the item. The list of possible values are: UPC, EAN, FNSKU, ASIN, CUSTOM. |
Example Response
{
"message": "Item identifier added",
"identifier": "1234567890"
}Add Service
The add services endpoint allows you to add services to an existing item.
POST
/inventory/services
| Parameter | Type | Examples | Description |
|---|---|---|---|
item_id
| int | 14 | (required) The primary key for the item you want to add services to. |
services
| array | See services.* for ids example | (required) An array of ids associated with the services you would like to add to the item. |
services.*
| int | 1 | (required) The ID for the service you would like to add to the item. |
Example Response
{
"message": "Services Updated"
}