{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1180cdb0-b193-4fb5-8292-62686092abf0","name":"EdgeOS API Docs","description":"Welcome to Edgistify's API Documentation. We've designed this document to help developers integrate their system with Edgistify EdgeOS for seamless and efficient operations.\n\nWe've listed all the APIs, their required parameters, and their example requests and responses on the right for easy understanding. The easiest way to start using the Edgistify APIs is by clicking the **Run in Postman** button above. The [Postman]() is a free tool that helps developers run and debug API requests.\n\nOur APIs are based around [REST]() architecture and use the basic [HTTP]() request methods. Our APIs accept [JSON]() - encoded body requests and return data in the same form.\n\nRead through the following sections for the integration process.\n\n# Webhooks\n\n## **Order Status Updates:**\n\nYou can set up a Webhook with Edgistify to get order status updates. We will proactively notify your system whenever there is a new update for an order.\n\n#### **Setup**:\n\n\\* Share the Webhook url for Order status with the Edgistify team.  \n\\* Share the security token (not mandatory).\n\nWhenever there's a status update for any of your orders in the Edgistify system, a POST request is made to the callback URL you shared with us for order status update.\n\n#### **Webhook Specifications:**\n\n\\* Method: POST  \n\\* The `Content-Type` header should be set to `application/json`  \n\\* Security token should be an`x-api-key`  \n\\* The URL should be set to send only code 200 in response.\n\n#### SAMPLE BODY:\n\n```\n{\n    \"edgId\": \"74748654\",\n    \"orderId\": \"7474865\",\n    \"warehouseName\": \"New Warehouse\",\n    \"marketplaceName\": \"Amazon\",\n    \"paymentStatus\": \"Prepaid\", // enum: [\"Prepaid\", \"COD\"]\n    \"orderTimestamp\": \"2022-05-22 11:17:30\",\n    \"importTimestamp\": \"2022-05-22 11:17:30\",\n    \"turnAroundTime\": \"2022-05-22 11:17:30\",\n    \"orderCategory\": \"Ecommerce\", // enum: [\"Ecommerce\", \"Hyperlocal\"]\n    \"slaBreachDate\": \"2022-05-22 11:17:30\",\n    \"isErrorOrder\": false, // Boolean\n    \"errorReason\": \"\", // Error reason exists only when isErrorOrder is true. Possible values: [\"AWB not assigned\", \"Tax code unavailable\", \"Missing Package Dimension\", \"Unmapped SKU\", \"Unknown SKU\", \"Inventory not assigned\", \"No warehouse serving this Pincode\", \"No suitable box found\", \"\"]\n    \"orderStatus\": \"DELIVERED\", // enum: [\"CREATED\", \"IMPORTED\", \"ORDER_PICKED\", \"ORDER_IN_PROCESS\", \"INVOICE_PRINTED\", \"LABEL_PRINTED\", \"PICKLIST_PRINTED\", \"LABEL_INVOICE_PRINTED\", \"READY_TO_DISPATCH\", \"MANIFEST_GENERATED\", \"DISPATCHED\", \"DELIVERED\", \"RETURNED\"]\n    \"statusDetails\": [\n        {\n            \"_id\": 1,\n            \"status\": \"Added to Batch\",\n            \"dateAndTime\": \"2022-09-09 09:11:28\",\n            \"otherDetails\": \"Batch ID: 100137\",\n            \"isActive\": true\n        },\n        {\n            \"_id\": 2,\n            \"status\": \"Picked\",\n            \"dateAndTime\": \"2022-09-09 09:13:21\",\n            \"otherDetails\": \"Picker: PICKER\",\n            \"isActive\": true\n        },\n        {\n            \"_id\": 4,\n            \"status\": \"Manifest Generated\",\n            \"dateAndTime\": \"2022-09-09 09:18:31\",\n            \"otherDetails\": \"Manifest ID: 100067\",\n            \"isActive\": true\n        },\n        {\n            \"_id\": 3,\n            \"status\": \"Packed\",\n            \"dateAndTime\": \"2022-09-09 09:50:11\",\n            \"otherDetails\": \"Order Packed\",\n            \"isActive\": true\n        },\n        {\n            \"_id\": 6,\n            \"isActive\": true,\n            \"status\": \"In Transit\",\n            \"dateAndTime\": \"2022-09-16 16:21:03\",\n            \"otherDetails\": \"Shiprocket: SRTP2201036488\"\n        },\n        {\n            \"_id\": 5,\n            \"isActive\": true,\n            \"status\": \"Dispatched\",\n            \"dateAndTime\": \"2022-09-12 17:48:44\",\n            \"otherDetails\": \"Shiprocket: SRTP2201036488\"\n        },\n        {\n            \"_id\": 7,\n            \"isActive\": true,\n            \"status\": \"Delivered\",\n            \"dateAndTime\": \"2022-09-17 06:30:38\",\n            \"otherDetails\": \"Order delivered\"\n        }\n    ],\n    \"shippingPartner\": {\n        \"awbNumber\": \"SRTP2201036488\",\n        \"courierAggregator\": \"Shiprocket\",\n        \"name\": \"Ekart Logistics Surface\",\n        \"shippingStatus\": \"GENERATED_AWB\",\n        \"shippingStatusReadable\": \"AWB Number Generated\",\n        \"shippingMethod\": \"Surface\",\n        \"manifestDate\": \"2022-09-09 09:18:31\",\n        \"manifestId\": 100067\n    },\n    \"orderSkus\": [\n        {\n            \"productSku\": \"pyjama2\",\n            \"isInventoryAssigned\": true\n        },\n        {\n            \"productSku\": \"GL858585ES\",\n            \"isInventoryAssigned\": true\n        }\n    ],\n    \"shippingPartnerErrorReasons\": \"\", // Exists in case the order converts to error order and the errorReason is \"AWB not assigned\"\n    // Shipping partner error example:\n    // shippingPartnerErrorReasons: [\n    //     { shippingPartnerName: 'FarEye',\n    //    errorReason: { status_code: 400,\n    //       message: 'Failed :  Hub must be present in the datastore !'\n    //         }\n    //     },\n    //     { shippingPartnerName: 'Shiprocket',\n    //    errorReason: { status_code: 350,\n    //       message: 'Please recharge your ShipRocket wallet. The minimum required balance is Rs 100'\n    //         }\n    //     }\n    // ]\n}\n\n ```\n\n## **Inventory Updates:**\n\nWe will proactively notify your system whenever there is an inventory update in any of your warehouses.\n\n#### **Setup**:\n\n\\* Share the Webhook url for Inventory status with the Edgistify team.  \n\\* Share the security token (not mandatory).\n\nWhenever there is an inventory update in any of your warehouses in the Edgistify system, a POST request is made to the callback URL you shared with us for Inventory update details.\n\n#### **Webhook Specifications:**\n\n\\* Method: POST  \n\\* The `Content-Type` header should be set to `application/json`  \n\\* Security token should be an`x-api-key`  \n\\* The URL should be set to send only code 200 in response.\n\n#### SAMPLE BODY:\n\n```\n{\n    \"_id\": \"62f0c83f609cbf12c3c8ca0d\",\n    \"warehouseName\": \"Sumeet Warehouse\",\n    \"total_Qty\": 3344,\n    \"total_skus\": 1,\n    \"isActive\": true\n}\n\n ```\n\nThis notifies your system about inventory update in any of your linked warehouses. In order to sync the inventory in detail, please use the `https://app.edgistify.com/api_c/master-inventory/warehouse/product/list` API described in the Inventory APIs section, by using the `_id` from the above result as `warehouse_id`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33233418","team":6064492,"collectionId":"1180cdb0-b193-4fb5-8292-62686092abf0","publishedId":"2sA2rFQed6","public":true,"publicUrl":"https://apidocs.edgistify.com","privateUrl":"https://go.postman.co/documentation/33233418-1180cdb0-b193-4fb5-8292-62686092abf0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"EgdeOS API Collection"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/dea7cd5e-63ba-4122-9f28-22200bde27f2/ZWRnaXN0aWZ5LnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/e1a236e1-7148-4e73-a872-4ec4e8aed1f0/ZWRnaXN0aWZ5LnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-02-27T11:30:31.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"EgdeOS API Collection","description":""},"logos":{"logoLight":"https://content.pstmn.io/e1a236e1-7148-4e73-a872-4ec4e8aed1f0/ZWRnaXN0aWZ5LnBuZw==","logoDark":"https://content.pstmn.io/dea7cd5e-63ba-4122-9f28-22200bde27f2/ZWRnaXN0aWZ5LnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/49de1a83fbe1fd3441cd1b37d130f9721e381d07bb9009866f1dc13db39166a1","favicon":"https://edgistify.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apidocs.edgistify.com/view/metadata/2sA2rFQed6"}