{ "opencollection": "1.0.0", "info": { "name": "Omniful Integration APIs Background Jobs Inventory API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Inventory", "type": "folder" }, "items": [ { "info": { "name": "Get Seller Hub Inventory", "type": "http" }, "http": { "method": "GET", "url": "https://prodapi.omniful.com/sales-channel/public/v1/seller/inventory/hubs/:hub_code", "params": [ { "name": "hub_code", "value": "", "type": "path" } ] }, "docs": "📌 Get Seller Hub Inventory API - Overview The Get Seller Hub Inventory API retrieves inventory details for all SKUs stored in a specific warehouse for a seller. This API helps sellers track stock levels, monitor availability, and manage inventory efficiently at a single warehouse location." }, { "info": { "name": "Get Seller Hub Inventory Report of a Seller", "type": "http" }, "http": { "method": "GET", "url": "https://prodapi.omniful.com/sales-channel/public/v1/seller/inventory/hubs/:hub_code/report", "params": [ { "name": "hub_code", "value": "", "type": "path" } ] }, "docs": "📌 Get Seller Hub Inventory Report API - Overview The Get Seller Hub Inventory Report API provides a detailed inventory report of all SKUs stored at a specific hub for a seller. This report is sent to the webhook URL configured in the Custom Sales Channel settings, allowing automated inventory tracking and real-time stock updates. Sample Webhook: { \"event_name\": \"inventory.report.event\", \"data\": { \"inventory_report_url\": \"https://omniful-production-uploads.s3.amazonaws.com/analytics/reports/down" }, { "info": { "name": "Get Inventory for SKU Across All Hubs", "type": "http" }, "http": { "method": "GET", "url": "https://prodapi.omniful.com/sales-channel/public/v1/inventory/hubs/skus/:sku_code", "params": [ { "name": "sku_code", "value": "", "type": "path" } ] }, "docs": "📌 Get Inventory for SKU Across All Hubs API - Overview The Get All Hubs Inventory API retrieves inventory details of a specific SKU across all mapped hubs. This API helps users track stock availability at multiple locations, ensuring efficient inventory distribution and fulfillment management.Gives the Inventory of a SKU at all mapped hubs" }, { "info": { "name": "Post Hub Inventory", "type": "http" }, "http": { "method": "POST", "url": "https://prodapi.omniful.com/sales-channel/public/v1/inventory/hubs/:hub_code", "params": [ { "name": "hub_code", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "📌 Update Hub Inventory API - Overview The Update Hub Inventory API allows users to modify inventory levels for specific SKUs at a given hub. 📌 Key Points to Consider: The hub must have location inventory turned off; otherwise, this API will return a bad request. This API requires hub code and SKU details, including SKU code and quantity. 📌 Required Fields: hub_code (string) – Unique identifier of the hub where inventory needs to be updated. sku_detail (array of objects, max length: 200) – Lis" }, { "info": { "name": "Push Safety Stock", "type": "http" }, "http": { "method": "PUT", "url": "https://prodapi.omniful.com/sales-channel/public/v1/inventory/hubs/:hub_code/safety_stock", "params": [ { "name": "hub_code", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Push Safety Stock" }, { "info": { "name": "Push Inventory", "type": "http" }, "http": { "method": "PUT", "url": "https://prodapi.omniful.com/sales-channel/public/v1/tenants/hubs/:hub_code/sellers/:seller_code/inventory", "params": [ { "name": "hub_code", "value": "", "type": "path" }, { "name": "seller_code", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Push Hub Inventory This endpoint allows you to update the inventory corresponding to a specific seller and hub. By providing the seller's unique code and the hub's unique code, you can modify the available quantities of skus of that seller in that hub. This route can only be used for hubs which are location-inventory off. Request Method: PUT Endpoint: {{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/sellers/:seller_code/inventory Request Body The request body must be in JSON format an" }, { "info": { "name": "Get Hub Inventory", "type": "http" }, "http": { "method": "GET", "url": "https://prodapi.omniful.com/sales-channel/public/v1/tenants/hubs/:hub_code/inventory", "params": [ { "name": "hub_code", "value": "", "type": "path" } ] }, "docs": "Get Hub Inventory" }, { "info": { "name": "Get Inventory for SKU Across All Hubs", "type": "http" }, "http": { "method": "GET", "url": "https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/:seller_code/skus/:sku_code/inventory", "params": [ { "name": "seller_code", "value": "", "type": "path" }, { "name": "sku_code", "value": "", "type": "path" } ] }, "docs": "Get Inventory for SKU Across All Hubs" }, { "info": { "name": "Push Safety Stock", "type": "http" }, "http": { "method": "PUT", "url": "https://prodapi.omniful.com/sales-channel/public/v1/tenants/hubs/:hub_code/sellers/:seller_code/safety_stock", "params": [ { "name": "hub_code", "value": "", "type": "path" }, { "name": "seller_code", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Push Safety Stock" } ] } ], "bundled": true }