Channels

For any call on this page, you are required to set the merchant using the Merchant Header.

Index

Get a list of channels for the merchant.

GET /channels

Example Response

{
    "channels": [
        {
            "id": 2,
            "team_id": 2,
            "type": "amazon",
            "nickname": "Amazon Store",
            "channel_account_id": "23o-othvv-xkrxh-rlrw",
            "connection_status": "active",
            "countryId": "ATVPDKIKX0DER"
        }
    ]
}

Index Listings

See a list of the listings for a channel. Returns up to 500 items in a single call. This endpoint has not yet been migrated to our newer pagination method. In order to retreive the next page, past the lowest ID from the previous response as the starting_id parameter.

GET /channels/{CHANNEL_ID}/listings

Example Response

{
    "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": [],
            "item_searchable": "Recycled Paper NotebooksRecycled-Pa-4430894120401983452B07B6AEUH9X00HFKELAI",
            "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,
                "fnsku": "X00HFKELAI",
                "asin": "B07B6AEUH9",
                "searchableIdentifiers": "4120401983452,B07B6AEUH9,X00HFKELAI",
                "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"
                    }
                ]
            }
        }
    ]
}

Create Listing

Create a listing on a channel for an inventory item

POST /channels/{CHANNEL_ID}/listings
Parameter Type Examples Description
item_id integer 22 (required) ID of the item you are creating a listing for.
channel_identifier string ABC-1234 (required) The unique identifier for the item on the channel. This is generally, but not required to be, the SKU of the item.
item_exists string yes Whether the listing already exists on the channel. If yes, we will attempt to sync with the listing on the channel. If no, we will attempt to create the listing on the channel. Valid values: 'yes', 'no'.

Example Response

{
    "message": "Listing created",
    "listing": {
        "channel_identifier": "Recycled-Pa-4430892",
        "status": "checking",
        "item_id": 50,
        "channel_id": 2,
        "updated_at": "2024-04-16T07:06:08.000000Z",
        "created_at": "2024-04-16T07:06:08.000000Z",
        "id": 151,
        "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=="
            }
        }
    }
}