{ "info": { "_postman_id": "db37cedd-893c-4a6e-b0cf-cef5ac99e1db", "name": "Omnivore V2 API Copy", "description": "Example usage of Omnivore V2 JSON/REST API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "25689277" }, "item": [ { "name": "List products", "request": { "method": "GET", "header": [ { "key": "X-OMNIVORE-CLIENT-ID", "value": "VDof7rRAiEyYDlV4OGqZQ1icJZNKGfBu", "type": "text" }, { "key": "X-OMNIVORE-CLIENT-SECRET", "value": "mfo8X98glsU0GSOE2gItwza2imO105x8", "type": "text" } ], "url": { "raw": "https://m2.omnivore.com.au/v2/retailer/all-that-digi/products/list", "protocol": "https", "host": [ "m2", "omnivore", "com", "au" ], "path": [ "v2", "retailer", "all-that-digi", "products", "list" ] }, "description": "List the current product catalogue" }, "response": [] }, { "name": "List orders", "request": { "method": "GET", "header": [ { "key": "X-OMNIVORE-CLIENT-ID", "value": "VDof7rRAiEyYDlV4OGqZQ1icJZNKGfBu", "type": "text" }, { "key": "X-OMNIVORE-CLIENT-SECRET", "value": "mfo8X98glsU0GSOE2gItwza2imO105x8", "type": "text" } ], "url": { "raw": "https://m2.omnivore.com.au/v2/retailer/all-that-digi/products/list", "protocol": "https", "host": [ "m2", "omnivore", "com", "au" ], "path": [ "v2", "retailer", "all-that-digi", "products", "list" ] }, "description": "List the current product catalogue" }, "response": [] }, { "name": "Upload products", "request": { "method": "POST", "header": [ { "key": "X-OMNIVORE-CLIENT-ID", "type": "text", "value": "VDof7rRAiEyYDlV4OGqZQ1icJZNKGfBu" }, { "key": "X-OMNIVORE-CLIENT-SECRET", "type": "text", "value": "mfo8X98glsU0GSOE2gItwza2imO105x8" } ], "body": { "mode": "raw", "raw": "{\r\n \"products\": [ \r\n {\r\n \"id\": 90681470,\r\n \"sku\": \"31998935065\",\r\n \"name\": \"Catch of the day\",\r\n \"url\": \"https://all-that-digi.myshopify.com/products/catch-of-the-day\",\r\n \"description\": \"<p>The freshest snapper fillet available. Cleaned with the choice of skin on or removed.</p>\\n<p>Each portion weighs approximately 200grams</p>\\n<p> </p>\",\r\n \"brand\": \"All That Digi\",\r\n \"active\": true,\r\n \"condition\": \"new\",\r\n \"categories\": [\r\n {\r\n \"code\": \"default\",\r\n \"name\": \"DEFAULT CATEGORY\",\r\n \"path\": \"DEFAULT CATEGORY\",\r\n \"parent_code\": null\r\n }\r\n ],\r\n \"variants\": [\r\n {\r\n \"id\": 165325404,\r\n \"sku\": \"177370464281\",\r\n \"upc\": null,\r\n \"ean\": null,\r\n \"isbn\": null,\r\n \"mpn\": null,\r\n \"sell_price\": {\r\n \"with_tax\": \"5.50\",\r\n \"without_tax\": \"5.00\",\r\n \"tax\": \"0.50\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"rrp_price\": {\r\n \"with_tax\": \"5.50\",\r\n \"without_tax\": \"5.00\",\r\n \"tax\": \"0.50\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"quantity\": 10,\r\n \"options\": [\r\n {\r\n \"name\": \"Skin\",\r\n \"value\": \"Skin on\"\r\n },\r\n {\r\n \"name\": \"Servings\",\r\n \"value\": \"2\"\r\n }\r\n ],\r\n \"weight\": \"0.2\",\r\n \"width\": null,\r\n \"length\": null,\r\n \"height\": null,\r\n \"shipping_options\": [\r\n \"express\",\r\n \"standard\"\r\n ],\r\n \"images\": [\r\n \"https://cdn.shopify.com/s/files/1/0551/2993/products/download.jpg\",\r\n \"https://cdn.shopify.com/s/files/1/0551/2993/products/snapper_fillets.jpg\",\r\n \"https://cdn.shopify.com/s/files/1/0551/2993/products/fillets.jpg\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": 90681469,\r\n \"sku\": \"9676118284\",\r\n \"name\": \"aussie thongs\",\r\n \"url\": \"https://all-that-digi.myshopify.com/products/aussie-thongs\",\r\n \"description\": \"<p>aussie thongs</p>\",\r\n \"brand\": \"All That Digi\",\r\n \"active\": true,\r\n \"condition\": \"new\",\r\n \"categories\": [\r\n {\r\n \"code\": \"frontpage\",\r\n \"name\": \"Frontpage\",\r\n \"path\": \"Frontpage\",\r\n \"parent_code\": null\r\n }\r\n ],\r\n \"variants\": [\r\n {\r\n \"id\": 165325401,\r\n \"sku\": \"34266263948\",\r\n \"upc\": null,\r\n \"ean\": null,\r\n \"isbn\": null,\r\n \"mpn\": \"T2\",\r\n \"sell_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"rrp_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"quantity\": 10,\r\n \"options\": [\r\n {\r\n \"name\": \"Size\",\r\n \"value\": \"Med\"\r\n }\r\n ],\r\n \"weight\": \"0.0\",\r\n \"width\": null,\r\n \"length\": null,\r\n \"height\": null,\r\n \"shipping_options\": [\r\n \"express\",\r\n \"standard\"\r\n ],\r\n \"images\": [\r\n \"https://cdn.shopify.com/s/files/1/0551/2993/products/thongs_3.jpg\"\r\n ]\r\n },\r\n {\r\n \"id\": 165325403,\r\n \"sku\": \"34266264012\",\r\n \"upc\": null,\r\n \"ean\": null,\r\n \"isbn\": null,\r\n \"mpn\": \"T3\",\r\n \"sell_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"rrp_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"quantity\": 9,\r\n \"options\": [\r\n {\r\n \"name\": \"Size\",\r\n \"value\": \"Large\"\r\n }\r\n ],\r\n \"weight\": \"0.0\",\r\n \"width\": null,\r\n \"length\": null,\r\n \"height\": null,\r\n \"shipping_options\": [\r\n \"express\",\r\n \"standard\"\r\n ],\r\n \"images\": [\r\n \"https://cdn.shopify.com/s/files/1/0551/2993/products/thongs_2.jpg\"\r\n ]\r\n },\r\n {\r\n \"id\": 165325402,\r\n \"sku\": \"36066036428\",\r\n \"upc\": null,\r\n \"ean\": null,\r\n \"isbn\": null,\r\n \"mpn\": \"T1\",\r\n \"sell_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"rrp_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"quantity\": 0,\r\n \"options\": [\r\n {\r\n \"name\": \"Size\",\r\n \"value\": \"Small\"\r\n }\r\n ],\r\n \"weight\": \"0.0\",\r\n \"width\": null,\r\n \"length\": null,\r\n \"height\": null,\r\n \"shipping_options\": [\r\n \"express\",\r\n \"standard\"\r\n ],\r\n \"images\": [\r\n \"https://cdn.shopify.com/s/files/1/0551/2993/products/thongs_1.jpg\"\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://m2.omnivore.com.au/v2/retailer/all-that-digi/products/bulkUpdate", "protocol": "https", "host": [ "m2", "omnivore", "com", "au" ], "path": [ "v2", "retailer", "all-that-digi", "products", "bulkUpdate" ] }, "description": "Upload products" }, "response": [] }, { "name": "Upload inventory", "request": { "method": "POST", "header": [ { "key": "X-OMNIVORE-CLIENT-ID", "type": "text", "value": "VDof7rRAiEyYDlV4OGqZQ1icJZNKGfBu" }, { "key": "X-OMNIVORE-CLIENT-SECRET", "type": "text", "value": "mfo8X98glsU0GSOE2gItwza2imO105x8" } ], "body": { "mode": "raw", "raw": "{\r\n \"products\": [ \r\n {\r\n \"sku\": \"31998935065\",\r\n \"variants\": [\r\n {\r\n \"sku\": \"177370464281\",\r\n \"sell_price\": {\r\n \"with_tax\": \"5.50\",\r\n \"without_tax\": \"5.00\",\r\n \"tax\": \"0.50\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"rrp_price\": {\r\n \"with_tax\": \"5.50\",\r\n \"without_tax\": \"5.00\",\r\n \"tax\": \"0.50\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"quantity\": 8\r\n }\r\n ]\r\n },\r\n {\r\n \"sku\": \"9676118284\",\r\n \"variants\": [\r\n {\r\n \"sku\": \"34266263948\",\r\n \"sell_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"rrp_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"quantity\": 10\r\n },\r\n {\r\n \"sku\": \"34266264012\",\r\n \"sell_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"rrp_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"quantity\": 9\r\n },\r\n {\r\n \"sku\": \"36066036428\",\r\n \"sell_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"rrp_price\": {\r\n \"with_tax\": \"55.00\",\r\n \"without_tax\": \"50.00\",\r\n \"tax\": \"5.00\",\r\n \"currency\": \"AUD\"\r\n },\r\n \"quantity\": 0\r\n }\r\n ]\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://m2.omnivore.com.au/v2/retailer/all-that-digi/inventory/bulkUpdate", "protocol": "https", "host": [ "m2", "omnivore", "com", "au" ], "path": [ "v2", "retailer", "all-that-digi", "inventory", "bulkUpdate" ] }, "description": "Upload products" }, "response": [] }, { "name": "Order acknowledge", "request": { "method": "POST", "header": [ { "key": "X-OMNIVORE-CLIENT-ID", "type": "text", "value": "VDof7rRAiEyYDlV4OGqZQ1icJZNKGfBu" }, { "key": "X-OMNIVORE-CLIENT-SECRET", "type": "text", "value": "mfo8X98glsU0GSOE2gItwza2imO105x8" } ], "body": { "mode": "raw", "raw": "{\r\n \"order_number\": \"12345678901234567890\",\r\n \"status\": \"pending-shipped\"\r\n}" }, "url": { "raw": "https://m2.omnivore.com.au/v2/retailer/all-that-digi/marketplace/ebay/order/update", "protocol": "https", "host": [ "m2", "omnivore", "com", "au" ], "path": [ "v2", "retailer", "all-that-digi", "marketplace", "ebay", "order", "update" ] }, "description": "Upload products" }, "response": [] }, { "name": "Order ship", "request": { "method": "POST", "header": [ { "key": "X-OMNIVORE-CLIENT-ID", "type": "text", "value": "VDof7rRAiEyYDlV4OGqZQ1icJZNKGfBu" }, { "key": "X-OMNIVORE-CLIENT-SECRET", "type": "text", "value": "mfo8X98glsU0GSOE2gItwza2imO105x8" } ], "body": { "mode": "raw", "raw": "{\r\n \"order_number\": \"12345678901234567890\",\r\n \"status\": \"shipped\",\r\n \"shipping\":\r\n {\r\n \"carrier\": \"Australia Post\",\r\n \"tracking_code\": \"1234567890\"\r\n },\r\n \"line_items\": [\r\n {\r\n \"product_sku\": \"5235AF\",\r\n \"variant_sku\": \"5235AF-RED-XL\",\r\n \"quantityShipped\": 2\r\n },\r\n {\r\n \"product_sku\": \"5235AF\",\r\n \"variant_sku\": \"5235AF-BLUE-XL\",\r\n \"quantityShipped\": 1\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://m2.omnivore.com.au/v2/retailer/all-that-digi/marketplace/ebay/order/update", "protocol": "https", "host": [ "m2", "omnivore", "com", "au" ], "path": [ "v2", "retailer", "all-that-digi", "marketplace", "ebay", "order", "update" ] }, "description": "Upload products" }, "response": [] }, { "name": "Order refund", "request": { "method": "POST", "header": [ { "key": "X-OMNIVORE-CLIENT-ID", "type": "text", "value": "VDof7rRAiEyYDlV4OGqZQ1icJZNKGfBu" }, { "key": "X-OMNIVORE-CLIENT-SECRET", "type": "text", "value": "mfo8X98glsU0GSOE2gItwza2imO105x8" } ], "body": { "mode": "raw", "raw": "{\r\n \"order_number\": \"12345678901234567890\",\r\n \"status\": \"refunded-online\",\r\n \"refund\": {\r\n \"reason\": \"Damaged goods\",\r\n \"reference\": \"33WDL500722366600655001\"\r\n }\r\n \"line_items\": [\r\n {\r\n \"product_sku\": \"5235AF\",\r\n \"variant_sku\": \"5235AF-RED-XL\",\r\n \"quantityRefunded\": 2\r\n },\r\n {\r\n \"product_sku\": \"5235AF\",\r\n \"variant_sku\": \"5235AF-BLUE-XL\",\r\n \"quantityRefunded\": 1\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://m2.omnivore.com.au/v2/retailer/all-that-digi/marketplace/ebay/order/update", "protocol": "https", "host": [ "m2", "omnivore", "com", "au" ], "path": [ "v2", "retailer", "all-that-digi", "marketplace", "ebay", "order", "update" ] }, "description": "Upload products" }, "response": [] }, { "name": "Order ready for pick up", "request": { "method": "POST", "header": [ { "key": "X-OMNIVORE-CLIENT-ID", "type": "text", "value": "VDof7rRAiEyYDlV4OGqZQ1icJZNKGfBu" }, { "key": "X-OMNIVORE-CLIENT-SECRET", "type": "text", "value": "mfo8X98glsU0GSOE2gItwza2imO105x8" } ], "body": { "mode": "raw", "raw": "{\r\n \"order_number\": \"12345678901234567890\",\r\n \"status\": \"ready-for-pick-up\",\r\n \"ready_for_pick_up\": {\r\n \"note\": \"Go to the customer service counter\",\r\n \"code\": \"4345736683\"\r\n }\r\n \"line_items\": [\r\n {\r\n \"product_sku\": \"5235AF\",\r\n \"variant_sku\": \"5235AF-RED-XL\",\r\n \"quantityReadyForPickup\": 2\r\n },\r\n {\r\n \"product_sku\": \"5235AF\",\r\n \"variant_sku\": \"5235AF-BLUE-XL\",\r\n \"quantityReadyForPickup\": 1\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://m2.omnivore.com.au/v2/retailer/all-that-digi/marketplace/ebay/order/update", "protocol": "https", "host": [ "m2", "omnivore", "com", "au" ], "path": [ "v2", "retailer", "all-that-digi", "marketplace", "ebay", "order", "update" ] }, "description": "Upload products" }, "response": [] }, { "name": "Order picked up", "request": { "method": "POST", "header": [ { "key": "X-OMNIVORE-CLIENT-ID", "type": "text", "value": "VDof7rRAiEyYDlV4OGqZQ1icJZNKGfBu" }, { "key": "X-OMNIVORE-CLIENT-SECRET", "type": "text", "value": "mfo8X98glsU0GSOE2gItwza2imO105x8" } ], "body": { "mode": "raw", "raw": "{\r\n \"order_number\": \"12345678901234567890\",\r\n \"status\": \"ready-for-pick-up\",\r\n \"ready_for_pickup\": {\r\n \"note\": \"Go to the customer service counter\",\r\n \"code\": \"4345736683\"\r\n }\r\n \"line_items\": [\r\n {\r\n \"product_sku\": \"5235AF\",\r\n \"variant_sku\": \"5235AF-RED-XL\",\r\n \"quantityReadyForPickup\": 2\r\n },\r\n {\r\n \"product_sku\": \"5235AF\",\r\n \"variant_sku\": \"5235AF-BLUE-XL\",\r\n \"quantityReadyForPickup\": 1\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://m2.omnivore.com.au/v2/retailer/all-that-digi/marketplace/ebay/order/update", "protocol": "https", "host": [ "m2", "omnivore", "com", "au" ], "path": [ "v2", "retailer", "all-that-digi", "marketplace", "ebay", "order", "update" ] }, "description": "Upload products" }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }