{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","description":"## ⚠️ **Important Notice**\n\n> The following fields will be deprecated from our Custom Integration APIs starting **30th September 2025 11:59 PM UTC** :  \n• The “**order_items**” field in the Get Seller Orders API response when using the query parameter include=order_items.  \nWe recommend you review and update your custom integrations to ensure they're compatible with these changes. \n  \n\n# **Welcome to Omniful’s API Documentation 🚀**\n\nWe’ve written this documentation to help developers and Omniful users **seamlessly integrate and deploy** Custom Integrations using our API with ease. With these APIs, you can access and manage most of the features available on your Omniful dashboard.\n\nFor ease of use, we have documented all API endpoints, including their **required parameters, example requests, and responses**, which you can find on the right side in the form of code snippets. The quickest way to get started with our APIs is by clicking the **“Run in Postman”** button above.\n\n> [Postman](https://www.getpostman.com/) is a free tool that simplifies API testing and debugging. \n  \n\nOmniful’s APIs follow [<b>RESTful</b>](https://en.wikipedia.org/wiki/Representational_state_transfer) architecture and utilize standard [<b>HTTP</b>](https://www.tutorialspoint.com/http/http_status_codes) methods. Our APIs accept and return data in [<b>JSON</b>](https://www.w3schools.com/whatis/whatis_json.asp) encoded body, ensuring a consistent and developer-friendly experience.\n\nRefer to the following sections for a step-by-step guide on integrating Omniful’s APIs into your system. 🚀\n\n# Getting Started\n\nFirst, you need to have an integration in your Omniful dashboard.\n\n1. **Log in** to your Omniful dashboard.\n    \n2. Navigate to **Settings → Apps & Integrations → Custom Apps → Seller Custom Integration / Tenant Custom Integration → Custom (+)**.\n    \n3. Once completed, you’ll receive the required **API credentials** for authentication.\n    \n\n#### 📹 **Watch our short video guide on setting up Custom Integrations**: [<b>Video Link</b>](https://www.youtube.com/watch?v=JBUIbn6p6-0)\n\n# 📕API **Documentation** and API Usage Guidelines\n\n### 📘 **Overview**\n\nOur APIs support standard HTTP methods:\n\n- **GET** – Retrieve data.\n    \n- **POST** – Create a new record.\n    \n- **PATCH** – Update specific record fields.\n    \n- **PUT** – Update the entire record.\n    \n\nYou can import and test our complete API collection in Postman by clicking the **“Run in Postman”** button.\n\n> ⚠ **Note:** Any API requests made with valid credentials will directly affect real-time data in your Omniful custom integration. Please exercise caution when making changes. \n  \n\n### 🔑 Authentication\n\nAll API requests must be authenticated using a **Bearer Token**. Include your token in the Authorization header as follows:  \n**Authorization:** **`Bearer`**\n\n### 🌍 **Base URLs**\n\nUse the following base URLs for staging and production, depending on your environment:\n\n- **Staging:** [<b>https://api.staging.omniful.com</b>](https://api.staging.omniful.com)\n    \n- **Production:** [<b>https://prodapi.omniful.com</b>](https://prodapi.omniful.com)\n    \n\n### 🔄 **Request & Response Formats**\n\n- All API requests and responses follow the **JSON** format.\n    \n- Each API is documented with example request and response payloads for both **successful** and **failed** calls.\n    \n\n### **⚡ Rate Limiting**\n\nTo ensure **fair usage and performance stability**, Omniful APIs have a default rate limit of:\n\n✅ **60 requests per minute for Seller and Sales Channel APIs**\n\n✅ **120 requests per minute for Tenant APIs**\n\n📌 **Exceeding the limit may result in temporary API restrictions.**\n\n# 🔔 Webhooks: Get Real-Time Updates\n\nOmniful supports **webhooks** for **real-time event notifications**. Whenever an event (e.g., order update, shipment creation) occurs, Omniful will send a POST request to your webhook URL.\n\n**✅ How to Set Up a Webhook**\n\n1. **Log in** to your Omniful Dashboard.\n    \n2. Navigate to **Settings → Apps & Integrations → Custom Apps → Seller Custom Integration/Tenant Custom Integration → Configurations Tab → Webhook URLs**.\n    \n3. Add your **Webhook URL** and **enable the toggle**.\n    \n4. Click **Save** to apply changes.\n    \n\n**Webhook Specifications:**\n\n- **Method:** `POST`\n    \n- **Content-Type Header:** **`application/json`**\n    \n- **Response:** Must be set to return **`HTTP 200 Code`****Only**\n    \n\n📌 **Ensure your webhook URL is always reachable** to avoid missing important updates.\n\n**Please click Here to view** [Sample Webhook Payload](https://docs.omniful.tech/#3cd8c4e8-1fcd-442a-9ffe-c2c77c5b546a)\n\n### 🔄 **API Functionality & Button Status**\n\nSome API functions **depend on specific settings** in your Omniful dashboard.\n\nFor example:\n\n- If the **“Order Sync”** button is **disabled**, API calls related to order sync **will return an error**.\n    \n- Ensure that all required **settings are enabled** in the dashboard to successfully fetch data from the APIs.\n    \n\n### ⏱ Timestamp Format\n\nAll timestamps in API requests, responses, and webhooks are returned in UTC (ISO 8601 format) unless explicitly stated otherwise.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"34031863","collectionId":"2714ea86-d918-46ac-a643-1a78d2a3c059","publishedId":"2sA35K1Kqo","public":true,"publicUrl":"https://docs.omniful.tech","privateUrl":"https://go.postman.co/documentation/34031863-2714ea86-d918-46ac-a643-1a78d2a3c059","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-04-12T05:56:35.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://omniful.tech/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://docs.omniful.tech/view/metadata/2sA35K1Kqo"}