{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fc955907-89f0-42ba-87f6-2907e0d75a7d","name":"Omuni.cloud - APIs","description":"Welcme to Shiprocket Omuni!  \nOmuni, now a part of **Shiprocket**, is India’s leading omnichannel retail enablement platform. Originally built by Arvind Internet and developed by retail industry experts, Omuni has been at the forefront of solving the technological and operational complexities of unified commerce.  \nToday, as part of the **Shiprocket ecosystem**, we power the omnichannel journeys of 100+ global and Indian brands across 10,000+ stores, marketplaces, and digital touchpoints.  \nThis document is designed to help developer teams from Omuni customers & partners to fully understand and integrate Omuni API(s).  \nThe APIs are listed along with their required parameters if any, and their example requests and responses on the right, for easy understanding. The easiest way to start using the Omuni APIs, is by clicking the **Run in Postman** button above. [Postman](https://www.getpostman.com/) is a free tool that helps developers run and debug API requests.  \nOur APIs are based around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) architecture and use the basic [HTTP](https://www.tutorialspoint.com/http/http_status_codes) request methods. Our APIs accept [JSON](https://www.w3schools.com/whatis/whatis_json.asp) - encoded body requests and return back data in the same form.\n\n# Instructions for Onboarding\n\n- First step is to signup for an Omuni account. Reach out to your Account or Delivery manager for the same.\n    \n- Follow the API specs mentioned here to integrate for specific omnichannel journeys.\n    \n- For any questions/queries/doubts - please reach out to your Account or Delivery Manager. Or Write to us at [csm_team@omuni.com](https://mailto:csm_team@omuni.com).\n    \n- Your Account or Delivery manager will also provide you with the credentials needed for authentications of the APIs\n    \n\n# Document and API Usage Guidelines\n\n- Our APIs use the basic HTTP request codes: _POST_, _GET_, etc.\n    \n- You can select the required response and request code language by selecting it from the drop-down menu on the top.\n    \n- You can test all our APIs by importing the full API collection through the **'Run in Postman'** button and running them in the Postman app.\n    \n- To use Omuni APIs, a proper data setup needs to be done for inventory, catalog, stores, and mappings. The given payloads are samples and can't be used for your testing. It will return an error/ bad payload response.\n    \n- The base URL, credentials differ for QA/ Staging and Production. Few examples:\n    \n- Pre-Prod base URL: [https://api-preprod.ailiens.com/b/namo/api/v1/](https://api-preprod.ailiens.com/b/namo/api/v1/)\n    \n- Production base URL:[https://mplace.omuni.com/api/v1/](https://mplace.omuni.com/api/v1/)\n    \n- **Note**: Any requests made using the valid API credentials will affect the production data in your Omuni account.\n    \n- All the APIs are provided with their appropriate example requests and responses. The example definitions are:\n    \n    - **Successful Call** : The correct API call was made.\n        \n    - **Invalid Data** : The data entered was incorrect.\n        \n    - **Missing Fields** : Some of the required fields are missing.\n        \n    - **Wrong Format** : There is a syntax error in the code.\n        \n\n# Errors and Response codes\n\nWhile using Omuni APIs, you may run into some standard response and error codes. The most common ones are listed along with their descriptions as follows:\n\n| **RESPONSE CODE** | **DESCRIPTION** |\n| --- | --- |\n| `200` & `202` - **OK** & **Accepted** | Everything worked as expected. The response is displayed or the processing starts. Some API's may respond with an error message if data is invalid. |\n| `400` - **Bad Request** | The request was unacceptable, often due to missing a required parameter. |\n| `401` - **Unauthorized** | There is some error in validation. You need to check your token or credentials. |\n| `404` - **Not Found** | The URL is inaccessible. This is either due to the wrong URL input or the resource being depreciated. |\n| `405` - **Method Not Allowed** | The API was accessed using a wrong method. Check your HTTP method. |\n| `422` - **Unprocessable Entity** | It means the request contains incorrect syntax or cannot be fulfilled. Try checking your code for errors. |\n| `429` - **Too Many Requests** | Too many hits were attempted at the API too quickly. Provide the API some time to process. |\n| `500`, `502`, `503`, `504` - **Server Errors** | Some server error occurred. Some APIs may show this due to syntax or parameter errors. Try contacting support if this persists. |\n\n### Support:\n\n- For any integration and API related support, please feel free to drop us an email at [csm_team@omuni.com](https://mailto:csm_team@omuni.com).\n    \n- For any other issues, please contact your Account or Delivery manager.\n    \n- Omuni's Privacy Policy listed here: [Privacy Policy](https://www.omuni.com/privacy-policy)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12807531","team":1282018,"collectionId":"fc955907-89f0-42ba-87f6-2907e0d75a7d","publishedId":"TVejhptE","public":true,"publicUrl":"https://developers.omuni.com","privateUrl":"https://go.postman.co/documentation/12807531-fc955907-89f0-42ba-87f6-2907e0d75a7d","customColor":{"top-bar":"ffffff","right-sidebar":"303030","highlight":"EC008C"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2021-03-31T16:14:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/14d3eeb039a2468b52e45d636b91875a11b4be93214389329bfaf17cb1c667c0","favicon":"https://res.cloudinary.com/postman/image/upload/v1621961396/team/reqv0a3xpdhlk8xxh4gg.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":"http://developers.omuni.com/view/metadata/TVejhptE"}