{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/affiliate-api.ainfluencer.com" } ], "info": { "name": "Affiliate API Documentation", "_postman_id": "37ba5456-b9f9-4a71-846f-3d81087c205e", "description": "REST API for affiliates: manage tracking links and sources, browse products, brands, and stores, run performance reports, and handle partnership requests. Every call is authenticated with your affiliate API key.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Brand", "description": "", "item": [ { "name": "Brand Show", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the Seller Brand ." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"encoded_brand_id\",\n \"name\": \"Apple\",\n \"terms_file\": \"\",\n \"image\": \"https:\/\/via.placeholder.com\/640x480.png\/0033bb?text=quia\",\n \"rating\": \"4.5\",\n \"review_count\": 125,\n \"category\": {\n \"id\": \"encoded_category_id\",\n \"name\": \"Electronics\"\n },\n \"average_price\": \"299.99\",\n \"description\": \"Premium electronics brand\",\n \"amazon_link\": \"https:\/\/www.amazon.com\/s?k=apple&ref=nb_sb_noss_2\",\n \"seller_storefront_link\": \"https:\/\/www.amazon.com\/s?me=123456789&marketplace=987654321\",\n \"average_commission\": \"15.50\",\n \"commission_type\": \"percent\",\n \"seller\": {\n \"id\": \"encoded_seller_id\",\n \"name\": \"John Doe\",\n \"avatar\": \"https:\/\/api.dicebear.com\/9.x\/initials\/png?seed=John+Doe\"\n },\n \"active_contracts_count\": 5,\n \"product_count\": 12,\n \"partnered_statistics\": {\n \"clicks\": 203,\n \"add_to_cart\": 67,\n \"sales\": \"1285.90\",\n \"units\": 18,\n \"purchases\": 15,\n \"conversions\": 15,\n \"conversion_rate\": \"0.0739\",\n \"commission\": \"257.18\"\n },\n \"active_partnership_request\": {\n \"id\": \"encoded_request_id\",\n \"status\": \"pending\",\n \"commission\": \"20.00\",\n \"commission_type\": \"percent\",\n \"is_custom_commission\": \"1\",\n \"message\": \"Partnership request message\",\n \"type\": \"affiliate_to_seller\",\n \"created_at\": 1640995200\n },\n \"status\": \"active\",\n \"partnership_status\": \"partnered\",\n \"affiliate_count\": 3,\n \"partnership_applied_date\": 1640995200,\n \"slug\": \"apple-electronics\",\n \"landing_page_config\": \"{\\\"hide_featured_products\\\":false,\\\"hide_brand_analytics\\\":false,\\\"featured_product_ids\\\":[1,2,3]}\"\n },\n \"status\": \"success\",\n \"message\": \"brand fetched successfully\"\n}", "name": "" } ] }, { "name": "Brand List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/brands", "query": [ { "key": "order_by%5Bid%5D", "value": "desc", "description": "optional string for sort by id can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bname%5D", "value": "desc", "description": "optional string for sort by name can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bmain_category%5D", "value": "desc", "description": "optional string for sort by category can include: asc or desc.", "disabled": false }, { "key": "order_by%5Buser%5D", "value": "desc", "description": "optional string for sort by seller can include: asc or desc.", "disabled": false }, { "key": "order_by%5Breview_count%5D", "value": "", "description": "optional string for sort by review count can include: asc or desc.", "disabled": true }, { "key": "order_by%5Brating%5D", "value": "desc", "description": "optional string for sort by average rating can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bproduct_count%5D", "value": "", "description": "optional string for sort by products count can include: asc or desc.", "disabled": true }, { "key": "order_by%5Baverage_commission%5D", "value": "desc", "description": "optional string for sort by average commission can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bpartnership_status%5D", "value": "desc", "description": "optional string for sort by partnership status can include: asc or desc.", "disabled": false }, { "key": "order_by%5Baverage_price%5D", "value": "desc", "description": "optional string for sort by average price can include: asc or desc.", "disabled": false }, { "key": "query", "value": "brand+name", "description": "optional string for search in brand name.", "disabled": false }, { "key": "category_ids%5B%5D", "value": "1", "description": "optional array number for filter brand category.", "disabled": false }, { "key": "seller_ids%5B%5D", "value": "1", "description": "optional array number for filter seller.", "disabled": false }, { "key": "price_from", "value": "1000", "description": "optional number for filter brand minimum price.", "disabled": false }, { "key": "price_to", "value": "2000", "description": "optional number for filter brand maximum price.", "disabled": false }, { "key": "commission_from", "value": "10", "description": "optional number for filter brand minimum commission.", "disabled": false }, { "key": "commission_to", "value": "15", "description": "optional number for filter brand maximum commission.", "disabled": false }, { "key": "rating_from", "value": "1", "description": "optional number for filter brand minimum rating.", "disabled": false }, { "key": "rating_to", "value": "5", "description": "optional number for filter brand maximum rating.", "disabled": false }, { "key": "review_count_from", "value": "10", "description": "optional number for filter brand maximum review count.", "disabled": false }, { "key": "review_count_to", "value": "20", "description": "optional number for filter brand maximum review count.", "disabled": false }, { "key": "partnership_status", "value": "", "description": "optional number for filter partnership status include: partnered, not_partnered.", "disabled": true } ], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/brands?order_by%5Bid%5D=desc&order_by%5Bname%5D=desc&order_by%5Bmain_category%5D=desc&order_by%5Buser%5D=desc&order_by%5Breview_count%5D=&order_by%5Brating%5D=desc&order_by%5Bproduct_count%5D=&order_by%5Baverage_commission%5D=desc&order_by%5Bpartnership_status%5D=desc&order_by%5Baverage_price%5D=desc&query=brand+name&category_ids%5B%5D=1&seller_ids%5B%5D=1&price_from=1000&price_to=2000&commission_from=10&commission_to=15&rating_from=1&rating_to=5&review_count_from=10&review_count_to=20&partnership_status=" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": \"alg_PWZ7nGw8vJ1m4R1aX9My\",\n\"name\": \"Flexon\",\n\"image\": \"\",\n\"main_category\": {\n\"id\": \"alg_gkVdwbOKZ9Qrvl6NoneZ\",\n\"name\": \"Parts & Connectors\"\n},\n\"user\": {\n\"id\": \"alg_PWZ7nGw8vJQ1m4R1aX9M\",\n\"name\": \"S.Ahmad\",\n\"avatar\": \"\"\n},\n\"status\": \"active\",\n\"average_price\": \"44.00\",\n\"average_commission\": \"20.00\",\n\"rating\": \"4.0\",\n\"review_count\": 497,\n\"product_count\": 1,\n\"partnership_status\": \"not_partnered\"\n}\n],\n\"pagination\": {\n\"current_page\": 1,\n\"per_page\": 15,\n\"total\": 1\n},\n\"status\": \"success\",\n\"message\": \"brand fetched successfully\"\n}", "name": "" } ] } ] }, { "name": "Landing Page", "description": "", "item": [ { "name": "Index Landing Page", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/landing-pages", "query": [ { "key": "order_by%5Bcreated_at%5D", "value": "desc", "description": "optional string for sort by created at can include: asc or desc.", "disabled": false }, { "key": "category_ids%5B%5D", "value": "1", "description": "optional array number for filter landing has category assignee.", "disabled": false }, { "key": "brand_ids%5B%5D", "value": "1", "description": "optional array number for filter landing has brand assignee.", "disabled": false }, { "key": "product_ids%5B%5D", "value": "1", "description": "optional array number for filter landing has product assignee.", "disabled": false }, { "key": "created_at_from", "value": "14654834564", "description": "optional array number for filter landing has creation date greater than .", "disabled": false }, { "key": "created_at_to", "value": "14654834564", "description": "optional array number for filter landing has creation date less than .", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/landing-pages?order_by%5Bcreated_at%5D=desc&category_ids%5B%5D=1&brand_ids%5B%5D=1&product_ids%5B%5D=1&created_at_from=14654834564&created_at_to=14654834564" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": \"alg_8gae74jd0M10LG3XZoND\",\n\"name\": \"My landing page 3\",\n\"template\": {\n\"id\": \"alg_NOb3Z51n0VaK8odBjrJe\",\n\"title\": \"Left Side - Blue\",\n\"content\": \"Praesentium saepe voluptas praesentium quis doloremque. Est facere molestias tenetur doloremque voluptate non. Nisi eveniet perferendis quod enim officia vitae. Corrupti eos sit odio voluptas.\\n\\nQuam minus nesciunt iste recusandae expedita eius qui. Maxime eius dolor labore doloribus sapiente. Molestiae nulla qui sapiente eaque aliquam delectus dolores.\\n\\nUt quam harum et deserunt possimus temporibus. Deleniti suscipit aut sapiente eum quam tenetur laboriosam. Eius rerum velit repellat autem. Corporis corrupti quam quis.\",\n\"thumbnail\": \"left-blue.png\",\n\"grid_id\": alg_NOb3Z51n0VaK8odBjrJe\",\n\"color_id\": alg_NOb3Z51n0VaK8odBjrJe\"\n},\n\"is_default\": false,\n\"is_system\": false,\n\"links_count\": 0,\n\"created_at\": 1719476064\n},\n],\n\"pagination\": {\n\"current_page\": 1,\n\"per_page\": 15,\n\"total\": 3\n},\n\"status\": \"success\",\n\"message\": \"Landing page fetched successfully\"\n}", "name": "" } ] } ] }, { "name": "Management", "description": "", "item": [ { "name": "Product List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/managements\/products", "query": [ { "key": "query", "value": "product+name", "description": "optional string for search in product name.", "disabled": false }, { "key": "brand_ids%5B%5D", "value": "1", "description": "optional array number for filter product brand.", "disabled": false }, { "key": "seller_ids%5B%5D", "value": "1", "description": "optional array number for filter product seller.", "disabled": false }, { "key": "price_from", "value": "1000", "description": "optional number for filter product minimum price.", "disabled": false }, { "key": "price_to", "value": "2000", "description": "optional number for filter product maximum price.", "disabled": false }, { "key": "commission_from", "value": "10", "description": "optional number for filter product minimum commission.", "disabled": false }, { "key": "commission_to", "value": "15", "description": "optional number for filter product maximum commission.", "disabled": false }, { "key": "availability", "value": "in_stock+or+out_of_stock", "description": "optional string for filter availability.", "disabled": false }, { "key": "has_promotion", "value": "true", "description": "optional boolean for filter products with promotions.", "disabled": false }, { "key": "status", "value": "active", "description": "optional string for filter product status include: active or inactive.", "disabled": false }, { "key": "inactive_date_from", "value": "1726177546", "description": "optional number for filter product minimum inactive date.", "disabled": false }, { "key": "inactive_date_to", "value": "1726177546", "description": "optional number for filter product maximum inactive date.", "disabled": false }, { "key": "order_by%5Bid%5D", "value": "desc", "description": "optional string for sort by id can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bname%5D", "value": "desc", "description": "optional string for sort by name can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bbrand%5D", "value": "desc", "description": "optional string for sort by brand can include: asc or desc.", "disabled": false }, { "key": "order_by%5Buser%5D", "value": "desc", "description": "optional string for sort by seller can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bamazon_price%5D", "value": "desc", "description": "optional string for sort by price can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bcommission%5D", "value": "desc", "description": "optional string for sort by commission can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bhas_promotion%5D", "value": "desc", "description": "optional string for sort by has\\_promotion can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bavailability%5D", "value": "desc", "description": "optional string for sort by availability can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bpartnered_on%5D", "value": "desc", "description": "optional string for sort by partnered\\_on can include: asc or desc.", "disabled": false }, { "key": "order_by%5Binactive_at%5D", "value": "desc", "description": "optional string for sort by inactive\\_at can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bproduct_links_count%5D", "value": "", "description": "optional string for sort by product\\_links\\_count can include: asc or desc.", "disabled": true }, { "key": "order_by%5Btotal_clicks%5D", "value": "desc", "description": "optional string for sort by total\\_clicks can include: asc or desc.", "disabled": false }, { "key": "order_by%5Btotal_sales%5D", "value": "desc", "description": "optional string for sort by total\\_sales can include: asc or desc.", "disabled": false }, { "key": "platform", "value": "amazon+or+shopify", "description": "optional string for filter by platform.", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/managements\/products?query=product+name&brand_ids%5B%5D=1&seller_ids%5B%5D=1&price_from=1000&price_to=2000&commission_from=10&commission_to=15&availability=in_stock+or+out_of_stock&has_promotion=true&status=active&inactive_date_from=1726177546&inactive_date_to=1726177546&order_by%5Bid%5D=desc&order_by%5Bname%5D=desc&order_by%5Bbrand%5D=desc&order_by%5Buser%5D=desc&order_by%5Bamazon_price%5D=desc&order_by%5Bcommission%5D=desc&order_by%5Bhas_promotion%5D=desc&order_by%5Bavailability%5D=desc&order_by%5Bpartnered_on%5D=desc&order_by%5Binactive_at%5D=desc&order_by%5Bproduct_links_count%5D=&order_by%5Btotal_clicks%5D=desc&order_by%5Btotal_sales%5D=desc&platform=amazon+or+shopify" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "This endpoint returns a list of products that the affiliate has access to." }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 27,\n\"asin\": \"B081TPHGGK\",\n\"name\": \"Emprian Big Bag of 600 gr (1.32 lb) Blue Wax Beans - Waxing Kit for Deep Hair Removal Works for Skin on Face, Armpit, Bikini Line, Leg, Arm - Wooden Applicators, Transparent Hard Wax Beads\",\n\"image\": \"https:\/\/m.media-amazon.com\/images\/I\/814tANbwLhL.jpg\",\n\"link\": \"https:\/\/www.amazon.com\/dp\/B081TPHGGK?m=AQO9TRV0YRH57\",\n\"brand\": {\n\"id\": \"alg_g4rlB87nvyZKzZG5YEw1\",\n\"name\": \"Emprian\",\n\"image\": \"http:\/\/localhost:8082\/storage\/alg_g4rlB87nvyZKzZG5YEw1\/conversions\/Qk5sUngzZFc0YjA2ekNCbUEvbXE2YnpZeENqUkcvNDBzZFpqNG9URXJvWnlnS1lUYjJsMXd4TmFkK3lETlpZTzltTzZnYlVSMlh4Q29QaU9Sb0dHTGw0RFd3TWdBR280K0NqWm5Lank3NmM9-medium_thumbnail.jpg\"\n},\n\"user\": {\n\"id\": \"alg_PWZ7nGw8vJQ1m4R1aX9M\",\n\"name\": \"s\",\n\"avatar\": \"\"\n},\n\"status\": \"active\",\n\"amazon_price\": \"18.83\",\n\"commission\": \"20.00\",\n\"commission_type\": \"percent\",\n\"availability\": \"out_of_stock\",\n\"promotions_count\": 0,\n\"total_clicks\": 0,\n\"total_sales\": 0,\n\"product_links\": [\n{\n\"id\": \"alg_k98ZOV1r0lJvPXE3aL2w\",\n\"display_name\": \"Default\",\n\"is_default\": true,\n\"is_system\": true,\n\"source\": null,\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_k98ZOV1r0lJvPXE3aL2w\",\n\"affiliate_amazon_tag\": null\n}\n],\n\"product_links_count\": 1,\n\"partnered_on\": 1726177546,\n\"inactive_at\": null\n},\n{\n\"id\": 28,\n\"asin\": \"B081TPJ12Z\",\n\"name\": \"Pink Hard Wax Beans 600 gr All in one Body Hair Removal Formula Wax Beads Works for Skin on Face Armpit Bikini Line Leg Arm Wooden Applicators 2 Prep Post Treatment Sprays Prefect Refill\",\n\"image\": \"https:\/\/m.media-amazon.com\/images\/I\/81tU8SVGjGL.jpg\",\n\"link\": \"https:\/\/www.amazon.com\/dp\/B081TPJ12Z?m=AQO9TRV0YRH57\",\n\"brand\": {\n\"id\": \"alg_g4rlB87nvyZKzZG5YEw1\",\n\"name\": \"Emprian\",\n\"image\": \"http:\/\/localhost:8082\/storage\/alg_g4rlB87nvyZKzZG5YEw1\/conversions\/Qk5sUngzZFc0YjA2ekNCbUEvbXE2YnpZeENqUkcvNDBzZFpqNG9URXJvWnlnS1lUYjJsMXd4TmFkK3lETlpZTzltTzZnYlVSMlh4Q29QaU9Sb0dHTGw0RFd3TWdBR280K0NqWm5Lank3NmM9-medium_thumbnail.jpg\"\n},\n\"user\": {\n\"id\": \"alg_PWZ7nGw8vJQ1m4R1aX9M\",\n\"name\": \"s\",\n\"avatar\": \"\"\n},\n\"status\": \"active\",\n\"amazon_price\": \"21.85\",\n\"commission\": \"20.00\",\n\"commission_type\": \"percent\",\n\"availability\": \"out_of_stock\",\n\"promotions_count\": 0,\n\"total_clicks\": 0,\n\"total_sales\": 0,\n\"product_links\": [\n{\n\"id\": \"alg_lZ2YpjWqvzJavaoO79dD\",\n\"display_name\": \"test3\",\n\"is_default\": false,\n\"is_system\": false,\n\"source\": {\n\"id\": \"alg_X2Zq8RbnvPz0wM56WEoz\",\n\"primary_id\": \"test3\",\n\"display_name\": \"test3\",\n\"sub_id\": \"test3\"\n},\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_rVkgED43KDgvRnx61lNz\",\n\"affiliate_amazon_tag\": null\n},\n{\n\"id\": \"alg_8gae74jd0M10LG3XZoND\",\n\"display_name\": \"Default\",\n\"is_default\": true,\n\"is_system\": true,\n\"source\": null,\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_8gae74jd0M10LG3XZoND\",\n\"affiliate_amazon_tag\": null\n}\n],\n\"product_links_count\": 2,\n\"partnered_on\": 1726177546,\n\"inactive_at\": null\n},\n{\n\"id\": 24,\n\"asin\": \"B07CXZSMM1\",\n\"name\": \"Flexon WS100KITCN 20-Piece Soaker Hose Kit, 100 ft, Black\",\n\"image\": \"https:\/\/m.media-amazon.com\/images\/I\/61C+FHXWQVL.jpg\",\n\"link\": \"https:\/\/www.amazon.com\/dp\/B07CXZSMM1?m=AQO9TRV0YRH57\",\n\"brand\": {\n\"id\": \"alg_PWZ7nGw8vJ1m4R1aX9My\",\n\"name\": \"Flexon\",\n\"image\": \"\"\n},\n\"user\": {\n\"id\": \"alg_PWZ7nGw8vJQ1m4R1aX9M\",\n\"name\": \"s\",\n\"avatar\": \"\"\n},\n\"status\": \"inactive\",\n\"amazon_price\": \"44.00\",\n\"commission\": \"22.00\",\n\"commission_type\": \"percent\",\n\"availability\": \"in_stock\",\n\"promotions_count\": 0,\n\"total_clicks\": 200,\n\"total_sales\": 50,\n\"product_links\": [\n{\n\"id\": \"alg_DE4wXVog0ow0kJNGq5dM\",\n\"display_name\": \"Default\",\n\"is_default\": true,\n\"is_system\": true,\n\"source\": null,\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_DE4wXVog0ow0kJNGq5dM\",\n\"affiliate_amazon_tag\": null\n}\n],\n\"product_links_count\": 1,\n\"partnered_on\": 1726177546,\n\"inactive_at\": 1726189537\n}\n],\n\"pagination\": {\n\"current_page\": 1,\n\"per_page\": 15,\n\"total\": 3\n},\n\"status\": \"success\",\n\"message\": \"product fetched successfully\"\n}", "name": "" } ] }, { "name": "Brand List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/managements\/brands", "query": [ { "key": "query", "value": "brand+name", "description": "optional string for search in brand name.", "disabled": false }, { "key": "category_ids%5B%5D", "value": "1", "description": "optional array number for filter brand category.", "disabled": false }, { "key": "seller_ids%5B%5D", "value": "1", "description": "optional array number for filter seller.", "disabled": false }, { "key": "price_from", "value": "1000", "description": "optional number for filter brand minimum price.", "disabled": false }, { "key": "price_to", "value": "2000", "description": "optional number for filter brand maximum price.", "disabled": false }, { "key": "rating_from", "value": "1", "description": "optional number for filter brand minimum rating.", "disabled": false }, { "key": "rating_to", "value": "5", "description": "optional number for filter brand maximum rating.", "disabled": false }, { "key": "inactive_date_from", "value": "1625097600", "description": "optional number for filter brand inactive date from (timestamp).", "disabled": false }, { "key": "inactive_date_to", "value": "1627689600", "description": "optional number for filter brand inactive date to (timestamp).", "disabled": false }, { "key": "total_sales_from", "value": "100", "description": "optional number for filter brand minimum total sales.", "disabled": false }, { "key": "total_sales_to", "value": "500", "description": "optional number for filter brand maximum total sales.", "disabled": false }, { "key": "revenue_from", "value": "1000", "description": "optional number for filter brand minimum revenue.", "disabled": false }, { "key": "revenue_to", "value": "5000", "description": "optional number for filter brand maximum revenue.", "disabled": false }, { "key": "status", "value": "active", "description": "optional string for filter brand status include: active or inactive.", "disabled": false }, { "key": "order_by%5Bid%5D", "value": "desc", "description": "optional string for sort by id can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bname%5D", "value": "desc", "description": "optional string for sort by name can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bmain_category%5D", "value": "desc", "description": "optional string for sort by main category can include: asc or desc.", "disabled": false }, { "key": "order_by%5Buser%5D", "value": "desc", "description": "optional string for sort by seller can include: asc or desc.", "disabled": false }, { "key": "order_by%5Brating%5D", "value": "desc", "description": "optional string for sort by rating can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bproduct_count%5D", "value": "", "description": "optional string for sort by product count can include: asc or desc.", "disabled": true }, { "key": "order_by%5Baverage_commission%5D", "value": "desc", "description": "optional string for sort by average commission can include: asc or desc.", "disabled": false }, { "key": "order_by%5Baverage_price%5D", "value": "desc", "description": "optional string for sort by average price can include: asc or desc.", "disabled": false }, { "key": "order_by%5Btotal_sales%5D", "value": "desc", "description": "optional string for sort by total sales can include: asc or desc.", "disabled": false }, { "key": "order_by%5Brevenue%5D", "value": "desc", "description": "optional string for sort by revenue can include: asc or desc.", "disabled": false }, { "key": "order_by%5Binactive_at%5D", "value": "desc", "description": "optional string for sort by inactive date can include: asc or desc.", "disabled": false }, { "key": "platform", "value": "amazon+or+shopify%0AReturns+brands+for+Amazon+platform+and+stores+for+Shopify+platform", "description": "optional string for filter by platform.", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/managements\/brands?query=brand+name&category_ids%5B%5D=1&seller_ids%5B%5D=1&price_from=1000&price_to=2000&rating_from=1&rating_to=5&inactive_date_from=1625097600&inactive_date_to=1627689600&total_sales_from=100&total_sales_to=500&revenue_from=1000&revenue_to=5000&status=active&order_by%5Bid%5D=desc&order_by%5Bname%5D=desc&order_by%5Bmain_category%5D=desc&order_by%5Buser%5D=desc&order_by%5Brating%5D=desc&order_by%5Bproduct_count%5D=&order_by%5Baverage_commission%5D=desc&order_by%5Baverage_price%5D=desc&order_by%5Btotal_sales%5D=desc&order_by%5Brevenue%5D=desc&order_by%5Binactive_at%5D=desc&platform=amazon+or+shopify%0AReturns+brands+for+Amazon+platform+and+stores+for+Shopify+platform" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "This endpoint returns a list of brands that the affiliate has access to." }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": \"alg_PWZ7nGw8vJ1m4R1aX9My\",\n\"name\": \"Flexon\",\n\"image\": \"\",\n\"main_category\": {\n\"id\": \"alg_gkVdwbOKZ9Qrvl6NoneZ\",\n\"name\": \"Parts & Connectors\"\n},\n\"user\": {\n\"id\": \"alg_PWZ7nGw8vJQ1m4R1aX9M\",\n\"name\": \"s\",\n\"avatar\": \"\"\n},\n\"status\": \"active\",\n\"average_price\": \"44.00\",\n\"average_commission\": \"20.00\",\n\"rating\": \"4.0\",\n\"product_count\": 1,\n\"partnered_on\": 1718653264,\n\"inactive_at\": null,\n\"total_sales\": 260,\n\"revenue\": 1350\n}\n],\n\"pagination\": {\n\"current_page\": 1,\n\"per_page\": 15,\n\"total\": 1\n},\n\"status\": \"success\",\n\"message\": \"brand fetched successfully\"\n}", "name": "" } ] } ] }, { "name": "Partnership", "description": "", "item": [ { "name": "Brand", "description": "", "item": [ { "name": "Store Brand Request", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/partnerships\/brand\/request", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/partnerships\/brand\/request" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"seller_brand_ids\":[16],\"message\":\"I want to be your partner\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n 'status'=>'success',\n 'message'=>'Partnership request stored successfully.',\n 'data'=>[]\n}", "name": "" } ] } ] }, { "name": "Product", "description": "", "item": [ { "name": "Store Product Request", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/partnerships\/product\/request", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/partnerships\/product\/request" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"seller_product_ids\":[16],\"commission_type\":\"percent\",\"commission\":10,\"message\":\"I want to be your partner\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n 'status'=>'success',\n 'message'=>'Partnership request stored successfully.',\n 'data'=>[]\n}", "name": "" } ] } ] }, { "name": "Partnership Contract List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/partnerships\/contracts", "query": [ { "key": "order_by%5Bcommission%5D", "value": "desc", "description": "optional string for sort by commission can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bprice%5D", "value": "desc", "description": "optional string for sort by price can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bprofit%5D", "value": "desc", "description": "optional string for sort by profit can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bcreated_at%5D", "value": "desc", "description": "optional string for sort by created at can include: asc or desc.", "disabled": false }, { "key": "status%5B%5D", "value": "active", "description": "optional array of strings for search in contracts. It accpets `active` and `inactive` and `revoked`.", "disabled": false }, { "key": "type%5B%5D", "value": "products", "description": "optional array of strings for search in contracts. It accpets `brands` and `products`.", "disabled": false }, { "key": "platform", "value": "amazon", "description": "optional string for filter by platform. It accepts `amazon` or `shopify`.", "disabled": false }, { "key": "marketplace", "value": "ATVPDKIKX0DER", "description": "optional string for filter by marketplace (only for Amazon platform).", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/partnerships\/contracts?order_by%5Bcommission%5D=desc&order_by%5Bprice%5D=desc&order_by%5Bprofit%5D=desc&order_by%5Bcreated_at%5D=desc&status%5B%5D=active&type%5B%5D=products&platform=amazon&marketplace=ATVPDKIKX0DER" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"alg@7b9ZAVdemE2voXyxNPR8\",\n \"affiliate\": {\n \"id\": \"alg@7b9ZAVdemE2voXyxNPR8\",\n \"name\": \"Philip J. Fry\",\n \"avatar\": \"\"\n },\n \"products\": [\n {\n \"id\": \"alg@DE4wXVog0ow0kJNGq5dM\",\n \"name\": \"Consequatur et possimus nam dolorem ratione quia quibusdam.\",\n \"image\": \"https:\/\/m.media-amazon.com\/images\/I\/41DusbJFRoL._AA64_.jpg\",\n \"asin\": null,\n \"sub_category\": {\n \"id\": \"alg@36J12ON0NdrqvYVPDeLw\",\n \"name\": \"Action & Adventure\"\n },\n \"main_category\": null,\n \"brand\": {\n \"id\": \"alg@lZ2YpjWqvzamaoO79dDN\",\n \"name\": \"Miss Winnifred Hoppe III\",\n \"image\": \"\"\n },\n \"amazon_link\": \"https:\/\/trantow.org\/id-cum-autem-eveniet-est-et-voluptas.html?m=6102970121\",\n \"best_seller_rank\": null,\n \"rating\": \"1.7\",\n \"price\": \"10.00\",\n \"commission\": \"24.00\",\n \"commission_type\": \"percent\",\n \"is_custom_commission\": false,\n \"profit\": 2.4,\n \"status\": \"active\",\n \"created_at\": 1703209446,\n \"revoked_at\": null\n }\n ],\n \"brands\": [],\n \"total_commission\": \"0.00\",\n \"total_sales_count\": 0,\n \"total_sales_amount\": \"0.00\",\n \"status\": \"active\",\n \"created_at\": 1703209446\n },\n {\n \"id\": \"alg@YVnAZalrvYLmXD2o5bJk\",\n \"affiliate\": {\n \"id\": \"alg@7b9ZAVdemE2voXyxNPR8\",\n \"name\": \"Philip J. Fry\",\n \"avatar\": \"\"\n },\n \"products\": [],\n \"brands\": [\n {\n \"id\": \"alg@YVnAZalrvYLmXD2o5bJk\",\n \"name\": \"Miss Kariane Stiedemann V\",\n \"image\": \"\",\n \"category_name\": \"Double French Horns\",\n \"rating\": \"2.8\",\n \"average_price\": \"2\",\n \"commission\": 23,\n \"active_contracts_count\": 0,\n \"product_count\": null,\n \"profit\": 0,\n \"status\": \"active\",\n \"revoked_at\": null,\n \"created_at\": 1703209446\n }\n ],\n \"total_commission\": \"0.00\",\n \"total_sales_count\": 0,\n \"total_sales_amount\": \"0.00\",\n \"status\": \"revoked\",\n \"created_at\": 1703209446\n },\n {\n \"id\": \"alg@NOb3Z51n0VaK8odBjrJe\",\n \"affiliate\": {\n \"id\": \"alg@7b9ZAVdemE2voXyxNPR8\",\n \"name\": \"Philip J. Fry\",\n \"avatar\": \"\"\n },\n \"products\": [\n {\n \"id\": \"alg@jP9WoOz4mbVm2Ee3ALDk\",\n \"name\": \"Quia placeat cum sit voluptas et officiis eaque minima.\",\n \"image\": \"https:\/\/m.media-amazon.com\/images\/I\/41DusbJFRoL._AA64_.jpg\",\n \"asin\": null,\n \"sub_category\": {\n \"id\": \"alg@36J12ON0NdrqvYVPDeLw\",\n \"name\": \"Action & Adventure\"\n },\n \"main_category\": null,\n \"brand\": {\n \"id\": \"alg@l9xnzAZ50B20eaW8XEBw\",\n \"name\": \"Prof. Edwina Lynch\",\n \"image\": \"\"\n },\n \"amazon_link\": \"http:\/\/www.bechtelar.com\/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121\",\n \"best_seller_rank\": null,\n \"rating\": \"4.9\",\n \"price\": \"10.00\",\n \"commission\": \"59.00\",\n \"commission_type\": \"percent\",\n \"is_custom_commission\": false,\n \"profit\": 5.9,\n \"status\": \"active\",\n \"created_at\": 1702946489,\n \"revoked_at\": null\n }\n ],\n \"brands\": [],\n \"total_commission\": \"0.00\",\n \"total_sales_count\": 0,\n \"total_sales_amount\": \"0.00\",\n \"status\": \"active\",\n \"created_at\": 1702946489\n },\n {\n \"id\": \"alg@jP9WoOz4mbVm2Ee3ALDk\",\n \"affiliate\": {\n \"id\": \"alg@7b9ZAVdemE2voXyxNPR8\",\n \"name\": \"Philip J. Fry\",\n \"avatar\": \"\"\n },\n \"products\": [],\n \"brands\": [\n {\n \"id\": \"alg@NOb3Z51n0VaK8odBjrJe\",\n \"name\": \"Alysson Kutch\",\n \"image\": \"\",\n \"category_name\": \"Cross-Country Skiing\",\n \"rating\": \"4.2\",\n \"average_price\": null,\n \"commission\": 57,\n \"active_contracts_count\": 0,\n \"product_count\": null,\n \"profit\": 0,\n \"status\": \"active\",\n \"revoked_at\": null,\n \"created_at\": 1702946489\n }\n ],\n \"total_commission\": \"0.00\",\n \"total_sales_count\": 0,\n \"total_sales_amount\": \"0.00\",\n \"status\": \"revoked\",\n \"created_at\": 1702946489\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 4\n },\n \"status\": \"success\",\n \"message\": \"partnership fetched successfully\"\n}", "name": "" } ] }, { "name": "Contract", "description": "", "item": [ { "name": "Show Partnership Contract Details", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/partnerships\/contracts\/:contractId", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/partnerships\/contracts\/:contractId", "variable": [ { "id": "contractId", "key": "contractId", "value": "1", "description": "The ID of the partnership contract." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n{\n\"status\": \"success\",\n\"message\": \"words.partnership_contract Successfully Fetched\",\n\"data\": {\n\"id\": 20,\n\"seller\": {\n\"id\": \"alg@jP9WoOz4mbBVm2Ee3ALD\",\n\"name\": \"test\"\n},\n\"status\": \"active\",\n\"partnered_at\": 1734376523,\n\"brandDetails\": [],\n\"productDetails\": {\n\"brand\": \"Emprian\",\n\"product\": \"B081TPHGGK\",\n\"category\": \"Beauty & Personal Care\",\n\"price\": \"18.83\",\n\"profit\": 3.77,\n\"commission_type\": \"percent\",\n\"commission\": \"20.00\",\n\"affiliates_count\": 1,\n\"terms_of_sale\": \"\"\n}\n}", "name": "" } ] } ] }, { "name": "Revoke Partnership Contract", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/partnerships\/contracts\/:contractId\/revoke", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/partnerships\/contracts\/:contractId\/revoke", "variable": [ { "id": "contractId", "key": "contractId", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\" => \"success\",\n \"message\" => \"Partnership contract revoked successfully.\",\n \"data\" => []\n}", "name": "" } ] }, { "name": "Partnership Request List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/partnerships\/requests", "query": [ { "key": "order_by%5Bcommission%5D", "value": "desc", "description": "optional string for sort by commission can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bprice%5D", "value": "desc", "description": "optional string for sort by price can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bprofit%5D", "value": "desc", "description": "optional string for sort by profit can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bcreated_at%5D", "value": "desc", "description": "optional string for sort by created at can include: asc or desc.", "disabled": false }, { "key": "status%5B%5D", "value": "active", "description": "optional array of strings for search in contracts. It accepts `accepted`, `canceled`, `pending` and `rejected`.", "disabled": false }, { "key": "type%5B%5D", "value": "products", "description": "optional array of strings for search in contracts. It accepts `brands` and `products`.", "disabled": false }, { "key": "direction", "value": "affiliate_to_seller", "description": "optional string for search in contracts. It accepts `seller_to_affiliate` and `affiliate_to_seller`.", "disabled": false }, { "key": "platform", "value": "amazon", "description": "optional string for filter by platform. It accepts `amazon` or `shopify`.", "disabled": false }, { "key": "marketplace", "value": "ATVPDKIKX0DER", "description": "optional string for filter by marketplace (only for Amazon platform).", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/partnerships\/requests?order_by%5Bcommission%5D=desc&order_by%5Bprice%5D=desc&order_by%5Bprofit%5D=desc&order_by%5Bcreated_at%5D=desc&status%5B%5D=active&type%5B%5D=products&direction=affiliate_to_seller&platform=amazon&marketplace=ATVPDKIKX0DER" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"alg@DE4wXVog0ow0kJNGq5dM\",\n \"seller\": {\n \"id\": \"alg@bANMR19W0j1qKqBQDrOY\",\n \"name\": \"Austyn Hackett\",\n \"avatar\": \"\"\n },\n \"products\": [\n {\n \"id\": \"alg@jP9WoOz4mbVm2Ee3ALDk\",\n \"name\": \"Quia placeat cum sit voluptas et officiis eaque minima.\",\n \"image\": \"https:\/\/m.media-amazon.com\/images\/I\/41DusbJFRoL._AA64_.jpg\",\n \"asin\": null,\n \"sub_category\": {\n \"id\": \"alg@36J12ON0NdrqvYVPDeLw\",\n \"name\": \"Action & Adventure\"\n },\n \"main_category\": null,\n \"brand\": {\n \"id\": \"alg@l9xnzAZ50B20eaW8XEBw\",\n \"name\": \"Prof. Edwina Lynch\",\n \"image\": \"\"\n },\n \"best_seller_rank\": null,\n \"rating\": \"4.9\",\n \"amazon_link\": \"http:\/\/www.bechtelar.com\/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121\",\n \"price\": \"10.00\",\n \"profit\": 0,\n \"commission\": null,\n \"commission_type\": null,\n \"is_custom_commission\": false,\n \"status\": \"active\"\n }\n ],\n \"brands\": [],\n \"status\": \"pending\",\n \"type\": \"seller_to_affiliate\",\n \"created_at\": 1717208058\n },\n {\n \"id\": \"alg@lZ2YpjWqvzamaoO79dDN\",\n \"seller\": null,\n \"products\": [\n {\n \"id\": \"alg@NOb3Z51n0VaK8odBjrJe\",\n \"name\": \"Ratione vel esse explicabo et error sed amet.\",\n \"image\": \"https:\/\/m.media-amazon.com\/images\/I\/41DusbJFRoL._AA64_.jpg\",\n \"asin\": null,\n \"sub_category\": {\n \"id\": \"alg@8MEDr2kvAknB0W43jVZx\",\n \"name\": \"Highlighters\"\n },\n \"main_category\": null,\n \"brand\": {\n \"id\": \"alg@rVkgED43KDgvRnx61lNz\",\n \"name\": \"Ada Fisher\",\n \"image\": \"\"\n },\n \"best_seller_rank\": null,\n \"rating\": \"1.0\",\n \"amazon_link\": \"http:\/\/larkin.com\/voluptatem-esse-eum-sapiente-beatae-deleniti?m=6102970121\",\n \"price\": \"10.00\",\n \"profit\": 0,\n \"commission\": null,\n \"commission_type\": null,\n \"status\": \"active\"\n }\n ],\n \"brands\": [],\n \"status\": \"pending\",\n \"type\": \"seller_to_affiliate\",\n \"created_at\": 1717207524\n },\n {\n \"id\": \"alg@rVkgED43KDgvRnx61lNz\",\n \"seller\": null,\n \"products\": [\n {\n \"id\": \"alg@NOb3Z51n0VaK8odBjrJe\",\n \"name\": \"Ratione vel esse explicabo et error sed amet.\",\n \"image\": \"https:\/\/m.media-amazon.com\/images\/I\/41DusbJFRoL._AA64_.jpg\",\n \"asin\": null,\n \"sub_category\": {\n \"id\": \"alg@8MEDr2kvAknB0W43jVZx\",\n \"name\": \"Highlighters\"\n },\n \"main_category\": null,\n \"brand\": {\n \"id\": \"alg@rVkgED43KDgvRnx61lNz\",\n \"name\": \"Ada Fisher\",\n \"image\": \"\"\n },\n \"best_seller_rank\": null,\n \"rating\": \"1.0\",\n \"amazon_link\": \"http:\/\/larkin.com\/voluptatem-esse-eum-sapiente-beatae-deleniti?m=6102970121\",\n \"price\": \"10.00\",\n \"profit\": 0,\n \"commission\": null,\n \"commission_type\": null,\n \"status\": \"active\"\n }\n ],\n \"brands\": [],\n \"status\": \"pending\",\n \"type\": \"seller_to_affiliate\",\n \"created_at\": 1717206650\n },\n {\n \"id\": \"alg@X2Zq8RbnvPz0wM56WEoz\",\n \"affiliate\": {\n \"id\": \"alg@7b9ZAVdemE2voXyxNPR8\",\n \"name\": \"Philip J. Fry\",\n \"avatar\": \"\"\n },\n \"products\": [\n {\n \"id\": \"alg@NOb3Z51n0VaK8odBjrJe\",\n \"name\": \"Ratione vel esse explicabo et error sed amet.\",\n \"image\": \"https:\/\/m.media-amazon.com\/images\/I\/41DusbJFRoL._AA64_.jpg\",\n \"asin\": null,\n \"sub_category\": {\n \"id\": \"alg@8MEDr2kvAknB0W43jVZx\",\n \"name\": \"Highlighters\"\n },\n \"main_category\": null,\n \"brand\": {\n \"id\": \"alg@rVkgED43KDgvRnx61lNz\",\n \"name\": \"Ada Fisher\",\n \"image\": \"\"\n },\n \"best_seller_rank\": null,\n \"rating\": \"1.0\",\n \"amazon_link\": \"http:\/\/larkin.com\/voluptatem-esse-eum-sapiente-beatae-deleniti?m=6102970121\",\n \"price\": \"10.00\",\n \"profit\": 0,\n \"commission\": null,\n \"commission_type\": null,\n \"status\": \"active\"\n }\n ],\n \"brands\": [],\n \"status\": \"pending\",\n \"type\": \"seller_to_affiliate\",\n \"created_at\": 1717206059\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 4\n },\n \"status\": \"success\",\n \"message\": \"partnership fetched successfully\"\n}", "name": "" } ] } ] }, { "name": "Product", "description": "", "item": [ { "name": "Product List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products", "query": [ { "key": "platform", "value": "amazon", "description": "optional string The platform to fetch products from. Must be either 'amazon' or 'shopify' if provided.", "disabled": false }, { "key": "query", "value": "product+name", "description": "optional string for search in product name.", "disabled": false }, { "key": "category_ids%5B%5D", "value": "1", "description": "optional array number for filter product category.", "disabled": false }, { "key": "brand_ids%5B%5D", "value": "1", "description": "optional array number for filter product brand.", "disabled": false }, { "key": "shopify_profile_ids%5B%5D", "value": "1", "description": "optional array int for Shopify: filter by ShopifyAccountStore ids.", "disabled": false }, { "key": "seller_ids%5B%5D", "value": "1", "description": "optional array number for filter product seller.", "disabled": false }, { "key": "price_from", "value": "1000", "description": "optional number for filter product minimum price.", "disabled": false }, { "key": "price_to", "value": "2000", "description": "optional number for filter product maximum price.", "disabled": false }, { "key": "commission_from", "value": "10", "description": "optional number for filter product minimum commission.", "disabled": false }, { "key": "commission_to", "value": "15", "description": "optional number for filter product maximum commission.", "disabled": false }, { "key": "rating_from", "value": "1", "description": "optional number for filter product minimum rating.", "disabled": false }, { "key": "rating_to", "value": "5", "description": "optional number for filter product maximum rating.", "disabled": false }, { "key": "review_count_from", "value": "10", "description": "optional number for filter product minimum review count.", "disabled": false }, { "key": "review_count_to", "value": "20", "description": "optional number for filter product maximum review count.", "disabled": false }, { "key": "partnership_status", "value": "partnered+or+not_partnered", "description": "optional string for filter partnership status.", "disabled": false }, { "key": "availability", "value": "in_stock%2C+out_of_stock%2C+in_stock_scarce%2C+leadtime%2C+available_date%2C+removed%2C+preorder", "description": "optional string for filter availability.", "disabled": false }, { "key": "one_promote", "value": "true+or+false", "description": "optional bool for filter auto_approval_brand.", "disabled": false }, { "key": "order_by%5Bid%5D", "value": "desc", "description": "optional string for sort by id can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bname%5D", "value": "desc", "description": "optional string for sort by name can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bmain_category%5D", "value": "desc", "description": "optional string for sort by category can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bbrand%5D", "value": "desc", "description": "optional string for sort by brand can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bbest_seller_rank%5D", "value": "desc", "description": "optional string for sort by bsr can include: asc or desc.", "disabled": false }, { "key": "order_by%5Buser%5D", "value": "desc", "description": "optional string for sort by seller can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bamazon_price%5D", "value": "desc", "description": "optional string for sort by price can include: asc or desc.", "disabled": false }, { "key": "order_by%5Brating%5D", "value": "desc", "description": "optional string for sort by rating can include: asc or desc.", "disabled": false }, { "key": "order_by%5Breview_count%5D", "value": "", "description": "optional string for sort by review_count can include: asc or desc.", "disabled": true }, { "key": "order_by%5Bcommission%5D", "value": "desc", "description": "optional string for sort by commission can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bhas_promotion%5D", "value": "desc", "description": "optional string for sort by has_promotion can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bpartnership_status%5D", "value": "desc", "description": "optional string for sort by partnership_status can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bavailability%5D", "value": "desc", "description": "optional string for sort by availability can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bstatus%5D", "value": "desc", "description": "optional string for sort by status can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bfeatured%5D", "value": "desc", "description": "optional string for sort by featured can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bhighest_profit%5D", "value": "desc", "description": "optional string for sort by highest_profit can include: asc or desc.", "disabled": false }, { "key": "order_by%5Brecommended%5D", "value": "desc", "description": "optional string for sort by recommended can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bpopular%5D", "value": "desc", "description": "optional string for sort by popular can include: asc or desc.", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/products?platform=amazon&query=product+name&category_ids%5B%5D=1&brand_ids%5B%5D=1&shopify_profile_ids%5B%5D=1&seller_ids%5B%5D=1&price_from=1000&price_to=2000&commission_from=10&commission_to=15&rating_from=1&rating_to=5&review_count_from=10&review_count_to=20&partnership_status=partnered+or+not_partnered&availability=in_stock%2C+out_of_stock%2C+in_stock_scarce%2C+leadtime%2C+available_date%2C+removed%2C+preorder&one_promote=true+or+false&order_by%5Bid%5D=desc&order_by%5Bname%5D=desc&order_by%5Bmain_category%5D=desc&order_by%5Bbrand%5D=desc&order_by%5Bbest_seller_rank%5D=desc&order_by%5Buser%5D=desc&order_by%5Bamazon_price%5D=desc&order_by%5Brating%5D=desc&order_by%5Breview_count%5D=&order_by%5Bcommission%5D=desc&order_by%5Bhas_promotion%5D=desc&order_by%5Bpartnership_status%5D=desc&order_by%5Bavailability%5D=desc&order_by%5Bstatus%5D=desc&order_by%5Bfeatured%5D=desc&order_by%5Bhighest_profit%5D=desc&order_by%5Brecommended%5D=desc&order_by%5Bpopular%5D=desc" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "Get a paginated list of products from Amazon or Shopify platform." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"status\":\"error\",\"message\":\"Unauthenticated.\",\"data\":[]}", "name": "" } ] }, { "name": "Product Show", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/:id", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the Product ." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"id\": \"alg_lMWxe1baKXVm9gLnX8Qz\",\n\"name\": \"Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon\",\n\"main_category\": {\n\"id\": \"alg_QlAxz9rvWoRdv85OwqoD\",\n\"name\": \"Beauty & Personal Care\"\n},\n\"sub_category\": {\n\"id\": \"alg_98ZOV1r0l5aMmPXE3aL2\",\n\"name\": \"Waxing Kits\"\n},\n\"images\": [\n\"https:\/\/m.media-amazon.com\/images\/I\/81UaTcwVIFL.jpg\",\n\"https:\/\/m.media-amazon.com\/images\/I\/81s87rI-tKL.jpg\",\n\"https:\/\/m.media-amazon.com\/images\/I\/81R7izbTqUL.jpg\",\n\"https:\/\/m.media-amazon.com\/images\/I\/81TIrg-LUCL.jpg\",\n\"https:\/\/m.media-amazon.com\/images\/I\/71HlLZ-GI7L.jpg\",\n\"https:\/\/m.media-amazon.com\/images\/I\/81ytHRmbk+L.jpg\"\n],\n\"details\": [],\n\"description\": [\n\"\u2705 EVERYTHING YOU NEED - Our self waxing kit set has all the tools you need to remove unwanted hair from head to toe. You'll get a wax warmer device, 200 Grams of Blue Wax Beads, Two Different Type of Wooden Spatulas for Face and Body, Nose Applicators and a Electric Nose Hair Trimmer, Cooling gel pad, and Hair Removal Scissors.\",\n\"\u2705 EFFECTIVE HAIR REMOVAL - This home wax kit effectively facilitates the removal of even the shortest and finest hair. Keep your legs, armpits, and skin flawless, smooth and fuzz-free for longer.\",\n\"\u2705 WORKS WITH YOUR PREFERRED WAX - Designed to work with different types of waxes, our warmer lets you use what works best for you. You can go for beans, beads, block, Brazilian, hard, or canned wax.\",\n\"\u2705 EASY TO USE WAX KIT - We provide step-by-step instructions that are easy to follow. You can easily adjust the heating temperature of our wax warmer device using its manual setting knob.\",\n\"\u2705 SAVE TIME & MONEY! - Salon visits are not only expensive, but they also take time. Our professional-grade wax hair removal kit lets you complete your waxing session from the comfort of your home.\"\n],\n\"amazon_link\": \"https:\/\/www.amazon.com\/dp\/B07YLG56B2\",\n\"asin\": \"B07YLG56B2\",\n\"best_seller_rank\": 146,\n\"rating\": \"4.3\",\n\"amazon_price\": \"36.75\",\n\"review_count\": 313,\n\"commission\": \"40.00\",\n\"commission_type\": \"percent\",\n\"yppu\": 14.7,\n\"brand\": {\n\"id\": \"alg_g4rlB87nvyZKzZG5YEw1\",\n\"name\": \"Emprian\",\n\"image\": \"\",\n\"amazon_link\": null,\n\"commission\": \"23.33\",\n\"commission_type\": \"percent\",\n\"terms_file\": \"\"\n},\n\"seller\": {\n\"id\": \"alg_PWZ7nGw8vJQ1m4R1aX9M\",\n\"name\": \"S.Ahmad\",\n\"avatar\": \"\",\n\"user_type\": \"Pro Seller\",\n\"is_plan_free\": false\n},\n\"promotions\": [\n{\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"name\": \"saaa\",\n\"value_type\": \"percent\",\n\"value\": \"32.00\",\n\"start_date\": 1717286400,\n\"end_date\": 1876521600,\n\"is_public\": true\n}\n],\n\"affiliateProductLinks\": [\n{\n\"id\": \"alg_JWq3xEoGKgWKLXyMrRA2\",\n\"display_name\": \"test\",\n\"is_default\": false,\n\"is_system\": false,\n\"seller_product_id\": \"alg_lMWxe1baKXVm9gLnX8Qz\",\n\"product_name\": \"Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon\",\n\"product_image\": \"https:\/\/m.media-amazon.com\/images\/I\/81UaTcwVIFL._AA64_.jpg\",\n\"product_category_name\": \"Waxing Kits\",\n\"brand_name\": \"Emprian\",\n\"source\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"primary_id\": \"test2\",\n\"display_name\": \"test1\",\n\"sub_id\": \"test2\"\n},\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_JWq3xEoGKgWKLXyMrRA2\",\n\"affiliate_amazon_tag\": null,\n\"promotion\": null,\n\"landing_page\": null,\n\"created_at\": 1715979891\n},\n{\n\"id\": \"alg_lZ2YpjWqvzamaoO79dDN\",\n\"display_name\": \"stesatasdf\",\n\"is_default\": false,\n\"is_system\": false,\n\"seller_product_id\": \"alg_lMWxe1baKXVm9gLnX8Qz\",\n\"product_name\": \"Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon\",\n\"product_image\": \"https:\/\/m.media-amazon.com\/images\/I\/81UaTcwVIFL._AA64_.jpg\",\n\"product_category_name\": \"Waxing Kits\",\n\"brand_name\": \"Emprian\",\n\"source\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"primary_id\": \"test2\",\n\"display_name\": \"test1\",\n\"sub_id\": \"test2\"\n},\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_lZ2YpjWqvzamaoO79dDN\",\n\"affiliate_amazon_tag\": null,\n\"promotion\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"value\": \"32.00\",\n\"value_type\": \"percent\"\n},\n\"landing_page\": null,\n\"created_at\": 1718748552\n},\n{\n\"id\": \"alg_rZnBN5Wb01E0kX132Olq\",\n\"display_name\": \"Default\",\n\"is_default\": true,\n\"is_system\": true,\n\"seller_product_id\": \"alg_lMWxe1baKXVm9gLnX8Qz\",\n\"product_name\": \"Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon\",\n\"product_image\": \"https:\/\/m.media-amazon.com\/images\/I\/81UaTcwVIFL._AA64_.jpg\",\n\"product_category_name\": \"Waxing Kits\",\n\"brand_name\": \"Emprian\",\n\"source\": null,\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_rZnBN5Wb01E0kX132Olq\",\n\"affiliate_amazon_tag\": null,\n\"promotion\": null,\n\"landing_page\": null,\n\"created_at\": 1718912840\n}\n],\n\"partnership_status\": \"partnered\",\n\"availability\": \"out_of_stock\",\n\"status\": \"active\",\n\"total_commission_paid\": 1550,\n\"active_partnership_request\": null,\n\"page_views\": 1583,\n\"total_sales\": 260,\n\"commission_paid\": \"1350\",\n\"has_product_partnership\": false\n},\n\"status\": \"success\",\n\"message\": \"product fetched successfully\"\n}", "name": "" } ] }, { "name": "Product Variation List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/:id\/variations", "query": [ { "key": "order_by%5Bprice%5D", "value": "desc", "description": "optional string for sort by price can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bcommission%5D", "value": "desc", "description": "optional string for sort by commission can include: asc or desc.", "disabled": false }, { "key": "order_by%5Bname%5D", "value": "desc", "description": "optional string for sort by name can include: asc or desc.", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/:id\/variations?order_by%5Bprice%5D=desc&order_by%5Bcommission%5D=desc&order_by%5Bname%5D=desc", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the product." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"alg@jP9WoOz4mbVm2Ee3ALDk\",\n \"name\": \"Quia placeat cum sit voluptas et officiis eaque minima.\",\n \"image\": \"https:\/\/m.media-amazon.com\/images\/I\/41DusbJFRoL._AA64_.jpg\",\n \"asin\": \"q123eefw5\",\n \"brand\": \"brand\",\n \"rating\": \"4.9\",\n \"price\": \"10.00\",\n \"commission\": \"20.00\",\n \"commission_type\": \"percent\",\n \"link\": \"http:\/\/www.bechtelar.com\/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 1\n },\n \"status\": \"success\",\n \"message\": \"products fetched successfully\"\n}", "name": "" } ] } ] }, { "name": "Product Link", "description": "", "item": [ { "name": "Link Source", "description": "", "item": [ { "name": "Product Link Source List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links\/sources", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links\/sources" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\":\"success\",\n \"message\":\"Product link source fetched successfully\",\n \"data\": [{\n \"primary_id\": 121212,\n \"display_name\": \"Tests\",\n \"sub_id\": 1212\n}]\n}", "name": "" } ] }, { "name": "Create Product Link Source", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links\/sources", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links\/sources" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"primary_id\":\"25441\",\"display_name\":\"Facebook\",\"sub_id\":\"25443\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n 'status'=>'success',\n 'message'=>'affiliate product Link Source created successfully',\n 'data'=>{\n \"id\":87922,\n \"name\":\"Roberta Fay\",\n \"username\":\"simonis.chelsie\",\n \"email\":\"example@gmail.com\",\n }\n}", "name": "" } ] }, { "name": "Show Product Link Source", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links\/sources\/:productLinkSourceId", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links\/sources\/:productLinkSourceId", "variable": [ { "id": "productLinkSourceId", "key": "productLinkSourceId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\":\"success\",\n \"message\":\"Data fetched successfully\",\n \"data\":{\n \"id\":87922,\n \"name\":\"Roberta Fay\",\n \"username\":\"simonis.chelsie\",\n \"email\":\"example@gmail.com\",\n }\n}", "name": "" } ] }, { "name": "Update Product Link Source", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links\/sources\/:productLinkSourceId", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links\/sources\/:productLinkSourceId", "variable": [ { "id": "productLinkSourceId", "key": "productLinkSourceId", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"primary_id\":\"25441\",\"display_name\":\"Facebook\",\"sub_id\":\"25443\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n 'status'=>'success',\n 'message'=>'product Link updated successfully',\n 'data'=>[]\n}", "name": "" } ] }, { "name": "Delete Product Link", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links\/sources\/:productLinkSourceId", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links\/sources\/:productLinkSourceId", "variable": [ { "id": "productLinkSourceId", "key": "productLinkSourceId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n 'status'=>'success',\n 'message'=>'product Link deleted successfully',\n 'data'=>[]\n}", "name": "" } ] } ] }, { "name": "Link List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links", "query": [ { "key": "query", "value": "", "description": "optional string for search in product name or tracking number .", "disabled": true }, { "key": "category_ids%5B%5D", "value": "1", "description": "optional array number for filter product category.", "disabled": false }, { "key": "brand_ids%5B%5D", "value": "1", "description": "optional array number for filter product brand.", "disabled": false }, { "key": "product_ids%5B%5D", "value": "1", "description": "optional array number for filter product .", "disabled": false }, { "key": "source_ids%5B%5D", "value": "1", "description": "optional array number for filter source .", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links?query=&category_ids%5B%5D=1&brand_ids%5B%5D=1&product_ids%5B%5D=1&source_ids%5B%5D=1" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": \"alg_JWq3xEoGKgWKLXyMrRA2\",\n\"display_name\": \"test\",\n\"is_default\": false,\n\"is_system\": false,\n\"seller_product_id\": \"alg_lMWxe1baKXVm9gLnX8Qz\",\n\"product_name\": \"Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon\",\n\"product_image\": \"https:\/\/m.media-amazon.com\/images\/I\/81UaTcwVIFL._AA64_.jpg\",\n\"product_category_name\": \"Waxing Kits\",\n\"brand_name\": \"Emprian\",\n\"source\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"primary_id\": \"test2\",\n\"display_name\": \"test1\",\n\"sub_id\": \"test2\"\n},\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_JWq3xEoGKgWKLXyMrRA2\",\n\"affiliate_amazon_tag\": null,\n\"promotion\": null,\n\"landing_page\": null,\n\"created_at\": 1715979891\n},\n{\n\"id\": \"alg_lZ2YpjWqvzamaoO79dDN\",\n\"display_name\": \"stesatasdf\",\n\"is_default\": false,\n\"is_system\": false,\n\"seller_product_id\": \"alg_lMWxe1baKXVm9gLnX8Qz\",\n\"product_name\": \"Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon\",\n\"product_image\": \"https:\/\/m.media-amazon.com\/images\/I\/81UaTcwVIFL._AA64_.jpg\",\n\"product_category_name\": \"Waxing Kits\",\n\"brand_name\": \"Emprian\",\n\"source\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"primary_id\": \"test2\",\n\"display_name\": \"test1\",\n\"sub_id\": \"test2\"\n},\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_lZ2YpjWqvzamaoO79dDN\",\n\"affiliate_amazon_tag\": null,\n\"promotion\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"value\": \"32.00\",\n\"value_type\": \"percent\"\n},\n\"landing_page\": null,\n\"created_at\": 1718748552\n},\n{\n\"id\": \"alg_rZnBN5Wb01E0kX132Olq\",\n\"display_name\": \"Default\",\n\"is_default\": true,\n\"is_system\": true,\n\"seller_product_id\": \"alg_lMWxe1baKXVm9gLnX8Qz\",\n\"product_name\": \"Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon\",\n\"product_image\": \"https:\/\/m.media-amazon.com\/images\/I\/81UaTcwVIFL._AA64_.jpg\",\n\"product_category_name\": \"Waxing Kits\",\n\"brand_name\": \"Emprian\",\n\"source\": null,\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_rZnBN5Wb01E0kX132Olq\",\n\"affiliate_amazon_tag\": null,\n\"promotion\": null,\n\"landing_page\": null,\n\"created_at\": 1718912840\n}\n],\n\"pagination\": {\n\"current_page\": 1,\n\"per_page\": 15,\n\"total\": 3\n},\n\"status\": \"success\",\n\"message\": \"affiliate product link fetched successfully\"\n}", "name": "" } ] }, { "name": "Create Product Link", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"seller_product_id\":1,\"landing_page_id\":1,\"seller_promotion_id\":1,\"display_name\":\"Maud Ward\",\"source_id\":1,\"source\":{\"name\":\"architecto\",\"primary_id\":\"architecto\",\"sub_id\":\"architecto\"},\"is_default\":false}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"status\": \"success\",\n\"message\": \"affiliate product link fetched successfully\",\n\"data\": {\n\"id\": \"alg_lZ2YpjWqvzamaoO79dDN\",\n\"display_name\": \"stesatasdf\",\n\"is_default\": false,\n\"is_system\": false,\n\"seller_product_id\": \"alg_lMWxe1baKXVm9gLnX8Qz\",\n\"product_name\": \"Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon\",\n\"product_image\": \"https:\/\/m.media-amazon.com\/images\/I\/81UaTcwVIFL._AA64_.jpg\",\n\"product_category_name\": \"Waxing Kits\",\n\"brand_name\": \"Emprian\",\n\"source\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"primary_id\": \"test2\",\n\"display_name\": \"test1\",\n\"sub_id\": \"test2\"\n},\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_lZ2YpjWqvzamaoO79dDN\",\n\"affiliate_amazon_tag\": null,\n\"promotion\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"value\": \"32.00\",\n\"value_type\": \"percent\"\n},\n\"landing_page\": {\n\"id\": \"alg_l9xnzAZ50B20eaW8XEBw\",\n\"name\": \"My landing page2\",\n\"template\": {\n\"id\": \"alg_rVkgED43KDgvRnx61lNz\",\n\"title\": \"Right Side - Purple\",\n\"content\": \"Et magni quia qui dicta nobis. Nostrum nihil rerum ipsa sit architecto et voluptatem.\\n\\nCommodi qui fuga illum saepe culpa sit. Quam odit sed laborum corrupti sapiente.\\n\\nAut nemo sequi qui aut illum facilis voluptas. Est molestiae non molestiae magni iusto. Necessitatibus asperiores sint eligendi sit. Et enim cupiditate dicta dignissimos voluptatem. Repudiandae iusto commodi rerum deserunt qui quo.\",\n\"thumbnail\": \"right-purple.png\",\n\"grid_id\": 3,\n\"color_id\": 2\n}\n},\n\"created_at\": 1718748552\n}\n}", "name": "" } ] }, { "name": "Set default product link", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links\/set-default\/:productLinkId", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links\/set-default\/:productLinkId", "variable": [ { "id": "productLinkId", "key": "productLinkId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n 'status'=>'success',\n 'message'=>'Default product link set successfully',\n 'data'=>[]\n}", "name": "" } ] }, { "name": "Show Product Link", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links\/:productLinkId", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links\/:productLinkId", "variable": [ { "id": "productLinkId", "key": "productLinkId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"status\": \"success\",\n\"message\": \"affiliate product link fetched successfully\",\n\"data\": {\n\"id\": \"alg_lZ2YpjWqvzamaoO79dDN\",\n\"display_name\": \"stesatasdf\",\n\"is_default\": false,\n\"is_system\": false,\n\"seller_product_id\": \"alg_lMWxe1baKXVm9gLnX8Qz\",\n\"product_name\": \"Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon\",\n\"product_image\": \"https:\/\/m.media-amazon.com\/images\/I\/81UaTcwVIFL._AA64_.jpg\",\n\"product_category_name\": \"Waxing Kits\",\n\"brand_name\": \"Emprian\",\n\"source\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"primary_id\": \"test2\",\n\"display_name\": \"test1\",\n\"sub_id\": \"test2\"\n},\n\"link\": \"https:\/\/buy.ainfluencer.com\/product-link\/alg_lZ2YpjWqvzamaoO79dDN\",\n\"affiliate_amazon_tag\": null,\n\"promotion\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"value\": \"32.00\",\n\"value_type\": \"percent\"\n},\n\"landing_page\": {\n\"id\": \"alg_l9xnzAZ50B20eaW8XEBw\",\n\"name\": \"My landing page2\",\n\"template\": {\n\"id\": \"alg_rVkgED43KDgvRnx61lNz\",\n\"title\": \"Right Side - Purple\",\n\"content\": \"Et magni quia qui dicta nobis. Nostrum nihil rerum ipsa sit architecto et voluptatem.\\n\\nCommodi qui fuga illum saepe culpa sit. Quam odit sed laborum corrupti sapiente.\\n\\nAut nemo sequi qui aut illum facilis voluptas. Est molestiae non molestiae magni iusto. Necessitatibus asperiores sint eligendi sit. Et enim cupiditate dicta dignissimos voluptatem. Repudiandae iusto commodi rerum deserunt qui quo.\",\n\"thumbnail\": \"right-purple.png\",\n\"grid_id\": 3,\n\"color_id\": 2\n}\n},\n\"created_at\": 1718748552\n}\n}", "name": "" } ] }, { "name": "Update Product Link", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links\/:productLinkId", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links\/:productLinkId", "variable": [ { "id": "productLinkId", "key": "productLinkId", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"landing_page_id\":1,\"display_name\":\"Maud Ward\",\"seller_promotion_id\":1,\"is_default\":false}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n 'status'=>'success',\n 'message'=>'product Link updated successfully',\n 'data'=>[]\n}", "name": "" } ] }, { "name": "Delete Product Link", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/products\/links\/:productLinkId", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/products\/links\/:productLinkId", "variable": [ { "id": "productLinkId", "key": "productLinkId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n 'status'=>'success',\n 'message'=>'affiliate product Link deleted successfully',\n 'data'=>[]\n}", "name": "" } ] } ] }, { "name": "Report", "description": "", "item": [ { "name": "Performance Report List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/reports\/performance", "query": [ { "key": "from_date", "value": "2023%2F08%2F11", "description": "", "disabled": false }, { "key": "to_date", "value": "2023%2F08%2F11", "description": "", "disabled": false }, { "key": "seller_product_id%5B%5D", "value": "4", "description": "", "disabled": false }, { "key": "seller_brand_id%5B%5D", "value": "7", "description": "", "disabled": false }, { "key": "seller_id%5B%5D", "value": "7", "description": "", "disabled": false }, { "key": "source_id%5B%5D", "value": "7", "description": "", "disabled": false }, { "key": "order_by%5Bdate%5D", "value": "asc", "description": "", "disabled": false }, { "key": "order_by%5Bcommission%5D", "value": "desc", "description": "", "disabled": false }, { "key": "order_by%5Bclicks%5D", "value": "asc", "description": "", "disabled": false }, { "key": "order_by%5Bsales%5D", "value": "desc", "description": "", "disabled": false }, { "key": "order_by%5Bconversions%5D", "value": "asc", "description": "", "disabled": false }, { "key": "order_by%5Bconversion_rate%5D", "value": "desc", "description": "", "disabled": false }, { "key": "page", "value": "1", "description": "", "disabled": false }, { "key": "platform", "value": "0", "description": "", "disabled": true } ], "raw": "{{baseUrl}}\/affiliate\/v1\/reports\/performance?from_date=2023%2F08%2F11&to_date=2023%2F08%2F11&seller_product_id%5B%5D=4&seller_brand_id%5B%5D=7&seller_id%5B%5D=7&source_id%5B%5D=7&order_by%5Bdate%5D=asc&order_by%5Bcommission%5D=desc&order_by%5Bclicks%5D=asc&order_by%5Bsales%5D=desc&order_by%5Bconversions%5D=asc&order_by%5Bconversion_rate%5D=desc&page=1&platform=0" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n {\n \"date\": 1701388800,\n \"clicks\": 20,\n \"add_to_cart\": 3,\n \"sales\": \"25.50\",\n \"conversions\": 5,\n \"conversion_rate\": 0,\n \"commission\": \"0.00\"\n }\n],\n\"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 2\n},\n\"status\": \"success\",\n\"message\": \"report fetched successfully\"\n}", "name": "" } ] }, { "name": "Product Report List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/reports\/product", "query": [ { "key": "from_date", "value": "2023%2F08%2F11", "description": "", "disabled": false }, { "key": "to_date", "value": "2023%2F08%2F11", "description": "", "disabled": false }, { "key": "seller_brand_id", "value": "7", "description": "", "disabled": false }, { "key": "page", "value": "1", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/reports\/product?from_date=2023%2F08%2F11&to_date=2023%2F08%2F11&seller_brand_id=7&page=1" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"seller_product_ids\":[0]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"product\": {\n\"id\": \"alg_EXdg5Yj903W0kwep28zo\",\n\"brand_id\": \"alg_PWZ7nGw8vJ1m4R1aX9My\",\n\"name\": \"Flexon WS100KITCN 20-Piece Soaker Hose Kit, 100 ft, Black\",\n\"thumbnail\": \"https:\/\/m.media-amazon.com\/images\/I\/61C+FHXWQVL._AA64_.jpg\",\n\"asin\": null,\n\"amazon_link\": \"https:\/\/www.amazon.com\/dp\/B07CXZSMM1?m=AQO9TRV0YRH57\"\n},\n\"clicks\": 200,\n\"add_to_cart\": 50,\n\"sales\": \"1200.00\",\n\"conversions\": 50,\n\"conversion_rate\": 25,\n\"commission\": \"200.00\"\n},\n{\n\"product\": {\n\"id\": \"alg_lMWxe1baKXVm9gLnX8Qz\",\n\"brand_id\": \"alg_g4rlB87nvyZKzZG5YEw1\",\n\"name\": \"Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon\",\n\"thumbnail\": \"https:\/\/m.media-amazon.com\/images\/I\/81UaTcwVIFL._AA64_.jpg\",\n\"asin\": null,\n\"amazon_link\": \"https:\/\/www.amazon.com\/dp\/B07YLG56B2?m=AQO9TRV0YRH57\"\n},\n\"clicks\": 703,\n\"add_to_cart\": 244,\n\"sales\": \"4000.00\",\n\"conversions\": 220,\n\"conversion_rate\": 31,\n\"commission\": \"850.00\"\n}\n],\n\"status\": \"success\",\n\"message\": \"report fetched successfully\"\n}", "name": "" } ] }, { "name": "Brand Report List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/reports\/brand", "query": [ { "key": "from_date", "value": "2023%2F08%2F11", "description": "", "disabled": false }, { "key": "to_date", "value": "2023%2F08%2F11", "description": "", "disabled": false }, { "key": "page", "value": "1", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/reports\/brand?from_date=2023%2F08%2F11&to_date=2023%2F08%2F11&page=1" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"seller_brand_ids\":[1]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"brand\": {\n\"id\": \"alg_PWZ7nGw8vJ1m4R1aX9My\",\n\"name\": \"Flexon\",\n\"image\": \"\"\n},\n\"clicks\": 200,\n\"add_to_cart\": 50,\n\"sales\": \"1200.00\",\n\"conversions\": 50,\n\"conversion_rate\": 25,\n\"commission\": \"200.00\"\n},\n{\n\"brand\": {\n\"id\": \"alg_g4rlB87nvyZKzZG5YEw1\",\n\"name\": \"Emprian\",\n\"image\": \"\"\n},\n\"clicks\": 703,\n\"add_to_cart\": 244,\n\"sales\": \"4000.00\",\n\"conversions\": 220,\n\"conversion_rate\": 31,\n\"commission\": \"850.00\"\n}\n],\n\"status\": \"success\",\n\"message\": \"report fetched successfully\"\n}", "name": "" } ] }, { "name": "Source Report List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/reports\/source", "query": [ { "key": "from_date", "value": "2023%2F08%2F11", "description": "", "disabled": false }, { "key": "to_date", "value": "2023%2F08%2F11", "description": "", "disabled": false }, { "key": "page", "value": "1", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/reports\/source?from_date=2023%2F08%2F11&to_date=2023%2F08%2F11&page=1" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"source_ids\":[0]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"date\": 1718713490,\n\"source\": {\n\"id\": \"alg_YVnAZalrvYLmXD2o5bJk\",\n\"name\": \"test2\"\n},\n\"clicks\": 0,\n\"add_to_cart\": 0,\n\"sales\": \"0.00\",\n\"conversions\": 0,\n\"conversion_rate\": 0,\n\"commission\": \"0.00\"\n},\n{\n\"date\": 1718713490,\n\"source\": {\n\"id\": \"alg_7b9ZAVdemE2voXyxNPR8\",\n\"name\": \"test1\"\n},\n\"clicks\": 903,\n\"add_to_cart\": 294,\n\"sales\": \"5200.00\",\n\"conversions\": 270,\n\"conversion_rate\": 29,\n\"commission\": \"1050.00\"\n}\n],\n\"status\": \"success\",\n\"message\": \"report fetched successfully\"\n}", "name": "" } ] }, { "name": "Landing Page Report List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/reports\/landing-page", "query": [ { "key": "from_date", "value": "2023%2F08%2F11", "description": "", "disabled": false }, { "key": "to_date", "value": "2023%2F08%2F11", "description": "", "disabled": false }, { "key": "seller_product_id", "value": "4", "description": "", "disabled": false }, { "key": "page", "value": "1", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/reports\/landing-page?from_date=2023%2F08%2F11&to_date=2023%2F08%2F11&seller_product_id=4&page=1" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"landing_page_ids\":[0]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": \"alg_YVnAZalrvYLmXD2o5bJk\",\n\"name\": \"test\",\n\"views\": 3,\n\"conversions\": 2,\n\"conversion_rate\": \"0.67\"\n},\n{\n\"id\": \"alg_X2Zq8RbnvPz0wM56WEoz\",\n\"name\": \"test2\",\n\"views\": 4,\n\"conversions\": 3,\n\"conversion_rate\": \"0.75\"\n}\n],\n\"status\": \"success\",\n\"message\": \"report fetched successfully\"\n}", "name": "" } ] } ] }, { "name": "Shopify Store", "description": "", "item": [ { "name": "Store List", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/stores", "query": [ { "key": "main_category_id", "value": "1+or+%5B1%2C2%2C3%5D", "description": "Filter by main category ID(s). Can be a single ID or array of IDs.", "disabled": false }, { "key": "min_avg_price", "value": "10.50", "description": "Filter stores with average price greater than or equal to this value.", "disabled": false }, { "key": "max_avg_price", "value": "100.00", "description": "Filter stores with average price less than or equal to this value.", "disabled": false }, { "key": "min_avg_commission", "value": "5.00", "description": "Filter stores with average commission greater than or equal to this value.", "disabled": false }, { "key": "max_avg_commission", "value": "20.00", "description": "Filter stores with average commission less than or equal to this value.", "disabled": false }, { "key": "status", "value": "active", "description": "Filter by status. Can be numeric (1=Active, 2=Inactive, 3=Suspended) or string (active, inactive, suspended).", "disabled": false }, { "key": "partnership_status", "value": "partnered", "description": "Filter by partnership status. Values: partnered, not_partnered.", "disabled": false }, { "key": "order_by%5Bmain_category_id%5D", "value": "asc", "description": "Sort by main category ID. Values: asc, desc.", "disabled": false }, { "key": "order_by%5Bproduct_count%5D", "value": "", "description": "Sort by product count. Values: asc, desc.", "disabled": true }, { "key": "order_by%5Bavg_price%5D", "value": "desc", "description": "Sort by average price. Values: asc, desc.", "disabled": false }, { "key": "order_by%5Bavg_commission%5D", "value": "desc", "description": "Sort by average commission. Values: asc, desc.", "disabled": false }, { "key": "order_by%5Bstatus%5D", "value": "asc", "description": "Sort by status. Values: asc, desc.", "disabled": false }, { "key": "order_by%5Bpartnership_status%5D", "value": "desc", "description": "Sort by partnership status. Values: asc, desc.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of items per page. Default: 15. Max: 100.", "disabled": false } ], "raw": "{{baseUrl}}\/affiliate\/v1\/stores?main_category_id=1+or+%5B1%2C2%2C3%5D&min_avg_price=10.50&max_avg_price=100.00&min_avg_commission=5.00&max_avg_commission=20.00&status=active&partnership_status=partnered&order_by%5Bmain_category_id%5D=asc&order_by%5Bproduct_count%5D=&order_by%5Bavg_price%5D=desc&order_by%5Bavg_commission%5D=desc&order_by%5Bstatus%5D=asc&order_by%5Bpartnership_status%5D=desc&per_page=20" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": \"alg_PWZ7nGw8vJ1m4R1aX9My\",\n\"store_domain\": \"example.myshopify.com\",\n\"seller\": {\n\"id\": \"alg_PWZ7nGw8vJQ1m4R1aX9M\",\n\"name\": \"S.Ahmad\",\n\"avatar\": \"\"\n},\n\"main_category\": null,\n\"products_count\": 10,\n\"avg_price\": null,\n\"avg_commission\": null,\n\"partnership_status\": \"partnered\"\n}\n],\n\"pagination\": {\n\"current_page\": 1,\n\"per_page\": 15,\n\"total\": 1\n},\n\"status\": \"success\",\n\"message\": \"stores fetched successfully\"\n}", "name": "" } ] }, { "name": "Store Show", "request": { "url": { "host": "{{baseUrl}}", "path": "affiliate\/v1\/stores\/:id", "query": [], "raw": "{{baseUrl}}\/affiliate\/v1\/stores\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the Shopify Account Store." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "X-Platform", "value": "shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"encoded_store_id\",\n \"store_domain\": \"example.myshopify.com\",\n \"shop_name\": \"Example Store\",\n \"main_category\": {\n \"id\": \"encoded_category_id\",\n \"name\": \"Electronics\"\n },\n \"avg_commission\": \"15.50\",\n \"avg_price\": \"299.99\",\n \"terms_of_sale\": null,\n \"seller\": {\n \"id\": \"encoded_seller_id\",\n \"name\": \"John Doe\",\n \"avatar\": \"https:\/\/api.dicebear.com\/9.x\/initials\/png?seed=John+Doe\"\n },\n \"product_count\": 12,\n \"status\": \"active\",\n \"partnership_status\": \"partnered\",\n \"active_partnership_request\": {\n \"id\": \"encoded_request_id\",\n \"status\": \"pending\",\n \"commission\": \"20.00\",\n \"commission_type\": \"percent\",\n \"is_custom_commission\": \"1\",\n \"message\": \"Partnership request message\",\n \"type\": \"affiliate_to_seller\",\n \"created_at\": 1640995200\n },\n \"affiliate_count\": 3,\n \"partnership_applied_date\": 1640995200\n },\n \"status\": \"success\",\n \"message\": \"store fetched successfully\"\n}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }