{"info":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","description":"

⚠️ Important Notice

\n
The following fields will be deprecated from our Custom Integration APIs starting 30th September 2025 11:59 PM UTC :
• The “order_items” field in the Get Seller Orders API response when using the query parameter include=order_items.
We recommend you review and update your custom integrations to ensure they're compatible with these changes.
\n

Welcome to Omniful’s API Documentation 🚀

We’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.

For 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
Postman is a free tool that simplifies API testing and debugging.
\n

Omniful’s APIs follow RESTful architecture and utilize standard HTTP methods. Our APIs accept and return data in JSON encoded body, ensuring a consistent and developer-friendly experience.

Refer to the following sections for a step-by-step guide on integrating Omniful’s APIs into your system. 🚀

Getting Started

First, you need to have an integration in your Omniful dashboard.

Log in to your Omniful dashboard.
\n
Navigate to Settings → Apps & Integrations → Custom Apps → Seller Custom Integration / Tenant Custom Integration → Custom (+).
\n
Once completed, you’ll receive the required API credentials for authentication.
\n

📹 Watch our short video guide on setting up Custom Integrations: Video Link

📕API Documentation and API Usage Guidelines

📘 Overview

Our APIs support standard HTTP methods:

GET – Retrieve data.
\n
POST – Create a new record.
\n
PATCH – Update specific record fields.
\n
PUT – Update the entire record.
\n

You can import and test our complete API collection in Postman by clicking the “Run in Postman” button.

\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

🔑 Authentication

All API requests must be authenticated using a Bearer Token. Include your token in the Authorization header as follows:
Authorization: Bearer

🌍 Base URLs

Use the following base URLs for staging and production, depending on your environment:

Staging: https://api.staging.omniful.com
\n
Production: https://prodapi.omniful.com
\n

🔄 Request & Response Formats

All API requests and responses follow the JSON format.
\n
Each API is documented with example request and response payloads for both successful and failed calls.
\n

⚡ Rate Limiting

To ensure fair usage and performance stability, Omniful APIs have a default rate limit of:

✅ 60 requests per minute for Seller and Sales Channel APIs

✅ 120 requests per minute for Seller and Sales Channel APIs

📌 Exceeding the limit may result in temporary API restrictions.

🔔 Webhooks: Get Real-Time Updates

Omniful 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.

✅ How to Set Up a Webhook

Log in to your Omniful Dashboard.
\n
Navigate to Settings → Apps & Integrations → Custom Apps → Seller Custom Integration/Tenant Custom Integration → Configurations Tab → Webhook URLs.
\n
Add your Webhook URL and enable the toggle.
\n
Click Save to apply changes.
\n

Webhook Specifications:

Method: POST
\n
Content-Type Header: application/json
\n
Response: Must be set to return **HTTP 200 Code**Only
\n

📌 Ensure your webhook URL is always reachable to avoid missing important updates.

Please click Here to view Sample Webhook Payload

🔄 API Functionality & Button Status

Some API functions depend on specific settings in your Omniful dashboard.

For example:

If the “Order Sync” button is disabled, API calls related to order sync will return an error.
\n
Ensure that all required settings are enabled in the dashboard to successfully fetch data from the APIs.
\n

⏱ Timestamp Format

All timestamps in API requests, responses, and webhooks are returned in UTC (ISO 8601 format) unless explicitly stated otherwise.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Welcome to Omniful’s API Documentation 🚀","slug":"welcome-to-omnifuls-api-documentation"},{"content":"Getting Started","slug":"getting-started"},{"content":"📕API Documentation and API Usage Guidelines","slug":"api-documentation-and-api-usage-guidelines"},{"content":"🔔 Webhooks: Get Real-Time Updates","slug":"webhooks-get-real-time-updates"}],"owner":"34031863","collectionId":"2714ea86-d918-46ac-a643-1a78d2a3c059","publishedId":"2sA35K1Kqo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-12T05:56:35.000Z"},"item":[{"name":"Seller and Sales Channel APIs","item":[{"name":"Orders","item":[{"name":"Create Order","event":[{"listen":"test","script":{"id":"d53fd8e4-737e-4dbe-aa6c-5b644eb384e7","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.have.property(\"is_success\");"," pm.expect(responseData).to.have.property(\"status_code\");"," pm.expect(responseData).to.have.property(\"data\");"," pm.expect(responseData).to.have.property(\"meta\");","});","","","pm.test(\"is_success is a boolean value\", function () {"," const responseData = pm.response.json();"," pm.expect(responseData.is_success).to.be.a('boolean');","});","","","pm.test(\"status_code is a non-negative integer\", function () {"," const responseData = pm.response.json();"," pm.expect(responseData.status_code).to.be.a('number').and.to.be.at.least(0);","});","","","pm.test(\"Validate data is an object and contains the required field - status\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.data.status).to.exist;","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d46cd54a-1d74-4e27-b85c-8661a89cf420","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipment_type\": \"omniful_generated\",\n \"order_id\": \"order_no__1\",\n \"order_alias\": \"order_omniful-alias\",\n \"hub_code\": \"test_hub_1\",\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"name\": \"iPhone 15 Pro\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-11-234-5678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"national_address_code\": \"code\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"MKA\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"national_address_code\": \"code\"\n },\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_mode\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [\n {\n \"name\": \"profile_picture\",\n \"description\": \"User's profile avatar image\",\n \"mime_type\": \"image/jpeg\",\n \"url\": \"https://example.com/profile1.jpg\"\n },\n {\n \"name\": \"document\",\n \"description\": \"Monthly financial report in PDF format\",\n \"mime_type\": \"application/pdf\",\n \"url\": \"https://example.com/report.pdf\"\n },\n {\n \"name\": \"screenshot\",\n \"description\": \"Screenshot of an error log for debugging\",\n \"mime_type\": \"image/png\",\n \"url\": \"https://example.com/screenshot.png\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"payment_method\": \"prepaid\",\n \"delivery_type\": \"normal_delivery\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"b2b\",\n \"external_fields\": [\n {\n \"key\": \"order_id\",\n \"value\": \"12345\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n },\n {\n \"key\": \"status\",\n \"value\": \"shipped\"\n }\n ],\n \"cancel_order_after_seconds\": 30\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders","description":"

📌 Create Order API Overview

The Create Order API allows users to place new orders in Omniful by providing order details, customer information, shipping and billing addresses, invoice details, and payment information.

📝 Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
order_id	string	Must be a globally unique identifier for the order (e.g., \"order_0008\"). Cannot be reused if the order is deleted.	✅ Yes
order_alias	string	Secondary identifier for tracking in external systems (e.g., ERP or warehouse systems).	❌ No
hub_code	string	Code for the warehouse/fulfillment center that will handle this order. Ensure it matches a valid hub in your system.	✅ Yes
order_items	object	Array of items in this order. Must contain at least one item with complete product and pricing details.	✅ Yes
order_items.sku_code	string	Product’s unique SKU identifier, must match exactly with the product catalog.	✅ Yes
order_items.name	string	Product display name, used in the order summary and customer communications.	❌ No
order_items.display_price	number	Original product price before discounts. Used to show savings to the customer.	❌ No
order_items.selling_price	number	Final price charged after base discounts. Used for order calculations.	✅ Yes
order_items.is_substituted	boolean	Set to true if this is a substitution for the customer's original choice. Helps track substitutions.	❌ No
order_items.quantity	integer	Number of units ordered. Must be at least 1. Affects all price calculations.	✅ Yes
order_items.tax_percent	number	Tax rate for this item (e.g., 10 for 10%). Used to calculate the tax amount.	❌ No
order_items.tax	number	Calculated tax for this line item based on the selling price and quantity.	❌ No
order_items.unit_price	number	Price per unit, base price used for quantity calculations.	❌ No
order_items.subtotal	number	Line item total before tax and special discounts (unit_price × quantity).	❌ No
order_items.total	number	Final amount for the line item including all taxes and discounts.	❌ No
order_items.discount	number	Total discount applied to this item.	❌ No
order_items.tax_inclusive	boolean	If true, prices include tax. Important for tax calculations.	❌ No
billing_address	object	Address used for billing and tax calculations. Must be a valid physical address.	✅ Yes
billing_address.address1	string	Main address line (street number and name).	✅ Yes
billing_address.address2	string	Additional address details like apartment number, floor, or landmarks.	❌ No
billing_address.city	string	City name. Must be valid for the given state and country.	✅ Yes
billing_address.country	string	Full country name. Must match with country_code provided.	✅ Yes
billing_address.first_name	string	First name of the billing contact person.	❌ No
billing_address.last_name	string	Last name of the billing contact person.	❌ No
billing_address.phone	string	Contact number for billing issues.	❌ No
billing_address.state	string	Full state name. Must be valid for the given country.	❌ No
billing_address.zip	string	Postal code for the address.	❌ No
billing_address.state_code	string	Standard state/province code (e.g., \"RIY\" for Riyadh).	❌ No
billing_address.country_code	string	Two-letter ISO country code (e.g., \"SA\" for Saudi Arabia).	❌ No
billing_address.latitude	number	Optional GPS latitude for precise location.	❌ No
billing_address.longitude	number	Optional GPS longitude for precise location.	❌ No
billing_address.national_address_code	string	National address code of billing address.	❌ No
shipping_address	object	Delivery address where the order will be sent.	✅ Yes
shipping_address.address1	string	Primary delivery address. Must be accurate for successful delivery.	✅ Yes
shipping_address.address2	string	Extra delivery instructions or landmark details.	❌ No
shipping_address.city	string	Delivery city. Must be within serviceable area.	✅ Yes
shipping_address.country	string	Delivery country name. Must match with your shipping rules.	✅ Yes
shipping_address.first_name	string	First name of person receiving delivery.	❌ No
shipping_address.last_name	string	Last name of person receiving delivery.	❌ No
shipping_address.phone	string	Contact number for delivery updates.	❌ No
shipping_address.state	string	Full state name for delivery.	❌ No
shipping_address.zip	string	Postal code for delivery location.	❌ No
shipping_address.state_code	string	Standard state code for delivery location.	❌ No
shipping_address.country_code	string	Two-letter country code for delivery location.	❌ No
shipping_address.latitude	number	Optional GPS latitude for precise location.	❌ No
shipping_address.longitude	number	Optional GPS longitude for precise location.	❌ No
shipping_address.national_address_code	string	National address code of shipping address.	❌ No
invoice	object	Contains all financial details and calculations for the order.	✅ Yes
invoice.currency	string	Three-letter currency code (e.g., \"USD\", \"SAR\").	✅ Yes
invoice.subtotal	number	Sum of all item prices before tax/discounts.	❌ No
invoice.shipping_price	number	Delivery fee charged to customer.	❌ No
invoice.shipping_refund	number	Any shipping fee refunded to customer.	❌ No
invoice.tax	number	Total tax amount for the order.	❌ No
invoice.discount	number	Total order level discounts (not including item discounts).	❌ No
invoice.total	number	Final order amount including all items, tax, shipping, and discounts.	✅ Yes
invoice.total_paid	number	Amount already received from customer.	❌ No
invoice.total_due	number	Remaining amount to be paid. Should be 0 for prepaid orders.	❌ No
invoice.total_refunded	number	Total amount refunded to customer from this order.	❌ No
invoice.payment_mode	string	How the customer paid (e.g., \"visa\", \"cash\",\"mada\", \"credit card\").	❌ No
invoice.tax_percent	number	Overall tax rate applied to order.	❌ No
invoice.shipping_tax	number	Tax amount specifically for the shipping fee.	❌ No
invoice.sub_total_tax_inclusive	boolean	Whether subtotal includes tax.	❌ No
invoice.sub_total_discount_inclusive	boolean	Whether subtotal includes discounts.	❌ No
invoice.shipping_tax_inclusive	boolean	Whether shipping fee includes tax.	❌ No
invoice.shipping_discount_inclusive	boolean	Whether shipping fee includes discounts.	❌ No
invoice.attachments	array	Optional files like invoices or gift receipts.	❌ No
invoice.attachments.url	string	URL to the attachment.	❌ No
invoice.attachments.type	string	Type of attachment (e.g., \"invoice\", \"receipt\").	❌ No
customer	object	Details about who placed the order.	✅ Yes
customer.id	string	Unique identifier for this customer in your system.	✅ Yes
customer.first_name	string	Customer's first name.	✅ Yes
customer.last_name	string	Customer's last name.	❌ No
customer.mobile	string	Mobile number for updates.	❌ No
customer.mobile_code	string	Country calling code with + prefix.	❌ No
customer.email	string	Customer’s email for order confirmations.	❌ No
customer.avatar	string	URL to customer’s profile image.	❌ No
customer.gender	string	Customer's gender, if provided.	❌ No
labels	array	Custom tags to categorize the order.	❌ No
slot	object	Selected delivery time window.	❌ No
slot.delivery_date	string	Delivery date in DDMMYYYY format.	❌ No
slot.start_time	integer	Delivery window start time in HHMM format.	❌ No
slot.end_time	integer	Delivery window end time in HHMM format.	❌ No
payment_method	string	Payment method chosen (e.g., \"prepaid\", \"postpaid\",\"pending\").	✅ Yes
delivery_type	string	Delivery Types supported. (e.g., click_and_collect, express_delivery, slot_delivery, normal_delivery)	❌ No
transactions	array	List of payment transactions for this order.	❌ No
transactions.transaction_id	string	Unique transaction ID.	❌ No
transactions.amount	number	Transaction amount.	❌ No
transactions.type	integer	Transaction type code (e.g., 1=payment, 2=refund).	❌ No
transactions.card_number	string	Masked card number.	❌ No
transactions.source_account	string	Source account for payment.	❌ No
transactions.destination_account	string	Destination account receiving payment.	❌ No
transactions.status	integer	Payment status code (e.g., 1=success, 0=pending).	❌ No
transactions.description	string	Human-readable explanation of the transaction.	❌ No
is_cash_on_delivery	boolean	Set to true if payment is collected during delivery.	✅ Yes
note	string	Special instructions for order handling.	❌ No
type	string	Order category (e.g., \"b2b\", \"b2c\").	✅ Yes
external_fields	array	Custom fields for external system integration.	❌ No
external_fields.key	string	Custom field name for external systems.	❌ No
external_fields.value	string	Custom field value.	❌ No
cancel_order_after_seconds	integer	Order auto-cancels after this many seconds.	❌ No

✅ Notes

Fields marked as ✅ Yes under \"Required\" must be included in the request.
\n
Geolocation fields (latitude, longitude) are optional but useful for delivery tracking.
\n
The payment_method should match an accepted payment type in the system.
\n
Ensure customer.id is valid if using an existing customer, or create a new customer by passing the required fields.
\n
The order_items array must contain at least one item to process the order.
\n

❓ Frequently Asked Questions (FAQs)

1️⃣ How do I force an order to a specific hub?

To manually route an order to a specific hub, provide the hub's unique code in the hub_code field.

Example: { \"hub_code\": \"HUB123\" }

2️⃣ What if payment details are missing?

If payment information is unavailable and you need to block shipment creation at the packing stage, set:
{ \"payment_method\": \"pending\" }

This ensures the shipment cannot be created until payment details are updated.

3️⃣ How do I create a shipment if the payment status is pending?

Set the payment status to \"pending\" when creating the order.
\n
Once the invoice details are received, update the order using the Update Order Invoice API.
\n
After updating the invoice, shipment creation will be enabled via the dashboard.
\n

📌 Update Order API - Overview

The Update Order API allows users to modify the details of an existing order that was previously placed. This API can be used to update various order attributes, such as order items, shipping details, billing information, and customer details.

Users can update an order only if it is not in the \"packed\" state. Once an order reaches the packed stage, further modifications using this API are restricted.

This API ensures flexibility in managing orders before final processing while maintaining data integrity after packing.

Note: The note field is always treated as part of the update. If the note key is included in the payload with an empty value or if the note key is not provided at all, it will be treated as an update with an empty note, resulting in the deletion of any previously saved note.

📝 Request Body Parameters

Field	Data Type	Description	Required
order_id	string	The ID of the order you want to update. You can't change this value. Example: \"order_0003\".	✅ Yes
hub_code	string	The warehouse handling this order. Example: \"Shubhra001\".	✅ Yes
order_items	array	List of products in the order. You can update quantities, add or remove items.	✅ Yes
order_items.sku_code	string	The product's unique ID in your catalog. Ensure it exists before using it.	✅ Yes
order_items.name	string	The name that appears on the order for this product.	❌ No
order_items.display_price	number	The original price before any discounts.	❌ No
order_items.selling_price	number	The actual price charged for this item after basic discounts.	✅ Yes
order_items.is_substituted	boolean	Set to true if replacing the original item with something else.	❌ No
order_items.quantity	integer	How many of this item you want now. Must be 1 or more.	❌ No
order_items.tax_percent	number	The tax rate for this item (e.g., 10 for 10%).	❌ No
order_items.tax	number	The calculated tax amount for this item based on quantity and price.	❌ No
order_items.unit_price	number	Price per unit of the item.	❌ No
order_items.subtotal	number	Total cost before tax (unit_price × quantity).	❌ No
order_items.total	number	Final price including everything (tax, discounts, etc.).	❌ No
order_items.discount	number	How much discount is applied to this item.	❌ No
order_items.tax_inclusive	boolean	Set to true if prices include tax.	❌ No
billing_address.address1	string	Main billing street address.	❌ No
billing_address.city	string	City for billing.	❌ No
billing_address.country	string	Country for billing.	❌ No
billing_address.first_name	string	First name of the person being billed.	❌ No
billing_address.last_name	string	Last name of the person being billed.	❌ No
billing_address.phone	string	Phone number for billing questions.	❌ No
billing_address.state	string	State for billing.	❌ No
billing_address.zip	string	ZIP or postal code for billing.	❌ No
billing_address.state_code	string	Short code for the state (e.g., \"NY\" for New York).	❌ No
billing_address.country_code	string	Two-letter country code (e.g., \"US\" for United States).	❌ No
billing_address.latitude	number	Latitude for the address, if needed.	❌ No
billing_address.longitude	number	Longitude for the address, if needed.	❌ No
billing_address.national_address_code	string	National address code of billing address.	❌ No
shipping_address.address1	string	Main delivery address.	❌ No
shipping_address.city	string	City for delivery.	❌ No
shipping_address.country	string	Country for delivery.	❌ No
shipping_address.first_name	string	First name of the person receiving the package.	❌ No
shipping_address.last_name	string	Last name of the person receiving the package.	❌ No
shipping_address.phone	string	Phone number to call for delivery.	❌ No
shipping_address.state	string	State for delivery.	❌ No
shipping_address.zip	string	ZIP or postal code for delivery.	❌ No
shipping_address.state_code	string	Short code for the delivery state.	❌ No
shipping_address.country_code	string	Two-letter code for delivery country.	❌ No
shipping_address.latitude	number	Latitude for delivery location, if needed.	❌ No
shipping_address.longitude	number	Longitude for delivery location, if needed.	❌ No
shipping_address.national_address_code	string	National address code of shipping address.	❌ No
order_created_at	string	The order’s creation time. Cannot be changed.	❌ No
invoice.currency	string	Currency used for the order (e.g., \"USD\"). Cannot be changed after creation.	❌ No
invoice.subtotal	number	Total cost of all items before any extras.	❌ No
invoice.shipping_price	number	Delivery charge.	❌ No
invoice.shipping_refund	number	Refund for shipping issues.	❌ No
invoice.tax	number	Total tax for the entire order.	❌ No
invoice.discount	number	Total discount applied to the order.	❌ No
invoice.total	number	Final total amount, including everything.	❌ No
invoice.total_paid	number	Total amount already received.	❌ No
invoice.total_due	number	Remaining amount to be paid.	❌ No
invoice.total_refunded	number	Total refunded to the customer.	❌ No
invoice.payment_mode	string	How the customer paid (e.g., \"visa\", \"cash\",\"mada\", \"credit card\").	❌ No
invoice.tax_percent	number	Overall tax rate applied to the order.	❌ No
invoice.shipping_tax	number	Tax applied to the shipping cost.	❌ No
invoice.sub_total_tax_inclusive	boolean	Whether subtotal includes tax.	❌ No
invoice.sub_total_discount_inclusive	boolean	Whether subtotal includes discounts.	❌ No
invoice.shipping_tax_inclusive	boolean	Whether shipping includes tax.	❌ No
invoice.shipping_discount_inclusive	boolean	Whether shipping includes discounts.	❌ No
customer.first_name	string	Customer’s first name.	❌ No
customer.last_name	string	Customer’s last name.	❌ No
customer.mobile	string	Customer’s phone number without country code.	❌ No
customer.mobile_code	string	Country code for the phone (e.g., \"+1\" for US).	❌ No
customer.email	string	Customer’s email for order updates.	❌ No
customer.avatar	string	Link to customer’s profile picture.	❌ No
customer.gender	string	Customer’s gender, if provided.	❌ No
shipment.shipping_partner_name	string	Delivery company name.	❌ No
shipment.shipping_partner_tag	string	Internal code for the delivery company.	❌ No
shipment.awb_number	string	Tracking number for the package.	❌ No
shipment.awb_label	string	Link to download the shipping label.	❌ No
shipment.tracking_link	string	Link for customers to track their package.	❌ No
labels	array	Tags to categorize the order (e.g., [\"urgent\", \"fragile\"]).	❌ No
payment_method	string	Payment method used (e.g., \"prepaid\", \"postpaid\",\"pending\").	❌ No
is_cash_on_delivery	boolean	Set true if cash is collected on delivery.	❌ No
note	string	Special instructions or comments for the order.	❌ No
external_fields	array	Custom fields for system integration.	❌ No
external_fields.key	string	Name of the custom field.	❌ No
external_fields.value	string	Value of the custom field.	❌ No
cancel_order_after_seconds	integer	Auto-cancel the order after this many seconds. Use 0 for never auto-cancel.	❌ No

⚠ Key Points to Consider When Updating Orders

Only orders with the status \"on_hold\" can be updated.
\n
Ensure all required fields are correctly formatted before submitting the update request.
\n

📌 Update Order Invoice API - Overview

The Update Order Invoice API allows users to modify the invoice details of a previously placed order. This API is useful when adjustments or modifications are required in the invoice amount, tax details, discounts, payment information, or other financial components of an order.

Users can use this API to ensure that the invoice reflects the correct pricing and charges before final processing or fulfillment.

To successfully update an invoice, all the fields from both the order_items and invoice objects are required.

📝 Request Body Parameters

Field	Data Type	Description	Required
order_items	array	Array of items to update in the order invoice.	✅ Yes
order_items.sku_code	string	Product's SKU identifier that needs invoice update.	❌ No
order_items.display_price	number	Original advertised price shown to customer.	❌ No
order_items.selling_price	number	Actual selling price after base discounts.	❌ No
order_items.tax_percent	number	Tax percentage applied to the item.	❌ No
order_items.tax	number	Calculated tax amount for the item.	❌ No
order_items.unit_price	number	Base price per unit excluding tax.	❌ No
order_items.total	number	Total price including tax for this item.	❌ No
order_items.tax_inclusive	boolean	Whether the item price includes tax.	❌ No
invoice.currency	string	Three-letter currency code (e.g., \"USD\").	✅ Yes
invoice.subtotal	number	Sum of all items before adjustments.	✅ Yes
invoice.shipping_price	number	Cost of shipping.	✅ Yes
invoice.shipping_refund	number	Amount refunded for shipping.	❌ No
invoice.tax	number	Total tax amount for the order.	✅ Yes
invoice.tax_percent	number	Overall tax percentage applied.	❌ No
invoice.discount	number	Total discount applied to order.	❌ No
invoice.total	number	Final total after all adjustments.	✅ Yes
invoice.total_paid	number	Amount already paid by customer.	❌ No
invoice.total_due	number	Remaining amount to be paid.	❌ No
invoice.total_refunded	number	Total amount refunded to customer.	❌ No
invoice.payment_mode	string	How the customer paid (e.g., \"visa\", \"cash\",\"mada\", \"credit card\").	❌ No
invoice.loyalty_discount	number	Discount applied from loyalty points.	❌ No
invoice.wallet_amount	number	Amount paid from customer wallet.	❌ No
invoice.shipping_tax	number	Tax applied to shipping cost.	❌ No
invoice.sub_total_tax_inclusive	boolean	Whether subtotal includes tax.	❌ No
invoice.sub_total_discount_inclusive	boolean	Whether subtotal includes discounts.	❌ No
invoice.shipping_tax_inclusive	boolean	Whether shipping price includes tax.	❌ No
invoice.shipping_discount_inclusive	boolean	Whether shipping price includes discounts.	❌ No
invoice.additional_charges	array	List of any additional charges applied.	✅ Yes
invoice.refunded_amounts	array	List of all refund transactions.	✅ Yes

The unique identifier of the order in which the invoice needs to be updated.

\n","type":"text/plain"},"type":"any","value":"","key":"order_id"}]}},"response":[{"id":"8fb3a587-7e56-4412-97f0-c4b5abbb4a42","name":"Update Order Invoice","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payment_method\": \"\", // prepaid, postpaid, partially_paid, pending, unknown\n \"order_items\": [\n {\n \"sku_code\": \"txyz\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"total\": 768.9,\n \"tax_inclusive\": true\n }\n ],\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 1900,\n \"shipping_price\": 200,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"tax_percent\": 10,\n \"discount\": 200,\n \"total\": 233.3,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_mode\": \"\",\n \"loyalty_discount\": 0,\n \"wallet_amount\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [],\n \"refunded_amounts\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/invoice/:order_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","invoice",":order_id"],"variable":[{"key":"order_id","value":"4371"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 Apr 2024 07:57:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"e2daca2c-8cfb-4d01-99e1-d8e2f378e428"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"874a62e908a685d8-BOM"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Invoice Updated successfully.\",\n \"meta\": null\n}"}],"_postman_id":"5d410144-e091-4379-9a7e-86c774ea3095"},{"name":"Cancel Order","id":"ff758c7e-d019-4e2b-9876-e5b45ab75f39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"cancel_reason\": \"Not needed now.\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/:order_id/cancel","description":"

📌 Overview

The Cancel Order API allows users to cancel an existing order by providing a cancellation reason.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`cancel_reason`	`string`	✅ Yes	Reason for canceling the order.

The unique identifier of the order to be canceled.

\n","type":"text/plain"},"type":"any","value":"TestOrder_0001","key":"order_id"}]}},"response":[{"id":"ac752f04-766f-4395-8275-3879d61ab9d4","name":"Cancel Order","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"cancel_reason\": \"I dont want it.\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.staging.omniful.com/sales-channel/public/v1/orders/:order_id/cancel","protocol":"https","host":["api","staging","omniful","com"],"path":["sales-channel","public","v1","orders",":order_id","cancel"],"variable":[{"key":"order_id","value":"custom-10101"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Aug 2023 06:59:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f0cae1828af3f97-BOM"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Order cancelled successfully.\"\n },\n \"meta\": null\n}"}],"_postman_id":"ff758c7e-d019-4e2b-9876-e5b45ab75f39"},{"name":"Approve Order","id":"ab007c8b-079f-4980-82f1-efd671fb1444","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/:order_id/approve","description":"

📌 Approve Order API - Overview

The Approve Order API is used to manually approve orders that require user authorization before processing. This API ensures that orders needing validation, review, or confirmation are not automatically processed without approval.

Once an order is approved, it can proceed to the next stage in the fulfillment workflow, such as packing and shipping.

The unique identifier of order to be approved.

\n","type":"text/plain"},"type":"any","value":"TestOrder_0001","key":"order_id"}]}},"response":[{"id":"dee9b5bf-dc99-4dac-9e8f-96b5d7684e8d","name":"Approve Order","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/:order_id/approve","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders",":order_id","approve"],"variable":[{"key":"order_id","value":"order_0007"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jan 2025 04:55:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"80656b0f-69c6-42bf-b020-4440caee82b4"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9096a127aa252015-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Order approved successfully.\",\n \"meta\": null\n}"}],"_postman_id":"ab007c8b-079f-4980-82f1-efd671fb1444"},{"name":"Get Seller Orders","id":"e8024315-3aca-4511-8ceb-fd721c115fed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/seller/orders","description":"

📌 Get Seller Orders API - Overview

The Get Seller Orders API allows users to retrieve a list of all orders for a specific seller who has integrated a Custom Integration on their dashboard. This API enables sellers to fetch and manage orders placed within the last three months, providing real-time visibility into their order history.

It is useful for tracking order statuses, processing fulfillment, and analyzing order trends over time.

📝 Response Body Parameters

Field	Data Type	Description	Always Included
is_success	boolean	Indicates if the request was successful.	✅ Yes
status_code	number	HTTP status code of the response.	✅ Yes
data	array	Array of seller order objects.	✅ Yes
data[].order_id	string	Unique identifier for the order.	✅ Yes
data[].order_alias	string	Marketplace-specific order reference.	✅ Yes
data[].omniful_order_id	string	Internal system order identifier.	✅ Yes
data[].status_code	string	Current order processing status.	✅ Yes
data[].display_status	string	Human-readable order status.	✅ Yes
data[].hub_code	string	Assigned fulfillment center code.	✅ Yes
data[].total	number	Total number of items in the order.	✅ Yes
data[].billing_address	object	Customer billing information.	✅ Yes
data[].billing_address.address1	string	Primary billing street address.	✅ Yes
data[].billing_address.address2	string	Secondary billing address details.	❌ No
data[].billing_address.city	string	Billing city name.	✅ Yes
data[].billing_address.country	string	Billing country name.	✅ Yes
data[].billing_address.first_name	string	Billing contact first name.	✅ Yes
data[].billing_address.last_name	string	Billing contact last name.	✅ Yes
data[].billing_address.phone	string	Billing contact phone number.	✅ Yes
data[].billing_address.state	string	Billing state/province name.	✅ Yes
data[].billing_address.zip	string	Billing postal/ZIP code.	✅ Yes
data[].billing_address.state_code	string	Billing state/province code.	✅ Yes
data[].billing_address.country_code	string	Two-letter ISO country code.	✅ Yes
data[].billing_address.latitude	number	Billing address latitude.	❌ No
data[].billing_address.longitude	number	Billing address longitude.	❌ No
data[].billing_address.national_address_code	string	Billing address national address code.	❌ No
data[].shipping_address	object	Order delivery information.	✅ Yes
data[].shipping_address.address1	string	Primary delivery street address.	✅ Yes
data[].shipping_address.address2	string	Secondary delivery address details.	❌ No
data[].shipping_address.city	string	Delivery city name.	✅ Yes
data[].shipping_address.country	string	Delivery country name.	✅ Yes
data[].shipping_address.first_name	string	Recipient's first name.	✅ Yes
data[].shipping_address.last_name	string	Recipient's last name.	✅ Yes
data[].shipping_address.phone	string	Recipient's contact number.	✅ Yes
data[].shipping_address.state	string	Delivery state/province name.	✅ Yes
data[].shipping_address.zip	string	Delivery postal/ZIP code.	✅ Yes
data[].shipping_address.state_code	string	Delivery state/province code.	✅ Yes
data[].shipping_address.country_code	string	Two-letter ISO country code for delivery.	✅ Yes
data[].shipping_address.latitude	number	Delivery location latitude.	❌ No
data[].shipping_address.longitude	number	Delivery location longitude.	❌ No
data[].shipping_address.national_address_code	string	Shipping address national address code.	❌ No
data[].slot	object	Delivery scheduling information.	✅ Yes
data[].slot.delivery_date	string	Planned delivery date (DDMMYYYY).	✅ Yes
data[].slot.start_time	number	Delivery window start (24hr format).	✅ Yes
data[].slot.end_time	number	Delivery window end (24hr format).	✅ Yes
data[].order_created_at	string	Order placement timestamp (ISO).	✅ Yes
data[].invoice	object	Order financial details.	✅ Yes
data[].invoice.currency	string	Order currency code.	✅ Yes
data[].invoice.subtotal	number	Order value before adjustments.	✅ Yes
data[].invoice.shipping_price	number	Delivery fee charged.	✅ Yes
data[].invoice.shipping_refund	number	Delivery fee refunded.	✅ Yes
data[].invoice.tax	number	Total tax amount.	✅ Yes
data[].invoice.discount	number	Total discount applied.	✅ Yes
data[].invoice.total	number	Final order amount.	✅ Yes
data[].invoice.total_paid	number	Amount received.	✅ Yes
data[].invoice.total_due	number	Outstanding balance.	✅ Yes
data[].invoice.tax_percent	number	Applied tax rate.	✅ Yes
data[].invoice.shipping_tax	number	Tax on shipping fee.	✅ Yes
data[].invoice.sub_total_tax_inclusive	boolean	If subtotal includes tax.	✅ Yes
data[].invoice.sub_total_discount_inclusive	boolean	If subtotal includes discounts.	✅ Yes
data[].invoice.shipping_tax_inclusive	boolean	If shipping includes tax.	✅ Yes
data[].invoice.shipping_discount_inclusive	boolean	If shipping includes discounts.	✅ Yes
data[].invoice.additional_charges	array	Extra fees applied.	✅ Yes
data[].invoice.attachments	array	Related documents.	✅ Yes
data[].invoice.attachments[].url	string	Document access URL.	✅ Yes
data[].invoice.attachments[].type	string	Document category.	✅ Yes
data[].customer	object	Buyer information.	✅ Yes
data[].customer.first_name	string	Customer's first name.	✅ Yes
data[].customer.last_name	string	Customer's last name.	✅ Yes
data[].customer.mobile	string	Customer's phone number.	✅ Yes
data[].customer.mobile_code	string	Customer's country calling code.	✅ Yes
data[].customer.email	string	Customer's email address.	✅ Yes
data[].customer.avatar	string	Profile picture URL.	❌ No
data[].customer.gender	string	Customer's gender.	❌ No
data[].shipment	object	Delivery tracking details.	✅ Yes
data[].shipment.delivery_status	string	Current shipping status.	✅ Yes
data[].payment_method	string	Payment type used.	✅ Yes
data[].shipment_type	string	Delivery service category.	✅ Yes
data[].labels	array	Order classification tags.	❌ No
data[].expected_delivery_epoch	number	Expected delivery timestamp.	✅ Yes
data[].external_fields	array	External reference data.	❌ No
data[].external_fields[].key	string	External data identifier.	✅ Yes
data[].external_fields[].value	string	External data value.	✅ Yes
data[].sales_channel	object	Details about the sales channel from which the order originated.	✅ Yes
data[].sales_channel.tag	string	Identifier tag for the sales channel (e.g., `custom`).	✅ Yes
data[].sales_channel.name	string	Display name of the sales channel.	✅ Yes
data[].sales_channel.category	string	Category/type of the sales channel (e.g., `SalesChannel`).	✅ Yes
data[].sales_channel.logo_url	string	URL of the sales channel logo.	✅ Yes
meta	object	Pagination metadata.	✅ Yes
meta.current_page	number	Current result page number.	✅ Yes
meta.last_page	number	Final available page number.	✅ Yes
meta.per_page	number	Results per page count.	✅ Yes
meta.total	number	Total available results.	✅ Yes
---

Important Notes:

Pagination

Results are paginated with 20 orders per page.
\n
Use the page query parameter for navigation.
\n
Results are sorted by order creation date in descending order.
\n

Query Parameters

page: Page number (default: 1)
\n
per_page: Results per page (default: 20, max: 100)
\n

Status Codes

200: Successful request
\n
400: Invalid parameters
\n
401: Authentication required
\n
403: Insufficient permissions
\n

Filter Based on Single Order ID

\n","type":"text/plain"},"key":"order_id","value":"order_0003"},{"disabled":true,"description":{"content":"

Filter Based on STO request ID

\n","type":"text/plain"},"key":"sto_request_id","value":"STO_order_0003"},{"disabled":true,"description":{"content":"

Filter Based on Order Created Date Range. Default value is (created_to - 90 days). Additionally, created_to - created_from should not exceed 90 days.

\n","type":"text/plain"},"key":"created_from","value":"2024-02-20"},{"disabled":true,"description":{"content":"

Filter Based on Order Created Date Range. Default value is today. Additionally, created_to - created_from should not exceed 90 days.

\n","type":"text/plain"},"key":"created_to","value":"2024-02-23"},{"disabled":true,"description":{"content":"

Filter Based on Order Updated Date Range

\n","type":"text/plain"},"key":"updated_to","value":"2024-03-28"},{"disabled":true,"description":{"content":"

Filter Based on Order Updated Date Range

\n","type":"text/plain"},"key":"updated_from","value":"2024-01-21"},{"disabled":true,"description":{"content":"

Pagination

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Pagination

\n","type":"text/plain"},"key":"per_page","value":"100"},{"disabled":true,"description":{"content":"

Filter Based on Unique Customer ID

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

Filter Based on Customer Name

\n","type":"text/plain"},"key":"customer_name","value":""},{"disabled":true,"description":{"content":"

Filter Based on Customer Email

\n","type":"text/plain"},"key":"customer_email","value":""},{"disabled":true,"description":{"content":"

Filter Based on Order Status

\n","type":"text/plain"},"key":"status","value":"delivered"},{"disabled":true,"description":{"content":"

Filter Based on Order Statuses.

\n","type":"text/plain"},"key":"statuses","value":"new_order"},{"disabled":true,"description":{"content":"

Filter Based on the AWB number of the shipment

\n","type":"text/plain"},"key":"awb_number","value":"20601738845957"},{"disabled":true,"description":{"content":"

Filter Based on the Shipment Statuses

\n","type":"text/plain"},"key":"shipment_status","value":"delivered"}],"variable":[]}},"response":[{"id":"9286386a-63fc-4bab-a095-6e518205a1f1","name":"Get Seller Orders","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/seller/orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","seller","orders"],"query":[{"key":"order_id","value":"order_0003","description":"Filter Based on Single Order ID","disabled":true},{"key":"order_ids","value":null,"description":"Filter Based on Multiple Order IDs","type":"text","disabled":true},{"key":"sto_request_id","value":"STO_order_0003","description":"Filter Based on STO request ID","type":"text","disabled":true},{"key":"created_from","value":"2024-02-20","description":"Filter Based on Order Created Date Range","disabled":true},{"key":"created_to","value":"2024-02-23","description":"Filter Based on Order Created Date Range","disabled":true},{"key":"updated_to","value":"2024-03-28","description":"Filter Based on Order Updated Date Range","disabled":true},{"key":"updated_from","value":"2024-01-21","description":"Filter Based on Order Updated Date Range","disabled":true},{"key":"page","value":"1","description":"Pagination","disabled":true},{"key":"per_page","value":"100","description":"Pagination","disabled":true},{"key":"customer_id","value":null,"description":"Filter Based on Unique Customer ID","type":"text","disabled":true},{"key":"customer_name","value":null,"description":"Filter Based on Customer Name ","type":"text","disabled":true},{"key":"customer_email","value":null,"description":"Filter Based on Customer Email","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jan 2025 06:48:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"6281bbeb-4717-4720-b81f-7e104ca468f4"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9097468d2dc76fad-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"69bb97dcfafcde472db01bef\",\n \"order_id\": \"12345657898754defrgtaswe\",\n \"order_alias\": \"order_omniful-alias\",\n \"omniful_order_id\": \"69bb97dcfafcde472db01bef\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"console\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-19T06:29:48.479Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/profile1.jpg\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/report.pdf\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/screenshot.png\",\n \"type\": \"\"\n }\n ],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n }\n },\n {\n \"id\": \"69bb8f6c4d84599f5c84e6c6\",\n \"order_id\": \"12345657898754defrgtas\",\n \"order_alias\": \"order_omniful-alias\",\n \"omniful_order_id\": \"69bb8f6c4d84599f5c84e6c6\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"console\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-19T05:53:48.489Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/profile1.jpg\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/report.pdf\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/screenshot.png\",\n \"type\": \"\"\n }\n ],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n }\n },\n {\n \"id\": \"69bb8f684d84599f5c84e6c3\",\n \"order_id\": \"32431ewdse\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69bb8f684d84599f5c84e6c3\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-19T05:53:44.899Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 3,\n \"tax\": 69.9,\n \"discount\": 103,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69bab8bf6537a58b1f71ece5\",\n \"order_id\": \"12345657898754defrgt\",\n \"order_alias\": \"order_omniful-alias\",\n \"omniful_order_id\": \"69bab8bf6537a58b1f71ece5\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"console\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-18T14:37:51.234Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/profile1.jpg\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/report.pdf\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/screenshot.png\",\n \"type\": \"\"\n }\n ],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n }\n },\n {\n \"id\": \"69bab4d76537a58b1f71ec80\",\n \"order_id\": \"note_test_134ty\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69bab4d76537a58b1f71ec80\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-18T14:21:11.03Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 3,\n \"tax\": 69.9,\n \"discount\": 103,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69b2c78db47e3ef10d8ca4a5\",\n \"order_id\": \"sale_wms\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69b2c78db47e3ef10d8ca4a5\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-12T14:02:53.118Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69b2c7817fbdd7d30c9f6d28\",\n \"order_id\": \"sales2_wms\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69b2c7817fbdd7d30c9f6d28\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-12T14:02:41.57Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"wms_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69b2c77e37d3e278a9bc5cb6\",\n \"order_id\": \"omni2_wms\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69b2c77e37d3e278a9bc5cb6\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-12T14:02:38.821Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"wms_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69b2705cfc70a08700828bfe\",\n \"order_id\": \"omni_wms\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69b2705cfc70a08700828bfe\",\n \"status_code\": \"packed\",\n \"display_status\": \"Packed\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-12T07:50:52.557Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"wms_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69b2704937d3e278a9bc4945\",\n \"order_id\": \"sales_wms\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69b2704937d3e278a9bc4945\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"https://omniful.slack.com/archives/C08G2S1KJ84/p1773033726807059?thread_ts=1773033692.969059&cid=C08G2S1KJ84\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-565345322\",\n \"state\": \"Jeddah\",\n \"zip\": \"https://omniful.slack.com/archives/C08G2S1KJ84/p1773033726807059?thread_ts=1773033692.969059&cid=C08G2S1KJ84\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"RFCD2323\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-12T07:50:33.924Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69b263eefc70a08700828a23\",\n \"order_id\": \"sales\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69b263eefc70a08700828a23\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-12T06:57:50.487Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69b263e8d6dfcc94da8313b9\",\n \"order_id\": \"sales_c\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69b263e8d6dfcc94da8313b9\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-12T06:57:44.591Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69afdd47b4c0999f20e8c789\",\n \"order_id\": \"omni\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69afdd47b4c0999f20e8c789\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-10T08:58:47.618Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69afdc1670279d06931de680\",\n \"order_id\": \"omni_order\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69afdc1670279d06931de680\",\n \"status_code\": \"on_hold\",\n \"display_status\": \"On Hold\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-10T08:53:42.629Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"shipment_created_at\": \"2026-03-10T08:54:18.06Z\",\n \"awb_number\": \"AWBMANUAL123451161888266133\",\n \"delivery_status\": \"created\",\n \"awb_label\": \"https://example.link.com/shipping/b59de7e04cc5687_awb_label.pdf\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"tracking_url\": \"https://tracking.example.com/123456789\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"69afdc0870279d06931de67d\",\n \"order_id\": \"sc_order\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"69afdc0870279d06931de67d\",\n \"status_code\": \"on_hold\",\n \"display_status\": \"On Hold\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-10T08:53:28.558Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"698ae1c0673be7393529b42d\",\n \"order_id\": \"Omniful_CHANNEL_2\",\n \"order_alias\": \"order-alias-127\",\n \"omniful_order_id\": \"698ae1c0673be7393529b42d\",\n \"status_code\": \"shipped\",\n \"display_status\": \"Shipped\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-02-10T07:44:00.35Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"shipment_created_at\": \"2026-03-10T09:06:40.542Z\",\n \"order_shipped_at\": \"2026-03-10T09:07:43.386Z\",\n \"awb_number\": \"AWBMANUAL12345116188826613ss\",\n \"delivery_status\": \"dispatched\",\n \"awb_label\": \"https://example.link.com/shipping/b59de7e04cc5687_awb_label.pdf\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"tracking_url\": \"https://tracking.example.com/123456789\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"698ae07e6c6e5ad84bd6cd24\",\n \"order_id\": \"newone\",\n \"order_alias\": \"order-alias\",\n \"omniful_order_id\": \"698ae07e6c6e5ad84bd6cd24\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-02-10T07:38:38.143Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"698ae02546c8b9d6b23fb4dd\",\n \"order_id\": \"myordeqr1\",\n \"order_alias\": \"order-alias\",\n \"omniful_order_id\": \"698ae02546c8b9d6b23fb4dd\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-02-10T07:37:08.996Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"698adfae88335a9fd47f83eb\",\n \"order_id\": \"myorder1\",\n \"order_alias\": \"order-alias\",\n \"omniful_order_id\": \"698adfae88335a9fd47f83eb\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-02-10T07:35:10.473Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"698adf526c6e5ad84bd6cccc\",\n \"order_id\": \"bulk_32320921\",\n \"order_alias\": \"order-alias\",\n \"omniful_order_id\": \"698adf526c6e5ad84bd6cccc\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-02-10T07:33:38.266Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"sales_channel_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"tenant_custom\",\n \"name\": \"Tenant Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 2,\n \"per_page\": 20,\n \"total\": 29\n }\n}"}],"_postman_id":"e8024315-3aca-4511-8ceb-fd721c115fed"},{"name":"Get Seller Order By OrderID","id":"1bd9ee3e-d292-40c8-b141-f80a67a5da77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/seller/orders/:order_id","description":"

📌 Get Seller Order by Order ID API - Overview

The Get Seller Order by Order ID API allows users to fetch details of a single order for a seller using the Omniful-generated Order ID (omniful_order_id).

This API is particularly useful for retrieving order details that were not placed through the Custom Sales Channel Integration. It provides complete order information, including order items, customer details, billing and shipping addresses, and invoice details, ensuring sellers have full visibility into individual orders placed through any of the sales channels they have integrated on their account.

📝 Response Body Parameters

Field	Data Type	Description	Always Included
is_success	boolean	Indicates if the request was successful.	✅ Yes
status_code	number	HTTP status code of the response.	✅ Yes
data	object	Order details object.	✅ Yes
data.order_id	string	Unique order identifier.	✅ Yes
data.order_alias	string	Seller-specific order reference.	✅ Yes
data.omniful_order_id	string	Internal system order identifier.	✅ Yes
data.status_code	string	Current order status code.	✅ Yes
data.display_status	string	Human-readable order status.	✅ Yes
data.store_name	string	Name of the seller store.	✅ Yes
data.source	string	Sales channel origin.	✅ Yes
data.order_items	array	List of items in the order.	✅ Yes
data.order_items[].sku_code	string	Product SKU identifier.	✅ Yes
data.order_items[].hs_code	string	Harmonized System code.	❌ No
data.order_items[].sku_id	string	Internal SKU reference.	❌ No
data.order_items[].display_price	number	Original listed price.	✅ Yes
data.order_items[].selling_price	number	Final selling price.	✅ Yes
data.order_items[].is_substituted	boolean	Item substitution status.	✅ Yes
data.order_items[].substitute_seller_sku_codes	array	Allowed substitute SKUs.	❌ No
data.order_items[].serialised_sku_codes	array	Item serial numbers.	❌ No
data.order_items[].item_barcodes	array	Item barcode list.	❌ No
data.order_items[].quantity	number	Ordered quantity.	✅ Yes
data.order_items[].picked_quantity	number	Items picked for fulfillment.	✅ Yes
data.order_items[].packed_quantity	number	Items packed for shipping.	✅ Yes
data.order_items[].tax_percent	number	Applied tax rate.	✅ Yes
data.order_items[].tax	number	Calculated tax amount.	✅ Yes
data.order_items[].unit_price	number	Price per unit.	✅ Yes
data.order_items[].subtotal	number	Total before tax/discounts.	✅ Yes
data.order_items[].total	number	Final item total.	✅ Yes
data.order_items[].discount	number	Discount amount.	✅ Yes
data.order_items[].tax_inclusive	boolean	If price includes tax.	✅ Yes
data.total	number	Total number of items.	✅ Yes
data.billing_address	object	Billing information.	✅ Yes
data.billing_address.address1	string	Primary billing address.	✅ Yes
data.billing_address.address2	string	Secondary billing address.	❌ No
data.billing_address.city	string	Billing city.	✅ Yes
data.billing_address.country	string	Billing country.	✅ Yes
data.billing_address.first_name	string	Billing contact first name.	✅ Yes
data.billing_address.last_name	string	Billing contact last name.	✅ Yes
data.billing_address.phone	string	Billing contact phone.	✅ Yes
data.billing_address.state	string	Billing state/province.	✅ Yes
data.billing_address.zip	string	Billing postal code.	✅ Yes
data.billing_address.state_code	string	Billing state code.	✅ Yes
data.billing_address.country_code	string	Two-letter country code.	✅ Yes
data.billing_address.latitude	number	Billing location latitude.	❌ No
data.billing_address.longitude	number	Billing location longitude.	❌ No
data.billing_address.national_address_code	number	Billing location national address code.	❌ No
data.shipping_address	object	Delivery information.	✅ Yes
data.shipping_address.address1	string	Primary shipping address.	✅ Yes
data.shipping_address.address2	string	Secondary shipping address.	❌ No
data.shipping_address.city	string	Shipping city.	✅ Yes
data.shipping_address.country	string	Shipping country.	✅ Yes
data.shipping_address.first_name	string	Recipient's first name.	✅ Yes
data.shipping_address.last_name	string	Recipient's last name.	✅ Yes
data.shipping_address.phone	string	Recipient's phone.	✅ Yes
data.shipping_address.state	string	Shipping state/province.	✅ Yes
data.shipping_address.zip	string	Shipping postal code.	✅ Yes
data.shipping_address.state_code	string	Shipping state code.	✅ Yes
data.shipping_address.country_code	string	Two-letter country code for shipping.	✅ Yes
data.shipping_address.latitude	number	Delivery location latitude.	❌ No
data.shipping_address.longitude	number	Delivery location longitude.	❌ No
data.shipping_address.national_address_code	number	Shipping location national address code.	❌ No
data.slot	object	Delivery time slot details.	✅ Yes
data.slot.delivery_date	string	Delivery date (DDMMYYYY).	✅ Yes
data.slot.start_time	number	Window start time (24hr format).	✅ Yes
data.slot.end_time	number	Window end time (24hr format).	✅ Yes
data.order_created_at	string	Creation timestamp (ISO).	✅ Yes
data.invoice	object	Payment details.	✅ Yes
data.invoice.currency	string	Order currency code.	✅ Yes
data.invoice.subtotal	number	Order subtotal.	✅ Yes
data.invoice.shipping_price	number	Shipping cost.	✅ Yes
data.invoice.shipping_refund	number	Shipping refund amount.	✅ Yes
data.invoice.tax	number	Total tax amount.	✅ Yes
data.invoice.discount	number	Total discount.	✅ Yes
data.invoice.total	number	Final order total.	✅ Yes
data.invoice.total_paid	number	Amount received.	✅ Yes
data.invoice.total_due	number	Outstanding balance.	✅ Yes
data.invoice.shipping_tax	number	Tax on shipping.	✅ Yes
data.invoice.sub_total_tax_inclusive	boolean	If subtotal includes tax.	✅ Yes
data.invoice.sub_total_discount_inclusive	boolean	If subtotal includes discounts.	✅ Yes
data.invoice.shipping_tax_inclusive	boolean	If shipping includes tax.	✅ Yes
data.invoice.shipping_discount_inclusive	boolean	If shipping includes discounts.	✅ Yes
data.invoice.additional_charges	array	Extra fees list.	✅ Yes
data.invoice.attachments	array	Invoice documents.	✅ Yes
data.invoice.attachments[].url	string	Document URL.	✅ Yes
data.invoice.attachments[].type	string	Document type.	✅ Yes
data.customer	object	Customer details.	✅ Yes
data.customer.first_name	string	Customer's first name.	✅ Yes
data.customer.last_name	string	Customer's last name.	✅ Yes
data.customer.mobile	string	Customer's phone.	✅ Yes
data.customer.mobile_code	string	Country calling code.	✅ Yes
data.customer.email	string	Customer's email.	✅ Yes
data.customer.avatar	string	Profile picture URL.	❌ No
data.customer.gender	string	Customer's gender.	❌ No
data.shipment	object	Shipping details.	✅ Yes
data.shipment.delivery_status	string	Current delivery status.	✅ Yes
data.payment_method	string	Payment method used.	✅ Yes
data.shipment_type	string	Type of shipment.	✅ Yes
data.type	string	Order type.	✅ Yes
data.driver_details	object	Delivery driver info.	❌ No
data.expected_delivery_epoch	number	Expected delivery timestamp.	✅ Yes
data.external_fields	array	External reference data.	❌ No
data.external_fields[].key	string	Reference field name.	✅ Yes
data.external_fields[].value	string	Reference field value.	✅ Yes
data.cancel_order_after_seconds	number	Auto-cancellation time.	✅ Yes
data.sales_channel	object	Details about the sales channel from which the order originated.	:white_check_mark: Yes
data.sales_channel.tag	string	Identifier tag for the sales channel (e.g., `custom`).	:white_check_mark: Yes
data.sales_channel.name	string	Display name of the sales channel.	:white_check_mark: Yes
data.sales_channel.category	string	Category/type of the sales channel (e.g., `SalesChannel`).	:white_check_mark: Yes
data.sales_channel.logo_url	string	URL of the sales channel logo.	:white_check_mark: Yes
meta	object	Response metadata.	❌ No

🔹 Key Information

omniful_order_id is unique and generated by Omniful for every order.
\n
This is different from the order ID received from the sales channel.
\n
If a seller has multiple sales channels connected, the same sales channel order ID may appear in different channels. However, the Omniful Order ID remains unique across all orders.
\n
Using omniful_order_id ensures accurate order retrieval without conflicts.
\n

\n","urlObject":{"path":["sales-channel","public","v1","seller","orders",":order_id"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

Filter Based on Single Order ID

\n","type":"text/plain"},"key":"order_id","value":"order_0003"},{"disabled":true,"description":{"content":"

Filter Based on Multiple Order IDs

\n","type":"text/plain"},"key":"order_ids","value":""},{"disabled":true,"description":{"content":"

Filter Based on STO request ID

\n","type":"text/plain"},"key":"sto_request_id","value":"STO_order_0003"},{"disabled":true,"description":{"content":"

Filter Based on Order Created Date Range

\n","type":"text/plain"},"key":"created_from","value":"2024-02-20"},{"disabled":true,"description":{"content":"

Filter Based on Order Created Date Range

\n","type":"text/plain"},"key":"created_to","value":"2024-02-23"},{"disabled":true,"description":{"content":"

Filter Based on Order Updated Date Range

\n","type":"text/plain"},"key":"updated_to","value":"2024-03-28"},{"disabled":true,"description":{"content":"

Filter Based on Order Updated Date Range

\n","type":"text/plain"},"key":"updated_from","value":"2024-01-21"},{"disabled":true,"description":{"content":"

Pagination

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Pagination

\n","type":"text/plain"},"key":"per_page","value":"100"},{"disabled":true,"description":{"content":"

Filter Based on Unique Customer ID

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

Filter Based on Customer Name

\n","type":"text/plain"},"key":"customer_name","value":""},{"disabled":true,"description":{"content":"

Filter Based on Customer Email

\n","type":"text/plain"},"key":"customer_email","value":""},{"disabled":true,"description":{"content":"

Shows a list of items/SKUs ordered in this order.

\n","type":"text/plain"},"key":"order_items","value":""}],"variable":[{"description":{"content":"

This is a unique identifier generated by Omniful for every order.

\n","type":"text/plain"},"type":"any","value":"omniful_order_id","key":"order_id"}]}},"response":[{"id":"3e57c1fe-dd50-4fbf-b9aa-0a7c858cc1d8","name":"Get Seller Order By OrderID","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/seller/orders/:order_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","seller","orders",":order_id"],"query":[{"key":"order_id","value":"order_0003","description":"Filter Based on Single Order ID","disabled":true},{"key":"order_ids","value":null,"description":"Filter Based on Multiple Order IDs","type":"text","disabled":true},{"key":"sto_request_id","value":"STO_order_0003","description":"Filter Based on STO request ID","type":"text","disabled":true},{"key":"created_from","value":"2024-02-20","description":"Filter Based on Order Created Date Range","disabled":true},{"key":"created_to","value":"2024-02-23","description":"Filter Based on Order Created Date Range","disabled":true},{"key":"updated_to","value":"2024-03-28","description":"Filter Based on Order Updated Date Range","disabled":true},{"key":"updated_from","value":"2024-01-21","description":"Filter Based on Order Updated Date Range","disabled":true},{"key":"page","value":"1","description":"Pagination","disabled":true},{"key":"per_page","value":"100","description":"Pagination","disabled":true},{"key":"customer_id","value":null,"description":"Filter Based on Unique Customer ID","type":"text","disabled":true},{"key":"customer_name","value":null,"description":"Filter Based on Customer Name ","type":"text","disabled":true},{"key":"customer_email","value":null,"description":"Filter Based on Customer Email","type":"text","disabled":true},{"key":"order_items","value":null,"description":"Shows a list of items/SKUs ordered in this order.","type":"text","disabled":true}],"variable":[{"key":"order_id","value":"69bb97dcfafcde472db01bef"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 10:12:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"6475673a-67e8-4215-bfd8-de2a7e24f661"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90da5d1a484e8027-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"69bb97dcfafcde472db01bef\",\n \"order_id\": \"12345657898754defrgtaswe\",\n \"order_alias\": \"order_omniful-alias\",\n \"omniful_order_id\": \"69bb97dcfafcde472db01bef\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"console\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"order_items\": [\n {\n \"item_id\": \"\",\n \"sales_channel_order_item_id\": \"6302592\",\n \"sku_code\": \"6302592\",\n \"hs_code\": \"\",\n \"sku_id\": \"\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"substitute_seller_sku_codes\": null,\n \"serialised_sku_codes\": null,\n \"item_barcodes\": null,\n \"quantity\": 8,\n \"picked_quantity\": 0,\n \"packed_quantity\": 0,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 0,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-19T06:29:48.479Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/profile1.jpg\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/report.pdf\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/screenshot.png\",\n \"type\": \"\"\n }\n ],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n }\n },\n \"meta\": null\n}"}],"_postman_id":"1bd9ee3e-d292-40c8-b141-f80a67a5da77"},{"name":"Get Orders","event":[{"listen":"test","script":{"id":"c781de08-cd73-4c28-ac1d-ac9f40534e7c","exec":["pm.test(\"Response status code is 200\", function () {"," pm.expect(pm.response.code).to.equal(200);","});","","","pm.test(\"is_success field should be true\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.is_success).to.be.true;","});","","","pm.test(\"Status code should be 0\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData.status_code).to.equal(0);","});","","","pm.test(\"Data array is present in the response\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.exist;","});","","","pm.test(\"Meta field should be null\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.meta).to.be.null;","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d1177b2e-7f7b-4a9d-a60b-53395471cc19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders","description":"

⚠️ Important Notice

The following fields will be deprecated from our Custom Integration APIs starting 30th September 2025 11:59 PM UTC :
• The “order_items” field in the Get Seller Orders API response when using the query parameter include=order_items.
We recommend you review and update your custom integrations to ensure they're compatible with these changes.

📌 Get Orders API - Overview

The Get Orders API allows users to retrieve a list of all orders created for a seller through the Custom Integration Sales Channel. This API provides order details, including order status, customer information, billing and shipping addresses, invoice details, and payment method.

Response Body Parameters

Field	Data Type	Description	Always Included
is_success	boolean	Indicates if the request was successful.	✅ Yes
status_code	number	HTTP status code of the response.	✅ Yes
data	array	Array of order objects.	✅ Yes
data[].order_id	string	Unique identifier for the order.	✅ Yes
data[].order_alias	string	Alternative reference for the order.	✅ Yes
data[].omniful_order_id	string	Internal system order identifier.	✅ Yes
data[].status_code	string	Current order status code.	✅ Yes
data[].display_status	string	Human-readable order status.	✅ Yes
data[].hub_code	string	Fulfillment center identifier.	✅ Yes
data[].total	number	Total number of items in order.	✅ Yes
data[].billing_address	object	Billing address details.	✅ Yes
data[].billing_address.address1	string	Primary billing address line.	✅ Yes
data[].billing_address.address2	string	Secondary billing address line.	❌ No
data[].billing_address.city	string	Billing city.	✅ Yes
data[].billing_address.country	string	Billing country.	✅ Yes
data[].billing_address.first_name	string	Billing contact first name.	✅ Yes
data[].billing_address.last_name	string	Billing contact last name.	✅ Yes
data[].billing_address.phone	string	Billing contact phone.	✅ Yes
data[].billing_address.state	string	Billing state/province.	✅ Yes
data[].billing_address.zip	string	Billing postal code.	✅ Yes
data[].billing_address.state_code	string	Billing state code.	✅ Yes
data[].billing_address.country_code	string	Two-letter country code.	✅ Yes
data[].billing_address.latitude	number	Billing location latitude.	❌ No
data[].billing_address.longitude	number	Billing location longitude.	❌ No
data[].billing_address.national_address_code	string	Billing location national address code.	❌ No
data[].shipping_address	object	Delivery address details.	✅ Yes
data[].shipping_address.address1	string	Primary shipping address line.	✅ Yes
data[].shipping_address.address2	string	Secondary shipping address line.	❌ No
data[].shipping_address.city	string	Shipping city.	✅ Yes
data[].shipping_address.country	string	Shipping country.	✅ Yes
data[].shipping_address.first_name	string	Recipient's first name.	✅ Yes
data[].shipping_address.last_name	string	Recipient's last name.	✅ Yes
data[].shipping_address.phone	string	Recipient's phone number.	✅ Yes
data[].shipping_address.state	string	Shipping state/province.	✅ Yes
data[].shipping_address.zip	string	Shipping postal code.	✅ Yes
data[].shipping_address.state_code	string	Shipping state code.	✅ Yes
data[].shipping_address.country_code	string	Two-letter country code.	✅ Yes
data[].shipping_address.latitude	number	Delivery location latitude.	❌ No
data[].shipping_address.longitude	number	Delivery location longitude.	❌ No
data[].shipping_address.national_address_code	string	Shipping location national address code.	❌ No
data[].slot	object	Delivery time slot information.	✅ Yes
data[].slot.delivery_date	string	Scheduled delivery date (DDMMYYYY format).	✅ Yes
data[].slot.start_time	number	Delivery window start time (24-hour format).	✅ Yes
data[].slot.end_time	number	Delivery window end time (24-hour format).	✅ Yes
data[].order_created_at	string	Order creation timestamp (ISO format).	✅ Yes
data[].invoice	object	Invoice and payment details.	✅ Yes
data[].invoice.currency	string	Three-letter currency code.	✅ Yes
data[].invoice.subtotal	number	Order subtotal before adjustments.	✅ Yes
data[].invoice.shipping_price	number	Shipping cost.	✅ Yes
data[].invoice.shipping_refund	number	Shipping refund amount.	✅ Yes
data[].invoice.tax	number	Total tax amount.	✅ Yes
data[].invoice.discount	number	Total discount amount.	✅ Yes
data[].invoice.total	number	Final order total.	✅ Yes
data[].invoice.total_paid	number	Amount paid.	✅ Yes
data[].invoice.total_due	number	Remaining balance.	✅ Yes
data[].invoice.tax_percent	number	Overall tax rate.	✅ Yes
data[].invoice.shipping_tax	number	Tax on shipping.	✅ Yes
data[].invoice.sub_total_tax_inclusive	boolean	If subtotal includes tax.	✅ Yes
data[].invoice.sub_total_discount_inclusive	boolean	If subtotal includes discounts.	✅ Yes
data[].invoice.shipping_tax_inclusive	boolean	If shipping includes tax.	✅ Yes
data[].invoice.shipping_discount_inclusive	boolean	If shipping includes discounts.	✅ Yes
data[].invoice.additional_charges	array	List of additional charges.	✅ Yes
data[].invoice.attachments	array	List of invoice-related documents.	✅ Yes
data[].invoice.attachments[].url	string	Document URL.	✅ Yes
data[].invoice.attachments[].type	string	Document type identifier.	✅ Yes
data[].customer	object	Customer information.	✅ Yes
data[].customer.first_name	string	Customer's first name.	✅ Yes
data[].customer.last_name	string	Customer's last name.	✅ Yes
data[].customer.mobile	string	Customer's phone number.	✅ Yes
data[].customer.mobile_code	string	Customer's country calling code.	✅ Yes
data[].customer.email	string	Customer's email address.	✅ Yes
data[].customer.avatar	string	URL to customer's profile picture.	❌ No
data[].customer.gender	string	Customer's gender.	❌ No
data[].shipment	object	Shipping information.	✅ Yes
data[].shipment.delivery_status	string	Current delivery status.	✅ Yes
data[].payment_method	string	Payment method used.	✅ Yes
data[].shipment_type	string	Type of shipment.	✅ Yes
data[].driver_details	object	Delivery driver information.	❌ No
data[].labels	array	List of order labels/tags.	❌ No
data[].expected_delivery_epoch	number	Expected delivery timestamp.	✅ Yes
data[].external_fields	array	Additional reference fields.	❌ No
data[].external_fields[].key	string	External reference field name.	✅ Yes
data[].external_fields[].value	string	External reference field value.	✅ Yes
data[].cancel_order_after_seconds	number	Auto-cancellation time.	✅ Yes
data[].sales_channel	object	Details about the sales channel from which the order originated.	:white_check_mark: Yes
data[].sales_channel.tag	string	Identifier tag for the sales channel (e.g., `custom`).	:white_check_mark: Yes
data[].sales_channel.name	string	Display name of the sales channel.	:white_check_mark: Yes
data[].sales_channel.category	string	Category/type of the sales channel (e.g., `SalesChannel`).	:white_check_mark: Yes
data[].sales_channel.logo_url	string	URL of the sales channel logo.	:white_check_mark: Yes
meta	object	Pagination metadata.	❌ No

Important Notes:

Response Structure

The response contains an array of orders in data.
\n
Each order follows the same structure.
\n
Pagination details are provided in the meta object.
\n

Pagination

Default page size is 20 items.
\n
Pages start from 1.
\n
Total count and last page are always included.
\n
Use query parameters for page navigation.
\n

Query Parameters

page: Page number (default: 1).
\n
per_page: Results per page (default: 20, max: 100).
\n

Status Codes

200: Successful request.
\n
400: Invalid parameters.
\n
401: Unauthorized.
\n
403: Forbidden.
\n

List Of Order Statuses in Omniful:

new_order
\n
pending
\n
on_hold
\n
hub_assigned
\n
in_picking
\n
picked
\n
consolidated
\n
ready_to_pack
\n
in_packing
\n
ready_to_ship
\n
shipped
\n
packed
\n
cancelled
\n
delivered
\n

Important Points to Consider

Order items will not be included in the Get Orders API response.
\n
To retrieve order items, use the Get Order By OrderID API instead.
\n

Filter based on Order ID

\n","type":"text/plain"},"key":"order_id","value":"order_0008"},{"disabled":true,"description":{"content":"

Filter based on Order Status

\n","type":"text/plain"},"key":"status","value":"in_packing"},{"disabled":true,"description":{"content":"

Filter based on Type of order (B2B/B2C)

\n","type":"text/plain"},"key":"types","value":"b2b"},{"disabled":true,"description":{"content":"

Pagination

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Pagination

\n","type":"text/plain"},"key":"per_page","value":"20"},{"disabled":true,"description":{"content":"

Unique Identifier for Customer

\n","type":"text/plain"},"key":"customer_id","value":"677cb5f65ec53bfcd30afceb"},{"disabled":true,"description":{"content":"

Filter based on customer name

\n","type":"text/plain"},"key":"customer_name","value":"John"},{"disabled":true,"description":{"content":"

Filter based on customer email

\n","type":"text/plain"},"key":"customer_email","value":"John@email.com"},{"disabled":true,"description":{"content":"

Filter based on omniful order id.

\n","type":"text/plain"},"key":"omniful_order_id","value":"6867bff01fc150b5fc2241bc"},{"disabled":true,"description":{"content":"

Filter based on SKU code

\n","type":"text/plain"},"key":"sku_code","value":"687686788"},{"disabled":true,"description":{"content":"

Filter Based on Order Created Date Range. Default value is (created_to - 90 days). Additionally, created_to - created_from should not exceed 90 days.

\n","type":"text/plain"},"key":"created_from","value":"2024-02-23"},{"disabled":true,"description":{"content":"

Filter Based on Order Created Date Range. Default value is today. Additionally, created_to - created_from should not exceed 90 days.

\n","type":"text/plain"},"key":"created_to","value":"2024-02-20"},{"disabled":true,"description":{"content":"

Filter Based on Order Updated Date Range

\n","type":"text/plain"},"key":"updated_to","value":"2024-03-28"},{"disabled":true,"description":{"content":"

Filter Based on Order Updated Date Range

\n","type":"text/plain"},"key":"updated_from","value":"2024-01-21"}],"variable":[]}},"response":[{"id":"a65d23d4-3cd3-4953-ad6b-0093d3bdd740","name":"Get Orders","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders"],"query":[{"key":"order_id","value":"order_0008","description":"Filter based on Order ID","type":"text","disabled":true},{"key":"status","value":"in_packing","description":"Filter based on Order Status","disabled":true},{"key":"types","value":"b2b","description":"Filter based on Type of order (B2B/B2C)","disabled":true},{"key":"include","value":"order_items","disabled":true},{"key":"page","value":"1","description":"Pagination ","disabled":true},{"key":"per_page","value":"20","description":"Pagination","type":"text","disabled":true},{"key":"customer_id","value":"677cb5f65ec53bfcd30afceb","description":"Unique Identifier for Customer","type":"text","disabled":true},{"key":"customer_name","value":"John","description":"Filter based on customer name","type":"text","disabled":true},{"key":"customer_email","value":"John@email.com","description":"Filter based on customer email","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jan 2025 06:47:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"d1bc4e41-3b2d-4f3e-8ed0-b30a5a1e096a"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"909745a35b5e0664-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"69bb97dcfafcde472db01bef\",\n \"order_id\": \"12345657898754defrgtaswe\",\n \"order_alias\": \"order_omniful-alias\",\n \"omniful_order_id\": \"69bb97dcfafcde472db01bef\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"console\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-19T06:29:48.479Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/profile1.jpg\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/report.pdf\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/screenshot.png\",\n \"type\": \"\"\n }\n ],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n }\n },\n {\n \"id\": \"69bb8f6c4d84599f5c84e6c6\",\n \"order_id\": \"12345657898754defrgtas\",\n \"order_alias\": \"order_omniful-alias\",\n \"omniful_order_id\": \"69bb8f6c4d84599f5c84e6c6\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"console\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-19T05:53:48.489Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/profile1.jpg\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/report.pdf\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/screenshot.png\",\n \"type\": \"\"\n }\n ],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n }\n },\n {\n \"id\": \"69bab8bf6537a58b1f71ece5\",\n \"order_id\": \"12345657898754defrgt\",\n \"order_alias\": \"order_omniful-alias\",\n \"omniful_order_id\": \"69bab8bf6537a58b1f71ece5\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"console\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-03-18T14:37:51.234Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/profile1.jpg\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/report.pdf\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/screenshot.png\",\n \"type\": \"\"\n }\n ],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n }\n },\n {\n \"id\": \"695cdc7c6f9b39749598f32e\",\n \"order_id\": \"samosa12ede34567werf\",\n \"order_alias\": \"order_omniful-alias\",\n \"omniful_order_id\": \"695cdc7c6f9b39749598f32e\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"02\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-01-06T09:57:16.25Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/profile1.jpg\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/report.pdf\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/screenshot.png\",\n \"type\": \"\"\n }\n ],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"6953a4d8eba70e411ae0b48b\",\n \"order_id\": \"samosa1234567\",\n \"order_alias\": \"\",\n \"omniful_order_id\": \"6953a4d8eba70e411ae0b48b\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"total\": 2,\n \"billing_address\": {\n \"address1\": \"123 Main Street\",\n \"address2\": \"\",\n \"city\": \"New York\",\n \"country\": \"United States\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"123-456-7890\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"state_code\": \"NY\",\n \"country_code\": \"US\",\n \"latitude\": 40.7128,\n \"longitude\": -74.006,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"code\"\n },\n \"shipping_address\": {\n \"address1\": \"456 Elm Street\",\n \"address2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"United States\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"987-654-3210\",\n \"state\": \"CA\",\n \"zip\": \"90001\",\n \"state_code\": \"CA\",\n \"country_code\": \"US\",\n \"latitude\": 34.0522,\n \"longitude\": -118.2437,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"code\"\n },\n \"slot\": {\n \"delivery_date\": \"\",\n \"start_time\": 0,\n \"end_time\": 0\n },\n \"order_created_at\": \"2025-12-30T10:09:28.928Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 1900,\n \"shipping_price\": 200,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 200,\n \"total\": 233.3,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 200,\n \"cost\": 0,\n \"cost_without_tax\": 200,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"US\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"United States\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n {\n \"id\": \"6953a0f2eba70e411ae0b3f5\",\n \"order_id\": \"samosa123456\",\n \"order_alias\": \"\",\n \"omniful_order_id\": \"6953a0f2eba70e411ae0b3f5\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"total\": 2,\n \"billing_address\": {\n \"address1\": \"123 Main Street\",\n \"address2\": \"\",\n \"city\": \"New York\",\n \"country\": \"United States\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"123-456-7890\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"state_code\": \"NY\",\n \"country_code\": \"US\",\n \"latitude\": 40.7128,\n \"longitude\": -74.006,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"code\"\n },\n \"shipping_address\": {\n \"address1\": \"456 Elm Street\",\n \"address2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"United States\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"987-654-3210\",\n \"state\": \"CA\",\n \"zip\": \"90001\",\n \"state_code\": \"CA\",\n \"country_code\": \"US\",\n \"latitude\": 34.0522,\n \"longitude\": -118.2437,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"code\"\n },\n \"slot\": {\n \"delivery_date\": \"\",\n \"start_time\": 0,\n \"end_time\": 0\n },\n \"order_created_at\": \"2025-12-30T09:52:49.975Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 1900,\n \"shipping_price\": 200,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 200,\n \"total\": 233.3,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 200,\n \"cost\": 0,\n \"cost_without_tax\": 200,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"US\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"United States\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 6\n }\n}"}],"_postman_id":"d1177b2e-7f7b-4a9d-a60b-53395471cc19"},{"name":"Get Order By OrderID","event":[{"listen":"test","script":{"id":"cc6aab51-b78d-4015-aaab-ff5cfa35dee5","exec":["pm.test(\"Response status code is 200\", function () {"," pm.expect(pm.response.code).to.equal(200);","});","","","pm.test(\"is_success field should be true\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.is_success).to.be.true;","});","","","pm.test(\"Status code should be 0\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData.status_code).to.equal(0);","});","","","pm.test(\"Data array is present in the response\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.exist;","});","","","pm.test(\"Meta field should be null\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.meta).to.be.null;","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"47e3bb14-05a4-4142-ab64-015fbf430282","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/sales-channel/public/v1/orders/:order_id","description":"

⚠️ Important Notice

📌 Get Order by Order ID API - Overview

The Get Order by Order ID API allows users to fetch detailed information about a specific order using the order ID provided in the path parameters. This API is useful when you need to retrieve a single order along with its associated order items, making it easier to track individual products and their details.

📝 Response Body Parameters

Field	Data Type	Description	Always Included
is_success	boolean	Indicates if the request was successful.	✅ Yes
status_code	number	HTTP status code of the response.	✅ Yes
data	object	Contains the main order information.	✅ Yes
data.order_id	string	Unique identifier for the order.	✅ Yes
data.order_alias	string	Alternative reference for the order.	✅ Yes
data.omniful_order_id	string	Internal system order identifier.	✅ Yes
data.status_code	string	Current order status code.	✅ Yes
data.display_status	string	Human-readable order status.	✅ Yes
data.order_items	array	List of items in the order.	✅ Yes
data.order_items.sku_code	string	Product SKU identifier.	✅ Yes
data.order_items.hs_code	string	Harmonized System code for international shipping.	❌ No
data.order_items.sku_id	string	Internal SKU identifier.	❌ No
data.order_items.display_price	number	Original advertised price.	✅ Yes
data.order_items.selling_price	number	Actual selling price after discounts.	✅ Yes
data.order_items.is_substituted	boolean	Whether the item was substituted.	✅ Yes
data.order_items.substitute_seller_sku_codes	array	List of acceptable substitute SKUs.	❌ No
data.order_items.serialised_sku_codes	array	List of serial numbers for the item.	❌ No
data.order_items.item_barcodes	array	List of item barcodes.	❌ No
data.order_items.quantity	number	Ordered quantity.	✅ Yes
data.order_items.picked_quantity	number	Quantity picked for fulfillment.	✅ Yes
data.order_items.packed_quantity	number	Quantity packed for shipping.	✅ Yes
data.order_items.tax_percent	number	Tax rate percentage.	✅ Yes
data.order_items.tax	number	Calculated tax amount.	✅ Yes
data.order_items.unit_price	number	Price per unit.	✅ Yes
data.order_items.subtotal	number	Total before tax and discounts.	✅ Yes
data.order_items.total	number	Final total including tax and discounts.	✅ Yes
data.order_items.discount	number	Discount amount applied.	✅ Yes
data.order_items.tax_inclusive	boolean	Whether price includes tax.	✅ Yes
data.total	number	Total number of items in the order.	✅ Yes
data.billing_address	object	Billing address details.	✅ Yes
data.billing_address.address1	string	Primary billing address line.	✅ Yes
data.billing_address.address2	string	Secondary billing address line.	❌ No
data.billing_address.city	string	Billing city.	✅ Yes
data.billing_address.country	string	Billing country.	✅ Yes
data.billing_address.first_name	string	Billing contact first name.	✅ Yes
data.billing_address.last_name	string	Billing contact last name.	✅ Yes
data.billing_address.phone	string	Billing contact phone.	✅ Yes
data.billing_address.state	string	Billing state/province.	✅ Yes
data.billing_address.zip	string	Billing postal code.	✅ Yes
data.billing_address.state_code	string	Billing state code.	✅ Yes
data.billing_address.country_code	string	Two-letter country code.	✅ Yes
data.billing_address.latitude	number	Billing location latitude.	❌ No
data.billing_address.longitude	number	Billing location longitude.	❌ No
data.billing_address.country_calling_code	string	Country dialing code.	❌ No
data.billing_address.national_address_code	string	Billing location national address code.	❌ No
data.shipping_address	object	Delivery address details.	✅ Yes
data.shipping_address.address1	string	Primary shipping address line.	✅ Yes
data.shipping_address.address2	string	Secondary shipping address line.	❌ No
data.shipping_address.city	string	Shipping city.	✅ Yes
data.shipping_address.country	string	Shipping country.	✅ Yes
data.shipping_address.first_name	string	Recipient's first name.	✅ Yes
data.shipping_address.last_name	string	Recipient's last name.	✅ Yes
data.shipping_address.phone	string	Recipient's phone number.	✅ Yes
data.shipping_address.state	string	Shipping state/province.	✅ Yes
data.shipping_address.zip	string	Shipping postal code.	✅ Yes
data.shipping_address.state_code	string	Shipping state code.	✅ Yes
data.shipping_address.country_code	string	Two-letter country code.	✅ Yes
data.shipping_address.latitude	number	Delivery location latitude.	❌ No
data.shipping_address.longitude	number	Delivery location longitude.	❌ No
data.shipping_address.country_calling_code	string	Country dialing code.	❌ No
data.shipping_address.national_address_code	string	Shipping location national address code.	❌ No
data.slot	object	Delivery time slot information.	✅ Yes
data.slot.delivery_date	string	Scheduled delivery date (DDMMYYYY format).	✅ Yes
data.slot.start_time	number	Delivery window start time (24-hour format).	✅ Yes
data.slot.end_time	number	Delivery window end time (24-hour format).	✅ Yes
data.order_created_at	string	Order creation timestamp (ISO format).	✅ Yes
data.invoice	object	Invoice and payment details.	✅ Yes
data.invoice.currency	string	Three-letter currency code.	✅ Yes
data.invoice.subtotal	number	Order subtotal before adjustments.	✅ Yes
data.invoice.shipping_price	number	Shipping cost.	✅ Yes
data.invoice.shipping_refund	number	Shipping refund amount.	✅ Yes
data.invoice.tax	number	Total tax amount.	✅ Yes
data.invoice.discount	number	Total discount amount.	✅ Yes
data.invoice.total	number	Final order total.	✅ Yes
data.invoice.total_paid	number	Amount paid.	✅ Yes
data.invoice.total_due	number	Remaining balance.	✅ Yes
data.invoice.tax_percent	number	Overall tax rate.	✅ Yes
data.invoice.shipping_tax	number	Tax on shipping.	✅ Yes
data.invoice.sub_total_tax_inclusive	boolean	Whether subtotal includes tax.	✅ Yes
data.invoice.sub_total_discount_inclusive	boolean	Whether subtotal includes discounts.	✅ Yes
data.invoice.shipping_tax_inclusive	boolean	Whether shipping includes tax.	✅ Yes
data.invoice.shipping_discount_inclusive	boolean	Whether shipping includes discounts.	✅ Yes
data.invoice.additional_charges	array	List of additional charges.	✅ Yes
data.invoice.attachments	array	List of invoice-related documents.	✅ Yes
data.invoice.attachments.url	string	Document URL.	✅ Yes
data.invoice.attachments.type	string	Document type identifier.	✅ Yes
data.customer	object	Customer information.	✅ Yes
data.customer.first_name	string	Customer's first name.	✅ Yes
data.customer.last_name	string	Customer's last name.	✅ Yes
data.customer.mobile	string	Customer's phone number.	✅ Yes
data.customer.mobile_code	string	Customer's country calling code.	✅ Yes
data.customer.country_code	string	Customer's country code.	❌ No
data.customer.email	string	Customer's email address.	✅ Yes
data.customer.avatar	string	URL to customer's profile picture.	❌ No
data.customer.gender	string	Customer's gender.	❌ No
data.shipment	object	Shipping information.	✅ Yes
data.shipment.delivery_status	string	Current delivery status.	✅ Yes
data.payment_method	string	Payment method used.	✅ Yes
data.shipment_type	string	Type of shipment.	✅ Yes
data.type	string	Order type identifier.	✅ Yes
data.driver_details	object	Delivery driver information.	❌ No
data.labels	array	List of order labels/tags.	❌ No
data.expected_delivery_epoch	number	Expected delivery timestamp.	✅ Yes
data.external_fields	array	Additional external reference fields.	❌ No
data.cancel_order_after_minutes	number	Auto-cancellation time in minutes.	✅ Yes
data.sales_channel	object	Details about the sales channel from which the order originated.	:white_check_mark: Yes
data.sales_channel.tag	string	Identifier tag for the sales channel (e.g., `custom`).	:white_check_mark: Yes
data.sales_channel.name	string	Display name of the sales channel.	:white_check_mark: Yes
data.sales_channel.category	string	Category/type of the sales channel (e.g., `SalesChannel`).	:white_check_mark: Yes
data.sales_channel.logo_url	string	URL of the sales channel logo.	:white_check_mark: Yes
meta	object	Additional metadata about the response.	❌ No

Important Notes:

Time Formats

Delivery slot times use 24-hour format (e.g., 1100 = 11:00 AM).
\n
Dates in slots use DDMMYYYY format.
\n

Status Codes

200: Successful request.
\n
404: Order not found.
\n
401: Unauthorized.
\n
403: Forbidden.
\n

show order items for the given order id

\n","type":"text/plain"},"key":"include","value":"order_items"},{"disabled":true,"description":{"content":"

Filter based on omniful order id

\n","type":"text/plain"},"key":"omniful_order_id","value":"6867bff01fc150b5fc2241bc"}],"variable":[{"type":"any","value":"10167211491622","key":"order_id"}]}},"response":[{"id":"05a6f907-8951-48be-ad86-e3ba353c01d9","name":"Get Order By OrderID","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/order123?include=order_items","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders","order123"],"query":[{"key":"include","value":"order_items","description":"show order items for the given order ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 31 Jan 2025 10:50:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"3290751e-1c4a-4f33-ada2-8f3425c08555"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90a923eb78fa8e7e-DEL"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"695cdc7c6f9b39749598f32e\",\n \"order_id\": \"order123\",\n \"order_alias\": \"order_omniful-alias\",\n \"omniful_order_id\": \"695cdc7c6f9b39749598f32e\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"Store 1\",\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"02\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"order_created_at\": \"2026-01-06T09:57:16.25Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/profile1.jpg\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/report.pdf\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"mime_type\": \"\",\n \"url\": \"https://example.com/screenshot.png\",\n \"type\": \"\"\n }\n ],\n \"refunded_amounts\": [],\n \"total_refunded\": 0\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"SA\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"Saudi Arabia\",\n \"country_calling_code\": \"+1\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"type\": \"\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": [],\n \"cancel_order_after_seconds\": 0,\n \"sales_channel\": {\n \"tag\": \"custom\",\n \"name\": \"Custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n }\n },\n \"meta\": null\n}"}],"_postman_id":"47e3bb14-05a4-4142-ab64-015fbf430282"},{"name":"Get Order Logs","event":[{"listen":"test","script":{"id":"cc6aab51-b78d-4015-aaab-ff5cfa35dee5","exec":["pm.test(\"Response status code is 200\", function () {"," pm.expect(pm.response.code).to.equal(200);","});","","","pm.test(\"is_success field should be true\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.is_success).to.be.true;","});","","","pm.test(\"Status code should be 0\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData.status_code).to.equal(0);","});","","","pm.test(\"Data array is present in the response\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.exist;","});","","","pm.test(\"Meta field should be null\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.meta).to.be.null;","});"],"type":"text/javascript","packages":{}}}],"id":"639094b0-7145-41cb-b390-77297bb0fc52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/orders/:order_id/logs","description":"

📌 Get Order Logs API – Overview

The Get Order Logs API allows users to retrieve detailed logs for a specific order using its Order ID.

It provides real-time insights into the order’s lifecycle within the warehouse, including:

Status updates
\n
Fulfillment progress
\n
Modifications made to the order
\n

This API is particularly useful for:

Tracking order history
\n
Troubleshooting operational issues
\n
Ensuring seamless order management
\n

Response Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description	Always Included
is_success	boolean	Indicates whether the request was successful	✅ Yes
status_code	number	HTTP status code of the response	✅ Yes
data	object	Contains the order log information	✅ Yes
data.logs	array	List of order event logs	✅ Yes
data.logs[].event	string	Type of event that occurred (e.g., `\"New Order\"`, `\"Hub Assigned\"`)	✅ Yes
data.logs[].event_updated_by	string	Name or identifier of the user/system that made the update	✅ Yes
data.logs[].event_updated_at	string	Timestamp of when the event occurred, in the format `MMM DD, YYYY HH:mm:ss AM/PM`	✅ Yes
data.logs[].note	string	Additional comments or information about the event	✅ Yes
meta	object	Additional metadata about the response	❌ No

Important Notes

Event Types

New Order – Initial order creation
\n
Hub Assigned – Order assigned to a fulfillment center
\n
In Picking – Items being collected from the warehouse
\n
Picked – All items collected successfully
\n
In Packing – Items being prepared for shipping
\n
Additional status updates may also be available
\n

Time Format

All timestamps follow a 12-hour format with AM/PM
\n
Example: \"Oct 12, 2024 04:30:38 AM\"
\n
Includes date, hours, minutes, and seconds
\n

Event Sources

User-generated events display the user’s name (e.g., \"Ritik\", \"RishabhL\")
\n
System-generated events display \"System\" as the updater
\n
Every event maintains a complete audit trail
\n

Log Structure

Logs are ordered chronologically (newest first)
\n
Each log entry contains full event details
\n
The note field may be an empty string if no comments are provided
\n

Status Codes

200 – Successfully retrieved logs
\n
401 – Unauthorized
\n
403 – Insufficient permissions
\n
404 – Order not found
\n

The unique Identifier of the order

\n","type":"text/plain"},"type":"any","value":"sto_id_27654","key":"order_id"}]}},"response":[{"id":"057980ea-bff5-4b65-9d8c-0a69093f8ae1","name":"Get Order Logs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/:order_id/logs","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders",":order_id","logs"],"variable":[{"key":"order_id","value":"sto_id_27654","description":"The unique identifier of the order."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 13 Oct 2024 08:20:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"318dbe76-f51d-4f25-931f-3fd4f84f5f66"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d1de990184505e3-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"logs\": [\n {\n \"event\": \"New Order\",\n \"event_updated_by\": \"Ritik\",\n \"event_updated_at\": \"Oct 12, 2024 04:30:38 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"Hub Assigned\",\n \"event_updated_by\": \"System\",\n \"event_updated_at\": \"Oct 12, 2024 04:30:38 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"In Picking\",\n \"event_updated_by\": \"RishabhL\",\n \"event_updated_at\": \"Oct 12, 2024 04:33:08 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"Picked\",\n \"event_updated_by\": \"RishabhL\",\n \"event_updated_at\": \"Oct 12, 2024 04:35:57 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"In Packing\",\n \"event_updated_by\": \"RishabhL\",\n \"event_updated_at\": \"Oct 12, 2024 04:35:57 AM\",\n \"note\": \"\"\n }\n ]\n },\n \"meta\": null\n}"}],"_postman_id":"639094b0-7145-41cb-b390-77297bb0fc52"},{"name":"Update Shipping Address","event":[{"listen":"test","script":{"id":"cc6aab51-b78d-4015-aaab-ff5cfa35dee5","exec":["pm.test(\"Response status code is 200\", function () {"," pm.expect(pm.response.code).to.equal(200);","});","","","pm.test(\"is_success field should be true\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.is_success).to.be.true;","});","","","pm.test(\"Status code should be 0\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData.status_code).to.equal(0);","});","","","pm.test(\"Data array is present in the response\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.exist;","});","","","pm.test(\"Meta field should be null\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.meta).to.be.null;","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b0ee0977-b569-499c-845a-534d168759db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 4B\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"7044063694\",\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"state\": \"NY\",\n \"area\": \"Manhattan\",\n \"district\": \"Downtown\",\n \"street\": \"Broadway\",\n \"zip\": \"10001\",\n \"state_code\": \"NY\",\n \"latitude\": 40.7128,\n \"longitude\": -74.0060,\n \"national_address_code\": \"nac_1234\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/:order_id/shipping_address","description":"

📌 Update Shipping Address API – Overview

The Update Shipping Address API allows users to modify the shipping address details of an order until it reaches the shipped state.

This API provides flexibility in updating recipient details, address, and contact information, helping Prevent delivery issues, Ensure accurate fulfillment, Maintain customer satisfaction.

\n
Users can only update the shipping address associated with a specific Order ID.
\n

Users can only update the shipping address associated with a specific Order ID.

Request Body Parameters

Field	Data Type	Description	Required
address1	string	Main address line (e.g., `\"123 Main St\"`)	✅ Yes
address2	string	Additional address details (e.g., `\"Apt 4B\"`)	❌ No
city	string	City name	✅ Yes
country	string	Country name	✅ Yes
first_name	string	Recipient’s first name	❌ No
last_name	string	Recipient’s last name	❌ No
phone_number	string	Recipient’s phone number (without country code)	✅ Yes
country_calling_code	string	Phone country code with plus sign (e.g., `\"+91\"`)	✅ Yes
country_code	string	Two-letter country code (ISO 3166-1 alpha-2, e.g., `\"IN\"`)	❌ No
state	string	State or province name	❌ No
area	string	Area or neighborhood name	❌ No
district	string	District name	❌ No
street	string	Street name	❌ No
zip	string	Postal or ZIP code	✅ Yes
state_code	string	State abbreviation code	❌ No
latitude	number	Latitude coordinate of the location	❌ No
longitude	number	Longitude coordinate of the location	❌ No
national_address_code	string	National address code of the location	❌ No

The unique identifer of the order for which shipping details needs to be updated.

\n","type":"text/plain"},"type":"any","value":"order_0003","key":"order_id"}]}},"response":[{"id":"68d408a7-c29b-481d-9438-9262c47b5dc6","name":"Update Shipping Address","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 4B\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"7044063694\",\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"state\": \"NY\",\n \"area\": \"Manhattan\",\n \"district\": \"Downtown\",\n \"street\": \"Broadway\",\n \"zip\": \"10001\",\n \"state_code\": \"NY\",\n \"latitude\": 40.7128,\n \"longitude\": -74.0060,\n \"national_address_code\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/:order_id/shipping_address","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders",":order_id","shipping_address"],"variable":[{"key":"order_id","value":"order_0003","description":"The unique identifer of the order for which the shipping details needs to be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Nov 2024 09:00:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"06b72453-f19f-490f-bd8d-2f8aa6ff7f12"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8e2e0cb079913afc-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success: Shipping address was successfully updated.\"\n },\n \"meta\": null\n}"}],"_postman_id":"b0ee0977-b569-499c-845a-534d168759db"},{"name":"Update Shipping Details","event":[{"listen":"test","script":{"id":"cc6aab51-b78d-4015-aaab-ff5cfa35dee5","exec":["pm.test(\"Response status code is 200\", function () {"," pm.expect(pm.response.code).to.equal(200);","});","","","pm.test(\"is_success field should be true\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.is_success).to.be.true;","});","","","pm.test(\"Status code should be 0\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData.status_code).to.equal(0);","});","","","pm.test(\"Data array is present in the response\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.exist;","});","","","pm.test(\"Meta field should be null\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.meta).to.be.null;","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"28dbcc38-1b16-4142-9086-aec66ca7e7b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"fields_to_update\": [\n \"slot\",\"address\"\n ],\n \"address\": {\n \"address1\": \"129 Main Street\",\n \"address2\": \"Apt 4B\",\n \"city\": \"New York\",\n \"country\": \"United States\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+1 212-555-1234\",\n \"country_calling_code\": \"+1\",\n \"country_code\": \"US\",\n \"state\": \"New York\",\n \"area\": \"Manhattan\",\n \"district\": \"Downtown\",\n \"zip\": \"10001\",\n \"state_code\": \"NY\",\n \"latitude\": 40.712776,\n \"longitude\": -74.005974,\n \"email\": \"johndoe@example.com\",\n \"national_address_code\" : \"nac_1234\"\n },\n \"slot\": {\n \"delivery_date\": \"12012026\",\n \"start_time\": 1500,\n \"end_time\": 2059\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/:order_id/shipping_details","description":"

📌 Update Shipping Details API - Overview

The Update Shipping Details API allows users to modify the shipping details for an order until it reaches the shipped state.

This API ensures flexibility in updating recipient details, address, and contact information for a particular order, preventing delivery issues and ensuring accurate fulfillment. Users can only update the shipping address associated with a specific Order ID.

Fields to be updated cannot be empty. No more than two fields can be updated at once.

📝 Request Body Parameters

Root Level Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description	Required
fields_to_update	array	List of fields to update (`address`, `slot`)	✅ Yes
address	object	Shipping address details	❌ Conditional
slot	object	Delivery slot details	❌ Conditional

\n
address or slot is required if included in fields_to_update.
\n

Address Object Parameters

Field	Data Type	Description	Required
address1	string	Main address line (e.g., \"123 Main St\")	✅ Yes
address2	string	Additional address details (e.g., \"Apt 4B\")	❌ No
city	string	City name	✅ Yes
country	string	Country name	✅ Yes
first_name	string	Recipient's first name	❌ No
last_name	string	Recipient's last name	❌ No
phone	string	Recipient's phone number	✅ Yes
country_calling_code	string	Phone country code with plus sign (e.g., \"+91\")	✅ Yes
country_code	string	Two-letter country code (e.g., \"IN\")	❌ No
state	string	State or province name	❌ No
area	string	Area or locality	❌ No
district	string	District name	❌ No
street	string	Street name	❌ No
zip	string	Postal or ZIP code	✅ Yes
state_code	string	State abbreviation code	❌ No
latitude	number	Latitude coordinate	❌ No
longitude	number	Longitude coordinate	❌ No
email	string	Recipient email address	❌ No
national_address_code	string	National address code	❌ No

Slot Object Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description	Required
delivery_date	string	Delivery date in `DDMMYYYY` format	✅ Yes
start_time	number	Slot start time (24-hour format, HHMM)	✅ Yes
end_time	number	Slot end time (24-hour format, HHMM)	✅ Yes

Unique identifier of an order

\n","type":"text/plain"},"type":"any","value":"test-omniful_12","key":"order_id"}]}},"response":[{"id":"73940b56-62e3-478b-a5cf-2d250d95f87d","name":"Update Shipping Details","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fields_to_update\": [\n \"slot\",\"address\"\n ],\n \"address\": {\n \"address1\": \"129 Main Street\",\n \"address2\": \"Apt 4B\",\n \"city\": \"New York\",\n \"country\": \"United States\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+1 212-555-1234\",\n \"country_calling_code\": \"+1\",\n \"country_code\": \"US\",\n \"state\": \"New York\",\n \"area\": \"Manhattan\",\n \"district\": \"Downtown\",\n \"zip\": \"10001\",\n \"state_code\": \"NY\",\n \"latitude\": 40.712776,\n \"longitude\": -74.005974,\n \"email\": \"johndoe@example.com\",\n \"national_address_code\" : \"nac_1234\"\n },\n \"slot\": {\n \"delivery_date\": \"12012026\",\n \"start_time\": 1500,\n \"end_time\": 2059\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/test-omniful_12/shipping_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Mar 2025 14:47:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"9ae6212c-2216-4a3e-baa7-3c58bbcd6884"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9256f70bd9615a7b-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success: Shipping address was successfully updated.\"\n },\n \"meta\": null\n}"}],"_postman_id":"28dbcc38-1b16-4142-9086-aec66ca7e7b0"}],"id":"04745243-93ec-40d6-9bff-95d724f48fe1","description":"

📦 Orders API Documentation

The Orders API allows you to create, fetch, update, and manage orders within the Omniful platform. This API resource provides comprehensive details on order structures, including order items, billing, shipping, transactions, delivery schedules, and payment details. You can use the API to handle all aspects of order processing for your custom sales channels.

🛒 Order Resource (`orders`)

This resource is used to define an order in the system and its associated metadata.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`order_id`	string	Unique identifier for the order (must always be unique).
`order_alias`	string	Alias for easy reference of the order.
`hub_code`	string	Code for the hub associated with the order.

📦 Order Items (`orders.order_items`)

The order_items array contains objects representing each item in the order. Each item includes product details, prices, quantities, and taxes.

Field	Type	Description
`sku_code`	string	Unique SKU identifier for the item.
`hs_code`	string	HS Code for product classification in international trade.
`sku_id`	string	Unique identifier for the SKU used for internal reference.
`name`	string	Name of the item.
`display_price`	number	Display price of the item.
`selling_price`	number	Final selling price of the item.
`is_substituted`	boolean	Indicates if the item has been substituted with an alternative SKU (true/false).
`substitute_seller_sku_codes`	array	List of the SKU codes for substitute items offered by the seller.
`serialised_sku_codes`	array	List of serial numbers for inventory control.
`item_barcodes`	string	Barcode used for scanning and quick identification.
`quantity`	integer	Quantity of the item in the order.
`picked_quantity`	integer	Quantity of the items picked in the order.
`packed_quantity`	integer	Quantity of the items packed in the order.
`unit_price`	number	Unit price of the item.
`subtotal`	number	Subtotal before tax and discounts (unit price * quantity).
`total`	number	Total amount after tax & discounts (subtotal + tax - discount).
`discount`	number	Discount applied to the item.
`tax_percent`	number	Tax percentage applied to the item.
`tax`	number	Tax amount calculated based on the tax percentage.
`tax_inclusive`	boolean	Indicates if the tax is included in the price.

🏠 Shipping & Billing Address (`orders.shipping_address` & `orders.billing_address`)

These objects contain the shipping and billing details for the order. Both follow the same structure. If no billing address is provided, it will be considered the same as the shipping address.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`address1`	string	First line of the address.
`address2`	string	Second line of the address (optional).
`city`	string	City of the address.
`state`	string	State or province.
`state_code`	string	State abbreviation.
`country`	string	Country name.
`country_code`	string	ISO country code (e.g., US, SA).
`zip`	string	ZIP or postal code.
`latitude`	number	Geographical latitude.
`longitude`	number	Geographical longitude.
`first_name`	string	First name of the person.
`last_name`	string	Last name of the person.
`phone`	string	Contact phone number.
`country_calling_code`	string	Country calling code (e.g., +966, +90).

🧾 Invoice (`orders.invoice`)

This object contains the billing and payment details related to the order.

Field	Type	Description
`currency`	string	Currency code (e.g., USD, SAR).
`subtotal`	number	Total before taxes & discounts.
`shipping_price`	number	Cost of shipping.
`shipping_refund`	number	Refund amount for shipping (if applicable).
`tax`	number	Tax amount calculated based on tax percentage.
`discount`	number	Total discount applied to the order.
`total`	number	Final amount after taxes & discounts.
`total_paid`	number	Amount already paid.
`total_due`	number	Remaining amount to be paid.
`total_refunded`	number	Total refunded amount.
`payment_mode`	string	Payment method (e.g., Mada, Credit Card).
`payment_method`	string	Payment state (prepaid, postpaid, pending).
`is_cash_on_delivery`	boolean	Indicates if cash on delivery is used.
`tax_percent`	number	Tax percentage applied.
`shipping_tax`	number	Tax on shipping cost.
`sub_total_tax_inclusive`	boolean	Indicates if the subtotal includes tax.
`sub_total_discount_inclusive`	boolean	Indicates if the subtotal includes discounts.
`shipping_tax_inclusive`	boolean	Indicates if the shipping cost includes tax.
`shipping_discount_inclusive`	boolean	Indicates if the shipping cost includes discounts.
`attachments`	array	List of associated attachment files.
`attachments[].url`	string	URL of the attachment (e.g., https://example.com/avatar1.jpg).
`attachments[].type`	string	Type of the attachment (e.g., image1, image2, image3).

👤 Customer (`orders.customer`)

Stores the customer details associated with the order. The system auto-fetches these details if a customer ID is provided. If not, you can manually enter the details.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	Customer ID (auto-fetches details if provided).
`first_name`	string	Customer's first name.
`last_name`	string	Customer's last name.
`mobile`	string	Mobile number.
`mobile_code`	string	Country code for mobile.
`email`	string	Email address.
`gender`	string	Gender (male, female, other).
`country`	string	Country of the customer.
`country_code`	string	Country code of the customer.
`country_calling_code`	string	Country's international calling code (e.g., +966, +90).
`avatar`	string	URL of the customer's profile picture.

🚚 Shipment Type (`orders.shipment_type`)

Defines the type of shipment for the order.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Description
`omniful_generated`	Omniful Generated Shipment: Shipments created manually or automatically by Omniful.
`sales_channel_generated`	Sales Channel Generated Shipment: Shipments generated by the sales channel system.

🚛 Delivery Type (`orders.delivery_type`)

Specifies the delivery method for an order.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Description
`click_and_collect`	The order will be prepared for collection by the customer at a designated location.
`express_delivery`	The order will be delivered to the customer on an expedited basis.
`slot_delivery`	The order will be delivered within a specific time slot chosen by the customer.
`normal_delivery`	The order will be delivered using the standard delivery method.

💳 Transaction Details (`orders.transactions`)

An array of transaction objects, each representing a single transaction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`transaction_id`	string	A unique identifier for the transaction (e.g., \"T123456\").
`amount`	number	The monetary value of the transaction (e.g., 100.50).
`type`	integer	Type of transaction (1: Coupon, 2: Coin, 3: Gift Card, 4: Account).
`card_number`	string	The masked card number used for the transaction (e.g., \"411111**1111\").
`source_account`	string	The account from which the transaction originates.
`destination_account`	string	The account receiving the transaction.
`status`	integer	Current state of the transaction (1: Pending, 2: Completed, 3: Failed).
`description`	string	A brief note about the transaction (e.g., \"Payment for order #12345\").

🌍 External Fields (`order.external_fields`)

Allows adding custom order data as key-value pairs.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`key`	string	External field name.
`value`	string	External field value.

⏳ Order Auto-Cancellation (`order.cancel_order_after_seconds`)

Defines the time (in seconds) after which the order will automatically cancel if it is in the on_hold state.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`cancel_order_after_seconds`	int	Time (in seconds) after which the order will be automatically canceled if it's on hold.

\n","_postman_id":"04745243-93ec-40d6-9bff-95d724f48fe1","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Shipment","item":[{"name":"Trigger Shipment","id":"c6cdcd4a-af6a-4f9d-9a6d-c5f13c22b155","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number_of_boxes\": 1,\n \"weight\": 1.2,\n \"remarks\": \"Please handle shipment carefully,\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/:order_id/shipment","description":"

📌 Create Shipment API – Overview

The Create Shipment API is used to generate shipments for orders in Omniful.

This API allows users to:

Assign a shipping partner
\n
Generate tracking numbers (AWB)
\n
Set shipment details
\n

\n

Note: The API only supports orders with the shipment type set to Omniful Generated.

Orders with other shipment types are not eligible for shipment creation through this API.

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description	Required
number_of_boxes	number	Total number of packages to be shipped	✅ Yes
weight	number	Total weight of all packages (in kilograms)	❌ No
remarks	string	Additional notes for shipment handling	❌ No

Response Body Parameters

Field	Data Type	Description	Always Included
is_success	boolean	Indicates whether the request was successful	✅ Yes
status_code	number	Response status code	✅ Yes
data	object	Contains shipment information	✅ Yes
data.oms_order_id	string	Omniful system order ID	✅ Yes
data.status	string	Current shipment status	✅ Yes
data.shipping_partner_order_id	string	Order ID assigned by shipping partner	✅ Yes
data.awb_number	string	Air waybill number for tracking	✅ Yes
data.shipping_partner_status	string	Shipment status from the shipping partner	✅ Yes
data.shipping_partner_tag	string	Unique tag of the shipping partner	✅ Yes
data.shipping_partner_name	string	Name of the shipping partner	✅ Yes
data.tracking_url	string	URL to track the shipment	✅ Yes
data.awb_label	string	URL to download the shipping label	✅ Yes
data.number_of_boxes	number	Number of packages in the shipment	✅ Yes
data.weight	number	Total shipment weight (in kilograms)	✅ Yes
data.remarks	string	Shipment handling notes	❌ No
data.pickup_otp	string	One-time password for pickup	❌ No
data.shipping_reference	string	Reference number for the shipment	❌ No
data.print_awb_allowed	boolean	Indicates if AWB can be printed	✅ Yes
data.print_manual_awb_allowed	boolean	Indicates if manual AWB can be printed	✅ Yes
data.print_delivery_note_allowed	boolean	Indicates if a delivery note can be printed	✅ Yes
data.shipping_account.id	number	Shipping account identifier	✅ Yes
data.shipping_account.name	string	Name of the shipping account	✅ Yes
data.shipping_account.display_name	string	Display name of the shipping account	✅ Yes
data.courier_partner.id	number	Courier service identifier	✅ Yes
data.courier_partner.name	string	Name of the courier service	✅ Yes
data.courier_partner.tag	string	Unique tag of the courier service	✅ Yes
data.courier_partner.logo	string	URL to the courier service logo	✅ Yes

✅ Improvements made:

Cleaned up phrasing (“Permission to print” → “Indicates if … can be printed”).
\n
Standardized weight references to kilograms.
\n
Clarified “links” as URL for tracking/labels/logos.
\n
Added callout for Omniful Generated constraint.
\n
Made deprecation notice visually prominent.
\n

Do you want me to also prepare a sample request/response JSON payload (with dummy values) for this API, like we did for Get Order Logs, so developers can see exactly how the structure looks in practice?

Unique identifier of the order for which the shipment needs to be created.

\n","type":"text/plain"},"type":"any","value":"order_000013","key":"order_id"}]}},"response":[{"id":"fd594c8a-0a5b-48be-9479-728b86eb34df","name":"Trigger Shipment","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number_of_boxes\": 1,\n \"weight\": 1.2,\n \"remarks\": \"Please handle shipment carefully,\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/:order_id/shipment","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders",":order_id","shipment"],"variable":[{"key":"order_id","value":"order_000013"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 10:29:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"166530f6-9870-46ae-b144-66d1bae6618f"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90da75550bd705c8-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"oms_order_id\": \"67a48ef6eaadd38fe033a603\",\n \"status\": \"Created\",\n \"shipping_partner_order_id\": \"\",\n \"awb_number\": \"250211914164\",\n \"shipping_awb_label\": \"\",\n \"tracking_info\": null,\n \"shipping_partner_status\": \"Created\",\n \"shipping_partner_tag\": \"kwick_box\",\n \"shipping_partner_name\": \"Kwick Box\",\n \"tracking_url\": \"https://www.kwick-box.com/250211914164/\",\n \"awb_label\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/shipping/kwick_box/demo/1429911/9673de5579ef38eae0e5a699_awb_label.pdf\",\n \"number_of_boxes\": 1,\n \"weight\": 1.2,\n \"remarks\": \"Please handle shipment carefully,\",\n \"pickup_otp\": \"\",\n \"shipping_reference\": \"\",\n \"print_awb_allowed\": true,\n \"print_manual_awb_allowed\": false,\n \"print_delivery_note_allowed\": true,\n \"pre_shipment_details\": null,\n \"courier_partner\": {\n \"name\": \"Kwick Box\",\n \"tag\": \"kwick_box\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/kwick_box.png\"\n }\n },\n \"meta\": null\n}"}],"_postman_id":"c6cdcd4a-af6a-4f9d-9a6d-c5f13c22b155"},{"name":"Add Shipment Details","id":"0916d9d8-1c0f-4d7b-b3a6-6a8b87e5ff2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"tracking_url\": \"https://tracking.fedex.com/123456789\",\n \"awb_number\": \"AWB123456787\",\n \"awb_label\": \"https://tracking.fedex.com/123456789.pdf\",\n \"package_details\": {\n \"number_of_boxes\": 1,\n \"weight\": 1,\n \"dimensions\": {\n \"length\": 30,\n \"breadth\": 20,\n \"height\": 15\n },\n \"remarks\": \"Handle with care\"\n },\n \"courier_partner\": {\n \"tag\": \"dhl_express\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/:order_id/shipment","description":"

📌 Add Shipment Details API – Overview

The Add Shipment Details API allows users to add existing shipment details for an order.

This API is typically used to update shipment-related information such as:

Tracking numbers (AWB)
\n
Courier service details
\n
Delivery tracking URLs
\n

📌 Key Information

This API applies only to orders where the shipment type is either:
\n
- sales_channel_generated
  \n
- sales_channel_notified
  \n
\n
If the shipment was created by the sales channel, users can update the shipment details as required.
\n
Always confirm the shipment type before making updates.
\n
Please use the Get Courier Partners API to retrieve the correct courier partner tag. If the provided tag is invalid, it will automatically default to manual
\n

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description	Required
tracking_url	string	URL to the carrier’s tracking page for real-time status updates	❌ No
awb_number	string	Unique airway bill (AWB) number provided by the carrier	✅ Yes
awb_label	string	Shipping label content, including barcodes and package identification details	❌ No
package_details	object	Information about package quantity, weight, size, and handling notes	❌ No
package_details.number_of_boxes	number	Total number of boxes in the shipment (positive integer)	❌ No
package_details.weight	number	Overall shipment weight in kilograms (kg)	❌ No
package_details.dimensions	object	Physical dimensions of the package (length, breadth, height)	❌ No
package_details.dimensions.length	number	Length in centimeters (cm), measured along the longest side	❌ No
package_details.dimensions.breadth	number	Breadth/width in centimeters (cm)	❌ No
package_details.dimensions.height	number	Height in centimeters (cm)	❌ No
package_details.remarks	string	Special handling notes (e.g., `\"Fragile\"`, `\"Handle with care\"`)	❌ No
courier_partner	object	Information about the courier partner handling last-mile delivery	✅ Yes
courier_partner.tag	string	Short code/tag representing the courier partner	✅ Yes

The unique identifier of the order for which the shipment needs to be updated.

\n","type":"text/plain"},"type":"any","value":"order_000014","key":"order_id"}]}},"response":[{"id":"f97623cc-04b3-4987-a9a9-89c5a802af9d","name":"Add Shipment Details","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"tracking_url\": \"https://tracking.fedex.com/123456789\",\n \"awb_number\": \"AWB123456787\",\n \"awb_label\": \"https://example.com/label.pdf\",\n \"package_details\": {\n \"number_of_boxes\": 1,\n \"weight\": 1,\n \"dimensions\": {\n \"length\": 30,\n \"breadth\": 20,\n \"height\": 15\n },\n \"remarks\": \"Handle with care\"\n },\n \"courier_partner\": {\n \"tag\": \"dhl_express\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/:order_id/shipment","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders",":order_id","shipment"],"variable":[{"key":"order_id","value":"order_000014"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 10:32:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"5a700a12-5925-466b-bd40-05c514f77714"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90da797a5db3172c-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Shipment updated successfully.\",\n \"meta\": null\n}"}],"_postman_id":"0916d9d8-1c0f-4d7b-b3a6-6a8b87e5ff2c"},{"name":"Update Shipment Status","id":"dc6787e8-2e14-4e1d-842e-2245bb539cf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"shipment_status\" : \"dispatched\"\n}"},"url":"{{base_url}}/sales-channel/public/v1/orders/:order_id/shipment/status","description":"

📌 Update Shipment Status API - Overview

The Update Shipment Status API allows users to update the shipment status of an order, ensuring real-time tracking updates for better shipment visibility.

📌 Supported Shipment Types:

Manual Shipment (omniful_generated) – Shipments created manually by users.
\n
Sales Channel Generated Shipment (sales_channel_generated) – Shipments generated by the sales channel system.
\n
Sales Channel Notified Shipment (sales_channel_notified) – Shipments updated based on notifications from the sales channel.
\n

This API helps keep users informed about their order's shipping progress by providing regular updates on courier tracking.

The following shipment statuses can be used to update the shipment status of an order:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
dispatched	Shipment has been handed over to the carrier and is en route.
out_for_delivery	Shipment is on its way to the final destination for delivery.
in_transit	Shipment is moving between different locations or hubs.
delivered	Shipment has been successfully delivered to the recipient.
return_to_origin	Shipment is being returned to the origin due to failed delivery or other reasons.

The unique identifier of the order for which the shipment status needs to be updated.

\n","type":"text/plain"},"type":"any","value":"order_000014","key":"order_id"}]}},"response":[{"id":"96b68de9-4839-495b-aa10-947e752dc3c7","name":"Update Shipment Status","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"shipment_status\" : \"dispatched\"\n}"},"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/:order_id/shipment/status","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders",":order_id","shipment","status"],"variable":[{"key":"order_id","value":"order_000014"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 10:34:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"d162f9cc-3ed7-4712-85d7-b9f6327a66a1"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90da7c71b9fa0939-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Shipment status updated successfully.\"\n },\n \"meta\": null\n}"}],"_postman_id":"dc6787e8-2e14-4e1d-842e-2245bb539cf7"}],"id":"68595bb2-5996-4e1a-8ba4-b26926399575","description":"

📌 Create Shipment API Collection - Overview

The Create Shipment API Collection on Postman includes APIs to create shipments, update shipment details, and change shipment status for an order on Omniful.

With these APIs, users can assign shipping partners, generate tracking numbers (AWB), track shipments, and update delivery status, helping to manage order fulfillment smoothly.

\n","_postman_id":"68595bb2-5996-4e1a-8ba4-b26926399575","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Products","item":[{"name":"Create SKUs","id":"291e3acf-b196-4793-8385-70a406fb270f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"Smart LED TV\",\n \"description\": \"High-quality 4K Smart LED TV with Wi-Fi connectivity.\",\n \"sku_id\": \"tv_sku123\",\n \"sku_code\": \"SKU-TV-123\",\n \"attributes\": [\n {\n \"name\": \"Screen Size\",\n \"sku_attribute_variation\": {\n \"name\": \"Variation 1\"\n }\n }\n ],\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"pcs\",\n \"sku_images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"https://example.com/images/tv/medium.jpg\",\n \"large\": \"https://example.com/images/tv/large.jpg\",\n \"url\": \"https://example.com/images/tv/image.jpg\",\n \"type\": \"image\",\n \"description\": \"Smart LED TV image\"\n }\n ],\n \"categories\": [\n {\n \"name\": \"Electronics\"\n },\n {\n \"name\": \"TV & Video\"\n }\n ],\n \"manufacturer_name\": \"ABC Electronics\",\n \"brand_name\": \"BrandX\",\n \"country_of_origin\": \"CountryX\",\n \"is_weighted\": false,\n \"dimensions\": {\n \"length\": {\n \"length\": 100,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 10,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 60,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"cost\": 300,\n \"retail_price\": 599,\n \"selling_price\": 499,\n \"tax_inclusive\": {\n \"selling_price\": true\n },\n \"tax_percentage\": {\n \"selling_price\": 20\n },\n \n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"10 kg\",\n \"max\": \"15 kg\",\n \"type\": \"fixed\"\n }\n },\n \"custom_attribute\": [\n {\n \"key\": \"Smart TV\",\n \"value\": \"Yes\"\n },\n {\n \"key\": \"Resolution\",\n \"value\": \"4K\"\n }\n ],\n \"product_url\": \"https://example.com/tv\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/skus","description":"

📌 Create SKU API – Overview

The Create SKU API is used to add new SKUs to a sales channel catalog (Sales Channel Listing).

This API enables businesses to publish product listings with all relevant details, including SKU identifiers, pricing, attributes, images, categories, and handling conditions.

⚠️ Important Considerations for Creating a SKU

Unique Identifier:
\n
The sku_code field is mandatory and must be unique for each SKU.
\n
Pricing:
cost, selling_price, and retail_price are required. These values define the SKU’s pricing strategy and profitability.
\n
Handling Type:
Must be one of:
\n
- \"hot\" → Requires heated or warm storage/handling
  \n
- \"cold\" → Requires refrigerated storage/handling
  \n
\n
SKU Type:
Must be either:
\n
- \"simple\" → Standalone product
  \n
- \"bundle\" → A grouped/bundled SKU
  \n
\n
SKU Status:
\n
Must be one of:
\n
- all
  \n
- live
  \n
- ready_to_list
  \n
- under_review
  \n
- draft
  \n
- un_sync
  \n
- others
  \n
\n

Request Body Parameters

Field	Data Type	Description	Required
name	string	Product name, e.g., `\"Smart LED TV\"`	✅ Yes
description	string	Detailed product description, e.g., `\"High-quality 4K Smart LED TV with Wi-Fi connectivity\"`	❌ No
sku_code	string	Unique SKU code, e.g., `\"SKU-TV-123\"`	✅ Yes
attributes	array	Attribute variations of the SKU	❌ No
attributes[].name	string	Attribute name, e.g., `\"Screen Size\"`	❌ No
attributes[].sku_attribute_variation	object	Attribute variation details	❌ No
attributes[].sku_attribute_variation.name	string	Variation name, e.g., `\"Variation 1\"`	❌ No
handling_type	string	Handling type (`\"hot\"` or `\"cold\"`)	✅ Yes
type	string	SKU type (`\"simple\"` or `\"bundle\"`)	✅ Yes
status	string	SKU lifecycle status (e.g., `\"live\"`, `\"draft\"`)	✅ Yes
unit	string	Measurement unit, e.g., `\"pcs\"`	❌ No
sku_images	array	Array of image objects	❌ No
hs_code	string	Harmonized System (HS) Code	❌ No
sku_images[].default	string	Default image URL	❌ No
sku_images[].thumbnail	string	Thumbnail image URL	❌ No
sku_images[].medium	string	Medium-sized image URL	❌ No
sku_images[].large	string	Large image URL	❌ No
sku_images[].url	string	Image URL	❌ No
sku_images[].type	string	Image type, e.g., `\"image\"`	❌ No
sku_images[].description	string	Image description	❌ No
categories	array	Array of category objects	❌ No
categories[].name	string	Category name, e.g., `\"Electronics\"`	❌ No
manufacturer_name	string	Manufacturer’s name	❌ No
brand_name	string	Brand name	❌ No
country_of_origin	string	Country of origin	❌ No
is_weighted	boolean	Whether SKU is weight-based	❌ No
dimensions	object	Physical product dimensions	❌ No
dimensions.length.length	number	Length value	❌ No
dimensions.length.unit	string	Unit of length, e.g., `\"cm\"`	❌ No
dimensions.breadth.breadth	number	Breadth value	❌ No
dimensions.breadth.unit	string	Unit of breadth	❌ No
dimensions.height.height	number	Height value	❌ No
dimensions.height.unit	string	Unit of height	❌ No
barcodes	array	Array of barcodes for the SKU	✅ Yes
cost	number	Cost price of the product	✅ Yes
retail_price	number	Retail (MRP) price	✅ Yes
selling_price	number	Selling price	✅ Yes
is_perishable	boolean	Indicates if the product is perishable	✅ Yes
configuration	object	Additional SKU configuration	❌ No
configuration.weight.min	string	Minimum weight, e.g., `\"10 kg\"`	❌ No
configuration.weight.max	string	Maximum weight, e.g., `\"15 kg\"`	❌ No
configuration.weight.type	string	Weight type, e.g., `\"fixed\"`	❌ No
custom_attribute	array	Array of custom attributes	❌ No
custom_attribute[].key	string	Custom attribute key	❌ No
custom_attribute[].value	string	Custom attribute value	❌ No
product_url	string	Product URL, e.g., `\"https://example.com/tv\"`	❌ No

\n","urlObject":{"path":["sales-channel","public","v1","skus"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b8208734-9f00-49b0-97ad-405736101b7a","name":"Create SKUs Successfully with all the required fields","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"Smart LED TV\",\n \"description\": \"High-quality 4K Smart LED TV with Wi-Fi connectivity.\",\n \"sku_id\": \"tv_sku123\",\n \"sku_code\": \"SKU-TV-123\",\n \"attributes\": [\n {\n \"name\": \"Screen Size\",\n \"sku_attribute_variation\": {\n \"name\": \"Variation 1\"\n }\n }\n ],\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"pcs\",\n \"sku_images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"https://example.com/images/tv/medium.jpg\",\n \"large\": \"https://example.com/images/tv/large.jpg\",\n \"url\": \"https://example.com/images/tv/image.jpg\",\n \"type\": \"image\",\n \"description\": \"Smart LED TV image\"\n }\n ],\n \"categories\": [\n {\n \"name\": \"Electronics\"\n },\n {\n \"name\": \"TV & Video\"\n }\n ],\n \"manufacturer_name\": \"ABC Electronics\",\n \"brand_name\": \"BrandX\",\n \"country_of_origin\": \"CountryX\",\n \"is_weighted\": false,\n \"dimensions\": {\n \"length\": {\n \"length\": 100,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 10,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 60,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"cost\": 300,\n \"retail_price\": 599,\n \"selling_price\": 499,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"10 kg\",\n \"max\": \"15 kg\",\n \"type\": \"fixed\"\n }\n },\n \"custom_attribute\": [\n {\n \"key\": \"Smart TV\",\n \"value\": \"Yes\"\n },\n {\n \"key\": \"Resolution\",\n \"value\": \"4K\"\n }\n ],\n \"is_barcode_adjusted\": true,\n \"product_url\": \"https://example.com/tv\"\n },\n {\n \"name\": \"Split Air Conditioner\",\n \"description\": \"Energy-efficient split air conditioner with cooling capacity.\",\n \"sku_id\": \"ac_sku456\",\n \"sku_code\": \"SKU-AC-456\",\n \"attributes\": [\n {\n \"name\": \"Cooling Capacity\",\n \"sku_attribute_variation\": {\n \"name\": \"Variation 2\"\n }\n }\n ],\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"pcs\",\n \"sku_images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1590756254933-2873d72a83b6?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8Mnx8YWlyJTIwY29uZGl0aW9uZXJ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1590756254933-2873d72a83b6?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8Mnx8YWlyJTIwY29uZGl0aW9uZXJ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"https://example.com/images/ac/medium.jpg\",\n \"large\": \"https://example.com/images/ac/large.jpg\",\n \"url\": \"https://example.com/images/ac/image.jpg\",\n \"type\": \"image\",\n \"description\": \"Split Air Conditioner image\"\n }\n ],\n \"categories\": [\n {\n \"name\": \"Electronics\"\n },\n {\n \"name\": \"TV & Video\"\n }\n ],\n \"manufacturer_name\": \"XYZ Appliances\",\n \"brand_name\": \"BrandY\",\n \"country_of_origin\": \"CountryY\",\n \"is_weighted\": false,\n \"dimensions\": {\n \"length\": {\n \"length\": 90,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 15,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 30,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"8765432109876\",\n \"0123456789012\"\n ],\n \"cost\": 500,\n \"retail_price\": 799,\n \"selling_price\": 699,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"20 kg\",\n \"max\": \"25 kg\",\n \"type\": \"fixed\"\n }\n },\n \"custom_attribute\": [\n {\n \"key\": \"Energy Efficiency\",\n \"value\": \"5 Star\"\n },\n {\n \"key\": \"Cooling Power\",\n \"value\": \"1.5 Ton\"\n }\n ],\n \"is_barcode_adjusted\": true,\n \"product_url\": \"https://example.com/ac\"\n },\n {\n \"name\": \"Smartphone\",\n \"description\": \"High-performance smartphone with advanced features.\",\n \"sku_id\": \"mobile_sku789\",\n \"sku_code\": \"SKU-MOB-789\",\n \"attributes\": [\n {\n \"name\": \"Storage Capacity\",\n \"sku_attribute_variation\": {\n \"name\": \"Variation 3\"\n }\n }\n ],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"pcs\",\n \"sku_images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1585060544812-6b45742d762f?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8OHx8bW9iaWxlfGVufDB8fDB8fHww&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1585060544812-6b45742d762f?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8OHx8bW9iaWxlfGVufDB8fDB8fHww&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"https://example.com/images/mobile/medium.jpg\",\n \"large\": \"https://example.com/images/mobile/large.jpg\",\n \"url\": \"https://example.com/images/mobile/image.jpg\",\n \"type\": \"image\",\n \"description\": \"Smartphone image\"\n }\n ],\n \"categories\": [\n {\n \"name\": \"Electronics\"\n },\n {\n \"name\": \"Mobile Phones\"\n }\n ],\n \"manufacturer_name\": \"MobileTech\",\n \"brand_name\": \"BrandZ\",\n \"country_of_origin\": \"CountryZ\",\n \"is_weighted\": false,\n \"dimensions\": {\n \"length\": {\n \"length\": 15,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 7,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0.8,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"7654321098765\",\n \"2109876543210\"\n ],\n \"cost\": 200,\n \"retail_price\": 499,\n \"selling_price\": 399,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.2 kg\",\n \"max\": \"0.3 kg\",\n \"type\": \"fixed\"\n }\n },\n \"custom_attribute\": [\n {\n \"key\": \"RAM\",\n \"value\": \"8 GB\"\n },\n {\n \"key\": \"Storage\",\n \"value\": \"128 GB\"\n }\n ],\n \"is_barcode_adjusted\": true,\n \"product_url\": \"https://example.com/smartphone\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.staging.omniful.com/sales-channel/public/v1/skus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Aug 2023 06:34:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f0c88a86e933f78-BOM"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Products created successfully.\"\n },\n \"meta\": null\n}"}],"_postman_id":"291e3acf-b196-4793-8385-70a406fb270f"},{"name":"Get SKUs","event":[{"listen":"test","script":{"id":"b080f796-bcad-4193-ac3f-3fb69302ef44","exec":["pm.test(\"Response status code is 200\", function () {"," pm.expect(pm.response.code).to.equal(200);","});","","","pm.test(\"Validate is_success field is true\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.is_success).to.be.true;","});","","","pm.test(\"Validate the status_code field is 0\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.status_code).to.equal(0);","});","","","pm.test(\"Data field is an array with at least one element\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.be.an('array').that.is.not.empty;","});","","","pm.test(\"Validate 'id' field is a non-empty string\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.be.an('array');"," pm.expect(responseData.data.length).to.be.above(0, \"Array should not be empty\");"," "," responseData.data.forEach(function (item) {"," pm.expect(item.id).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Value should not be empty\");"," });","});"],"type":"text/javascript","packages":{}}}],"id":"c4e0ce0f-c7f7-47d5-a32f-de295515bdaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/skus?per_page=1&page=1&sku_codes=SKU-MOB-789","description":"

📌 Overview

The Get SKU API allows users to retrieve details of an SKUs by searching with its SKU code. This API provides complete SKU information.

It fetches SKU details from the sales channel catalog only (Sales Channel Listing),

Pagination ( Default 20, Max 100 on a page)

\n","type":"text/plain"},"key":"per_page","value":"1"},{"description":{"content":"

Pagination

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

SKU code of the product you want to fetch details for

\n","type":"text/plain"},"key":"sku_codes","value":"SKU-MOB-789"},{"disabled":true,"description":{"content":"

If True, then inventory for the corresponding SKU is fetched

\n","type":"text/plain"},"key":"include_inventory","value":"true"},{"disabled":true,"description":{"content":"

Unique identifer for hub. Hub Code

\n","type":"text/plain"},"key":"hub_code","value":"hub_code_1"}],"variable":[]}},"response":[{"id":"9e3e898d-21e9-4e14-b49f-38cf555562d6","name":"Fetch SKUs With Pagination","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.staging.omniful.com/sales-channel/public/v1/skus?per_page=2&page=2","protocol":"https","host":["api","staging","omniful","com"],"path":["sales-channel","public","v1","skus"],"query":[{"key":"per_page","value":"2"},{"key":"page","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Aug 2023 06:47:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f0c9c21fb8e3f97-BOM"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"sku_id\": \"mobile_sku789\",\n \"name\": \"Smartphone\",\n \"description\": \"High-performance smartphone with advanced features.\",\n \"sku_code\": \"SKU-MOB-789\",\n \"cost\": 200,\n \"retail_price\": 499,\n \"selling_price\": 399,\n \"display_selling_price\": \"399.00 SAR\",\n \"display_retail_price\": \"499.00 SAR\",\n \"category\": [\n {\n \"name\": \"Electronics\"\n },\n {\n \"name\": \"Mobile Phones\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 15,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 7,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0.8,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"7654321098765\",\n \"2109876543210\"\n ],\n \"images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1585060544812-6b45742d762f?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8OHx8bW9iaWxlfGVufDB8fDB8fHww&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1585060544812-6b45742d762f?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8OHx8bW9iaWxlfGVufDB8fDB8fHww&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"https://example.com/images/mobile/medium.jpg\",\n \"large\": \"https://example.com/images/mobile/large.jpg\",\n \"type\": \"image\",\n \"description\": \"Smartphone image\"\n }\n ],\n \"attributes\": [\n {\n \"name\": \"Storage Capacity\",\n \"sku_attribute_variation\": {\n \"name\": \"Variation 3\"\n }\n }\n ],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"\",\n \"is_perishable\": false,\n \"country_of_origin\": \"CountryZ\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.2 kg\",\n \"max\": \"0.3 kg\",\n \"type\": \"fixed\"\n }\n },\n \"custom_attribute\": [\n {\n \"key\": \"RAM\",\n \"value\": \"8 GB\"\n },\n {\n \"key\": \"Storage\",\n \"value\": \"128 GB\"\n }\n ],\n \"created_by\": \"359\",\n \"updated_by\": \"\",\n \"created_at\": \"2023-08-03T06:34:16.152Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n },\n {\n \"sku_id\": \"tv_sku123\",\n \"name\": \"Smart LED TV\",\n \"description\": \"High-quality 4K Smart LED TV with Wi-Fi connectivity.\",\n \"sku_code\": \"SKU-TV-123\",\n \"cost\": 300,\n \"retail_price\": 599,\n \"selling_price\": 499,\n \"display_selling_price\": \"499.00 SAR\",\n \"display_retail_price\": \"599.00 SAR\",\n \"category\": [\n {\n \"name\": \"Electronics\"\n },\n {\n \"name\": \"TV & Video\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 100,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 10,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 60,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"https://example.com/images/tv/medium.jpg\",\n \"large\": \"https://example.com/images/tv/large.jpg\",\n \"type\": \"image\",\n \"description\": \"Smart LED TV image\"\n }\n ],\n \"attributes\": [\n {\n \"name\": \"Screen Size\",\n \"sku_attribute_variation\": {\n \"name\": \"Variation 1\"\n }\n }\n ],\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"\",\n \"is_perishable\": false,\n \"country_of_origin\": \"CountryX\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"10 kg\",\n \"max\": \"15 kg\",\n \"type\": \"fixed\"\n }\n },\n \"custom_attribute\": [\n {\n \"key\": \"Smart TV\",\n \"value\": \"Yes\"\n },\n {\n \"key\": \"Resolution\",\n \"value\": \"4K\"\n }\n ],\n \"created_by\": \"359\",\n \"updated_by\": \"\",\n \"created_at\": \"2023-08-03T06:34:16.152Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n ],\n \"meta\": {\n \"current_page\": 2,\n \"last_page\": 2,\n \"per_page\": 2,\n \"total\": 4\n }\n}"},{"id":"e45b2c70-d0d8-4cc6-982e-928b621929c6","name":"Fetch SKUs When No SKUs are present","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.staging.omniful.com/sales-channel/public/v1/skus","protocol":"https","host":["api","staging","omniful","com"],"path":["sales-channel","public","v1","skus"],"query":[{"key":"per_page","value":"5","disabled":true},{"key":"page","value":"1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Aug 2023 06:26:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f0c7cc8af6b3f78-BOM"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": null,\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 0,\n \"per_page\": 20,\n \"total\": 0\n }\n}"},{"id":"a70e734b-7bd5-4327-8e65-a29966e59e76","name":"Success (with Inventory)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/skus?include_inventory=true&hub_code=193","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","skus"],"query":[{"key":"include_inventory","value":"true","description":"If True, then inventory for the corresponding SKU is fetched"},{"key":"hub_code","value":"hub_code_1","description":"Unique identifer for hub. Hub Code","type":"text","disabled":true},{"key":"hub_code","value":"193"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 09 Sep 2025 12:03:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"da13d0e2-f11c-4837-83a3-ef6d18371599"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"97c68a9f5958919e-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"sku_code\": \"abcde\",\n \"name\": \"Smart LED TV\",\n \"description\": \"High-quality 4K Smart LED TV with Wi-Fi connectivity.\",\n \"cost\": 300,\n \"retail_price\": 599,\n \"selling_price\": 499,\n \"display_selling_price\": \"499.00 SAR\",\n \"display_retail_price\": \"599.00 SAR\",\n \"category\": null,\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 100,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 10,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 60,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"abcde\"\n ],\n \"images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"https://example.com/images/tv/medium.jpg\",\n \"large\": \"https://example.com/images/tv/large.jpg\",\n \"type\": \"image\",\n \"description\": \"Smart LED TV image\"\n }\n ],\n \"attributes\": [\n {\n \"name\": \"Screen Size\",\n \"sku_attribute_variation\": {\n \"name\": \"Variation 1\"\n }\n }\n ],\n \"sales_channel_custom_attributes\": null,\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Country\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"10 kg\",\n \"max\": \"15 kg\",\n \"type\": \"fixed\"\n }\n },\n \"custom_attribute\": [\n {\n \"key\": \"Smart TV\",\n \"value\": \"Yes\"\n },\n {\n \"key\": \"Resolution\",\n \"value\": \"4K\"\n }\n ],\n \"created_by\": \"5502\",\n \"updated_by\": \"5502\",\n \"created_at\": \"2025-09-09T10:41:15.074Z\",\n \"updated_at\": \"2025-09-09T10:41:15.073Z\",\n \"tax_inclusive\": {\n \"selling_price\": true\n },\n \"tax_percentage\": {\n \"selling_price\": 20\n },\n \"weighted_average_costs\": null,\n \"metadata\": {\n \"assembled_part_count\": 0\n },\n \"hub_inventory\": [\n {\n \"hub_code\": \"193\",\n \"sku_code\": \"abcde\",\n \"available_quantity\": 0,\n \"sku_name\": \"\",\n \"quantity_on_hand\": 0,\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"\",\n \"updated_at\": \"\"\n }\n ]\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"}],"_postman_id":"c4e0ce0f-c7f7-47d5-a32f-de295515bdaf"},{"name":"Get SKU By SKU Code","event":[{"listen":"test","script":{"id":"3d1afc11-0de1-4f61-b89a-7b15334898a4","exec":["pm.test(\"Response status code is 200\", function () {"," pm.expect(pm.response.code).to.equal(200);","});","","","pm.test(\"Validate the 'is_success' field is true\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.is_success).to.be.true;","});","","","pm.test(\"The 'data' array is present in the response and contains the expected number of elements\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.exist.and.to.be.an('array');"," pm.expect(responseData.data).to.have.lengthOf(1);","});","","","pm.test(\"Name field is a non-empty string\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.data).to.be.an('array').and.not.empty;"," "," responseData.data.forEach(function (sku) {"," pm.expect(sku.name).to.be.a('string').and.not.empty;"," });","});"],"type":"text/javascript","packages":{}}}],"id":"f85e1b38-662c-4d56-a2e7-30944d758b33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/skus/:sku_code","description":"

📌 Overview

The Get SKU by SKU Code API retrieves details of a single SKU from the seller's Sales Channel Listing Catalog using the SKU code.

If True, then inventory for the corresponding SKU is fetched

\n","type":"text/plain"},"key":"include_inventory","value":"true"},{"disabled":true,"description":{"content":"

Unique identifer for hub. Hub Code

\n","type":"text/plain"},"key":"hub_code","value":"hub_code_1"}],"variable":[{"description":{"content":"

SKU code of the product you want to fetch details for from the seller sales channel catalog listing.

\n","type":"text/plain"},"type":"any","value":"SKU-AC-456","key":"sku_code"}]}},"response":[{"id":"7f689044-18be-46d7-9bfa-d55a2abd42ca","name":"Fetch SKU By SKU Code","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.staging.omniful.com/sales-channel/public/v1/skus/:sku_code","protocol":"https","host":["api","staging","omniful","com"],"path":["sales-channel","public","v1","skus",":sku_code"],"variable":[{"key":"sku_code","value":"SKU-AC-456"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Oct 2023 12:39:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"e54c7747-d6b2-4ca9-8efd-8dd097a5bc7b"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81472ae69870a901-MAA"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"sku_code\": \"SKU-AC-456\",\n \"name\": \"Split Air Conditioner\",\n \"description\": \"Energy-efficient split air conditioner with cooling capacity.\",\n \"cost\": 500,\n \"retail_price\": 799,\n \"selling_price\": 699,\n \"display_selling_price\": \"699.00 SAR\",\n \"display_retail_price\": \"799.00 SAR\",\n \"category\": [\n {\n \"name\": \"Electronics\"\n },\n {\n \"name\": \"TV & Video\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 90,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 15,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 30,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"8765432109876\",\n \"0123456789012\"\n ],\n \"images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1590756254933-2873d72a83b6?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8Mnx8YWlyJTIwY29uZGl0aW9uZXJ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1590756254933-2873d72a83b6?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8Mnx8YWlyJTIwY29uZGl0aW9uZXJ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"https://example.com/images/ac/medium.jpg\",\n \"large\": \"https://example.com/images/ac/large.jpg\",\n \"type\": \"image\",\n \"description\": \"Split Air Conditioner image\"\n }\n ],\n \"attributes\": [\n {\n \"name\": \"Cooling Capacity\",\n \"sku_attribute_variation\": {\n \"name\": \"Variation 2\"\n }\n }\n ],\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"\",\n \"is_perishable\": false,\n \"country_of_origin\": \"CountryY\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"20 kg\",\n \"max\": \"25 kg\",\n \"type\": \"fixed\"\n }\n },\n \"custom_attribute\": [\n {\n \"key\": \"Energy Efficiency\",\n \"value\": \"5 Star\"\n },\n {\n \"key\": \"Cooling Power\",\n \"value\": \"1.5 Ton\"\n }\n ],\n \"created_by\": \"495\",\n \"updated_by\": \"\",\n \"created_at\": \"2023-10-04T12:52:42.15Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n },\n \"meta\": null\n}"},{"id":"9f669bd8-e2f0-4a74-8c1f-126b27e06711","name":"Fetch SKU Result when you enter invalid SKU","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.staging.omniful.com/sales-channel/public/v1/skus/:sku_code","protocol":"https","host":["api","staging","omniful","com"],"path":["sales-channel","public","v1","skus",":sku_code"],"variable":[{"key":"sku_code","value":"SKU-MOB-782"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Aug 2023 06:49:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f0c9e7a0a7f3f97-BOM"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": null,\n \"meta\": null\n}"},{"id":"455c75a8-10e6-4790-8cc2-0793e73d2aa8","name":"Success (with Inventory)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/skus/abcde?include_inventory=true&hub_code=193","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","skus","abcde"],"query":[{"key":"include_inventory","value":"true","description":"If True, then inventory for the corresponding SKU is fetched"},{"key":"hub_code","value":"193","description":"Unique identifer for hub. Hub Code"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 09 Sep 2025 12:05:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"2826c9be-b6cd-4df3-b2ac-46a0d934bf27"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"97c68ddfe8428019-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"sku_code\": \"abcde\",\n \"name\": \"Smart LED TV\",\n \"description\": \"High-quality 4K Smart LED TV with Wi-Fi connectivity.\",\n \"cost\": 300,\n \"retail_price\": 599,\n \"selling_price\": 499,\n \"display_selling_price\": \"499.00 SAR\",\n \"display_retail_price\": \"599.00 SAR\",\n \"category\": null,\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 100,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 10,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 60,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"abcde\"\n ],\n \"images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"https://example.com/images/tv/medium.jpg\",\n \"large\": \"https://example.com/images/tv/large.jpg\",\n \"type\": \"image\",\n \"description\": \"Smart LED TV image\"\n }\n ],\n \"attributes\": [\n {\n \"name\": \"Screen Size\",\n \"sku_attribute_variation\": {\n \"name\": \"Variation 1\"\n }\n }\n ],\n \"sales_channel_custom_attributes\": null,\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Country\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"10 kg\",\n \"max\": \"15 kg\",\n \"type\": \"fixed\"\n }\n },\n \"custom_attribute\": [\n {\n \"key\": \"Smart TV\",\n \"value\": \"Yes\"\n },\n {\n \"key\": \"Resolution\",\n \"value\": \"4K\"\n }\n ],\n \"created_by\": \"5502\",\n \"updated_by\": \"5502\",\n \"created_at\": \"2025-09-09T10:41:15.074Z\",\n \"updated_at\": \"2025-09-09T10:41:15.073Z\",\n \"tax_inclusive\": {\n \"selling_price\": true\n },\n \"tax_percentage\": {\n \"selling_price\": 20\n },\n \"weighted_average_costs\": null,\n \"metadata\": {\n \"assembled_part_count\": 0\n },\n \"hub_inventory\": [\n {\n \"hub_code\": \"193\",\n \"sku_code\": \"abcde\",\n \"available_quantity\": 0,\n \"sku_name\": \"\",\n \"quantity_on_hand\": 0,\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"\",\n \"updated_at\": \"\"\n }\n ]\n },\n \"meta\": null\n}"}],"_postman_id":"f85e1b38-662c-4d56-a2e7-30944d758b33"},{"name":"Update SKUs","id":"d1f11581-7769-460a-9796-fa724ae48154","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\n {\n \"sku_id\": \"sku_tv_12345\",\n \"name\": \"Smart LED TV\",\n \"description\": \"High-quality 4K Smart LED TV with Wi-Fi connectivity.\",\n \"sku_code\": \"SKU-TV-12345\",\n \"cost\": 441,\n \"retail_price\": 599,\n \"selling_price\": 551,\n \"display_selling_price\": \"499.00 SAR\",\n \"display_retail_price\": \"599.00 SAR\",\n \"category\": [\n {\n \"name\": \"Electronics\"\n },\n {\n \"name\": \"TV & Video\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 100,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 10,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 60,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1593305841991-05c297ba4575?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8M3x8dHZ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"https://example.com/images/tv/medium.jpg\",\n \"large\": \"https://example.com/images/tv/large.jpg\",\n \"type\": \"image\",\n \"description\": \"Smart LED TV image\"\n }\n ],\n \"attributes\": [\n {\n \"name\": \"Screen Size\",\n \"sku_attribute_variation\": {\n \"name\": \"Variation 1\"\n }\n }\n ],\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"\",\n \"is_perishable\": false,\n \"country_of_origin\": \"CountryX\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"10 kg\",\n \"max\": \"15 kg\",\n \"type\": \"fixed\"\n }\n },\n \"custom_attribute\": [\n {\n \"key\": \"Smart TV\",\n \"value\": \"Yes\"\n },\n {\n \"key\": \"Resolution\",\n \"value\": \"4K\"\n }\n ],\n \"created_by\": \"359\",\n \"updated_by\": \"\",\n \"created_at\": \"2023-08-03T06:35:40.136Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/skus","description":"

📌 Overview

The Update SKU API allows users to modify the details of an existing SKU within the Sales Channel Listing for a seller.

📌 Key Information:

SKU Code and SKU ID cannot be updated. Attempting to change them will result in creating a new SKU instead.
\n
This API is useful for updating pricing, product attributes, and other SKU-related details.
\n

It ensures that the SKU information in the sales channel remains accurate and up to date.

Here's the documentation for the JSON request body of the update SKUs API:

Update SKUs API Request Body

Field	Data Type	Description	Required
`sku_id`	`string`	The unique identifier of the SKU to be updated	✅ Yes
`name`	`string`	The updated name of the product	❌ No
`description`	`string`	The updated detailed description of the product	❌ No
`sku_code`	`string`	The updated unique code identifying the SKU	✅ Yes
`cost`	`number`	The updated cost of purchasing the product	❌ No
`retail_price`	`number`	The updated Manufacturer's Retail Price (MRP)	❌ No
`selling_price`	`number`	The updated price at which the product is being sold	❌ No
hs_code	`string`	Harmonized System (HS) Code	❌ No
`display_selling_price`	`string`	The formatted display string for the selling price	❌ No
`display_retail_price`	`string`	The formatted display string for the retail price	❌ No
`category`	`array`	An array of updated category objects	❌ No
`category[].name`	`string`	The name of the category	❌ No
`product`	`object`	An object representing the associated product details	❌ No
`product.name`	`string`	The name of the associated product	❌ No
`product.handling_type`	`string`	The handling type of the associated product	❌ No
`product.unit`	`string`	The unit of the associated product	❌ No
`product.type`	`string`	The type of the associated product	❌ No
`product.description`	`string`	The description of the associated product	❌ No
`dimensions`	`object`	An object representing the updated physical dimensions	❌ No
`dimensions.length`	`object`	The updated length of the SKU	❌ No
`dimensions.length.length`	`number`	The updated length value	❌ No
`dimensions.length.unit`	`string`	The updated unit of measurement for length	❌ No
`dimensions.breadth`	`object`	The updated breadth of the SKU	❌ No
`dimensions.breadth.breadth`	`number`	The updated breadth value	❌ No
`dimensions.breadth.unit`	`string`	The updated unit of measurement for breadth	❌ No
`dimensions.height`	`object`	The updated height of the SKU	❌ No
`dimensions.height.height`	`number`	The updated height value	❌ No
`dimensions.height.unit`	`string`	The updated unit of measurement for height	❌ No
`barcodes`	`array`	An array of updated barcode strings	❌ No
`images`	`array`	An array of updated image objects	❌ No
`images[].default`	`string`	The updated default image URL	❌ No
`images[].thumbnail`	`string`	The updated thumbnail image URL	❌ No
`images[].medium`	`string`	The updated medium-sized image URL	❌ No
`images[].large`	`string`	The updated large-sized image URL	❌ No
`images[].type`	`string`	The updated type of the image	❌ No
`images[].description`	`string`	The updated description of the image	❌ No
`attributes`	`array`	An array of updated attribute objects	❌ No
`attributes[].name`	`string`	The updated name of the attribute	❌ No
`attributes[].sku_attribute_variation.name`	`string`	The updated attribute variation name	❌ No
`handling_type`	`string`	The updated handling type for the SKU	✅ Yes
`type`	`string`	The updated type of the SKU	✅ Yes
`status`	`string`	The updated status of the product	✅ Yes
`unit`	`string`	The updated measuring unit for the SKU	❌ No
`is_perishable`	`boolean`	Indicates whether the SKU is perishable	❌ No
`country_of_origin`	`string`	The updated originating country of the product	❌ No
`is_weighted`	`boolean`	Indicates whether the SKU has weight considerations	❌ No
`configuration`	`object`	An object with updated SKU configurations	❌ No
`configuration.weight`	`object`	An object indicating the updated weight range	❌ No
`configuration.weight.min`	`string`	The updated minimum weight	❌ No
`configuration.weight.max`	`string`	The updated maximum weight	❌ No
`configuration.weight.type`	`string`	The updated type of weight configuration	❌ No
`custom_attribute`	`array`	An array of updated custom attribute objects	❌ No
`custom_attribute[].key`	`string`	The updated key of the custom attribute	❌ No
`custom_attribute[].value`	`string`	The updated value of the custom attribute	❌ No
`created_by`	`string`	The identifier of the user who created the SKU	❌ No
`updated_by`	`string`	The identifier of the user who last updated the SKU	❌ No
`created_at`	`string`	The timestamp indicating when the SKU was created	❌ No
`updated_at`	`string`	The timestamp indicating when the SKU was last updated	❌ No

📌 Overview

The Get Master Catalog SKUs API retrieves all SKU details available in the Master Catalog (Seller Catalog).

If true, inventory details will be fetched for corresponding hub

\n","type":"text/plain"},"key":"include_inventory","value":"true"},{"disabled":true,"description":{"content":"

Code for the hub whose inventory details are to be fetched

\n","type":"text/plain"},"key":"hub_code","value":"2134"}],"variable":[]}},"response":[{"id":"190fabb6-6894-4d21-9e86-a5d7391767ec","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://api.staging.omniful.com/sales-channel/public/v1/master/skus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 07:18:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Omniful-Request-Id","value":"03cf19de-885a-4d14-acf9-e899d1042035"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7fdac7866afc3989-MAA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"sku_code\": \"BabbuMaanTestSK5U\",\n \"name\": \"GeeksmantestProduct | Alpha2 | babbu MaanA1\",\n \"description\": \"\",\n \"cost\": 0,\n \"retail_price\": 0,\n \"selling_price\": 0,\n \"display_selling_price\": \"\",\n \"display_retail_price\": \"\",\n \"category\": null,\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"\"\n }\n },\n \"barcodes\": [\n \"TestBarcode\"\n ],\n \"images\": [],\n \"attributes\": [],\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"\",\n \"is_perishable\": false,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-07-19T09:25:32.46Z\",\n \"updated_at\": \"2023-07-19T09:25:32.46Z\"\n },\n {\n \"sku_code\": \"SKU-AC-456\",\n \"name\": \"Split Air Conditioner\",\n \"description\": \"Energy-efficient split air conditioner with cooling capacity.\",\n \"cost\": 899,\n \"retail_price\": 1299,\n \"selling_price\": 1099,\n \"display_selling_price\": \"1099.00 SAR\",\n \"display_retail_price\": \"1299.00 SAR\",\n \"category\": [\n {\n \"name\": \"Electronics\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 15,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 7,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0.9,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"8765432109876\"\n ],\n \"images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1590756254933-2873d72a83b6?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8Mnx8YWlyJTIwY29uZGl0aW9uZXJ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1590756254933-2873d72a83b6?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8Mnx8YWlyJTIwY29uZGl0aW9uZXJ8ZW58MHx8MHx8fDA%3D&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"url/to/phone1_medium.jpg\",\n \"large\": \"url/to/phone1_large.jpg\",\n \"type\": \"\",\n \"description\": \"High-quality mobile\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": true,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.1\",\n \"max\": \"0.3\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-07-28T08:28:47.143Z\",\n \"updated_at\": \"2023-07-28T08:28:47.143Z\"\n },\n {\n \"sku_code\": \"SKU-EARPHONES-789\",\n \"name\": \"Wireless Earphones\",\n \"description\": \"Product 3 Description\",\n \"cost\": 299,\n \"retail_price\": 399,\n \"selling_price\": 349,\n \"display_selling_price\": \"349.00 SAR\",\n \"display_retail_price\": \"399.00 SAR\",\n \"category\": [\n {\n \"name\": \"Home & Kitchen\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 25,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 20,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 30,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"barcode-earphones789\"\n ],\n \"images\": [\n {\n \"default\": \"https://m.media-amazon.com/images/I/61KNJav3S9L._AC_UY436_FMwebp_QL65_.jpg\",\n \"thumbnail\": \"https://m.media-amazon.com/images/I/61KNJav3S9L._AC_UY436_FMwebp_QL65_.jpg\",\n \"medium\": \"url/to/coffeemaker1_medium.jpg\",\n \"large\": \"url/to/coffeemaker1_large.jpg\",\n \"type\": \"\",\n \"description\": \"Home\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": true,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": true,\n \"configuration\": {\n \"weight\": {\n \"min\": \"2\",\n \"max\": \"5\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-08-01T14:38:05.59Z\",\n \"updated_at\": \"2023-08-01T14:38:05.59Z\"\n },\n {\n \"sku_code\": \"SKU-MOB-789\",\n \"name\": \"Smartphone\",\n \"description\": \"High-performance smartphone with advanced features.\",\n \"cost\": 29.99,\n \"retail_price\": 39.99,\n \"selling_price\": 34.99,\n \"display_selling_price\": \"34.99 SAR\",\n \"display_retail_price\": \"39.99 SAR\",\n \"category\": [\n {\n \"name\": \"Apparel\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 50,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 30,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 1,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"7654321098765\"\n ],\n \"images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1585060544812-6b45742d762f?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8OHx8bW9iaWxlfGVufDB8fDB8fHww&auto=format&fit=crop&w=800&q=60\",\n \"thumbnail\": \"https://images.unsplash.com/photo-1585060544812-6b45742d762f?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8OHx8bW9iaWxlfGVufDB8fDB8fHww&auto=format&fit=crop&w=800&q=60\",\n \"medium\": \"url/to/tshirt1_medium.jpg\",\n \"large\": \"url/to/tshirt1_large.jpg\",\n \"type\": \"\",\n \"description\": \"Local clothing\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.2\",\n \"max\": \"0.6\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-07-28T08:28:47.143Z\",\n \"updated_at\": \"2023-07-28T08:28:47.143Z\"\n },\n {\n \"sku_code\": \"SKU-SHOE-123\",\n \"name\": \"Running Shoes\",\n \"description\": \"Product 1 Description\",\n \"cost\": 899,\n \"retail_price\": 1299,\n \"selling_price\": 1099,\n \"display_selling_price\": \"1099.00 SAR\",\n \"display_retail_price\": \"1299.00 SAR\",\n \"category\": [\n {\n \"name\": \"Electronics\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 15,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 7,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0.9,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"barcode-shoe123\"\n ],\n \"images\": [\n {\n \"default\": \"https://m.media-amazon.com/images/G/31/img21/shoes/2023/SS23/Kids/SBCs/Sportsw._CB603477575_.png\",\n \"thumbnail\": \"https://m.media-amazon.com/images/G/31/img21/shoes/2023/SS23/Kids/SBCs/Sportsw._CB603477575_.png\",\n \"medium\": \"url/to/phone1_medium.jpg\",\n \"large\": \"url/to/phone1_large.jpg\",\n \"type\": \"\",\n \"description\": \"High-quality mobile\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": true,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.1\",\n \"max\": \"0.3\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-08-01T14:38:05.59Z\",\n \"updated_at\": \"2023-08-01T14:38:05.589Z\"\n },\n {\n \"sku_code\": \"SKU-TABLET-456\",\n \"name\": \"Tablet\",\n \"description\": \"Product 2 Description\",\n \"cost\": 29.99,\n \"retail_price\": 39.99,\n \"selling_price\": 34.99,\n \"display_selling_price\": \"34.99 SAR\",\n \"display_retail_price\": \"39.99 SAR\",\n \"category\": [\n {\n \"name\": \"Apparel\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 50,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 30,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 1,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"barcode-tablet456\"\n ],\n \"images\": [\n {\n \"default\": \"https://m.media-amazon.com/images/I/511mMK0LW2L._AC_UY436_FMwebp_QL65_.jpg\",\n \"thumbnail\": \"https://m.media-amazon.com/images/I/511mMK0LW2L._AC_UY436_FMwebp_QL65_.jpg\",\n \"medium\": \"url/to/tshirt1_medium.jpg\",\n \"large\": \"url/to/tshirt1_large.jpg\",\n \"type\": \"\",\n \"description\": \"Local clothing\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.2\",\n \"max\": \"0.6\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-08-01T14:38:05.59Z\",\n \"updated_at\": \"2023-08-01T14:38:05.59Z\"\n },\n {\n \"sku_code\": \"SKU123\",\n \"name\": \"Apple I Phone\",\n \"description\": \"Apple I Phone 14 pro max\",\n \"cost\": 299,\n \"retail_price\": 399,\n \"selling_price\": 349,\n \"display_selling_price\": \"349.00 SAR\",\n \"display_retail_price\": \"399.00 SAR\",\n \"category\": [\n {\n \"name\": \"Home & Kitchen\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 25,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 20,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 30,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"barcode123\"\n ],\n \"images\": [\n {\n \"default\": \"https://imagineonline.store/cdn/shop/products/MPVN3HN_A_1.jpg?v=1662718728\",\n \"thumbnail\": \"https://imagineonline.store/cdn/shop/products/MPVN3HN_A_1.jpg?v=1662718728\",\n \"medium\": \"url/to/coffeemaker1_medium.jpg\",\n \"large\": \"url/to/coffeemaker1_large.jpg\",\n \"type\": \"\",\n \"description\": \"Home\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": true,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": true,\n \"configuration\": {\n \"weight\": {\n \"min\": \"2\",\n \"max\": \"5\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-07-28T08:28:47.143Z\",\n \"updated_at\": \"2023-07-28T08:28:47.143Z\"\n },\n {\n \"sku_code\": \"dress -11\",\n \"name\": \"testProduct03 | بيج | 36 - XS\",\n \"description\": \"عطر اترنيتي او دو تواليت للرجال من كلفن كلاين 100مل\",\n \"cost\": 29.99,\n \"retail_price\": 39.99,\n \"selling_price\": 34.99,\n \"display_selling_price\": \"34.99 SAR\",\n \"display_retail_price\": \"39.99 SAR\",\n \"category\": [\n {\n \"name\": \"Apparel\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 50,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 30,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 1,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"dress -11\"\n ],\n \"images\": [\n {\n \"default\": \"\",\n \"thumbnail\": \"url/to/tshirt1_thumb.jpg\",\n \"medium\": \"url/to/tshirt1_medium.jpg\",\n \"large\": \"url/to/tshirt1_large.jpg\",\n \"type\": \"\",\n \"description\": \"Local clothing\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.2\",\n \"max\": \"0.6\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-07-21T06:15:05.166Z\",\n \"updated_at\": \"2023-07-21T06:15:05.166Z\"\n },\n {\n \"sku_code\": \"dress-10\",\n \"name\": \"testProduct03 | بيج | 38 - S\",\n \"description\": \"عطر 212 في اي بي ار يو اون ذا لست ان واي سي للرجال من كارولينا هيريرا 100مل\",\n \"cost\": 899,\n \"retail_price\": 1299,\n \"selling_price\": 1099,\n \"display_selling_price\": \"1099.00 SAR\",\n \"display_retail_price\": \"1299.00 SAR\",\n \"category\": [\n {\n \"name\": \"Electronics\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 15,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 7,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0.9,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"dress-10\"\n ],\n \"images\": [\n {\n \"default\": \"\",\n \"thumbnail\": \"url/to/phone1_thumb.jpg\",\n \"medium\": \"url/to/phone1_medium.jpg\",\n \"large\": \"url/to/phone1_large.jpg\",\n \"type\": \"\",\n \"description\": \"High-quality mobile\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": true,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.1\",\n \"max\": \"0.3\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-07-21T06:15:05.166Z\",\n \"updated_at\": \"2023-07-21T06:15:05.166Z\"\n },\n {\n \"sku_code\": \"product_dynamic_1\",\n \"name\": \"Simple Product 1\",\n \"description\": \"عطر 212 في اي بي ار يو اون ذا لست ان واي سي للرجال من كارولينا هيريرا 100مل\",\n \"cost\": 899,\n \"retail_price\": 1299,\n \"selling_price\": 1099,\n \"display_selling_price\": \"1099.00 SAR\",\n \"display_retail_price\": \"1299.00 SAR\",\n \"category\": [\n {\n \"name\": \"Electronics\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 15,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 7,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0.9,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"barcode_product_dynamic_1\"\n ],\n \"images\": [\n {\n \"default\": \"https://magentodev.omniful.store/media/catalog/product/6/4/642e92efb79421734881b53e1e1b18b6.jpg\",\n \"thumbnail\": \"url/to/phone1_thumb.jpg\",\n \"medium\": \"url/to/phone1_medium.jpg\",\n \"large\": \"url/to/phone1_large.jpg\",\n \"type\": \"\",\n \"description\": \"High-quality mobile\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": true,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.1\",\n \"max\": \"0.3\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-08-04T02:41:53.646Z\",\n \"updated_at\": \"2023-08-04T02:41:53.646Z\"\n },\n {\n \"sku_code\": \"product_dynamic_10\",\n \"name\": \"Simple Product 10\",\n \"description\": \"عطر اترنيتي او دو تواليت للرجال من كلفن كلاين 100مل\",\n \"cost\": 29.99,\n \"retail_price\": 39.99,\n \"selling_price\": 34.99,\n \"display_selling_price\": \"34.99 SAR\",\n \"display_retail_price\": \"39.99 SAR\",\n \"category\": [\n {\n \"name\": \"Apparel\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 50,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 30,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 1,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"barcode_product_dynamic_10\"\n ],\n \"images\": [\n {\n \"default\": \"https://magentodev.omniful.store/media/catalog/product/f/4/f457c545a9ded88f18ecee47145a72c0.jpg\",\n \"thumbnail\": \"url/to/tshirt1_thumb.jpg\",\n \"medium\": \"url/to/tshirt1_medium.jpg\",\n \"large\": \"url/to/tshirt1_large.jpg\",\n \"type\": \"\",\n \"description\": \"Local clothing\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"cold\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.2\",\n \"max\": \"0.6\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-08-04T02:41:53.646Z\",\n \"updated_at\": \"2023-08-04T02:41:53.646Z\"\n },\n {\n \"sku_code\": \"product_dynamic_100\",\n \"name\": \"Simple Product 100\",\n \"description\": \"عطر اترنيتي مومنت او دي برفيوم للنساء من كالفن كلاين 100مل\",\n \"cost\": 299,\n \"retail_price\": 399,\n \"selling_price\": 349,\n \"display_selling_price\": \"349.00 SAR\",\n \"display_retail_price\": \"399.00 SAR\",\n \"category\": [\n {\n \"name\": \"Home & Kitchen\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 25,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 20,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 30,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"barcode_product_dynamic_100\"\n ],\n \"images\": [\n {\n \"default\": \"https://magentodev.omniful.store/media/catalog/product/c/0/c0c7c76d30bd3dcaefc96f40275bdc0a.jpg\",\n \"thumbnail\": \"url/to/coffeemaker1_thumb.jpg\",\n \"medium\": \"url/to/coffeemaker1_medium.jpg\",\n \"large\": \"url/to/coffeemaker1_large.jpg\",\n \"type\": \"\",\n \"description\": \"Home\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": true,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": true,\n \"configuration\": {\n \"weight\": {\n \"min\": \"2\",\n \"max\": \"5\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-08-04T02:41:53.646Z\",\n \"updated_at\": \"2023-08-04T02:41:53.646Z\"\n },\n {\n \"sku_code\": \"sku-1001\",\n \"name\": \"product 1\",\n \"description\": \"\",\n \"cost\": 899,\n \"retail_price\": 1299,\n \"selling_price\": 1099,\n \"display_selling_price\": \"1099.00 SAR\",\n \"display_retail_price\": \"1299.00 SAR\",\n \"category\": [\n {\n \"name\": \"Electronics\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 15,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 7,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0.9,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"sku-1001\"\n ],\n \"images\": [\n {\n \"default\": \"\",\n \"thumbnail\": \"url/to/phone1_thumb.jpg\",\n \"medium\": \"url/to/phone1_medium.jpg\",\n \"large\": \"url/to/phone1_large.jpg\",\n \"type\": \"\",\n \"description\": \"High-quality mobile\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": true,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.1\",\n \"max\": \"0.3\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-07-18T15:31:44.701Z\",\n \"updated_at\": \"2023-07-18T15:31:44.7Z\"\n },\n {\n \"sku_code\": \"triloktestsku1024\",\n \"name\": \"GeeksmantestProduct | Beta | Alpha3\",\n \"description\": \"\",\n \"cost\": 899,\n \"retail_price\": 1299,\n \"selling_price\": 1099,\n \"display_selling_price\": \"1099.00 SAR\",\n \"display_retail_price\": \"1299.00 SAR\",\n \"category\": [\n {\n \"name\": \"Electronics\"\n }\n ],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 15,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 7,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0.9,\n \"unit\": \"cm\"\n }\n },\n \"barcodes\": [\n \"triloktestbarcode004\"\n ],\n \"images\": [\n {\n \"default\": \"\",\n \"thumbnail\": \"url/to/phone1_thumb.jpg\",\n \"medium\": \"url/to/phone1_medium.jpg\",\n \"large\": \"url/to/phone1_large.jpg\",\n \"type\": \"\",\n \"description\": \"High-quality mobile\"\n }\n ],\n \"attributes\": [],\n \"handling_type\": \"hot\",\n \"type\": \"simple\",\n \"status\": \"live\",\n \"unit\": \"kg\",\n \"is_perishable\": false,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": true,\n \"configuration\": {\n \"weight\": {\n \"min\": \"0.1\",\n \"max\": \"0.3\",\n \"type\": \"kg\"\n }\n },\n \"custom_attribute\": null,\n \"created_by\": \"381\",\n \"updated_by\": \"381\",\n \"created_at\": \"2023-07-19T09:25:32.46Z\",\n \"updated_at\": \"2023-07-19T09:25:32.46Z\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 14\n }\n}"},{"id":"a619c002-3405-4a4f-a4d8-01eda8304888","name":"Example (Inventory)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTkxMjU4NjYsImp0aSI6ImRlZTBiNDNiLTA3ZGQtNDRhNi1iYzU5LWRkMDdjNWI1MDI1NyIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6OTAyLCJTZWxsZXJJRCI6IjI1NSIsIlRlbmFudElEIjoiMyIsIlVzZXJJRCI6IjQ1MDgiLCJVc2VyTmFtZSI6IkRocnV2IEJoYXR0IiwiUmF0ZUxpbWl0RGV0YWlscyI6eyJFbmFibGVkIjp0cnVlLCJSZXF1ZXN0c1Blck1pbnV0ZSI6NjB9fSwidG9rZW5fdHlwZSI6IkJlYXJlciJ9.qxe_Kr9xfPvs848AQaWGMX_BY8heDny2xrCqA5zlb-7Q2yznNHgt25AqsTkCHpMQSc_AAGTRH2YBps0LDoM1W3zT_gOrcrUI4HTqeqleFXN0W1x0hQVnAoqlp6B7U63FedvG55CPVGYn6tfDzTldsMu0CjsHyQBqkZGwUDGKM55l32t8qhUwnjfXT4NyKhuH8cFdnlU2DiBx55eb41Wuf0yi5tdGzwUhLUqQFEqnWaUqRmlInKoO09GMKNjoJNy_uPP3RvEn6kBPegm91ctpJgq5WxHqtx7Q9O1B8DRSAfjoMDjs3rO8rLTSdgxTSjuSBmq3Rj-5XMRlwyP5j9dJvL04OjK2pccaPUSm7LpROMg964MJbCXE-KjyLwQx1XsIAbV1A4PjhTDmfIbVFFfckMFJwCin7BDH94rSaNAZlSINyUJ1y4Mbw9xUrnh16myZO_PfnDWqWaYtLkwSWD5xJdgOsSPXvY827pWoSyIIpv9_WutAZEPGz5OLYPkTmng_JGhxnUAGiHENiqeWzxP698coBC8aLEEsQ_unx0h74ZTMrqRZ-NouHeGcVv8lsKoQ8Z3I5_OnZafe0TM8QKxNGTFmrSANJxsx8IiDQd9Ttt5ViSB3ISfDA-QagJ5DNx08y27XRzduOLojBULKT-zbOjV2jIxFMlsxBMF_6VwM1bs"}],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/master/skus?include_inventory=true&hub_code=193&sku_code=Mirnda","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","master","skus"],"query":[{"key":"include_inventory","value":"true","description":"If true, inventory details will be fetched for corresponding hub"},{"key":"hub_code","value":"2134","description":"Code for the hub whose inventory details are to be fetched","type":"text","disabled":true},{"key":"hub_code","value":"193"},{"key":"sku_code","value":"Mirnda"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 30 Aug 2025 06:15:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"6462e3ed-cc25-436b-8a06-1032ff206259"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"977226be0ab159d6-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"name\": \"Mirnda\",\n \"description\": \"\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"simple\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 2000,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 2000,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 2000,\n \"unit\": \"cm\"\n }\n },\n \"sku_code\": \"Mirnda\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [\n {\n \"default\": \"https://omniful-production-uploads.s3.amazonaws.com/products/category/image/e87dfaed965e935718347a8218f8dce51737209817.jpeg\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"attributes\": [],\n \"barcodes\": [\n \"9990876\"\n ],\n \"cost\": 0,\n \"retail_price\": 100,\n \"selling_price\": 120,\n \"display_selling_price\": \"120.00 SAR\",\n \"display_retail_price\": \"100.00 SAR\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2024-07-31T10:25:39.699Z\",\n \"updated_at\": \"2025-04-08T05:44:02.956Z\",\n \"tax_inclusive\": {\n \"selling_price\": true\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": [],\n \"metadata\": {\n \"assembled_part_count\": 0\n },\n \"hub_inventory\": [\n {\n \"hub_code\": \"193\",\n \"sku_code\": \"Mirnda\",\n \"available_quantity\": 996,\n \"sku_name\": \"Mirnda\",\n \"quantity_on_hand\": 1000,\n \"quantity_location_pass_inventory_sum\": 999,\n \"quantity_location_fail_inventory_sum\": 0,\n \"quantity_reserved\": 3,\n \"uom\": \"ea\",\n \"updated_at\": \"May 18, 2025 01:09:00 PM\"\n }\n ]\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 10,\n \"total\": 1\n }\n}"}],"_postman_id":"295b1b76-dc87-4bd7-a168-d860c644e6d2"},{"name":"Create Master SKU","id":"0abbf255-acf4-406c-9d38-238c3932d3c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"ALU 3432423\",\n \"description\": \"This is a sample product description.\",\n \"sku_code\": \"nLOI\",\n \"barcodes\": [\n \"new-sku-barcode-7aaa\"\n ],\n \"images\": [\n {\n \"default\": \"https://m.media-amazon.com/images/I/71bmtncxa+L._AC_SX679_.jpg\"\n }\n ],\n \"type\": \"simple\",\n \"status\": \"live\",\n \"brand\": \"Sample Brand\",\n \"country_of_origin\": \"Sample Country\",\n \"weight\": {\n \"value\": 5,\n \"uom\": \"ea\" // Any Unit of Measurement other than \"ea\" will be treated as \"ea\" unless weighted configuration is enabled for the tenant.\n },\n \"uom\": \"ea\",\n \"dimensions\": {\n \"length\": {\n \"length\": 10,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 5,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 15,\n \"unit\": \"cm\"\n }\n },\n \"retail_price\": 49.99,\n \"selling_price\": 39.99,\n \"is_perishable\": true\n }\n]"},"url":"{{base_url}}/sales-channel/public/v1/master/skus","description":"

📌 Create Master SKU API – Overview

The Create Master SKU API allows users to create a new SKU in the Master Catalogue.

This API is used to add products to the seller’s catalog with essential details such as SKU code, pricing, attributes, and classification.

✅ Required Fields for Creating a Master SKU

sku_code → Unique identifier for the SKU (e.g., \"SKU-TV-123\")
\n
type → SKU type (\"simple\" or \"bundle\")
\n
status → SKU lifecycle status (must be one of: all, live, ready_to_list, under_review, draft, un_sync, others)
\n

⚠️ Important Considerations

Unique SKU Code → Each SKU must have a unique sku_code.
\n
Pricing → Must specify cost, selling_price, and retail_price.
\n
Handling Type → Must be \"hot\" or \"cold\" (storage/handling conditions).
\n
SKU Type → \"simple\" for standalone products, \"bundle\" for grouped products.
\n
Status Lifecycle → Valid options: all, live, ready_to_list, under_review, draft, un_sync, others.
\n

Request Body Parameters

Field	Data Type	Description	Required
name	string	Product name, e.g., `\"Smart LED TV\"`	✅ Yes
description	string	Detailed description, e.g., `\"High-quality 4K Smart LED TV with Wi-Fi connectivity\"`	✅ Yes
sku_code	string	Unique SKU code, e.g., `\"SKU-TV-123\"`	✅ Yes
attributes	array	Array of attribute objects	❌ No
attributes[].name	string	Attribute name, e.g., `\"Screen Size\"`	❌ No
attributes[].sku_attribute_variation	object	Attribute variation details	❌ No
attributes[].sku_attribute_variation.name	string	Variation name, e.g., `\"Variation 1\"`	❌ No
handling_type	string	Handling type (`\"hot\"` or `\"cold\"`)	❌ No
type	string	SKU type (`\"simple\"` or `\"bundle\"`)	✅ Yes
status	string	SKU status (`all`, `live`, `ready_to_list`, etc.)	✅ Yes
unit	string	Measuring unit for the SKU, e.g., `\"pcs\"`	❌ No
images	array	Array of image objects	❌ No
images[].default	string	Default image URL	❌ No
images[].thumbnail	string	Thumbnail image URL	❌ No
images[].medium	string	Medium-sized image URL	❌ No
images[].large	string	Large image URL	❌ No
images[].url	string	Image URL	❌ No
images[].type	string	Image type, e.g., `\"image\"`	❌ No
images[].description	string	Image description	❌ No
categories	array	Array of category objects	❌ No
categories[].name	string	Category name, e.g., `\"Electronics\"`	❌ No
manufacturer_name	string	Manufacturer’s name	❌ No
brand_name	string	Brand name	❌ No
country_of_origin	string	Country of origin	❌ No
is_weighted	boolean	Whether SKU has weight considerations	❌ No
dimensions	object	Product dimensions	❌ No
dimensions.length.length	number	Length value	❌ No
dimensions.length.unit	string	Length unit, e.g., `\"cm\"`	❌ No
dimensions.breadth.breadth	number	Breadth value	❌ No
dimensions.breadth.unit	string	Breadth unit, e.g., `\"cm\"`	❌ No
dimensions.height.height	number	Height value	❌ No
dimensions.height.unit	string	Height unit, e.g., `\"cm\"`	❌ No
barcodes	array	Array of barcodes for the SKU	❌ No
cost	number	Cost price of the product	✅ Yes
retail_price	number	Retail (MRP) price	✅ Yes
selling_price	number	Selling price	✅ Yes
is_perishable	boolean	Whether the SKU is perishable (`true` / `false`)	✅ Yes
configuration	object	Additional configuration settings	❌ No
configuration.weight.min	string	Minimum weight, e.g., `\"10 kg\"`	❌ No
configuration.weight.max	string	Maximum weight, e.g., `\"15 kg\"`	❌ No
configuration.weight.type	string	Weight config type, e.g., `\"fixed\"`	❌ No
custom_attribute	array	Array of custom attributes	❌ No
custom_attribute[].key	string	Attribute key	❌ No
custom_attribute[].value	string	Attribute value	❌ No
product_url	string	Product URL, e.g., `\"https://example.com/tv\"`	❌ No
uom	string	Unit of measure (`kg`, `lbs`, `g`, `l`, `ml`, `ea`)	❌ No

📌 Overview

The Update Master SKU API allows users to update the SKU in the Master Catalog. This API helps in updating products to the seller’s master catalog with essential details such as SKU code, pricing, and attributes.

📌 Required fields for Updating a Master SKU:

sku_code: A unique code that identifies the SKU, for example, \"SKU-TV-123\"
\n
type: Specifies the type of the SKU, which can be \"simple\" or \"bundle\".
\n

Here's the documentation for each field in the provided JSON:

Field	Data Type	Description	Required
name	string	The name of the product, e.g., \"Smart LED TV.\"	✅ Yes
description	string	A detailed description of the product, e.g., \"High-quality 4K Smart LED TV with Wi-Fi connectivity.\"	❌ No
sku_code	string	A unique code that identifies the SKU, e.g., \"SKU-TV-123.\"	✅ Yes
attributes	array	An array of attribute objects that differentiate the SKU from other variations.	❌ No
attributes[].name	string	The name of the attribute, e.g., \"Screen Size.\"	❌ No
attributes[].sku_attribute_variation	object	An object containing details about the attribute variation.	❌ No
attributes[].sku_attribute_variation.name	string	The specific variation detail, e.g., \"Variation 1.\"	❌ No
handling_type	string	Specifies the handling type for the SKU; should be either `hot` or `cold`.	❌ No
type	string	Specifies the type of the SKU, which can be either \"simple\" or \"bundle.\"	✅ Yes
status	string	Indicates the status of the product; valid options: all, live, ready_to_list, under_review, draft, un_sync, others.	❌ No
unit	string	The measuring unit for the SKU, such as \"pcs\" (pieces).	❌ No
images	array	An array of image objects associated with the SKU.	❌ No
images[].default	string	The default image URL.	❌ No
images[].thumbnail	string	The thumbnail image URL.	❌ No
images[].medium	string	The medium-sized image URL.	❌ No
images[].large	string	The large-sized image URL.	❌ No
images[].url	string	The URL of the image.	❌ No
images[].type	string	The type of the image, e.g., \"image.\"	❌ No
images[].description	string	A description of the image, e.g., \"Smart LED TV image.\"	❌ No
categories	array	An array of category objects.	❌ No
categories[].name	string	The name of the category, e.g., \"Electronics\" or \"TV & Video.\"	❌ No
manufacturer_name	string	The name of the manufacturer, e.g., \"ABC Electronics.\"	❌ No
brand_name	string	The brand name associated with the product, e.g., \"BrandX.\"	❌ No
country_of_origin	string	The originating country of the product, e.g., \"CountryX.\"	❌ No
is_weighted	boolean	Indicates whether the SKU has weight considerations.	❌ No
dimensions	object	An object representing the physical dimensions of the product.	❌ No
dimensions.length	object	An object for the SKU's length details.	❌ No
dimensions.length.length	number	The length value, e.g., 100.	❌ No
dimensions.length.unit	string	The unit of measurement for length, e.g., \"cm.\"	❌ No
dimensions.breadth	object	An object for the SKU's breadth details.	❌ No
dimensions.breadth.breadth	number	The breadth value, e.g., 10.	❌ No
dimensions.breadth.unit	string	The unit of measurement for breadth, e.g., \"cm.\"	❌ No
dimensions.height	object	An object for the SKU's height details.	❌ No
dimensions.height.height	number	The height value, e.g., 60.	❌ No
dimensions.height.unit	string	The unit of measurement for height, e.g., \"cm.\"	❌ No
barcodes	array	An array of barcode strings associated with the SKU.	❌ No
cost	number	The cost of purchasing the product, e.g., 300.	❌ No
retail_price	number	The Manufacturer's Retail Price (MRP) of the product, e.g., 599.	❌ No
selling_price	number	The price at which the product is being sold, e.g., 499.	❌ No
is_perishable	boolean	A boolean indicating whether the SKU is perishable (true or false).	❌ No
configuration	object	An object with SKU configurations.	❌ No
configuration.weight	object	An object indicating the weight range configuration for the SKU.	❌ No
configuration.weight.min	string	The minimum weight, e.g., \"10 kg.\"	❌ No
configuration.weight.max	string	The maximum weight, e.g., \"15 kg.\"	❌ No
configuration.weight.type	string	The type of weight configuration, e.g., \"fixed.\"	❌ No
custom_attribute	array	An array of custom attribute objects.	❌ No
custom_attribute[].key	string	The key of the custom attribute, e.g., \"Smart TV.\"	❌ No
custom_attribute[].value	string	The value of the custom attribute, e.g., \"Yes.\"	❌ No
product_url	string	The URL associated with the product, e.g., \"https://example.com/tv.\"	❌ No
uom	string	Unit used for quantifying and communicating measurements; valid options: kg, lbs, g, l, ml, ea.	❌ No

","urlObject":{"path":["sales-channel","public","v1","master","skus"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e8c302af-02d2-49fe-911d-13b0eda2faa6","name":"Create Master SKU","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"ALU 3432423\",\n \"description\": \"This is a sample product description.\",\n \"sku_code\": \"nLOI\",\n \"barcodes\": [\n \"new-sku-barcode-7aaa\"\n ],\n \"images\": [\n {\n \"default\": \"https://m.media-amazon.com/images/I/71bmtncxa+L._AC_SX679_.jpg\"\n }\n ],\n \"type\": \"simple\",\n \"status\": \"live\",\n \"brand\": \"Sample Brand\",\n \"country_of_origin\": \"Sample Country\",\n \"weight\": {\n \"value\": 5.2,\n \"uom\": \"kg\"\n },\n \"uom\": \"kg\",\n \"dimensions\": {\n \"length\": {\n \"length\": 10,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 5,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 15,\n \"unit\": \"cm\"\n }\n },\n \"retail_price\": 49.99,\n \"selling_price\": 39.99,\n \"is_perishable\": true\n }\n]"},"url":"{{base_url}}/sales-channel/public/v1/master/skus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Mar 2025 14:33:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"fe82c4b7-73ad-436a-9ed0-362dedb3f66b"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9235ed272e4cd705-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Your request has been queued\"\n },\n \"meta\": null\n}"}],"_postman_id":"3822ee5c-48bf-4b9c-86b4-0ddbbff58a52"}],"id":"e823824f-3c62-4e65-9c33-eac07edf071d","description":"

📌 Product API Collection - Overview

The Product API Collection in Postman allows users to manage SKUs and catalog data efficiently. With these APIs, users can:

Create New SKUs – Add new products to the catalog.
\n
Fetch SKU Details – Retrieve specific SKU information, including pricing, stock, and attributes.
\n
Fetch Master Catalog SKUs – Access the full list of SKUs available in the master catalog.
\n

These APIs help streamline product management and ensure accurate inventory tracking.

\n","_postman_id":"e823824f-3c62-4e65-9c33-eac07edf071d","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Inventory","item":[{"name":"Get Seller Hub Inventory","id":"0f60d888-9b86-44f1-b618-5bad31c9cc7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/seller/inventory/hubs/:hub_code?updated_to=2025-03-28 09:52:05&updated_from=2025-03-27 19:52:05&timezone=UTC","description":"

📌 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.

Pagination

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

Pagination of data to show on each page

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

Filter Based on SKU codes to fetch inventory from the hub.

\n","type":"text/plain"},"key":"sku_codes[]","value":"23243"},{"description":{"content":"

Use this parameter to define the end date and time until which you want to fetch inventory updates. This ensures you retrieve inventory data within a specific time range. (Format: YYYY-MM-DD HH:MM:SS)

\n","type":"text/plain"},"key":"updated_to","value":"2025-03-28 09:52:05"},{"description":{"content":"

Use this parameter to specify the starting date and time from which you want to retrieve inventory updates. This helps you fetch inventory changes from a specific point in time. (Format: YYYY-MM-DD HH:MM:SS)\nNote: This value is required to apply filter If this value is provided empty then filter will not be applied.

\n","type":"text/plain"},"key":"updated_from","value":"2025-03-27 19:52:05"},{"description":{"content":"

Specify the timezone in which you want the inventory update timestamps to be returned. If no timezone is provided, the system defaults to UTC. Example: Asia/Riyadh.

\n","type":"text/plain"},"key":"timezone","value":"UTC"}],"variable":[{"description":{"content":"

Hub code from which you want to fetch inventory for the seller

\n","type":"text/plain"},"type":"any","value":"ONLS","key":"hub_code"}]}},"response":[{"id":"3eb6c45b-0770-4c80-ba89-72d9c9b02aa0","name":"Get Seller Hub Inventory","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/seller/inventory/hubs/:hub_code?page=2&per_page=10","host":["{{base_url}}"],"path":["sales-channel","public","v1","seller","inventory","hubs",":hub_code"],"query":[{"key":"page","value":"2"},{"key":"per_page","value":"10"}],"variable":[{"key":"hub_code","value":"ONLS"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Jan 2024 12:50:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"56698621-6b87-49bd-a4a1-3919f53339f2"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"84667c780a2584fb-BOM"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004210\",\n \"available_quantity\": 0,\n \"sku_name\": \"Skip Hop Zoo Kids Rolling Luggage Bag Monkey\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\"\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004211\",\n \"available_quantity\": 0,\n \"sku_name\": \"Skip Hop Zoo Kids Rolling Luggage Bag Owl\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\"\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004214\",\n \"available_quantity\": 0,\n \"sku_name\": \"Bebe Folie Stroller Cooling Mat Mint Blue\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\"\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004212\",\n \"available_quantity\": 0,\n \"sku_name\": \"Skip Hop Zoo Kids Rolling Luggage Bag Unicorn\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\"\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004206\",\n \"available_quantity\": 0,\n \"sku_name\": \"Skip Hop Zoo Backpack Unicorn\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\"\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004208\",\n \"available_quantity\": 0,\n \"sku_name\": \"Skip Hop Zoo Kids Rolling Luggage Bag Giraffe\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\"\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004209\",\n \"available_quantity\": 0,\n \"sku_name\": \"Skip Hop Zoo Kids Rolling Luggage Bag Ladybug\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\"\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004202\",\n \"available_quantity\": 0,\n \"sku_name\": \"Skip Hop Zoo Backpack Monkey\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\"\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004205\",\n \"available_quantity\": 0,\n \"sku_name\": \"Skip Hop Zoo Backpack Sloth\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\"\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004198\",\n \"available_quantity\": 0,\n \"sku_name\": \"Skip Hop Zoo Backpack Hedgehog\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\"\n }\n ],\n \"meta\": {\n \"current_page\": 2,\n \"last_page\": 482,\n \"per_page\": 10,\n \"total\": 4817\n }\n}"}],"_postman_id":"0f60d888-9b86-44f1-b618-5bad31c9cc7e"},{"name":"Get Seller Hub Inventory Report of a Seller","id":"72aa4353-5087-4838-b931-7cabf0283f0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/seller/inventory/hubs/:hub_code/report","description":"

📌 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:

{\n  \"event_name\": \"inventory.report.event\",\n  \"data\": {\n    \"inventory_report_url\": \"https://omniful-production-uploads.s3.amazonaws.com/analytics/reports/downloads/Hub Inventory_7_20240108111445.csv\",\n    \"valid_until\": \"2024-01-08T13:14:46.373259786Z\",\n    \"valid_duration\": 7200000000000,\n    \"valid_duration_string\": \"2 hours\"\n  }\n}\n\n

Hub code from which you want to fetch seller hub inventory report.

\n","type":"text/plain"},"type":"any","value":"Hub232","key":"hub_code"}]}},"response":[{"id":"796232e0-76da-4fdc-965a-7b4a0a2d1da9","name":"Get Hub Inventory Report of a Seller","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/seller/inventory/hubs/:hub_code/report","host":["{{base_url}}"],"path":["sales-channel","public","v1","seller","inventory","hubs",":hub_code","report"],"variable":[{"key":"hub_code","value":"Hub232"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Jan 2024 11:14:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"cccba290-da03-4484-9554-57b5619f87b7"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"842404cb59f7f3e1-BOM"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"Message\": \"Report Generation In Progress!!\"\n },\n \"meta\": null\n}"}],"_postman_id":"72aa4353-5087-4838-b931-7cabf0283f0d"},{"name":"Get Inventory for SKU Across All Hubs","id":"faca4c10-02fc-4c48-a310-297274d279a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/inventory/hubs/skus/:sku_code?updated_from=2025-03-02 15:04:05&updated_to=2025-03-04 15:04:05&timezone=UTC","description":"

📌 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

Note: This value is required to apply filter If this value is provided empty then filter will not be applied.

\n","type":"text/plain"},"key":"updated_from","value":"2025-03-02 15:04:05"},{"description":{"content":"

\n","type":"text/plain"},"key":"updated_to","value":"2025-03-04 15:04:05"},{"description":{"content":"

Specify the timezone in which you want the inventory update timestamps to be returned. If no timezone is provided, the system defaults to UTC. Example: Asia/Riyadh.

\n","type":"text/plain"},"key":"timezone","value":"UTC"}],"variable":[{"description":{"content":"

SKU code of the SKU for which you want to fetch inventory for

\n","type":"text/plain"},"type":"any","value":"samsung190","key":"sku_code"}]}},"response":[{"id":"a8a06ff3-1e2e-4f3f-80c1-946de8e9ad8f","name":"Get All Hubs Inventory","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/inventory/hubs/skus/:sku_code?to=2025-02-07&from=2025-02-03","host":["{{base_url}}"],"path":["sales-channel","public","v1","inventory","hubs","skus",":sku_code"],"query":[{"key":"to","value":"2025-02-07"},{"key":"from","value":"2025-02-03"}],"variable":[{"key":"sku_code","value":"samsung190"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 11:32:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"4fd62f40-d6c5-4883-890a-d47d56f25e53"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90dad1e7efc7ef64-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"hub_code\": \"seamlessretail\",\n \"sku_code\": \"samsung190\",\n \"available_quantity\": 96,\n \"sku_name\": \"samsung190\",\n \"quantity_on_hand\": 100,\n \"quantity_reserved\": 4,\n \"uom\": \"ea\"\n }\n ],\n \"meta\": null\n}"}],"_postman_id":"faca4c10-02fc-4c48-a310-297274d279a0"},{"name":"Post Hub Inventory","id":"5c04f46c-5ca1-40c7-9408-db3c9f767c16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sku_detail\": [\n {\n \"sku_code\": \"SKU-TV-123\",\n \"quantity\": 100\n },\n {\n \"sku_code\": \"samsung190\",\n \"quantity\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/inventory/hubs/:hub_code","description":"

📌 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) – List of SKUs to be updated. Each object must contain:
- sku_code (string) – Unique SKU identifier.
- quantity (number) – The updated quantity for this SKU.Note: The array supports a maximum of 200 SKUs per request.
\n

This API ensures accurate inventory updates across warehouse locations.

Hub code of the Hub in which you want to make an inventory update for the SKU.

\n","type":"text/plain"},"type":"any","value":"seamlessretail","key":"hub_code"}]}},"response":[{"id":"7579ff30-ef21-4917-a514-cc7191690e51","name":"Push Hub Inventory","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sku_detail\": [\n {\n \"sku_code\": \"SKU-TV-123\",\n \"quantity\": 100\n },\n {\n \"sku_code\": \"samsung190\",\n \"quantity\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/inventory/hubs/:hub_code","host":["{{base_url}}"],"path":["sales-channel","public","v1","inventory","hubs",":hub_code"],"variable":[{"key":"hub_code","value":"seamlessretail","description":"Hub code of the Hub in which you want to make an inventory update for the SKU."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Apr 2025 05:59:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"c31d95bc-59b7-49f6-92ba-b3e83e112285"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"937c92d8ef430766-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"failed_skus\": [\n {\n \"sku_codes\": [\n \"sku-tv-123\"\n ],\n \"reason\": \"SKU not found\"\n }\n ]\n },\n \"meta\": null\n}"}],"_postman_id":"5c04f46c-5ca1-40c7-9408-db3c9f767c16"},{"name":"Push Safety Stock","id":"3be59e20-10b9-4879-95c2-7c5b5eeed23f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"sku_detail\": [\n {\n \"sku_code\": \"67999801331808\",\n \"quantity\": 101\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/inventory/hubs/:hub_code/safety_stock","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"path":["sales-channel","public","v1","inventory","hubs",":hub_code","safety_stock"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"hub_123","key":"hub_code"}]}},"response":[{"id":"9097eb37-b1ad-4a6e-94e6-74913b352384","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NzU5MDc1NDUsImp0aSI6IjlhNmI3NmJkLWVhNjEtNGU3My1hZmIyLWE3NzUxMDQwMTdiOCIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NDkxOCwiU2VsbGVySUQiOiI2OTI5IiwiVGVuYW50SUQiOiIzIiwiVXNlcklEIjoiNjQ2NiIsIlVzZXJOYW1lIjoiUHJpeWFuc2h1IEpoYSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.btPEkncJrgHdXWjGjS6R5p_tcCgyYh0TMOCd0lBY1hvMHzb28XUTyIGEqxyOzh8ifu4CwcDNtD52jQ3ILcKUvbYQS4hqH7aBtyfi8qNZihE3QZDQVzLxjiLW7RXbEe8L5gNL8zTz1Pg__EJip7q18YTyzB2JHvvZ8_tDbqxo0j5QAlIXg4Ry9W5C5HIU0AJz5pv1H_RyIybdh0qdRKX7mkoMls7pIB1Em7cagIiQuIgrauKacTEEt_Uc-wUhQNT2QUkZGtfXXorY6gdaetnsumTE28G15rwF_1J6W8yLr8pdPdAqD8JuTrI2HRFRKFkIP3Y9rl_IaAwHMjZdtU4-iFfOzaV5LoQEtPLZB4i8bDbc6MpSwZUIEq0KkfPSxrzGLvjPPPbYUjswPMOaYrwU6qdiXVRXsbkiCq5OB-tSTVNu6669jJYWu_qXYGL92sNvoCJNpsdn0PbZe-GoGYz4nuKA85vzswfieZ0_A_hDjtxgV3adJo6fmPRgj7K4eJIg1-91ujHD-ec5AqdhXaKMkNB64wCijXjddl4K9ekC97e679Nr4pK6FLLug5duaBgz1zKCa4v_PN0De87oIt1OgnmNciKv8yLBFDTRVX_r_J1ec8LoCggeqCG_0NHWtWS2HEM6RQHDSKGnWByIAO7GOFwD0lQEKdB3aWulKWs1csY"}],"body":{"mode":"raw","raw":"{\n \"sku_detail\": [\n {\n \"sku_code\": \"67999801331808\",\n \"quantity\": 101\n }\n \n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v1/inventory/hubs/locoff/safety_stock"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Thu, 02 Apr 2026 08:24:13 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"x-omniful-request-id","value":"87483d26-ca59-47e4-906f-d972f7fdbded"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"content-encoding","value":"br"},{"key":"server","value":"cloudflare"},{"key":"cf-ray","value":"9e5e6f98fcdc45ec-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"failed_skus\": null\n },\n \"meta\": null\n}"}],"_postman_id":"3be59e20-10b9-4879-95c2-7c5b5eeed23f"}],"id":"5b5894ff-e93e-473b-a7d7-d194c68bd7ce","description":"

📌 Inventory APIs - Overview

The Inventory APIs allow users to fetch inventory details of SKUs listed in the Sales Channel Catalog and Master Catalog within the warehouse.

These APIs help users track stock levels, availability, and SKU movement, ensuring accurate inventory management across different sales channels and warehouse locations.

\n","_postman_id":"5b5894ff-e93e-473b-a7d7-d194c68bd7ce","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Returns","item":[{"name":"Return Shipment","item":[{"name":"Create Return Shipment","id":"d1b8ff2d-6ec2-4b5c-a3dc-649189757712","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tracking_url\": \"https://tracking.fedex.com/123456789\",\n \"awb_number\": \"1124ee1231231232123213\",\n \"package_details\": {\n \"number_of_boxes\": 1,\n \"weight\": 1,\n \"dimensions\": {\n \"length\": 30,\n \"breadth\": 20,\n \"height\": 15\n },\n \"remarks\": \"Handle with care\"\n },\n \"courier_partner\": {\n \"tag\": \"jandt\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/return_orders/:id/shipment","description":"

Endpoint Description

This endpoint allows the user to create a shipment for a specific return order identified by :id. It is used to update the shipment details associated with a return order, including tracking information and package specifications.

Request Body

The request body must be in JSON format and should include the following parameters:

tracking_url (string): A URL that provides tracking information for the shipment.
\n
awb_number (string): The Air Waybill number associated with the shipment.
\n
package_details (object): An object containing details about the package.
\n
- number_of_boxes (integer): The number of boxes being shipped.
  \n
- weight (integer): The weight of the package in appropriate units.
  \n
- dimensions (object): An object specifying the dimensions of the package.
  \n
  - length (integer): The length of the package.
    \n
  - breadth (integer): The breadth of the package.
    \n
  - height (integer): The height of the package.
    \n
  \n
- remarks (string): Any special handling instructions for the package.
  \n
\n
courier_partner (object): An object specifying the courier partner.
\n
- tag (string): The identifier for the courier partner.
\n

Response

The response will be in JSON format and will contain the following fields:

is_success (boolean): Indicates whether the shipment creation was successful.
\n
status_code (integer): A code representing the status of the request.
\n
data (string): Additional data related to the shipment, if any.
\n

This endpoint is crucial for managing the logistics of return orders by allowing users to specify shipment details and track their packages effectively.

Update Shipment Status for Return Orders

This endpoint allows you to update the shipment status of a specific return order identified by its unique id. It is particularly useful for managing the logistics of returned items, enabling the system to track the status of shipments effectively.

Request Body

The request body must be in JSON format and should include the following parameter:

shipment_status (string): The new status of the shipment. Following are the allowed values:
\n
- \"picked_up\"
  \n
- \"return_to_origin\"
  \n
\n

The sequence of shipment statuses is created -> picked_up -> return_to_origin.

Response

The response from this endpoint will be in JSON format and will contain the following fields:

is_success (boolean): Indicates whether the operation was successful.
\n
status_code (integer): A code representing the status of the request (200 typically indicates success).
\n
data (object or null): Contains additional data related to the request, if applicable.
\n

This structure ensures that users can easily understand the outcome of their request and take appropriate actions based on the response received.

This API endpoint is used to create shipment for any return order of the seller.

This is the id of a return order.

\n","type":"text/plain"},"type":"any","value":"3278649783264","key":"id"}]}},"response":[{"id":"b2c7d2f3-f2ee-477b-b8db-3a51afed34ab","name":"Success","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Return shipment created successfully\",\n \"meta\": null\n}"}],"_postman_id":"a1b21a9f-7f93-443e-a9cc-3e76c5225340"},{"name":"Update Seller Return Shipment","id":"48ee9698-2095-4db2-9175-0f9f52cc3eb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"shipment_status\": \"return_to_origin\"\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v1/seller/return_orders/:id/shipment/status","description":"

This API endpoint is used to update the status of shipment for any return order of the seller.

\n","urlObject":{"protocol":"https","path":["sales-channel","public","v1","seller","return_orders",":id","shipment","status"],"host":["prodapi","omniful","com"],"query":[],"variable":[{"description":{"content":"

This is the id of a return order.

\n","type":"text/plain"},"type":"any","value":"38762397846","key":"id"}]}},"response":[{"id":"dac6b8b4-bf59-451b-9f03-b23772bbae59","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"shipment_status\": \"return_to_origin\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/seller/return_orders/:return_order_oms_id/shipment/status","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","seller","return_orders",":return_order_oms_id","shipment","status"],"variable":[{"key":"return_order_oms_id","value":"691b12763d214db83a9d586b"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 17 Nov 2025 13:15:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"f0c738c4-b4f0-4cac-b5e4-0455aabf0840"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"99ff7e95e9fb7fe8-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": null,\n \"meta\": null\n}"}],"_postman_id":"48ee9698-2095-4db2-9175-0f9f52cc3eb7"}],"id":"74f5a670-6dff-4c53-90da-28fa3a0b98a7","_postman_id":"74f5a670-6dff-4c53-90da-28fa3a0b98a7","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Sales Channel Returns","item":[{"name":"Create Return Order","id":"96f7c983-b6c0-42e4-af36-4510b40f5a2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"return_order_id\": \"RO1234561\",\n \"return_items\": [\n {\n \"sales_channel_item_id\": \"iPhone 15 Pro\",\n \"sales_channel_return_item_id\": \"iPhone 15 Pro\",\n \"seller_sku_code\": \"iPhone 15 Pro\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged item\",\n \"quantity\": 1\n }\n ],\n \"unit_price\": 50.00,\n \"discount\": 5.00,\n \"total\": 90.00\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"cod_fee\",\n \"cost\": 5.00,\n \"tax_inclusive\": true,\n \"tax_percentage\": 10.00,\n \"is_applied\": true\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 8.00,\n \"tax_inclusive\": false,\n \"tax_percentage\": 5.00,\n \"is_applied\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/:order_id/return_orders","description":"

📌 Create Return Order API – Overview

The Create Return Order API allows users to generate a customer return order against the provided order_id.

This API helps sellers and platforms record returned items, capture return reasons, and apply any additional charges related to the return.

📌 Required Fields

return_order_id → Unique identifier for the return order.
\n
return_items → Must include at least one returned item with:
\n
- seller_sku_code
  \n
- return_quantity
  \n
\n

📌 Request Body Parameters

Field	Data Type	Description	Required
return_order_id	string	Unique identifier for the return order, e.g., `\"RO123456\"`	✅ Yes
return_items	object	Object representing the returned item	✅ Yes
return_items.sales_channel_item_id	string	Unique identifier of the item in the sales channel, e.g., `\"samsung190\"`	❌ No
return_items.sales_channel_return_item_id	string	Unique identifier of the return item in the sales channel, e.g., `\"samsung190\"`	❌ No
return_items.seller_sku_code	string	Seller’s SKU code of the product being returned, e.g., `\"samsung190\"`	✅ Yes
return_items.return_quantity	integer	Quantity of the product being returned, e.g., `1`	✅ Yes
return_items.return_reasons	object	Object containing specific return reason(s)	❌ No
return_items.return_reasons.reason	string	Specific reason for the return, e.g., `\"Damaged item\"`	❌ No
return_items.return_reasons.quantity	integer	Quantity tied to the return reason, e.g., `1`	❌ No
return_items.unit_price	number	Unit price of the returned item, e.g., `50.00`	❌ No
return_items.discount	number	Discount applied to the returned item, e.g., `5.00`	❌ No
return_items.total	number	Total amount for the returned item after discount, e.g., `90.00`	❌ No
additional_charges	object	Object containing additional charges applied to the return order	❌ No
additional_charges.type	string	Type of charge, e.g., `\"cod_fee\"`, `\"return_shipment_fee\"`	❌ No
additional_charges.cost	number	Cost of the charge, e.g., `5.00`	❌ No
additional_charges.tax_inclusive	boolean	Whether the cost includes tax (`true` / `false`)	❌ No
additional_charges.tax_percentage	number	Tax percentage applied to the charge, e.g., `10.00`	❌ No
additional_charges.is_applied	boolean	Whether the charge is applied to the return order (`true` / `false`)	❌ No

Order ID against which return order needs to be created.

\n","type":"text/plain"},"type":"any","value":"test-omniful_12","key":"order_id"}]}},"response":[{"id":"1903ddc6-fe9a-4b59-af0c-4a315d6a19ff","name":"Create Return Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"return_order_id\": \"RO1234561\",\n \"return_items\": [\n {\n \"sales_channel_item_id\": \"iPhone 15 Pro\",\n \"sales_channel_return_item_id\": \"iPhone 15 Pro\",\n \"seller_sku_code\": \"iPhone 15 Pro\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged item\",\n \"quantity\": 1\n }\n ],\n \"unit_price\": 50.00,\n \"discount\": 5.00,\n \"total\": 90.00\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"cod_fee\",\n \"cost\": 5.00,\n \"tax_inclusive\": true,\n \"tax_percentage\": 10.00,\n \"is_applied\": true\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 8.00,\n \"tax_inclusive\": false,\n \"tax_percentage\": 5.00,\n \"is_applied\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/:order_id/return_orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders",":order_id","return_orders"],"variable":[{"key":"order_id","value":"test-omniful_12","description":"Order ID against which return order needs to be created."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Mar 2025 04:59:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"b665513e-a0f7-4c8c-bb17-5a0d230abe95"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"926414de8d2807c4-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Return order created successfully.\",\n \"meta\": null\n}"}],"_postman_id":"96f7c983-b6c0-42e4-af36-4510b40f5a2c"},{"name":"Create Return Requests","id":"f1563ed2-111f-45db-b825-64a595bb8f89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"shubhra-0009\",\n \"return_reason\": \"Damaged and Wrong Item\",\n \"hub_code\": \"Shubhra001\",\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged\",\n \"quantity\": 1\n },\n {\n \"reason\": \"Wrong Item\",\n \"quantity\": 1\n }\n ]\n }\n ],\n \"return_request_id\": \"omniful-1037\"\n}"},"url":"{{base_url}}/sales-channel/public/v1/returns/","description":"

📌 Create Return Request API – Overview

The Create Return Request API is used to initiate a return request for orders that are in the delivered state.

This API ensures efficient tracking and management of returned items by capturing essential details such as order ID, reasons for return, and hub information.

📌 Key Points to Consider

The order must be in the delivered state before a return request can be created.
\n
Each return request must include:
\n
- order_id
  \n
- return_reason
  \n
- hub_code (if applicable)
  \n
- order_items with SKU details and return quantities
  \n
\n

✅ Required Fields

order_id (string) → Unique identifier for the order.
\n
return_reason (string) → Overall reason for initiating the return.
\n
hub_code (string) → Hub associated with the order.
\n
order_items (array) → List of returned items, including:
\n
- sku_code (string) → SKU identifier of the item.
  \n
- return_quantity (number) → Quantity of the item being returned.
  \n
- return_reasons (array) → Specific reasons and quantities for return.
  \n
\n
return_request_id (string) → Unique identifier for the return request.
\n

📌 Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description	Required
order_id	string	Unique identifier for the order associated with the return request	✅ Yes
return_reason	string	Overall return reason (e.g., `\"Damaged and Wrong Item\"`)	✅ Yes
hub_code	string	Hub code where the return request is processed	❌ No
order_items	array	List of returned items with details	✅ Yes
order_items[].sku_code	string	SKU code of the returned product	✅ Yes
order_items[].return_quantity	integer	Total quantity of the SKU being returned	✅ Yes
order_items[].return_reasons	array	Specific reasons and corresponding quantities	❌ No
order_items[].return_reasons[].reason	string	Return reason (e.g., `\"Damaged\"`, `\"Wrong Item\"`)	❌ No
order_items[].return_reasons[].quantity	integer	Quantity associated with the return reason	❌ No
return_request_id	string	Unique identifier for the return request (used for tracking)	✅ Yes

📌 Get Return Request API - Overview

The Get Return Request API allows users to retrieve return requests for orders based on request status, order ID, and return order ID.

📌 Filters Available:

order_id – Fetch return requests for a specific order.
return_order_id – Retrieve details of a specific return request.
status – Filter return requests by status.

📌 Return Request Statuses:

new – The return request has been submitted and is awaiting action.
approved – The return request has been approved for processing.
rejected – The return request has been declined.

This API helps users track return requests efficiently, ensuring seamless return management.

Fetch return requests for a specific order.

\n","type":"text/plain"},"key":"status","value":"new"},{"disabled":true,"description":{"content":"

Retrieve details of a specific return request.

\n","type":"text/plain"},"key":"return_request_number","value":"test-1012"},{"disabled":true,"description":{"content":"

Fetch return requests for a specific order.

\n","type":"text/plain"},"key":"order_id","value":"test-1026"}],"variable":[]}},"response":[{"id":"b1359e73-724b-4da5-8d8d-e1f3d9c2e6f8","name":"Get return requests","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{staging_base_url}}/sales-channel/public/v1/returns?order_id=test-1026","host":["{{staging_base_url}}"],"path":["sales-channel","public","v1","returns"],"query":[{"key":"status","value":"new","disabled":true},{"key":"return_request_number","value":"test-1012","disabled":true},{"key":"order_id","value":"test-1026"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Oct 2023 08:44:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"b4e8ebaa-ed58-4488-a9c5-b620a372c8ce"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"811c9f6e7c90b293-MAA"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"return_request_number\": \"test-1026\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Kouta Store\",\n \"order_id\": \"test-1026\",\n \"return_reason\": \"Received Broken/Damaged Items\",\n \"hub_code\": \"20101\",\n \"order_items\": [\n {\n \"sku_code\": \"SKU-AC-456\",\n \"return_quantity\": 1,\n \"delivered_quantity\": 1\n }\n ],\n \"total_return_items_count\": 1,\n \"total_delivered_items_count\": 1,\n \"total_sku_count\": 1,\n \"total\": 699,\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false\n },\n \"payment_method\": \"Prepaid\",\n \"status\": \"New\",\n \"shipment_type\": \"Omniful Generated\",\n \"shipment\": {\n \"shipment_created_at\": \"0001-01-01T00:00:00Z\",\n \"order_delivered_at\": \"2023-10-06T08:42:35.663Z\",\n \"order_shipped_at\": \"2023-10-06T08:42:27.445Z\",\n \"awb_number\": \"4151696581704\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"number_of_boxes\": 1\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"},{"id":"b225d83a-ac07-4eca-b96b-fd55f7a00d40","name":"Get return requests","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{staging_base_url}}/sales-channel/public/v1/returns?status=new","host":["{{staging_base_url}}"],"path":["sales-channel","public","v1","returns"],"query":[{"key":"status","value":"new"},{"key":"return_request_number","value":"test-1012","disabled":true},{"key":"order_id","value":"test-1026","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Oct 2023 08:45:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"c643b91e-b542-4e33-bc19-f9f5563f1bb6"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"811ca039ca99b293-MAA"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"return_request_number\": \"test-1026\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Kouta Store\",\n \"order_id\": \"test-1026\",\n \"return_reason\": \"Received Broken/Damaged Items\",\n \"hub_code\": \"20101\",\n \"order_items\": [\n {\n \"sku_code\": \"SKU-AC-456\",\n \"return_quantity\": 1,\n \"delivered_quantity\": 1\n }\n ],\n \"total_return_items_count\": 1,\n \"total_delivered_items_count\": 1,\n \"total_sku_count\": 1,\n \"total\": 699,\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false\n },\n \"payment_method\": \"Prepaid\",\n \"status\": \"New\",\n \"shipment_type\": \"Omniful Generated\",\n \"shipment\": {\n \"shipment_created_at\": \"0001-01-01T00:00:00Z\",\n \"order_delivered_at\": \"2023-10-06T08:42:35.663Z\",\n \"order_shipped_at\": \"2023-10-06T08:42:27.445Z\",\n \"awb_number\": \"4151696581704\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"number_of_boxes\": 1\n }\n },\n {\n \"return_request_number\": \"test-1021\",\n \"customer\": {\n \"first_name\": \"Anurag\",\n \"last_name\": \"Shah\",\n \"mobile\": \"543100720\",\n \"mobile_code\": \"+966\",\n \"email\": \"anurag.shah@gmail.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Kouta Store\",\n \"order_id\": \"test-1021\",\n \"return_reason\": \"Received Broken/Damaged Items\",\n \"hub_code\": \"20101\",\n \"order_items\": [\n {\n \"sku_code\": \"SKU-AC-456\",\n \"return_quantity\": 1,\n \"delivered_quantity\": 1\n }\n ],\n \"total_return_items_count\": 1,\n \"total_delivered_items_count\": 1,\n \"total_sku_count\": 1,\n \"total\": 699,\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false\n },\n \"payment_method\": \"Prepaid\",\n \"status\": \"New\",\n \"shipment_type\": \"Omniful Generated\",\n \"shipment\": {\n \"shipment_created_at\": \"0001-01-01T00:00:00Z\",\n \"order_delivered_at\": \"2023-10-05T11:44:50.055Z\",\n \"order_shipped_at\": \"2023-10-05T11:44:41.002Z\",\n \"awb_number\": \"4151696506263\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"number_of_boxes\": 1\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 2\n }\n}"}],"_postman_id":"8a31f621-95f1-49b2-81f7-b560108c8336"},{"name":"Reject Return Requests","id":"dd990a82-56f0-4068-a0aa-a45104d6a5d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"{{base_url}}/sales-channel/public/v1/returns/reject?return_request_id=test-1026","description":"

📌 Reject Return Request API - Overview

The Reject Return Request API allows users to decline a return request for a specific return order ID.

This API ensures that return requests can be managed efficiently by rejecting invalid or non-eligible returns.

Return OrderID for which the return request needs to be rejected.

\n","type":"text/plain"},"key":"return_request_id","value":"test-1026"}],"variable":[]}},"response":[{"id":"f1c14c2b-e65c-41e0-bc2a-6c3b13c60bd2","name":"Reject return requests","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{staging_base_url}}/sales-channel/public/v1/returns/reject?return_request_id=test-1026","host":["{{staging_base_url}}"],"path":["sales-channel","public","v1","returns","reject"],"query":[{"key":"return_request_id","value":"test-1026"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Oct 2023 08:45:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"ac0bffe7-90c2-4a63-bff5-e69f9591ed87"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"811ca16319bfb293-MAA"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success : The Return Request was successfully rejected.\"\n },\n \"meta\": null\n}"}],"_postman_id":"dd990a82-56f0-4068-a0aa-a45104d6a5d7"},{"name":"Approve Return Request","id":"fe388794-6d2a-4486-b9ef-1cbe83d99c61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"test-1026\",\n \"order_items\": [\n\n ],\n \"total_refundable_amount\": 1,\n \"approval_mode\": \"full\",\n \"return_request_id\": \"test-1026\"\n}"},"url":"{{base_url}}/sales-channel/public/v1/returns/test-1026/approve","description":"

📌 Approve Return Request API - Overview

The Approve Return Request API is used to approve return requests for an order based on its return order ID. This API allows users to approve full or partial returns and process refunds accordingly.

📌 Important Fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
order_id	`string`	Unique identifier for the order.
order_items	`array of objects`	List of items being approved for return.
order_items.sku_code	`string`	SKU code of the item being returned.
order_items.return_quantity	`number`	Quantity of the SKU to be returned.
order_items.return_reason	`string`	Reason for the return.
total_refundable_amount	`number`	Total amount to be refunded for the return order.
approval_mode	`string`	Mode of approval: `\"full\"` or `\"partial\"`.
return_request_id	`string`	Unique identifier of the return request.

📌 Approval Modes:

Full Approval: Approves all order items in the return request. If full approval is selected, the \"order_items\" field can be empty, as all items in the request will be approved.
Partial Approval: Approves only specific order items. If partial approval is selected, users must explicitly specify the order items to be approved.

This API ensures smooth return processing, allowing businesses to handle refunds and return approvals efficiently.

Description:

Retrieve a list of return orders with support for filtering by individual return order ID, multiple return order IDs, or the original sales channel order ID. Ideal for listing or searching return orders in bulk.

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`return_order_id`	`string`	Fetch return order by single ID
`return_order_ids`	`array`	Fetch multiple return orders by ID list
`seller_sales_channel_order_id`	`string`	Fetch by the external seller's order ID

Page number of response

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of responses per page

\n","type":"text/plain"},"key":"per_page","value":"3"},{"disabled":true,"key":"return_order_id","value":"r-pos-SHUBHRAIPHONE15-1"},{"disabled":true,"key":"return_order_ids","value":"RO-13022025-XPNDS54"}],"variable":[]}},"response":[{"id":"38ea301a-40ac-4104-8cb1-717906b0a8e5","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/return_orders?return_order_id=RO-07072025-QACUI","host":["{{base_url}}"],"path":["sales-channel","public","v1","return_orders"],"query":[{"key":"return_order_id","value":"RO-07072025-QACUI","description":"Fetch return order by single ID"},{"key":"return_order_ids[]","value":null,"description":"Fetch multiple return orders by ID list","type":"text","disabled":true},{"key":"seller_sales_channel_order_id","value":null,"description":"Fetch by the external seller's order ID","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Jul 2025 06:12:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"46982112-beb3-43da-947f-2c928f4cfea5"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"96288cadfb71179e-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"return_order_id\": \"RO-07072025-QACUI\",\n \"order_id\": \"order_0003\",\n \"seller_name\": \"div_test\",\n \"type\": \"Customer Return\",\n \"source\": \"Manual\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+1-1234567890\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\",\n \"country\": \"\",\n \"country_calling_code\": \"\"\n },\n \"hub_code\": \"ONLS\",\n \"order_items\": [\n {\n \"sku_code\": \"sku-1234\",\n \"return_quantity\": 2,\n \"delivered_quantity\": 2\n }\n ],\n \"total_return_quantity\": 2,\n \"total_sku_count\": 1,\n \"delivered_quantity\": 2,\n \"total\": 1427.8,\n \"pickup_address\": {\n \"address1\": \"456 Elm Street\",\n \"address2\": \"\",\n \"city\": \"Los Angeles\",\n \"country\": \"United States\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+1-9876543210\",\n \"email\": \"\",\n \"state\": \"CA\",\n \"area\": \"\",\n \"zip\": \"90001\",\n \"state_code\": \"CA\",\n \"country_code\": \"US\",\n \"latitude\": 34.0522,\n \"longitude\": -118.2437\n },\n \"status\": \"Return Shipment Created\",\n \"refund_status\": \"Pending\",\n \"qc_fail_reasons\": [\n {\n \"key\": \"item_damaged\",\n \"display_name\": \"Item Damaged\"\n },\n {\n \"key\": \"color_faded\",\n \"display_name\": \"Color Faded\"\n },\n {\n \"key\": \"item_not_received\",\n \"display_name\": \"Item Not Received\"\n }\n ],\n \"oms_qc_status\": \"Pending\",\n \"shipment_created\": true,\n \"is_shipment_created\": true,\n \"print_awb_allowed\": true,\n \"shipment\": {\n \"awb_number\": \"1234987654\",\n \"shipping_partner_status\": \"Ready to Pick\",\n \"delivery_status\": \"\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\"\n },\n \"order_created_at\": \"2025-07-07T12:17:35.619Z\",\n \"order_delivered_at\": \"2025-07-07T12:28:20.595Z\",\n \"payment_method\": \"prepaid\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 1398,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 129.8,\n \"discount\": 100,\n \"total\": 1427.8,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": null,\n \"attachments\": null,\n \"refunded_amounts\": null,\n \"total_refunded\": 0\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 0\n }\n}"}],"_postman_id":"0b657035-a831-44d6-8a6c-e3863ff05175"},{"name":"Get Return Order by ID","id":"558c375b-2509-4a5d-bd0d-4b68b47b3ba2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/return_orders/{return_order_id} ","description":"

Endpoint

Description:

Fetch complete details of a single return order by its unique ID, including customer info, returned items, status, pickup address, QC details, and shipment information.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`return_order_id`	`string`	The unique return order ID

Sales Channel Returns — API Folder Overview

Use these APIs when creating and managing return requests and return orders for purchases placed on a seller’s Custom API integrated Sales Channels. This folder covers the full workflow from raising a return request against a channel order, through approval/rejection, to creating the resulting return order in Omniful.

When to use this folder

The original order was created from a Custom API Sales Channel into Omniful and then Delivered.
\n
You need to create/approve/reject return requests and, if approved, return orders tied to the channel order and its line items.
\n
For returns of orders created directly by any other seller sales channel, use the Seller Returns folder.
\n

\n","_postman_id":"49a9d981-7631-4c18-a849-a107ed4c985c","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Seller Returns","item":[{"name":"Create Return Request","id":"1a1922e5-ce92-4e18-aa1c-28b06615128c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"10456114397478\",\n \"return_reason\": \"Damaged and Wrong Items-reject\",\n \"hub_code\": \"132\", \n \"order_items\": [\n {\n \"sku_code\": \"8904355400626\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged\",\n \"quantity\": 1\n }\n ]\n }\n ],\n \"return_request_id\": \"RO12348372969\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/seller/orders/:order_id","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"path":["sales-channel","public","v1","seller","orders",":order_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"6904b95ea41db26f38e13c0a","key":"order_id"}]}},"response":[{"id":"8de4634c-23b7-446a-8f0a-4c6fcd0360c2","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"10456114397478\",\n \"return_reason\": \"Damaged and Wrong Items-reject\",\n \"hub_code\": \"132\", \n \"order_items\": [\n {\n \"sku_code\": \"8904355400626\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged\",\n \"quantity\": 1\n }\n ]\n }\n ],\n \"return_request_id\": \"RO12348372969\"\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/seller/orders/:order_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","seller","orders",":order_id"],"variable":[{"key":"order_id","value":"6904b95ea41db26f38e13c0a"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 06 Nov 2025 12:29:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"020c9003-7096-4135-855b-9e971a498c19"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"99a498b72e5954cb-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"return_request_number\": \"RO12348372969\",\n \"customer\": {\n \"country_code\": \"\",\n \"country\": \"\",\n \"country_calling_code\": \"\"\n },\n \"seller_name\": \"Aryaman Vashishtha\",\n \"order_id\": \"10456114397478\",\n \"hub_code\": \"132\",\n \"order_items\": [\n {\n \"sku_code\": \"8904355400626\",\n \"return_quantity\": 1,\n \"delivered_quantity\": 1\n }\n ],\n \"total_return_items_count\": 1,\n \"total_delivered_items_count\": 1,\n \"total_sku_count\": 1,\n \"total\": 402.5,\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 402.5,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 52.5,\n \"discount\": 0,\n \"total\": 402.5,\n \"total_paid\": 402.5,\n \"total_due\": 0,\n \"tax_percent\": 15,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": true,\n \"additional_charges\": [],\n \"attachments\": null,\n \"refunded_amounts\": null,\n \"total_refunded\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"status\": \"New\",\n \"shipment_type\": \"Omniful Generated\",\n \"shipment\": {\n \"order_delivered_at\": \"2025-11-06T12:22:01.102Z\",\n \"order_shipped_at\": \"2025-11-06T12:20:58.517Z\",\n \"shipment_order_id\": \"690c929ac19865aac79474f5\",\n \"awb_number\": \"764317624316422693\",\n \"delivery_status\": \"\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"number_of_boxes\": 1\n }\n },\n \"meta\": null\n}"}],"_postman_id":"1a1922e5-ce92-4e18-aa1c-28b06615128c"},{"name":"Approve Return Request","id":"374e53b8-0ad7-4460-9573-a5c3b3eb5c37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"10455642964262\",\n \"order_items\": [\n {\n \"sku_code\": \"132\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged\",\n \"quantity\": 1\n }\n ]\n }\n ],\n \"total_refundable_amount\": 100,\n \"approval_mode\": \"full\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/seller/orders/:order_id/:return_ request_id/approve","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"path":["sales-channel","public","v1","seller","orders",":order_id",":return_ request_id","approve"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"6904b95ea41db26f38e13c0a","key":"order_id"},{"type":"any","value":"RO12348372969","key":"return_ request_id"}]}},"response":[{"id":"eb4b03eb-5f11-4b65-82d2-91d36c729a38","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"10455642964262\",\n \"order_items\": [\n {\n \"sku_code\": \"132\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged\",\n \"quantity\": 1\n }\n ]\n }\n ],\n \"total_refundable_amount\": 100,\n \"approval_mode\": \"full\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/seller/orders/:order_id/:return_ request_id/approve","host":["{{base_url}}"],"path":["sales-channel","public","v1","seller","orders",":order_id",":return_ request_id","approve"],"variable":[{"key":"order_id","value":"6904b95ea41db26f38e13c0a"},{"key":"return_ request_id","value":"RO12348372969"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 06 Nov 2025 12:31:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"c1623a1a-e8e6-493a-bb09-7fe98a7ab057"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"99a49b89dfde2b0d-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success : The Return Request was successfully approved.\"\n },\n \"meta\": null\n}"}],"_postman_id":"374e53b8-0ad7-4460-9573-a5c3b3eb5c37"},{"name":"Reject Return Request","id":"59bc7f44-650d-4039-b9ff-258ee5d8272a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"{{base_url}}/sales-channel/public/v1/seller/orders/:order_id/reject?return_request_id=RR-06112025-WWFZC","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"path":["sales-channel","public","v1","seller","orders",":order_id","reject"],"host":["{{base_url}}"],"query":[{"key":"return_request_id","value":"RR-06112025-WWFZC"}],"variable":[{"type":"any","value":"690445a4a41db26f38e08871","key":"order_id"}]}},"response":[{"id":"4c26200f-20fc-41bf-b3ab-ef7940fb275e","name":"Success","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/seller/orders/:order_id/reject?return_request_id=RR-06112025-WWFZC","host":["{{base_url}}"],"path":["sales-channel","public","v1","seller","orders",":order_id","reject"],"query":[{"key":"return_request_id","value":"RR-06112025-WWFZC"}],"variable":[{"key":"order_id","value":"690445a4a41db26f38e08871"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success : The Return Request was successfully rejected.\"\n },\n \"meta\": null\n}"}],"_postman_id":"59bc7f44-650d-4039-b9ff-258ee5d8272a"},{"name":"Create Return Order","id":"9359ed43-a11c-4cab-86a8-dd7bc93c3692","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"return_order_id\": \"RO12345678931\",\n \"return_items\": [\n {\n \"sales_channel_item_id\": \"17032658518311\",\n \"sales_channel_return_item_id\": \"17032658518311\",\n \"seller_sku_code\": \"mohi-sku-5-shopify-100-100\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged item - test\",\n \"quantity\": 1\n }\n ],\n \"unit_price\": 100.00,\n \"discount\": 10.00,\n \"total\": 90.00\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"cod_fee\",\n \"cost\": 0.00,\n \"tax_inclusive\": true,\n \"tax_percentage\": 10.00,\n \"is_applied\": true\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 8.00,\n \"tax_inclusive\": false,\n \"tax_percentage\": 5.00,\n \"is_applied\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/seller/orders/:order_id/return_order","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"path":["sales-channel","public","v1","seller","orders",":order_id","return_order"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"order_id"}]}},"response":[{"id":"c4be9c10-129c-4a4d-a0e8-484d67b60c63","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"return_order_id\": \"RO12345678931\",\n \"return_items\": [\n {\n \"sales_channel_item_id\": \"17032658518311\",\n \"sales_channel_return_item_id\": \"17032658518311\",\n \"seller_sku_code\": \"mohi-sku-5-shopify-100-100\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged item - test\",\n \"quantity\": 1\n }\n ],\n \"unit_price\": 100.00,\n \"discount\": 10.00,\n \"total\": 90.00\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"cod_fee\",\n \"cost\": 0.00,\n \"tax_inclusive\": true,\n \"tax_percentage\": 10.00,\n \"is_applied\": true\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 8.00,\n \"tax_inclusive\": false,\n \"tax_percentage\": 5.00,\n \"is_applied\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/seller/orders/:order_id/return_order","host":["{{base_url}}"],"path":["sales-channel","public","v1","seller","orders",":order_id","return_order"],"variable":[{"key":"order_id","value":""}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"return_order_id\": \"RO12345678959\",\n \"order_id\": \"10455642636582\",\n \"seller_name\": \"Aryaman Vashishtha\",\n \"type\": \"Customer Return\",\n \"source\": \"Sales Channel\",\n \"customer\": {\n \"country_code\": \"\",\n \"country\": \"\",\n \"country_calling_code\": \"\"\n },\n \"hub_code\": \"109554893094\",\n \"order_items\": [\n {\n \"sku_code\": \"TAPO-01\",\n \"return_quantity\": 1,\n \"delivered_quantity\": 2\n }\n ],\n \"total_return_quantity\": 1,\n \"total_sku_count\": 1,\n \"delivered_quantity\": 2,\n \"total\": 2000,\n \"pickup_address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"Gurgaon\",\n \"country\": \"India\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"+91-8136089498\",\n \"email\": \"\",\n \"state\": \"\",\n \"area\": \"\",\n \"zip\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"IN\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"status\": \"Initiated\",\n \"refund_status\": \"Pending\",\n \"qc_fail_reasons\": [\n {\n \"key\": \"item_damaged\",\n \"display_name\": \"Item Damaged\"\n },\n {\n \"key\": \"color_faded\",\n \"display_name\": \"Color Faded\"\n },\n {\n \"key\": \"item_not_received\",\n \"display_name\": \"Item Not Received\"\n }\n ],\n \"oms_qc_status\": \"Pending\",\n \"shipment\": {\n \"delivery_status\": \"\"\n },\n \"order_created_at\": \"2025-10-31T05:14:10Z\",\n \"order_delivered_at\": \"2025-11-06T12:34:31.146Z\",\n \"payment_method\": \"postpaid\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 2000,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"total\": 1992,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"tax_percent\": 15,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": null,\n \"attachments\": null,\n \"refunded_amounts\": null,\n \"total_refunded\": 0\n }\n },\n \"meta\": null\n}"}],"_postman_id":"9359ed43-a11c-4cab-86a8-dd7bc93c3692"},{"name":"Get Seller Return Order","id":"55491852-270b-4aa6-930e-9bd5f27b546b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/seller/return_orders?return_order_id=RO452133","description":"

This API endpoint is used for getting all Return Orders of the seller.

Unique identifier for Return Order

\n","type":"text/plain"},"key":"return_order_id","value":"RO452133"},{"disabled":true,"description":{"content":"

Forward order alias

\n","type":"text/plain"},"key":"order_alias","value":"10262"},{"disabled":true,"description":{"content":"

Sales Channel Forward Order Id

\n","type":"text/plain"},"key":"seller_sales_channel_order_id","value":"B2C_8796907607607"},{"disabled":true,"description":{"content":"

Omniful Return order id

\n","type":"text/plain"},"key":"id","value":"67bc05df6412a6fcb2da2dba"},{"disabled":true,"description":{"content":"

Customer's Mobile Number

\n","type":"text/plain"},"key":"customer_mobile","value":"+966-123489723"}],"variable":[]}},"response":[{"id":"3134179b-3a11-4c56-9495-1f1cb1df24e2","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/seller/return_orders?return_order_id=RO452133","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","seller","return_orders"],"query":[{"key":"return_order_id","value":"RO452133"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 17 Nov 2025 13:04:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"4ae71fb0-f274-4802-91e8-a234c8d8ffdb"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"99ff6f82ac647eca-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"691b12763d214db83a9d586b\",\n \"return_order_id\": \"RO452133\",\n \"order_id\": \"6265169150167\",\n \"seller_name\": \"Test_Vikk\",\n \"type\": \"Customer Return\",\n \"source\": \"Sales Channel\",\n \"customer\": {\n \"country_code\": \"\",\n \"country\": \"\",\n \"country_calling_code\": \"\"\n },\n \"hub_code\": \"tech02\",\n \"total_return_quantity\": 1,\n \"total_sku_count\": 1,\n \"delivered_quantity\": 1,\n \"total\": 1090,\n \"pickup_address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"state\": \"\",\n \"area\": \"\",\n \"zip\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"status\": \"Return To Origin\",\n \"refund_status\": \"Pending\",\n \"qc_fail_reasons\": [\n {\n \"key\": \"item_damaged\",\n \"display_name\": \"Item Damaged\"\n },\n {\n \"key\": \"color_faded\",\n \"display_name\": \"Color Faded\"\n },\n {\n \"key\": \"item_not_received\",\n \"display_name\": \"Item Not Received\"\n }\n ],\n \"oms_qc_status\": \"Pending\",\n \"shipment_created\": true,\n \"is_shipment_created\": true,\n \"print_awb_allowed\": true,\n \"shipment\": {\n \"order_delivered_at\": \"2025-11-17T12:47:37.525Z\",\n \"shipment_order_id\": \"691b164d0f8d76475880267d\",\n \"awb_number\": \"1732121312223122\",\n \"shipping_partner_status\": \"ready_for_pickup\",\n \"delivery_status\": \"\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"tracking_url\": \"https://tracking.fedex.com/123456789\"\n },\n \"order_created_at\": \"2025-11-15T07:19:25Z\",\n \"order_delivered_at\": \"2025-11-15T09:19:57.699Z\",\n \"payment_method\": \"prepaid\",\n \"invoice\": {\n \"currency\": \"INR\",\n \"subtotal\": 1000,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 90,\n \"discount\": 0,\n \"total\": 1082,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"tax_percent\": 9,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": null,\n \"attachments\": null,\n \"refunded_amounts\": null,\n \"total_refunded\": 0\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"}],"_postman_id":"55491852-270b-4aa6-930e-9bd5f27b546b"}],"id":"de8d9e0b-1510-444d-ba6f-521e13de7c04","description":"

ChatGPT said:

Seller Returns — API Folder Overview

Use these APIs to create and manage return requests and return orders for any order placed by any seller sales channel that has been delivered. This folder supports the approval workflow (request → approve/reject) and direct creation of return orders.

\n

Important: Approve and Reject Return Request endpoints apply only to requests that were created using the Create Return Request API in this folder.

When to use this folder

The original order was created by any seller sales channel in Omniful.
\n
You need to create, approve/reject, and convert return requests to return orders for delivered items.
\n
For returns of only the Custom API Sales Channel orders, use the Sales Channel Returns folder.
\n

\n","_postman_id":"de8d9e0b-1510-444d-ba6f-521e13de7c04","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}}],"id":"03b74e72-bfad-459a-b96a-b06b1f6cf87b","description":"

📌 Return Order API Collection - Overview

The Return Order API Collection provides a set of APIs to manage return orders efficiently.

📌 Key Functions:

Create Return Order Request – Initiate a return request for an order.
\n
Approve Return Order Request – Approve a return request for processing.
\n
Create Return Order – Create a return order.
\n
Reject Return Order Request – Decline a return request if it doesn't meet the return criteria.
\n

These APIs help streamline the returns process, ensuring smooth handling of customer returns and order reversals.

\n","_postman_id":"03b74e72-bfad-459a-b96a-b06b1f6cf87b","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Purchase Order","item":[{"name":"Create Purchase Order","id":"bc156fe6-d49b-46ad-a8f8-a21674187378","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"supplier_email\": \"shubhra@omniful.com\",\n \"supplier_code\": \"At-H\",\n \"over_receive_allowed\": true,\n \"purchase_order_items\": [\n {\n \"sku_code\": \"samsung190\",\n \"quantity\": 10,\n \"unit_price\": 10.4\n }\n ],\n \"remark\": \"Ritik\",\n \"reference_purchase_order_id\": \"po-ref-01\",\n \"currency\": \"SAR\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/purchase_orders/hubs/:hub_code","description":"

📌 Create Purchase Order API – Overview

The Create Purchase Order API allows users to generate new purchase orders for suppliers, enabling streamlined procurement and inventory management.

📌 Key Points to Consider

To route the purchase order to a specific hub, provide the hub_code in the path parameter.
\n
A purchase order must include at least one valid SKU in purchase_order_items.
\n
Currency must be defined using a 3-letter ISO code (e.g., SAR for Saudi Riyal, USD for US Dollar).
\n

✅ Required Fields

supplier_code – Unique identifier for the supplier.
\n
purchase_order_items – Must contain at least one item with:
\n
- sku_code
  \n
- quantity
  \n
\n
currency – Currency code for the purchase order.
\n

📌 Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description	Required
supplier_email	string	Supplier’s email address	❌ No
supplier_code	string	Unique identifier code for the supplier	✅ Yes
over_receive_allowed	boolean	Whether receiving more than the ordered quantity is permitted (`true` / `false`)	❌ No
purchase_order_items	array	List of items included in the purchase order	✅ Yes
purchase_order_items[].sku_code	string	SKU code of the product	✅ Yes
purchase_order_items[].quantity	integer	Quantity of the product to purchase	✅ Yes
purchase_order_items[].unit_price	float	Price per unit of the product	❌ No
remark	string	Additional notes or comments about the purchase order	❌ No
reference_purchase_order_id	string	External reference ID for the purchase order	❌ No
currency	string	ISO 4217 3-letter currency code (e.g., `\"SAR\"`, `\"USD\"`)	✅ Yes

Hub code for which you want to raise the purchase order.

\n","type":"text/plain"},"type":"any","value":"Shubhra001","key":"hub_code"}]}},"response":[{"id":"1af994d3-9544-4892-b0ec-0aec4448e9dd","name":"Create Purchase Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"supplier_email\": \"shubhra@omniful.com\",\n \"supplier_code\": \"At-H\",\n \"over_receive_allowed\": true,\n \"purchase_order_items\": [\n {\n \"sku_code\": \"samsung190\",\n \"quantity\": 10,\n \"unit_price\": 10.4\n }\n ],\n \"remark\": \"Ritik\",\n \"reference_purchase_order_id\": \"po-ref-01\",\n \"currency\": \"SAR\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/purchase_orders/hubs/:hub_code","host":["{{base_url}}"],"path":["sales-channel","public","v1","purchase_orders","hubs",":hub_code"],"variable":[{"key":"hub_code","value":"Shubhra001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 12 Oct 2024 04:50:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"04be5ce8-0024-4bcc-b141-8086f90e3fdf"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d1478ae2a2cc92f-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"purchase_order_id\": \"PO-DE165-1\",\n \"reference_purchase_order_id\": \"po-ref-01\"\n },\n \"meta\": null\n}"}],"_postman_id":"bc156fe6-d49b-46ad-a8f8-a21674187378"},{"name":"Get Purchase Orders","id":"b22be43f-d54e-49ce-b40d-32ca379d82a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"supplier_email\": \"kouta@omniful.com\",\n \"purchase_order_items\": [\n {\n \"sku_code\": \"506308\",\n \"quantity\": 10,\n \"unit_price\": 10.4\n },\n {\n \"sku_code\": \"4718466011800\",\n \"quantity\": 90,\n \"unit_price\": 100\n }\n ],\n \"remark\": \"Ritik\",\n \"reference_purchase_order_id\": \"po-ref-1\",\n \"currency\": \"SAR\"\n}"},"url":"{{base_url}}/sales-channel/public/v1/purchase_orders/hubs/:hub_code?order_status=ordered","description":"

📌 Get Purchase Order API - Overview

The Get Purchase Order API allows users to retrieve all purchase orders for a specific hub using various query filters.

📌 Filters Available:

Date Range – Fetch purchase orders within a specific time period.
\n
Status – Filter purchase orders based on their current processing status.
\n
Purchase Order Number – Retrieve details of a specific purchase order.
\n

This API helps users track, manage, and analyze purchase orders efficiently within the hub.

Filter results based on the purchase order ID.

\n","type":"text/plain"},"key":"purchase_order_id","value":"PO-SA1-4"},{"disabled":true,"description":{"content":"

Filter results by using the reference purchase order ID for the purchase order.

\n","type":"text/plain"},"key":"reference_purchase_order_id","value":"po-ref-1"},{"description":{"content":"

Filter Based on Purchase Order Status (ordered, partial_received, received)

\n","type":"text/plain"},"key":"order_status","value":"ordered"},{"disabled":true,"description":{"content":"

Date Range Filter

\n","type":"text/plain"},"key":"created_from","value":"09-02-2024"},{"disabled":true,"description":{"content":"

Date Range Filter

\n","type":"text/plain"},"key":"created_to","value":"28-02-2024"}],"variable":[{"description":{"content":"

Code of the Hub for which you want to view purchase orders.

\n","type":"text/plain"},"type":"any","value":"Hub232","key":"hub_code"}]}},"response":[{"id":"4b923098-5479-4e5e-91ab-bf5106127bb1","name":"Get Purchase Orders","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/sales-channel/public/v1/purchase_orders/hubs/:hub_code","host":["{{base_url}}"],"path":["sales-channel","public","v1","purchase_orders","hubs",":hub_code"],"variable":[{"key":"hub_code","value":"Hub232"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Feb 2024 01:44:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"05f351db-7fa1-4ae4-97d5-cbcfb969745c"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"85286dffbf69b2b1-MAA"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"seller_name\": \"saleschannel-demo\",\n \"hub_code\": \"Hub232\",\n \"purchase_order_id\": \"PO-SA1-4\",\n \"reference_purchase_order_id\": \"po-ref-1\",\n \"supplier_name\": \"Kouta Supplier\",\n \"type\": \"standard\",\n \"total_amount\": 9104,\n \"currency\": \"SAR\",\n \"shipping\": {},\n \"item_number\": 100,\n \"remark\": \"Ritik\",\n \"created_at\": \"2024-02-09T01:43:11.726135Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\",\n \"deleted_at\": null\n },\n {\n \"seller_name\": \"saleschannel-demo\",\n \"hub_code\": \"Hub232\",\n \"purchase_order_id\": \"PO-SA1-3\",\n \"supplier_name\": \"Kouta Supplier\",\n \"type\": \"standard\",\n \"total_amount\": 9104,\n \"currency\": \"SAR\",\n \"shipping\": {},\n \"item_number\": 100,\n \"remark\": \"Ritik\",\n \"created_at\": \"2024-02-09T01:40:51.836016Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\",\n \"deleted_at\": null\n },\n {\n \"seller_name\": \"saleschannel-demo\",\n \"hub_code\": \"Hub232\",\n \"purchase_order_id\": \"PO-SA1-2\",\n \"supplier_name\": \"Kouta Supplier\",\n \"type\": \"standard\",\n \"total_amount\": 3660,\n \"currency\": \"SAR\",\n \"shipping\": {},\n \"item_number\": 30,\n \"remark\": \"qwertyui\",\n \"created_at\": \"2023-11-17T11:37:35.459178Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\",\n \"deleted_at\": null\n },\n {\n \"seller_name\": \"saleschannel-demo\",\n \"hub_code\": \"Hub232\",\n \"purchase_order_id\": \"PO-SA1-1\",\n \"supplier_name\": \"Kouta Supplier\",\n \"type\": \"standard\",\n \"total_amount\": 250,\n \"gate_entry_status\": true,\n \"currency\": \"SAR\",\n \"shipping\": {},\n \"item_number\": 5,\n \"remark\": null,\n \"created_at\": \"2023-11-08T06:29:15.629037Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\",\n \"deleted_at\": null\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 4\n }\n}"}],"_postman_id":"b22be43f-d54e-49ce-b40d-32ca379d82a0"},{"name":"Get Single Purchase Order","id":"c9b7a5ac-226b-4cd9-aa7b-df67caa081ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/purchase_orders/hubs/:hub_code/purchase_order/:purchase_order_id","description":"

📌 Get Single Purchase Order API - Overview

The Get Single Purchase Order API retrieves the details of a specific purchase order using its purchase order ID for the provided hub ID.

This API helps users access complete purchase order information.

Field Name	Type	Description
purchase_order_id	String	The unique ID for this purchase order.
order_details.quantity	Integer	The total number of items ordered in this purchase order.
order_details.grn_pass_quantity	Integer	The number of items that passed inspection during the goods receipt process.
order_details.grn_fail_quantity	Integer	The number of items that failed inspection during the goods receipt process.
order_details.put_away_pass_quantity	Integer	The number of items that were successfully stored in inventory.
order_details.put_away_fail_quantity	Integer	The number of items that could not be stored in inventory.
seller.name	String	The name of the seller who provided the order.
seller.phone	String	The seller's contact phone number.
seller.email	String	The seller's email address.
hub_code	String	The code for the hub where the order is processed.
supplier.name	String	The name of the supplier providing the items.
supplier.phone	String	The supplier's contact phone number.
supplier.email	String	The supplier's email address.
status	String	The current status of the purchase order (e.g., \"ordered\").
total_amount	Number	The total cost of the purchase order.
currency	String	The three-letter currency code used (e.g., SAR for Saudi Riyal).
item_number	Integer	The number of unique items included in the purchase order.
remark	String	Any extra notes or comments about the purchase order.
purchase_order_items.id	Integer	A unique ID for each individual item in the purchase order.
purchase_order_items.tenant_id	String	The identifier for the tenant associated with this purchase order.
purchase_order_items.seller_id	String	The identifier for the seller related to this specific item.
purchase_order_items.hub_id	Integer	The hub ID where this item is processed.
purchase_order_items.purchase_order_id	Integer	The purchase order ID to which this item belongs.
purchase_order_items.sku.name	String	The name of the SKU (product) for this item.
purchase_order_items.sku.seller_sku_id	String	The seller's unique identifier for this SKU.
purchase_order_items.sku.seller_sku_code	String	The seller's SKU code for this item.
purchase_order_items.sku.images	Array	A list of image URLs for the SKU.
purchase_order_items.sku.attributes	Array	A list of attributes (e.g., color, size) that describe the SKU.
purchase_order_items.sku.package_type	String	The type of packaging used for the SKU (e.g., box, envelope).
purchase_order_items.quantity	Integer	The number of units ordered for this item.
purchase_order_items.unit_price	Number	The price per unit of the item.
purchase_order_items.child_purchase_order_items	Array	Any sub-items related to this purchase order item, if applicable.
purchase_order_items.updated_at	String	The timestamp (in ISO format) of the last update for this item.
purchase_order_items.opened_quantity	Integer	The number of units that have been opened or unpacked.
purchase_order_items.received_quantity	Integer	The number of units that have been received for this item.
grn_details	Array	Details from the goods receipt notes related to this purchase order.
expected_receiving_date	Array	The expected dates for receiving the goods.
created_at	String	The date and time when the purchase order was created (in ISO format).
created_by	String	The name of the user who created the purchase order.
meta.current_page	Integer	The current page number in the paginated results.
meta.last_page	Integer	The last available page number in the paginated results.
meta.per_page	Integer	The number of items displayed per page.
meta.total	Integer	The total number of items across all pages.

Hub code for which you want to view the purchase order.

\n","type":"text/plain"},"type":"any","value":"Hub232","key":"hub_code"},{"description":{"content":"

Purchase order ID of the Purchase order you want to view.

\n","type":"text/plain"},"type":"any","value":"PO-SA1-6","key":"purchase_order_id"}]}},"response":[{"id":"c0953163-2414-4f58-901e-f605ec194d39","name":"Get Single Purchase Order","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/purchase_orders/hubs/:hub_code/purchase_order/:purchase_order_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","purchase_orders","hubs",":hub_code","purchase_order",":purchase_order_id"],"variable":[{"key":"hub_code","value":"Hub232"},{"key":"purchase_order_id","value":"PO-SA1-6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Apr 2024 11:48:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"c9a8a401-17ef-4efc-9c1a-f9d2016eab3b"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"86d8594b1efef48c-BOM"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"purchase_order_id\": \"PO-SA1-6\",\n \"order_details\": {\n \"quantity\": 10,\n \"grn_pass_quantity\": 0,\n \"grn_fail_quantity\": 0,\n \"put_away_pass_quantity\": 0,\n \"put_away_fail_quantity\": 0\n },\n \"seller\": {\n \"name\": \"saleschannel-demo\",\n \"phone\": \"9876543210\",\n \"email\": \"trilok.kaushik@omniful.com\"\n },\n \"hub_code\": \"Hub232\",\n \"supplier\": {\n \"name\": \"Kouta Supplier\",\n \"phone\": \"+918920638012\",\n \"email\": \"kouta@omniful.com\"\n },\n \"status\": \"ordered\",\n \"total_amount\": 1200,\n \"currency\": \"SAR\",\n \"item_number\": 1,\n \"remark\": null,\n \"purchase_order_items\": [\n {\n \"id\": 1080091,\n \"tenant_id\": \"\",\n \"seller_id\": \"\",\n \"hub_id\": 35,\n \"purchase_order_id\": 6368,\n \"sku\": {\n \"name\": \"New SKU 7\",\n \"seller_sku_id\": \"\",\n \"seller_sku_code\": \"new_sku_7\",\n \"images\": [],\n \"attributes\": [],\n \"package_type\": \"ea\"\n },\n \"quantity\": 10,\n \"unit_price\": 120,\n \"child_purchase_order_items\": [],\n \"updated_at\": \"2024-02-24T14:23:42.838326Z\",\n \"opened_quantity\": 0,\n \"received_quantity\": 0\n }\n ],\n \"grn_details\": [],\n \"expected_receiving_date\": [],\n \"created_at\": \"2024-02-24T14:23:42.834553Z\",\n \"created_by\": \"Divyank Goyal\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"}],"_postman_id":"c9b7a5ac-226b-4cd9-aa7b-df67caa081ab"},{"name":"Update Purchase Order","id":"90bdd84b-5a40-4fa3-9419-5395a72f76e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"remark\": \"\",\n \"awb\": \"\",\n \"purchase_order_id\": \"PO-SA1-5\",\n \"over_receive_allowed\": true,\n \"purchase_order_items\": [\n {\n \"sku_code\": \"506308\",\n \"quantity\": 270,\n \"unit_price\": 31\n }\n ]\n}"},"url":"{{base_url}}/sales-channel/public/v1/purchase_orders/hubs/:hub_code","description":"

📌 Important Fields for Purchase Order

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description	Required
remark	string	Additional notes or remarks related to the purchase order	❌ No
awb	string	Air Waybill number – a unique identifier assigned to a shipment for tracking purposes	❌ No
purchase_order_id	string	Unique identifier for the purchase order	✅ Yes
sku_code	string	SKU code of the item included in the purchase order	✅ Yes
quantity	string	Quantity of the item being purchased	❌ No
unit_price	string	Unit price of the item in the purchase order	❌ No

Hub Code for the hub in which you want to update the purchase order details .

\n","type":"text/plain"},"type":"any","value":"Hub232","key":"hub_code"}]}},"response":[{"id":"9bb18391-4b64-4f27-8997-8da46cc6e8fd","name":"Update Purchase Order","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"remark\": \"\",\n \"awb\":\"\",\n \"purchase_order_id\":\"PO-SA1-5\",\n \"purchase_order_items\": [\n {\n \"sku_code\": \"506308\",\n \"quantity\": 270,\n \"unit_price\": 32\n }\n ]\n}"},"url":{"raw":"{{base_url}}/sales-channel/public/v1/purchase_orders/hubs/:hub_code","host":["{{base_url}}"],"path":["sales-channel","public","v1","purchase_orders","hubs",":hub_code"],"variable":[{"key":"hub_code","value":"Hub232"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 24 Feb 2024 06:09:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"2ee19bf9-bee5-41e9-9741-bee8899f6ed5"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"85a589f3aa668603-BOM"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success\"\n },\n \"meta\": null\n}"}],"_postman_id":"90bdd84b-5a40-4fa3-9419-5395a72f76e1"},{"name":"Create Supplier","id":"6e3bf7e1-602d-44cc-b040-2a820dc6154c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Rg1\",\n \"contact_person\": \"Shubhra\",\n \"email\": \"shubhra@omniful.com\",\n \"code\": \"At-H\",\n \"phone\": \"9876543212\"\n}"},"url":"{{base_url}}/sales-channel/public/v1/suppliers","description":"

📌 Important Fields for Supplier

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description	Required
name	string	The name of the supplier	✅ Yes
contact_person	string	The contact person associated with the supplier	❌ No
email	string	The supplier’s email address	✅ Yes
phone	string	The supplier’s phone number	✅ Yes
code	string	Supplier code; if left empty, the system will automatically assign a new one	❌ No

Get All the suppilers

Pagination on Showing a number of entries per page.

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

Pagination

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"0ea0da90-4bde-4353-ad5e-aab0c1b9384d","name":"Get All Suppliers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/sales-channel/public/v1/suppliers?per_page=10&page=1","host":["{{base_url}}"],"path":["sales-channel","public","v1","suppliers"],"query":[{"key":"per_page","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 12 Oct 2024 04:48:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"81af9769-c92d-4ae9-844d-b09bd3ef3f1d"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d14754c6f4c8006-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"contact_person\": \"Shubhra\",\n \"email\": \"shubhra@omniful.com\",\n \"name\": \"Rg1\",\n \"phone\": \"9876543212\",\n \"code\": \"At-H\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 10,\n \"total\": 1\n }\n}"}],"_postman_id":"57007551-a2b4-41ff-8ed0-f747081f1b8e"}],"id":"2349677f-5f92-4a00-b268-7483f91b09d6","description":"

📌 Purchase Order API Collection - Overview

The Purchase Order API Collection on Postman provides a set of APIs that allow users to efficiently manage purchase orders and suppliers.

📌 Key Features:

Create Purchase Orders – Generate new purchase orders for suppliers.
\n
View Purchase Orders – Retrieve details of existing purchase orders.
\n
Update Purchase Orders – Modify purchase order details before processing.
\n
Manage Suppliers – View and create supplier records for procurement.
\n

This collection helps businesses streamline procurement operations, ensuring smooth supplier management and inventory replenishment.

\n","_postman_id":"2349677f-5f92-4a00-b268-7483f91b09d6","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"POS","item":[{"name":"Create POS Order","id":"4f0f3a26-0058-46d1-bc9b-6f0b58a337b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"pos-test-1\",\n \"order_alias\": \"ORD_ALIAS_123\",\n \"customer\": {\n \"id\": \"CUST123\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"9876543210\",\n \"mobile_code\": \"+1\",\n \"country_code\": \"US\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"hub_code\": \"ONLS\",\n \"order_created_at\": \"2023-07-28T09:00:00Z\",\n \"order_items\": [\n {\n \"sales_channel_sku_id\": \"SKU123\",\n \"seller_sku_code\": \"SELLER123\",\n \"sales_channel_order_item_id\": \"ITEM001\",\n \"display_price\": 19.99,\n \"selling_price\": 15.99,\n \"quantity\": 2,\n \"tax_percent\": 5,\n \"tax\": 1.6,\n \"unit_price\": 30.99,\n \"total\": 61.98,\n \"subtotal\": 59.98,\n \"tax_inclusive\": true,\n \"discount\": 5.0\n }\n ],\n \"invoice\": {\n \"sc_invoice_number\": \"INV123456\",\n \"currency\": \"USD\",\n \"subtotal\": 59.98,\n \"shipping_tax\": 1.5,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": true,\n \"shipping_discount_inclusive\": true,\n \"shipping_price\": 5.0,\n \"shipping_refund\": 0,\n \"tax\": 3.6,\n \"tax_percent\": 6,\n \"discount\": 5.0,\n \"total\": 69.98,\n \"total_paid\": 70.0,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_mode\": \"credit_card\",\n \"loyalty_discount\": 2.0\n }\n}"},"url":"{{base_url}}/sales-channel/public/v1/pos/order","description":"

Query Params

should_not_adjust_inventory (string): Set to true if you do not want to adjust inventory; otherwise, the inventory will always be adjusted.

Example: {{base_url}}/sales-channel/public/v1/pos/order?should_not_adjust_inventory=true

Order Details

`order_id` (String)

Unique identifier for the order.

`order_alias` (String)

Alias or alternate identifier for the order.

`customer` (Object)

Details of the customer placing the order.

first_name (String): First name of the customer.
\n
last_name (String): Last name of the customer.
\n
email (String): Email address of the customer.
\n
mobile (String): Mobile number of the customer.
\n
mobile_code (String): Country code for the mobile number.
\n
country_code (String): Country code of the customer.
\n

`hub_code` (String)

Code identifying the hub related to the order.

`order_created_at` (String)

Timestamp indicating when the order was created.

`order_items` (Array)

List of items in the order.

sales_channel_sku_id (String): SKU ID from the sales channel.
\n
seller_sku_code (String): Seller's SKU code.
\n
sales_channel_order_item_id (String): Order item ID from the sales channel.
\n
display_price (Float): Displayed price of the item.
\n
selling_price (Float): Selling price of the item.
\n
quantity (Int): Quantity of the item in the order.
\n
tax_percent (Float): Tax percentage applicable to the item.
\n
tax (Float): Tax amount for the item.
\n
unit_price (Float): Unit price of the item.
\n
total (Float): Total price for the quantity of the item.
\n
subtotal (Float): Subtotal price for the item.
\n
tax_inclusive (Boolean): Indicates if tax is included in the price.
\n
discount (Float): Discount applied to the item.
\n

`invoice` (Object)

Details of the invoice for the order.

currency (String): Currency used for the invoice.
\n
subtotal (Float): Subtotal amount of the invoice.
\n
shipping_tax (Float): Tax applied to shipping.
\n
sub_total_tax_inclusive (Boolean): Indicates if subtotal includes tax.
\n
sub_total_discount_inclusive (Boolean): Indicates if subtotal includes discount.
\n
shipping_tax_inclusive (Boolean): Indicates if shipping tax is inclusive.
\n
shipping_discount_inclusive (Boolean): Indicates if shipping discount is inclusive.
\n
shipping_price (Float): Price for shipping.
\n
shipping_refund (Float): Refund amount for shipping.
\n
tax (Float): Total tax amount.
\n
tax_percent (Float): Total tax percentage.
\n
discount (Float): Total discount applied.
\n
total (Float): Total amount payable.
\n
total_paid (Float): Total amount paid.
\n
total_due (Float): Total amount due.
\n
total_refunded (Float): Total amount refunded.
\n
payment_mode (String): Mode of payment(such as ApplePay etc).
\n
loyalty_discount (Number): Discount applied through loyalty program.
\n

\n","urlObject":{"path":["sales-channel","public","v1","pos","order"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"should_not_adjust_inventory","value":"true"}],"variable":[]}},"response":[{"id":"b3bf40d8-efa9-4132-9795-d8cbc8e0f81b","name":"Create POS Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"POS-Order_1\",\n \"order_alias\": \"ORD_ALIAS_123\",\n \"customer\": {\n \"id\": \"CUST123\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"7044063694\",\n \"mobile_code\": \"+91\",\n \"country_code\": \"IN\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"hub_code\": \"seamlessretail\",\n \"order_created_at\": \"2023-07-28T09:00:00Z\",\n \"order_items\": [\n {\n \"sales_channel_sku_id\": \"iPhone 15 Pro\",\n \"seller_sku_code\": \"iPhone 15 Pro\",\n \"sales_channel_order_item_id\": \"iPhone 15 Pro\",\n \"display_price\": 19.99,\n \"selling_price\": 15.99,\n \"quantity\": 2,\n \"tax_percent\": 5,\n \"tax\": 1.6,\n \"unit_price\": 30.99,\n \"total\": 61.98,\n \"subtotal\": 59.98,\n \"tax_inclusive\": true,\n \"discount\": 5.0\n },\n {\n \"sales_channel_sku_id\": \"samsung190\",\n \"seller_sku_code\": \"samsung190\",\n \"sales_channel_order_item_id\": \"samsung190\",\n \"display_price\": 19.99,\n \"selling_price\": 15.99,\n \"quantity\": 2,\n \"tax_percent\": 5,\n \"tax\": 1.6,\n \"unit_price\": 30.99,\n \"total\": 61.98,\n \"subtotal\": 59.98,\n \"tax_inclusive\": true,\n \"discount\": 5.0\n }\n ],\n \"invoice\": {\n \"sc_invoice_number\": \"INV123456\",\n \"currency\": \"USD\",\n \"subtotal\": 59.98,\n \"shipping_tax\": 1.5,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": true,\n \"shipping_discount_inclusive\": true,\n \"shipping_price\": 5.0,\n \"shipping_refund\": 0,\n \"tax\": 3.6,\n \"tax_percent\": 6,\n \"discount\": 5.0,\n \"total\": 69.98,\n \"total_paid\": 70.0,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_mode\": \"credit_card\",\n \"loyalty_discount\": 2.0\n }\n}"},"url":{"raw":"{{base_url}}/sales-channel/public/v1/pos/order","host":["{{base_url}}"],"path":["sales-channel","public","v1","pos","order"],"query":[{"key":"should_not_adjust_inventory","value":"true","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jan 2025 12:24:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"074861f8-480f-4726-b063-b26847ef95a8"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9088b8cd0edac9ac-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Created POS Order Successfully\",\n \"meta\": null\n}"}],"_postman_id":"4f0f3a26-0058-46d1-bc9b-6f0b58a337b9"},{"name":"Create POS Return Order","id":"18042eb4-2589-4c4f-8eb0-414b4134aff2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"return_order_id\": \"Pos-return-test-3\",\n \"order_id\": \"pos-test-3\",\n \"return_order_alias\": \"RO-123\",\n \"hub_code\": \"ONLS\",\n \"customer\": {\n \"id\": \"CUST123\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"9876543210\",\n \"mobile_code\": \"+91\",\n \"country_code\": \"IN\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"order_items\": [\n {\n \"seller_sku_code\": \"SELLER123\",\n \"return_reason\": \"Defective\",\n \"refunded_quantity\": 1,\n \"returned_quantity\": 2,\n \"uom\": \"ea\",\n \"discount\": 10,\n \"total\": 100,\n \"selling_price\": 100,\n \"unit_price\": 90\n }\n ],\n \"refund_status\": \"pending\",\n \"return_reason\": \"wrong_items\",\n \"invoice\": {\n \"invoice_number\": \"INV-123456\",\n \"currency\": \"USD\",\n \"subtotal\": 100.50,\n \"discount\": 10,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"tax\": 5.25,\n \"tax_percent\": 5,\n \"total\": 105.75,\n \"total_refunded\": 20,\n \"payment_mode\": \"Credit Card\"\n },\n \"order_created_at\": \"2023-07-28T09:00:00Z\",\n \"order_url\": \"https://example.com/orders/789012\"\n}"},"url":"{{base_url}}/sales-channel/public/v1/pos/returns/order","description":"

Return Order Details

`return_order_id` (String)

Unique identifier for the return order.

`order_id` (String)

Original order's identifier.

`return_order_alias` (String)

Alias or alternate identifier for the return order.

`hub_code` (String)

Code identifying the hub related to the return order.

`customer` (Object)

Details of the customer returning the order.

id (String): Unique identifier for the customer.
first_name (String): First name of the customer.
last_name (String): Last name of the customer.

`order_items` (Array)

List of items in the return order.

seller_sku_code (String): Seller's SKU code.
return_reason (String): Reason for returning the item.
refunded_quantity (Number): Quantity of items refunded.
returned_quantity (Number): Quantity of items returned.
tax_percent (Float): Tax percentage applicable to the item.
tax (Float): Tax amount for the item.
uom (String): Unit of measure for the item.
selling_price (number): The selling price of the item.
unit_price (number): The unit price of the item.
total (number): The total amount for the item(subtotal + tax - discount).
discount (number): The total discount applied to the order.

`refund_status` (String)

Status of the refund process.

`return_reason` (String)

General reason for the return.

`invoice` (Object)

Details of the invoice for the return order.

invoice_number (String): Invoice number.
currency (String): Currency used for the invoice.
subtotal (Number): Subtotal amount of the invoice.
sub_total_tax_inclusive (Boolean): Indicates if subtotal includes tax.
sub_total_discount_inclusive (Boolean): Indicates if subtotal includes discount.
tax (Number): Total tax amount.
tax_percent (Number): Total tax percentage.
total (Number): Total amount payable.
total_refunded (Number): Total amount refunded.
payment_mode (String): Mode of payment for the return order.
discount (number): The total discount applied to the order.

`order_created_at` (String)

Timestamp indicating when the original order was created.

`order_url` (String)

URL to access details of the original order.

\n","urlObject":{"path":["sales-channel","public","v1","pos","returns","order"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cf7ab25d-70a8-483d-b8a8-ac0c1c825b1a","name":"Create POS Return Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"return_order_id\": \"POS-Return-Order_1\",\n \"order_id\": \"POS-Order_1\",\n \"return_order_alias\": \"RO-123\",\n \"hub_code\": \"seamlessretail\",\n \"customer\": {\n \"id\": \"CUST123\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"9876543210\",\n \"mobile_code\": \"+91\",\n \"country_code\": \"IN\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"order_items\": [\n {\n \"seller_sku_code\": \"samsung190\",\n \"return_reason\": \"Defective\",\n \"refunded_quantity\": 1,\n \"returned_quantity\": 2,\n \"uom\": \"ea\",\n \"discount\": 10,\n \"total\": 100,\n \"selling_price\": 100,\n \"unit_price\": 90\n }\n ],\n \"refund_status\": \"pending\",\n \"return_reason\": \"wrong_items\",\n \"invoice\": {\n \"invoice_number\": \"INV-123456\",\n \"currency\": \"USD\",\n \"subtotal\": 100.50,\n \"discount\": 10,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"tax\": 5.25,\n \"tax_percent\": 5,\n \"total\": 105.75,\n \"total_refunded\": 20,\n \"payment_mode\": \"Credit Card\"\n },\n \"order_created_at\": \"2023-07-28T09:00:00Z\",\n \"order_url\": \"https://example.com/orders/789012\"\n}"},"url":"{{base_url}}/sales-channel/public/v1/pos/returns/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jan 2025 12:26:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"8f3d6e45-0a84-470a-86f9-2f95d3dbe782"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9088bb888d8b6f9d-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Created POS Return Order Successfully\",\n \"meta\": null\n}"}],"_postman_id":"18042eb4-2589-4c4f-8eb0-414b4134aff2"}],"id":"e5168693-3b8a-447b-bf61-1d1bbd777a8a","_postman_id":"e5168693-3b8a-447b-bf61-1d1bbd777a8a","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Customers","item":[{"name":"Create Customer","id":"77862a08-6001-4814-995e-f0311202e7d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Mr\",\n \"first_name\": \"Shubhra\",\n \"last_name\": \"Ghosh\",\n \"email\": \"shubhra.omniful@example14.com\",\n \"mobile\": \"7075156612\",\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"gender\": \"male\",\n \"date_of_birth\": \"1990-01-01\",\n \"user_name\": \"shubhra_ghosh\",\n \"preferred_languages\": [\n \"en\",\n \"es\"\n ],\n \"alternate_contact_number\": \"09876543211\",\n \"nationality\": \"Indian\",\n \"address\": {\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 101\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"country_code\": \"SA\",\n \"state\": \"Riyadh\",\n \"zip\": \"10001\",\n \"default_address\": true,\n \"national_address_code\": \"\"\n },\n \"documents\": [\n {\n \"type\": \"passport\",\n \"number\": \"4XEC5R67VT8BY\",\n \"issue_country_code\": \"SA\",\n \"issue_date\": \"2015-06-19\",\n \"expiry_date\": \"2025-06-12\",\n \"urls\": [\n \"https://example.com/passport-front.jpg\",\n \"https://example.com/passport-back.jpg\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/customers","description":"

Required fields to create customer:

first_name: First name of the customer.
\n
address: Nested object representing customer's address details.
a. address1: Address line 1
b. city: City of the address
c. country: Country of the address.
\n
Optional Field : title : An optional field to specify the title of the individual. If provided, it must be one of the supported titles.Supported Titles:
\n
- Mr
  \n
- Mrs
  \n
- Ms
  \n
- Dr
  \n
- Prof
  \n
- Rev
  \n
- Hon
  \n
- Sir
  \n
- Lady
  \n
\n
Optional Field gender : An optional field to specify the gender of the individual. If provided, it must be one of the supported gender types.Supported Gender Types:
\n
1. male
  \n
2. female
  \n
3. other
  \n
\n

For the documents field, is optional. However, if you provide this data, please select a type from the options below

passport
\n
driving_license
\n

InternalCustomer Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
first_name	String	First name of the customer.
last_name	String	Last name of the customer.
email	String	Email address of the customer.
mobile	String	Mobile number of the customer.
country_calling_code	String	Country calling code for the mobile number.
country_code	String	Country code of the customer's address.
address	Object	Nested object representing customer's address details.

CustomerAddress Object (nested within InternalCustomer)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
address1	String	Address line 1.
address2	String	Address line 2 (optional).
city	String	City of the address.
country	String	Country of the address.
country_code	String	Country code of the address.
state	String	State or region of the address.
zip	String	ZIP or postal code of the address.
default_address	Boolean	Indicates whether this is the default address for the customer.
national_address_code	String	National address code

","urlObject":{"path":["sales-channel","public","v1","customers"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9a9ee805-0c85-438a-9385-6175554fe262","name":"Create Customer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Mr\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.do35@example.com\",\n \"mobile\": \"7124023694\",\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"seller_code\": \"SELLER123\",\n \"source\": \"website\",\n \"gender\": \"male\",\n \"date_of_birth\": \"1990-05-15\",\n \"user_name\": \"johndoe90\",\n \"preferred_languages\": [\n \"en\",\n \"es\"\n ],\n \"alternate_contact_number\": \"0987654321\",\n \"nationality\": \"American\",\n \"address\": {\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 4B\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john2.2oe@example.com\",\n \"phone\": \"7144063614\",\n \"phone_number\": \"7241063694\",\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"default\": true,\n \"city_id\": 101,\n \"state_id\": 33,\n \"country_id\": 840\n },\n \"documents\": [\n {\n \"type\": \"passport\",\n \"document_id\": \"A123456713\",\n \"issue_country_code\": \"SA\",\n \"issue_date\": \"2017-06-01\",\n \"expiry_date\": \"2025-06-01\",\n \"urls\": [\n \"https://example.com/document1.jpg\",\n \"https://example.com/document2.jpg\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Jan 2025 09:15:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"4ae4c015-b62b-4d4d-9735-4e4111041094"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9066ae3b3f74065c-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"679208bc145ceb5063577e0e\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.do35@example.com\",\n \"mobile\": \"7124023694\",\n \"country_calling_code\": \"+91\",\n \"title\": \"Mr\",\n \"gender\": \"male\",\n \"date_of_birth\": \"1990-05-15\",\n \"user_name\": \"johndoe90\",\n \"preferred_languages\": [\n \"en\",\n \"es\"\n ],\n \"alternate_contact_number\": \"0987654321\",\n \"nationality\": \"American\",\n \"country_code\": \"IN\",\n \"address\": {\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 4B\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"default_address\": true,\n \"national_address_code\": \"\"\n },\n \"documents\": [\n {\n \"type\": \"passport\",\n \"document_id\": \"A123456713\",\n \"issue_country_code\": \"sa\",\n \"issue_date\": \"2017-06-01\",\n \"expiry_date\": \"2025-06-01\",\n \"urls\": [\n \"https://example.com/document1.jpg\",\n \"https://example.com/document2.jpg\"\n ],\n \"created_at\": \"Jan 23, 2025 09:15:40 AM\",\n \"updated_at\": \"Jan 23, 2025 09:15:40 AM\"\n }\n ]\n },\n \"meta\": null\n}"}],"_postman_id":"77862a08-6001-4814-995e-f0311202e7d7"},{"name":"Get Customers","id":"1153f99f-fd84-431b-b206-c0b6f00a5346","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/customers?name=john","description":"

InternalCustomer Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
first_name	String	First name of the customer.
last_name	String	Last name of the customer.
email	String	Email address of the customer.
mobile	String	Mobile number of the customer.
country_calling_code	String	Country calling code for the mobile number.
country_code	String	Country code of the customer's address.
address	Object	Nested object representing customer's address details.

CustomerAddress Object (nested within InternalCustomer)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
address1	String	Address line 1.
address2	String	Address line 2 (optional).
city	String	City of the address.
country	String	Country of the address.
country_code	String	Country code of the address.
state	String	State or region of the address.
zip	String	ZIP or postal code of the address.
default_address	Boolean	Indicates whether this is the default address for the customer.
national_address_code	String	National address code

Search Fields :

name
\n
- Description: The name of the customer to filter by.
\n
phone
\n
- Description: The customer's phone number (general field for phone).
\n
phone_number
\n
- Description: A specific field for filtering by the customer's complete phone number.
\n
email
\n
- Description: The email address of the customer to filter by.
\n
customer_id
\n
- Description: A unique identifier for the customer to filter by.
\n
document_id
\n
- Description: The ID of the document associated with the customer.
  \n
- Note: This field must be provided together with document_type to perform a search.
  \n
\n
document_type
\n
- Description: The type of document associated with the customer (e.g., passport, driving_license).
  \n
- Note: This field must be provided together with document_id to perform a search.
  \n
\n
search_fields
\n
- Description: A list of fields to include in the search query. This allows for more flexible and specific filtering.
\n

\n","urlObject":{"path":["sales-channel","public","v1","customers"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

Search based on customer email

\n","type":"text/plain"},"key":"email","value":"john@example.com"},{"description":{"content":"

Search based on customer name

\n","type":"text/plain"},"key":"name","value":"john"},{"disabled":true,"description":{"content":"

Search based on phone number

\n","type":"text/plain"},"key":"phone_number","value":"8920638012"}],"variable":[]}},"response":[{"id":"af37cabe-6bfd-456d-b48e-d421bc17ad82","name":"Get Customers","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/customers","host":["{{base_url}}"],"path":["sales-channel","public","v1","customers"],"query":[{"key":"email","value":"john@example.com","disabled":true},{"key":"name","value":"john","disabled":true},{"key":"phone_number","value":"8920638012","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jan 2025 11:50:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"c782b755-34e3-42be-b4ed-bf9084afd771"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9088865e29e029b5-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"69396aae92ecc57f6adc8358\",\n \"code\": \"\",\n \"first_name\": \"Shubhra\",\n \"last_name\": \"Ghosh\",\n \"email\": \"shubhra.omniful@example14.com\",\n \"mobile\": \"7075156612\",\n \"country_calling_code\": \"+91\",\n \"title\": \"Mr\",\n \"gender\": \"male\",\n \"date_of_birth\": \"1990-01-01\",\n \"user_name\": \"shubhra_ghosh\",\n \"preferred_languages\": [\n \"en\",\n \"es\"\n ],\n \"search_fields\": null,\n \"alternate_contact_number\": \"09876543211\",\n \"nationality\": \"Indian\",\n \"country_code\": \"IN\",\n \"address\": {\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 101\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"state\": \"Riyadh\",\n \"zip\": \"10001\",\n \"default_address\": true,\n \"national_address_code\": \"\"\n },\n \"documents\": []\n },\n {\n \"id\": \"6925405682ba7c15d8b5f424\",\n \"code\": \"\",\n \"first_name\": \"test\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"4152637261\",\n \"country_calling_code\": \"+91\",\n \"title\": \"\",\n \"gender\": \"\",\n \"date_of_birth\": \"0001-01-01\",\n \"user_name\": \"\",\n \"preferred_languages\": null,\n \"search_fields\": null,\n \"alternate_contact_number\": \"\",\n \"nationality\": \"\",\n \"country_code\": \"IN\",\n \"address\": {\n \"address1\": \"23\",\n \"address2\": \"\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"state\": \"\",\n \"zip\": \"\",\n \"default_address\": true,\n \"national_address_code\": \"\"\n },\n \"documents\": []\n },\n {\n \"id\": \"6900991b34d70a48078f4fc6\",\n \"code\": \"\",\n \"first_name\": \"ajbda\",\n \"last_name\": \"\",\n \"email\": \"asdbsa@fs.cdc\",\n \"mobile\": \"1234567890\",\n \"country_calling_code\": \"+91\",\n \"title\": \"\",\n \"gender\": \"\",\n \"date_of_birth\": \"0001-01-01\",\n \"user_name\": \"\",\n \"preferred_languages\": null,\n \"search_fields\": null,\n \"alternate_contact_number\": \"\",\n \"nationality\": \"\",\n \"country_code\": \"IN\",\n \"address\": {\n \"address1\": \"jkbdf\",\n \"address2\": \"ads\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"state\": \"Riyadh Region\",\n \"zip\": \"\",\n \"default_address\": true,\n \"national_address_code\": \"\"\n },\n \"documents\": []\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 3\n }\n}"}],"_postman_id":"1153f99f-fd84-431b-b206-c0b6f00a5346"},{"name":"Get Customer","id":"29fb7749-dfb6-4f97-b99e-53a2b539f2f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/customers/:customer_id","description":"

InternalCustomer Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
first_name	String	First name of the customer.
last_name	String	Last name of the customer.
email	String	Email address of the customer.
mobile	String	Mobile number of the customer.
country_calling_code	String	Country calling code for the mobile number.
country_code	String	Country code of the customer's address.
address	Object	Nested object representing customer's address details.

CustomerAddress Object (nested within InternalCustomer)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
address1	String	Address line 1.
address2	String	Address line 2 (optional).
city	String	City of the address.
country	String	Country of the address.
country_code	String	Country code of the address.
state	String	State or region of the address.
zip	String	ZIP or postal code of the address.
default_address	Boolean	Indicates whether this is the default address for the customer.
national_address_code	String	National address code

","urlObject":{"path":["sales-channel","public","v1","customers",":customer_id"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"

unique identifier of the customer

\n","type":"text/plain"},"type":"any","value":"677cb5f65ec53bfcd30afceb","key":"customer_id"}]}},"response":[{"id":"e4536504-5226-4f33-ad1c-dde50864f48d","name":"Get Customer","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/customers/:customer_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","customers",":customer_id"],"variable":[{"key":"customer_id","value":"679208bc145ceb5063577e0e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jan 2025 11:50:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"408ade85-d419-4601-b1d2-50cc1aa6680b"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90888725ffecc99b-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"679208bc145ceb5063577e0e\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.do35@example.com\",\n \"mobile\": \"7124023694\",\n \"country_calling_code\": \"+91\",\n \"title\": \"Mr\",\n \"gender\": \"male\",\n \"date_of_birth\": \"1990-05-15\",\n \"user_name\": \"johndoe90\",\n \"preferred_languages\": [\n \"en\",\n \"es\"\n ],\n \"alternate_contact_number\": \"0987654321\",\n \"nationality\": \"American\",\n \"country_code\": \"IN\",\n \"address\": {\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 4B\",\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"default_address\": true,\n \"national_address_code\": \"\"\n },\n \"documents\": [\n {\n \"type\": \"passport\",\n \"document_id\": \"A123456713\",\n \"issue_country_code\": \"sa\",\n \"issue_date\": \"2017-06-01\",\n \"expiry_date\": \"2025-06-01\",\n \"urls\": [\n \"https://example.com/document1.jpg\",\n \"https://example.com/document2.jpg\"\n ],\n \"created_at\": \"Jan 23, 2025 09:15:40 AM\",\n \"updated_at\": \"Jan 23, 2025 09:15:40 AM\"\n }\n ]\n },\n \"meta\": null\n}"}],"_postman_id":"29fb7749-dfb6-4f97-b99e-53a2b539f2f0"},{"name":"Update Customer","id":"346111ea-0401-416e-8205-0468f3d06849","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Shubhra\",\n \"last_name\": \"Omniful\",\n \"email\": \"shubhra@omniful.com\",\n \"mobile\": \"7044063691\",\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"documents\": [\n {\n \"type\": \"passport\",\n \"number\": \"4XEC5R67VT8BY\",\n \"issue_country_code\": \"SA\",\n \"issue_date\": \"2016-06-19\",\n \"expiry_date\": \"2026-06-12\",\n \"urls\": [\n \"https://example.com/passport-front.jpg\",\n \"https://example.com/passport-back.jpg\"\n ]\n },\n {\n \"type\": \"driving_license\",\n \"number\": \"D5R67VT87BY\",\n \"issue_country_code\": \"SA\",\n \"issue_date\": \"2015-06-19\",\n \"expiry_date\": \"2025-06-12\",\n \"urls\": [\n \"https://example.com/passport-front.jpg\",\n \"https://example.com/passport-back.jpg\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/customers/:customer_id","description":"

InternalCustomer Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
first_name	String	First name of the customer.
last_name	String	Last name of the customer.
email	String	Email address of the customer.
mobile	String	Mobile number of the customer.
country_calling_code	String	Country calling code for the mobile number.
country_code	String	Country code of the customer's address.
address	Object	Nested object representing customer's address details.

CustomerAddress Object (nested within InternalCustomer)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
address1	String	Address line 1.
address2	String	Address line 2 (optional).
city	String	City of the address.
country	String	Country of the address.
country_code	String	Country code of the address.
state	String	State or region of the address.
zip	String	ZIP or postal code of the address.
default_address	Boolean	Indicates whether this is the default address for the customer.
national_address_code	String	National address code

","urlObject":{"path":["sales-channel","public","v1","customers",":customer_id"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"

unique identifier of the customer

\n","type":"text/plain"},"type":"any","value":"67900000f70a610be0f240e7","key":"customer_id"}]}},"response":[{"id":"f6e08452-70e2-4a8a-a234-5e6e948d02a4","name":"Update Customer","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Shubhra\",\n \"last_name\": \"Omniful\",\n \"email\": \"shubhra@omniful.com\",\n \"mobile\": \"7044063691\",\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"documents\": [\n {\n \"type\": \"passport\",\n \"number\": \"4XEC5R67VT8BY\",\n \"issue_country_code\": \"SA\",\n \"issue_date\": \"2016-06-19\",\n \"expiry_date\": \"2026-06-12\",\n \"urls\": [\n \"https://example.com/passport-front.jpg\",\n \"https://example.com/passport-back.jpg\"\n ]\n },\n {\n \"type\": \"driving_license\",\n \"number\": \"D5R67VT87BY\",\n \"issue_country_code\": \"SA\",\n \"issue_date\": \"2015-06-19\",\n \"expiry_date\": \"2025-06-12\",\n \"urls\": [\n \"https://example.com/passport-front.jpg\",\n \"https://example.com/passport-back.jpg\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/customers/:customer_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","customers",":customer_id"],"variable":[{"key":"customer_id","value":"67900000f70a610be0f240e7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jan 2025 20:21:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"f791b572-41ff-4ee6-9a73-cea381fa7d4a"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"905a024f3ce3c9b8-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success: Customer details have been successfully updated.\"\n },\n \"meta\": null\n}"}],"_postman_id":"346111ea-0401-416e-8205-0468f3d06849"}],"id":"56eba116-8014-4403-a755-5f8709a6c528","_postman_id":"56eba116-8014-4403-a755-5f8709a6c528","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Return to Sender","item":[{"name":"Create Order","id":"be5f73c2-5fa1-4626-81c5-a8366780f1a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"rtv_to_supplier_1\",\n \"hub_code\": \"Shubhra001\",\n \"recipient_details\": {\n \"type\": \"supplier\", \n \"code\": \"At-H\"\n },\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"name\": \"iPhone 15 Pro\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Main Street\",\n \"city\": \"New York\",\n \"country\": \"United States\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"123-456-7890\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"state_code\": \"NY\",\n \"country_code\": \"US\",\n \"latitude\": 40.7128,\n \"longitude\": -74.0060,\n \"national_address_code\" : \"nac_1234\"\n },\n \"shipping_address\": {\n \"address1\": \"456 Elm Street\",\n \"city\": \"Los Angeles\",\n \"country\": \"United States\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"987-654-3210\",\n \"state\": \"CA\",\n \"zip\": \"90001\",\n \"state_code\": \"CA\",\n \"country_code\": \"US\",\n \"latitude\": 34.0522,\n \"longitude\": -118.2437,\n \"national_address_code\" : \"nac_1234\"\n },\n \"order_created_at\": \"2024-09-19T07:15:25.220Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"shipping_partner_name\": \"CourierX\",\n \"shipping_partner_tag\": \"courierx123\",\n \"awb_number\": \"AWB-456\",\n \"awb_label\": \"https://example.com/awb-label.jpg\",\n \"tracking_link\": \"https://example.com/tracking/456\"\n },\n \"payment_method\": \"prepaid\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/return_to_sender/orders","description":"

⚠️ Important Notice:

\n
The \"meta_data\" field will be deprecated from the response of this API, effective February 15, 2025. Please update your integrations to accommodate this change and ensure a smooth transition.
\n

📌 Return-to-Sender Order API - Overview

The Return-to-Sender Order API is used to create return orders for SKUs that need to be sent back due to expiration, quality check failures, or incorrect items received in a purchase order.

📌 Return Type Guidelines:

Supplier Returns: Set the type to \"supplier\" and provide the supplier code.
\n
Seller Returns: Set the type to \"seller\" and provide the seller code.
\n
Other Returns: Set the type to \"other\" (no code required).
\n

📌 Additional Requirements for \"Other\" Returns:

Shipping details must be provided.
\n
Billing details are mandatory.
\n
Custom details must be included.
\n

This API ensures efficient handling of returns, helping businesses manage inventory discrepancies and streamline return processing.

Field Name	Type	Description	Required
order_id	String	A unique ID for the return order.	✓ Yes
hub_code	String	The code for the hub that handles this return.	✓ Yes
recipient_details.type	String	Specifies the type of recipient (for example, \"supplier\").	✓ Yes
recipient_details.code	String	A unique code that identifies the recipient.	✓ Yes
order_items.sku_code	String	The SKU code for the product being returned.	✓ Yes
order_items.name	String	The name of the product.	✓ Yes
order_items.display_price	Number	The original or list price of the product.	✓ Yes
order_items.selling_price	Number	The actual selling price of the product.	✓ Yes
order_items.is_substituted	Boolean	True if the product was substituted; otherwise, false.	✓ Yes
order_items.quantity	Integer	The number of units being returned.	✓ Yes
order_items.tax_percent	Number	The tax percentage applied to the product.	✓ Yes
order_items.tax	Number	The tax amount for the product.	✓ Yes
order_items.unit_price	Number	The cost per unit of the product.	✓ Yes
order_items.subtotal	Number	The subtotal for this item before tax is added.	✓ Yes
order_items.total	Number	The total cost for this item, including tax.	✓ Yes
order_items.discount	Number	The discount applied to this item.	✓ Yes
order_items.tax_inclusive	Boolean	True if the listed price already includes tax; otherwise, false.	✓ Yes
billing_address.address1	String	The first line of the billing address.	✓ Yes
billing_address.city	String	The city for the billing address.	✓ Yes
billing_address.country	String	The country for the billing address.	✓ Yes
billing_address.first_name	String	The first name of the billing contact.	✓ Yes
billing_address.last_name	String	The last name of the billing contact.	✓ Yes
billing_address.phone	String	The phone number for billing.	✓ Yes
billing_address.state	String	The state for the billing address.	✓ Yes
billing_address.zip	String	The ZIP or postal code for the billing address.	✓ Yes
billing_address.state_code	String	The state code for the billing address.	✓ Yes
billing_address.country_code	String	The country code for the billing address.	✓ Yes
billing_address.latitude	Number	The latitude coordinate of the billing address.	✓ Yes
billing_address.longitude	Number	The longitude coordinate of the billing address.	✓ Yes
billing_address.national_address_code	String	The national address code of the billing address.	X No
shipping_address.address1	String	The first line of the shipping address.	✓ Yes
shipping_address.city	String	The city for the shipping address.	✓ Yes
shipping_address.country	String	The country for the shipping address.	✓ Yes
shipping_address.first_name	String	The first name of the shipping contact.	✓ Yes
shipping_address.last_name	String	The last name of the shipping contact.	✓ Yes
shipping_address.phone	String	The phone number for shipping.	✓ Yes
shipping_address.state	String	The state for the shipping address.	✓ Yes
shipping_address.zip	String	The ZIP or postal code for the shipping address.	✓ Yes
shipping_address.state_code	String	The state code for the shipping address.	✓ Yes
shipping_address.country_code	String	The country code for the shipping address.	✓ Yes
shipping_address.latitude	Number	The latitude coordinate of the shipping address.	✓ Yes
shipping_address.longitude	Number	The longitude coordinate of the shipping address.	✓ Yes
shipping_address.national_address_code	String	The national address code of the shipping address.	X No
order_created_at	String	The date and time when the order was created (in ISO format).	✓ Yes
invoice.currency	String	The currency code for the order (for example, SAR).	✓ Yes
invoice.subtotal	Number	The subtotal amount of all items before tax is added.	✓ Yes
invoice.shipping_price	Number	The shipping cost for the order.	✓ Yes
invoice.shipping_refund	Number	The shipping amount that was refunded.	✓ Yes
invoice.tax	Number	The total tax applied to the order.	✓ Yes
invoice.discount	Number	The total discount given on the order.	✓ Yes
invoice.total	Number	The final total amount of the order.	✓ Yes
invoice.total_paid	Number	The amount that has already been paid.	✓ Yes
invoice.total_due	Number	The remaining balance that needs to be paid.	✓ Yes
invoice.total_refunded	Number	The total amount that has been refunded.	✓ Yes
invoice.payment_method	String	The payment method used (for example, credit card or cash).	✓ Yes
invoice.tax_percent	Number	The overall tax percentage applied to the order.	✓ Yes
invoice.shipping_tax	Number	The tax applied to the shipping cost.	✓ Yes
invoice.sub_total_tax_inclusive	Boolean	True if the subtotal already includes tax; otherwise, false.	✓ Yes
invoice.sub_total_discount_inclusive	Boolean	True if the subtotal already includes the discount; otherwise, false.	✓ Yes
invoice.shipping_tax_inclusive	Boolean	True if the shipping cost includes tax; otherwise, false.	✓ Yes
invoice.shipping_discount_inclusive	Boolean	True if the shipping cost includes a discount; otherwise, false.	✓ Yes
customer.first_name	String	The customer's first name.	✓ Yes
customer.last_name	String	The customer's last name.	✓ Yes
customer.mobile	String	The customer's mobile phone number.	✓ Yes
customer.mobile_code	String	The country dialing code for the customer's mobile number.	✓ Yes
customer.email	String	The customer's email address.	✓ Yes
customer.avatar	String	The URL of the customer's profile picture.	✓ Yes
customer.gender	String	The customer's gender.	✓ Yes
shipment.shipping_partner_name	String	The name of the shipping company handling the order.	✓ Yes
shipment.shipping_partner_tag	String	A short identifier for the shipping carrier.	✓ Yes
shipment.awb_number	String	The Airway Bill (AWB) number used for tracking the shipment.	✓ Yes
shipment.awb_label	String	The URL where you can view the shipment's airway bill label.	✓ Yes
shipment.tracking_link	String	The URL to track the shipment in real time.	✓ Yes
payment_method	String	The payment method used for the order.	✓ Yes
is_cash_on_delivery	Boolean	True if the order is to be paid in cash upon delivery; otherwise, false.	✓ Yes
note	String	Any extra notes or instructions related to the order.	✓ Yes

","urlObject":{"path":["sales-channel","public","v1","return_to_sender","orders"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9c9e1120-e57f-48ef-ab60-9210c417fce0","name":"Create Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"rtv_to_supplier_1\",\n \"hub_code\": \"Shubhra001\",\n \"recipient_details\": {\n \"type\": \"supplier\", \n \"code\": \"At-H\"\n },\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"name\": \"iPhone 15 Pro\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Main Street\",\n \"city\": \"New York\",\n \"country\": \"United States\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"123-456-7890\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"state_code\": \"NY\",\n \"country_code\": \"US\",\n \"latitude\": 40.7128,\n \"longitude\": -74.0060,\n \"national_address_code\" : \"nac_1234\"\n },\n \"shipping_address\": {\n \"address1\": \"456 Elm Street\",\n \"city\": \"Los Angeles\",\n \"country\": \"United States\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"987-654-3210\",\n \"state\": \"CA\",\n \"zip\": \"90001\",\n \"state_code\": \"CA\",\n \"country_code\": \"US\",\n \"latitude\": 34.0522,\n \"longitude\": -118.2437,\n \"national_address_code\" : \"nac_1234\"\n },\n \"order_created_at\": \"2024-09-19T07:15:25.220Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"shipping_partner_name\": \"CourierX\",\n \"shipping_partner_tag\": \"courierx123\",\n \"awb_number\": \"AWB-456\",\n \"awb_label\": \"https://example.com/awb-label.jpg\",\n \"tracking_link\": \"https://example.com/tracking/456\"\n },\n \"payment_method\": \"prepaid\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"meta_data\": {\n \"name\": \"Metadata\",\n \"has_options\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/return_to_sender/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 12 Oct 2024 04:53:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"b031efaa-475c-4b08-a448-b2688adb2d42"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d147cb5ffecc94f-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"order_id\": \"rtv_to_supplier_1\",\n \"status_code\": \"new_order\",\n \"hub_code\": \"Shubhra001\",\n \"customer\": {\n \"first_name\": \"Rg1\",\n \"last_name\": \"\",\n \"phone\": {\n \"mobile\": \"9876543212\",\n \"mobile_code\": \"\"\n },\n \"email\": \"shubhra@omniful.com\"\n },\n \"seller_name\": \"Shubhra\",\n \"order_alias\": \"\",\n \"order_items\": [\n {\n \"id\": \"670a00d06f0c216802e728d9\",\n \"seller_sku_code\": \"iPhone 15 Pro\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"substitute_seller_sku_codes\": null,\n \"serialised_sku_codes\": null,\n \"item_barcodes\": null,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"reason\": \"\",\n \"picked_quantity\": 0,\n \"packed_quantity\": 0,\n \"unit_price\": 699,\n \"total\": 768.9,\n \"tax_inclusive\": true,\n \"discount\": 100\n }\n ],\n \"total_item_count\": 1,\n \"total_sku_count\": 1,\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"Rg1\",\n \"last_name\": \"\",\n \"phone\": \"9876543212\",\n \"state\": \"\",\n \"zip\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"national_address_code\" : \"nac_1234\"\n },\n \"shipping_address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"Rg1\",\n \"last_name\": \"\",\n \"phone\": \"9876543212\",\n \"state\": \"\",\n \"zip\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"google_address\": \"\",\n \"google_place_id\": 0,\n \"google_place_name\": \"\",\n \"omniful_country_id\": 0,\n \"omniful_country\": \"\",\n \"omniful_state_id\": 0,\n \"omniful_state\": \"\",\n \"omniful_city_id\": 0,\n \"omniful_city\": \"\",\n \"postal_code\": \"\",\n \"google_latitude\": 0,\n \"google_longitude\": 0,\n \"google_address_category\": \"\",\n \"national_address_code\" : \"nac_1234\"\n },\n \"reason\": \"\",\n \"cancelled_reason\": \"\",\n \"sub_status\": \"\",\n \"transactions\": [\n {\n \"created_at\": \"2024-10-12T04:53:36.610797504Z\",\n \"Amount\": 699,\n \"type\": 4,\n \"card_number\": \"\",\n \"source_account\": \"\",\n \"destination_account\": \"\",\n \"status\": 2,\n \"description\": \"\"\n }\n ],\n \"slot\": {\n \"delivery_date\": \"\",\n \"start_time\": 0,\n \"end_time\": 0\n },\n \"order_created_at\": \"2024-10-12T04:53:36.595783076Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"tax_percent\": 10,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_mode\": \"\",\n \"loyalty_discount\": 0,\n \"wallet_amount\": 0\n },\n \"shipment\": {\n \"ShipmentCreatedAt\": \"0001-01-01T00:00:00Z\",\n \"order_delivered_at\": \"0001-01-01T00:00:00Z\",\n \"order_shipped_at\": \"0001-01-01T00:00:00Z\",\n \"shipping_partner_order_id\": \"\",\n \"awb_number\": \"\",\n \"shipping_partner_status\": \"\",\n \"awb_label\": \"\",\n \"shipping_partner_tag\": \"\",\n \"shipping_partner_name\": \"\",\n \"shipment_id\": \"\",\n \"shipping_options\": [\n \"manual_dispatch\",\n \"shipping_partner\"\n ],\n \"number_of_boxes\": 0\n },\n \"delivery_type\": \"normal_delivery\",\n \"payment_method\": \"Prepaid\",\n \"shipment_created_at\": \"0001-01-01T00:00:00Z\",\n \"order_shipped_at\": \"0001-01-01T00:00:00Z\",\n \"order_delivered_at\": \"0001-01-01T00:00:00Z\"\n },\n \"meta\": null\n}"}],"_postman_id":"be5f73c2-5fa1-4626-81c5-a8366780f1a7"}],"id":"5a344e89-7aaa-44b1-8994-9ab241ca7be1","description":"

📌 Return-to-Sender Order API - Overview

The Return-to-Sender Order API allows users to create a return order for SKUs that need to be sent back to the supplier.

📌 Common Use Cases:

Returning expired items.
\n
Sending back items that failed quality checks (QC).
\n
Returning incorrect SKUs received in a purchase order.
\n

This API helps ensure efficient inventory management and accurate supplier returns.

\n","_postman_id":"5a344e89-7aaa-44b1-8994-9ab241ca7be1","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Stock Transfer Request","item":[{"name":"Create Stock Transfer Request","id":"f9db298f-730c-4a81-97f5-89da46d4dc46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"7044063694\",\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"mobile_code\": \"91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"order_items\": [\n {\n \"sku_code\": \"samsung190\",\n \"quantity\": 2\n }\n ],\n \"source_hub_code\": \"Shubhra001\",\n \"destination_hub_code\": \"SHUBHRA\",\n \"sto_request_id\": \"sto_id_27651\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/sto/requests","description":"

Required Fields for Creating Stock Transfer Requests:

transfer_id (string): The unique identifier for the stock transfer (must be unique always).
\n
order_items (array of objects): An array of objects representing the items in the stock transfer.
\n
- sku_code (string): The stock keeping unit code for the item.
  \n
- quantity (integer): The quantity of the item being transferred.
  \n
\n
source_hub_code (string): The hub code from which the stock is being transferred.
\n
destination_hub_code (string): The hub code to which the stock is being transferred.
\n
sto_id (string): The unique identifier for the sales channel.
\n
customer: Customer details associated with the transfer.
\n

\n","urlObject":{"path":["sales-channel","public","v1","orders","sto","requests"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0723afec-9d77-4619-b979-43f93e5c9a47","name":"Create Stock Transfer Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3Mjk4NTQ1ODMsImp0aSI6IjQ3YTQ1NTUwLWMxMTYtNGNlYS1iNTI1LTU2ZGIwZjJmOWJiNSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6MjA2NiwiU2VsbGVySUQiOiIxMTcxIiwiVGVuYW50SUQiOiI1MTYiLCJVc2VySUQiOiIyMjE4IiwiVXNlck5hbWUiOiJzaHViaHJhIn0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.aJBR6ixI0u9aEfGNWP99pSuEBeuiWiI7mW--gJTNlZJzk6L2Nn0rlpXxlK_v5waYypa5f6_-36tAGm0SrrTA__9ryUwZ9d3Bgh4IMvwtnBn0tDk203Sxabtn0nNzBy2nDjpuN4_nyo0-CpWLUWLU_N1j8nEO9CWxUarnpg_PFRTCv72vJGxMBn9_WGRit_9yzMEG6rBixLV7BlsEOLN7_QJGn3QRNXsPMhO5wdTTpRo4_2HHUHZUU2069_FCIUpWfomGe0ObhUzTgFsHb-FPOT3B-mNdqCS3JaKiDPr5bfOroOb75aReCynux6SWiorKPP9RuhRGcoHUufSkKZOIE46Zp9Za3BNLurdrTvKBP9mGhWodP7c3rNSVy7czPgT95DUhVFIqSlHICyuJstswfs1u7R9rbhi3bh43OEKeYQwrq7CqD5t4y_YYDhVXa_08JsHKpZvvb2YnKplZAcuPtYSjqhIcM3HoB8Mnh_mkiW8a08G6yocqOVVgItdwTpNatKFeDLKs7Sd0bqerP8fZsEciEbsRybCYGERu7F6Vol9Fjn3zq7nKS5Mllas4Dl9ul_G3szmTTyftRYP6QR_5cyfWETTRYG72lR-U3ZPo2eb_teTN7N-Y3aPqr-JECabxU-mGBKOsPtGQCoU9-ISZkfC8CFarj8hzbuylwoU6J5M","disabled":true},{"key":"Cookie","value":"AWSALB=14lh8xOFr2yOobMhzHsE8KzIwuB6gdypb5yYwvqw7jpX2rc1KdV5DFtHaUOmhfLyt49SO6vrAM7z4PaKM0t6YBIltYB5LZI3hsfu+HJ4h2x6WHKNklSZj4LL8Rkb; AWSALBCORS=14lh8xOFr2yOobMhzHsE8KzIwuB6gdypb5yYwvqw7jpX2rc1KdV5DFtHaUOmhfLyt49SO6vrAM7z4PaKM0t6YBIltYB5LZI3hsfu+HJ4h2x6WHKNklSZj4LL8Rkb","disabled":true}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"7044063694\",\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"mobile_code\": \"91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"quantity\": 4\n }\n ],\n \"source_hub_code\": \"Shubhra001\",\n \"destination_hub_code\": \"SHUBHRA\",\n \"sto_request_id\": \"sto_request_id_0001\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/sto/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 05 Oct 2024 07:03:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"e96e4515-1af6-4564-bda3-c8c71d8cc0f1"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8cdb8d63f819879a-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success : The Stock Transfer Request was successfully created.\"\n },\n \"meta\": null\n}"}],"_postman_id":"f9db298f-730c-4a81-97f5-89da46d4dc46"},{"name":"Update Stock Transfer Request","id":"311281f6-19ce-4717-bc94-b755302fcb1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"action_type\": \"edit_items\", // You can edit items with edit_items; use add_items to add another SKU.\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"quantity\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/sto/requests/:sto_request_id","description":"

Required Fields for Updating Stock Transfer Requests:

action_type (string): Specifies the action to perform.
\n
- \"add_items\": To add new items to the stock transfer request.
  \n
- \"edit_items\": To edit existing items in the stock transfer request.
  \n
\n
order_items (array of objects): An array of objects representing the items in the stock transfer.
\n
- sku_code (string): The stock keeping unit code for the item.
  \n
- quantity (integer): The quantity of the item to be added or updated.
  \n
\n

\n","urlObject":{"path":["sales-channel","public","v1","orders","sto","requests",":sto_request_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"sto_request_id_0001","key":"sto_request_id"}]}},"response":[{"id":"0cad401f-32de-4ba9-9325-1161f0c8a41f","name":"Update Stock Transfer Request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3Mjk4NTQ1ODMsImp0aSI6IjQ3YTQ1NTUwLWMxMTYtNGNlYS1iNTI1LTU2ZGIwZjJmOWJiNSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6MjA2NiwiU2VsbGVySUQiOiIxMTcxIiwiVGVuYW50SUQiOiI1MTYiLCJVc2VySUQiOiIyMjE4IiwiVXNlck5hbWUiOiJzaHViaHJhIn0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.aJBR6ixI0u9aEfGNWP99pSuEBeuiWiI7mW--gJTNlZJzk6L2Nn0rlpXxlK_v5waYypa5f6_-36tAGm0SrrTA__9ryUwZ9d3Bgh4IMvwtnBn0tDk203Sxabtn0nNzBy2nDjpuN4_nyo0-CpWLUWLU_N1j8nEO9CWxUarnpg_PFRTCv72vJGxMBn9_WGRit_9yzMEG6rBixLV7BlsEOLN7_QJGn3QRNXsPMhO5wdTTpRo4_2HHUHZUU2069_FCIUpWfomGe0ObhUzTgFsHb-FPOT3B-mNdqCS3JaKiDPr5bfOroOb75aReCynux6SWiorKPP9RuhRGcoHUufSkKZOIE46Zp9Za3BNLurdrTvKBP9mGhWodP7c3rNSVy7czPgT95DUhVFIqSlHICyuJstswfs1u7R9rbhi3bh43OEKeYQwrq7CqD5t4y_YYDhVXa_08JsHKpZvvb2YnKplZAcuPtYSjqhIcM3HoB8Mnh_mkiW8a08G6yocqOVVgItdwTpNatKFeDLKs7Sd0bqerP8fZsEciEbsRybCYGERu7F6Vol9Fjn3zq7nKS5Mllas4Dl9ul_G3szmTTyftRYP6QR_5cyfWETTRYG72lR-U3ZPo2eb_teTN7N-Y3aPqr-JECabxU-mGBKOsPtGQCoU9-ISZkfC8CFarj8hzbuylwoU6J5M","disabled":true},{"key":"Cookie","value":"AWSALB=14lh8xOFr2yOobMhzHsE8KzIwuB6gdypb5yYwvqw7jpX2rc1KdV5DFtHaUOmhfLyt49SO6vrAM7z4PaKM0t6YBIltYB5LZI3hsfu+HJ4h2x6WHKNklSZj4LL8Rkb; AWSALBCORS=14lh8xOFr2yOobMhzHsE8KzIwuB6gdypb5yYwvqw7jpX2rc1KdV5DFtHaUOmhfLyt49SO6vrAM7z4PaKM0t6YBIltYB5LZI3hsfu+HJ4h2x6WHKNklSZj4LL8Rkb","disabled":true}],"body":{"mode":"raw","raw":"{\n \"action_type\": \"edit_items\", // You can edit items with edit_items; use add_items to add another SKU.\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"quantity\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/sto/requests/:sto_request_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders","sto","requests",":sto_request_id"],"variable":[{"key":"sto_request_id","value":"sto_request_id_0001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 05 Oct 2024 07:04:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"639af9c8-0731-462e-9de7-b70195e2ba8f"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8cdb8f6138431ff2-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success : The Stock Transfer Request was successfully updated.\"\n },\n \"meta\": null\n}"}],"_postman_id":"311281f6-19ce-4717-bc94-b755302fcb1c"},{"name":"Approve Stock Transfer Request","id":"ad6abaaf-3cef-4220-988f-77075d0a3dd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"quantity\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/sto/requests/:sto_request_id/approve","description":"

Required Fields for Approving Stock Transfer Requests:

order_items (array of objects): An array of objects representing the items being approved in the stock transfer.
\n
- sku_code (string): The stock keeping unit code for the item.
  \n
- quantity (integer): The quantity of the item being approved.
  \n
\n

\n","urlObject":{"path":["sales-channel","public","v1","orders","sto","requests",":sto_request_id","approve"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"sto_request_id_0001","key":"sto_request_id"}]}},"response":[{"id":"a4a7aae1-0b0d-4b7a-8934-3e4b28584025","name":"Approve Stock Transfer Request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3Mjk4NTQ1ODMsImp0aSI6IjQ3YTQ1NTUwLWMxMTYtNGNlYS1iNTI1LTU2ZGIwZjJmOWJiNSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6MjA2NiwiU2VsbGVySUQiOiIxMTcxIiwiVGVuYW50SUQiOiI1MTYiLCJVc2VySUQiOiIyMjE4IiwiVXNlck5hbWUiOiJzaHViaHJhIn0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.aJBR6ixI0u9aEfGNWP99pSuEBeuiWiI7mW--gJTNlZJzk6L2Nn0rlpXxlK_v5waYypa5f6_-36tAGm0SrrTA__9ryUwZ9d3Bgh4IMvwtnBn0tDk203Sxabtn0nNzBy2nDjpuN4_nyo0-CpWLUWLU_N1j8nEO9CWxUarnpg_PFRTCv72vJGxMBn9_WGRit_9yzMEG6rBixLV7BlsEOLN7_QJGn3QRNXsPMhO5wdTTpRo4_2HHUHZUU2069_FCIUpWfomGe0ObhUzTgFsHb-FPOT3B-mNdqCS3JaKiDPr5bfOroOb75aReCynux6SWiorKPP9RuhRGcoHUufSkKZOIE46Zp9Za3BNLurdrTvKBP9mGhWodP7c3rNSVy7czPgT95DUhVFIqSlHICyuJstswfs1u7R9rbhi3bh43OEKeYQwrq7CqD5t4y_YYDhVXa_08JsHKpZvvb2YnKplZAcuPtYSjqhIcM3HoB8Mnh_mkiW8a08G6yocqOVVgItdwTpNatKFeDLKs7Sd0bqerP8fZsEciEbsRybCYGERu7F6Vol9Fjn3zq7nKS5Mllas4Dl9ul_G3szmTTyftRYP6QR_5cyfWETTRYG72lR-U3ZPo2eb_teTN7N-Y3aPqr-JECabxU-mGBKOsPtGQCoU9-ISZkfC8CFarj8hzbuylwoU6J5M","disabled":true},{"key":"Cookie","value":"AWSALB=14lh8xOFr2yOobMhzHsE8KzIwuB6gdypb5yYwvqw7jpX2rc1KdV5DFtHaUOmhfLyt49SO6vrAM7z4PaKM0t6YBIltYB5LZI3hsfu+HJ4h2x6WHKNklSZj4LL8Rkb; AWSALBCORS=14lh8xOFr2yOobMhzHsE8KzIwuB6gdypb5yYwvqw7jpX2rc1KdV5DFtHaUOmhfLyt49SO6vrAM7z4PaKM0t6YBIltYB5LZI3hsfu+HJ4h2x6WHKNklSZj4LL8Rkb","disabled":true}],"body":{"mode":"raw","raw":"{\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"quantity\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/sto/requests/:sto_request_id/approve","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders","sto","requests",":sto_request_id","approve"],"variable":[{"key":"sto_request_id","value":"sto_request_id_0001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 05 Oct 2024 07:06:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"57773562-3a9d-4ac9-b5c1-e1ac3701025c"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8cdb912dca780575-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success : The Stock Transfer Request was successfully approved.\"\n },\n \"meta\": null\n}"}],"_postman_id":"ad6abaaf-3cef-4220-988f-77075d0a3dd6"},{"name":"Reject Stock Transfer Request","id":"43b7374a-1881-440b-b0f1-8c5fbe359f37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Product not required\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/orders/sto/requests/:sto_request_id/reject","description":"

Required Fields for Rejecting Stock Transfer Requests:

reason (string): A mandatory field that specifies the reason for rejecting the stock transfer request. This helps provide clarity on the decision.

\n","urlObject":{"path":["sales-channel","public","v1","orders","sto","requests",":sto_request_id","reject"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"sto_request_id_001","key":"sto_request_id"}]}},"response":[{"id":"eabbf07d-131a-4a81-8527-4514c848062a","name":"Reject Stock Transfer Request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3Mjk4NTQ1ODMsImp0aSI6IjQ3YTQ1NTUwLWMxMTYtNGNlYS1iNTI1LTU2ZGIwZjJmOWJiNSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6MjA2NiwiU2VsbGVySUQiOiIxMTcxIiwiVGVuYW50SUQiOiI1MTYiLCJVc2VySUQiOiIyMjE4IiwiVXNlck5hbWUiOiJzaHViaHJhIn0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.aJBR6ixI0u9aEfGNWP99pSuEBeuiWiI7mW--gJTNlZJzk6L2Nn0rlpXxlK_v5waYypa5f6_-36tAGm0SrrTA__9ryUwZ9d3Bgh4IMvwtnBn0tDk203Sxabtn0nNzBy2nDjpuN4_nyo0-CpWLUWLU_N1j8nEO9CWxUarnpg_PFRTCv72vJGxMBn9_WGRit_9yzMEG6rBixLV7BlsEOLN7_QJGn3QRNXsPMhO5wdTTpRo4_2HHUHZUU2069_FCIUpWfomGe0ObhUzTgFsHb-FPOT3B-mNdqCS3JaKiDPr5bfOroOb75aReCynux6SWiorKPP9RuhRGcoHUufSkKZOIE46Zp9Za3BNLurdrTvKBP9mGhWodP7c3rNSVy7czPgT95DUhVFIqSlHICyuJstswfs1u7R9rbhi3bh43OEKeYQwrq7CqD5t4y_YYDhVXa_08JsHKpZvvb2YnKplZAcuPtYSjqhIcM3HoB8Mnh_mkiW8a08G6yocqOVVgItdwTpNatKFeDLKs7Sd0bqerP8fZsEciEbsRybCYGERu7F6Vol9Fjn3zq7nKS5Mllas4Dl9ul_G3szmTTyftRYP6QR_5cyfWETTRYG72lR-U3ZPo2eb_teTN7N-Y3aPqr-JECabxU-mGBKOsPtGQCoU9-ISZkfC8CFarj8hzbuylwoU6J5M","disabled":true},{"key":"Cookie","value":"AWSALB=14lh8xOFr2yOobMhzHsE8KzIwuB6gdypb5yYwvqw7jpX2rc1KdV5DFtHaUOmhfLyt49SO6vrAM7z4PaKM0t6YBIltYB5LZI3hsfu+HJ4h2x6WHKNklSZj4LL8Rkb; AWSALBCORS=14lh8xOFr2yOobMhzHsE8KzIwuB6gdypb5yYwvqw7jpX2rc1KdV5DFtHaUOmhfLyt49SO6vrAM7z4PaKM0t6YBIltYB5LZI3hsfu+HJ4h2x6WHKNklSZj4LL8Rkb","disabled":true}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Product not required\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/sto/requests/:sto_request_id/reject","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders","sto","requests",":sto_request_id","reject"],"variable":[{"key":"sto_request_id","value":"sto_request_id_001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 05 Oct 2024 07:07:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"48ad16c3-90dc-409a-ad04-0483f33947f0"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8cdb9359bf10828c-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success : The Stock Transfer Request was successfully rejected.\"\n },\n \"meta\": null\n}"}],"_postman_id":"43b7374a-1881-440b-b0f1-8c5fbe359f37"},{"name":"Get Stock Transfer Requests","id":"901fb999-d114-40c8-ab09-e19c2ae1df02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/orders/sto/requests?page=1&per_page=10","description":"

Response Fields Explained

is_success (boolean): Indicates if the request was successful.
\n
status_code (integer): The HTTP status code returned by the API.
\n
data (array): Contains the list of stock transfer requests.
\n
- sto_id (string): Unique identifier for the stock transfer.
  \n
- customer (object): Information about the customer associated with the transfer.
  \n
  - first_name (string): Customer's first name.
    \n
  - last_name (string): Customer's last name.
    \n
  - mobile (string): Customer's mobile number.
    \n
  - mobile_code (string): Country calling code for the mobile number.
    \n
  - email (string): Customer's email address.
    \n
  - avatar (string): URL to the customer’s avatar image.
    \n
  - gender (string): Customer's gender.
    \n
  \n
- seller_name (string): Name of the seller associated with the transfer.
  \n
- status (string): Current status of the stock transfer request.
  \n
- source_hub (object): Information about the source hub.
  \n
  - name (string): Name of the source hub.
    \n
  - code (string): Code of the source hub.
    \n
  \n
- destination_hub (object): Information about the destination hub.
  \n
  - name (string): Name of the destination hub.
    \n
  - code (string): Code of the destination hub.
    \n
  \n
- created_at (string): Timestamp when the request was created.
  \n
- created_by (string): User who created the request.
  \n
- updated_at (string): Timestamp when the request was last updated.
  \n
- updated_by (string): User who last updated the request.
  \n
\n
meta (object): Contains pagination information.
\n
- current_page (integer): The current page number.
  \n
- last_page (integer): The total number of pages available.
  \n
- per_page (integer): The number of results per page.
  \n
- total (integer): The total number of records available.
  \n
\n

\n","urlObject":{"path":["sales-channel","public","v1","orders","sto","requests"],"host":["{{base_url}}"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"}],"variable":[]}},"response":[{"id":"0c34270e-992e-4a4c-be95-cd041f4320e6","name":"Get Stock Transfer Requests","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/sto/requests?page=1&per_page=10","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders","sto","requests"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 12 Oct 2024 04:44:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"c4eee58d-7bd3-45f2-9fc4-4801195149d9"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d146fd09e813928-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"sto_request_id\": \"sto_id_27651\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Shubhra\",\n \"status\": \"Accepted\",\n \"source_hub\": {\n \"name\": \"Shubhra\",\n \"code\": \"Shubhra001\"\n },\n \"destination_hub\": {\n \"name\": \"Shubhra Testing\",\n \"code\": \"SHUBHRA\"\n },\n \"created_at\": \"Oct 12, 2024 04:36:26 AM\",\n \"created_by\": \"Ritik\",\n \"updated_at\": \"Oct 12, 2024 04:36:46 AM\",\n \"updated_by\": \"Ritik\"\n },\n {\n \"sto_request_id\": \"sto_id_27654\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Shubhra\",\n \"status\": \"Accepted\",\n \"source_hub\": {\n \"name\": \"Shubhra\",\n \"code\": \"Shubhra001\"\n },\n \"destination_hub\": {\n \"name\": \"Shubhra Testing\",\n \"code\": \"SHUBHRA\"\n },\n \"created_at\": \"Oct 12, 2024 04:30:03 AM\",\n \"created_by\": \"Ritik\",\n \"updated_at\": \"Oct 12, 2024 04:30:38 AM\",\n \"updated_by\": \"Ritik\"\n },\n {\n \"sto_request_id\": \"sto_request_id_001\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Shubhra\",\n \"status\": \"Cancelled\",\n \"source_hub\": {\n \"name\": \"Shubhra\",\n \"code\": \"Shubhra001\"\n },\n \"destination_hub\": {\n \"name\": \"Shubhra Testing\",\n \"code\": \"SHUBHRA\"\n },\n \"created_at\": \"Oct 05, 2024 07:07:21 AM\",\n \"created_by\": \"Ritik\",\n \"updated_at\": \"Oct 05, 2024 07:07:35 AM\",\n \"updated_by\": \"Ritik\"\n },\n {\n \"sto_request_id\": \"sto_request_id_0001\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Shubhra\",\n \"status\": \"Accepted\",\n \"source_hub\": {\n \"name\": \"Shubhra\",\n \"code\": \"Shubhra001\"\n },\n \"destination_hub\": {\n \"name\": \"Shubhra Testing\",\n \"code\": \"SHUBHRA\"\n },\n \"created_at\": \"Oct 05, 2024 07:03:31 AM\",\n \"created_by\": \"Ritik\",\n \"updated_at\": \"Oct 05, 2024 07:06:06 AM\",\n \"updated_by\": \"Ritik\"\n },\n {\n \"sto_request_id\": \"sales_channel_31\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Shubhra\",\n \"status\": \"Pending\",\n \"source_hub\": {\n \"name\": \"Shubhra\",\n \"code\": \"Shubhra001\"\n },\n \"destination_hub\": {\n \"name\": \"Shubhra Testing\",\n \"code\": \"SHUBHRA\"\n },\n \"created_at\": \"Sep 28, 2024 07:44:35 AM\",\n \"created_by\": \"Ritik\",\n \"updated_at\": \"Sep 28, 2024 07:44:35 AM\",\n \"updated_by\": \"Ritik\"\n },\n {\n \"sto_request_id\": \"sales_channel_30\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Shubhra\",\n \"status\": \"Pending\",\n \"source_hub\": {\n \"name\": \"Shubhra\",\n \"code\": \"Shubhra001\"\n },\n \"destination_hub\": {\n \"name\": \"Shubhra Testing\",\n \"code\": \"SHUBHRA\"\n },\n \"created_at\": \"Sep 28, 2024 07:42:19 AM\",\n \"created_by\": \"Ritik\",\n \"updated_at\": \"Sep 28, 2024 07:42:19 AM\",\n \"updated_by\": \"Ritik\"\n },\n {\n \"sto_request_id\": \"sales_channel_29\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Shubhra\",\n \"status\": \"Pending\",\n \"source_hub\": {\n \"name\": \"Shubhra\",\n \"code\": \"Shubhra001\"\n },\n \"destination_hub\": {\n \"name\": \"Shubhra Testing\",\n \"code\": \"SHUBHRA\"\n },\n \"created_at\": \"Sep 28, 2024 06:45:59 AM\",\n \"created_by\": \"Ritik\",\n \"updated_at\": \"Sep 28, 2024 06:45:59 AM\",\n \"updated_by\": \"Ritik\"\n },\n {\n \"sto_request_id\": \"sto_id_2\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Shubhra\",\n \"status\": \"Cancelled\",\n \"source_hub\": {\n \"name\": \"Shubhra\",\n \"code\": \"Shubhra001\"\n },\n \"destination_hub\": {\n \"name\": \"Shubhra Testing\",\n \"code\": \"SHUBHRA\"\n },\n \"created_at\": \"Sep 26, 2024 11:08:45 AM\",\n \"created_by\": \"Ritik\",\n \"updated_at\": \"Sep 26, 2024 11:09:05 AM\",\n \"updated_by\": \"Ritik\"\n },\n {\n \"sto_request_id\": \"sto_id_1\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Shubhra\",\n \"status\": \"Accepted\",\n \"source_hub\": {\n \"name\": \"Shubhra\",\n \"code\": \"Shubhra001\"\n },\n \"destination_hub\": {\n \"name\": \"Shubhra Testing\",\n \"code\": \"SHUBHRA\"\n },\n \"created_at\": \"Sep 26, 2024 10:59:31 AM\",\n \"created_by\": \"Ritik\",\n \"updated_at\": \"Sep 26, 2024 11:07:02 AM\",\n \"updated_by\": \"Ritik\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 10,\n \"total\": 9\n }\n}"}],"_postman_id":"901fb999-d114-40c8-ab09-e19c2ae1df02"},{"name":"Get Stock Transfer Request","id":"9b072b16-ce13-4c36-b0cd-d514c448281d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/orders/sto/requests/:sto_request_id","description":"

Response Fields Explained

is_success (boolean): Indicates if the request was successful.
\n
status_code (integer): The HTTP status code returned by the API.
\n
data (object): Contains details about the stock transfer request.
\n
- sto_id (string): Unique identifier for the stock transfer.
  \n
- customer (object): Information about the customer associated with the transfer.
  \n
  - first_name (string): Customer's first name.
    \n
  - last_name (string): Customer's last name.
    \n
  - mobile (string): Customer's mobile number.
    \n
  - mobile_code (string): Country calling code for the mobile number.
    \n
  - email (string): Customer's email address.
    \n
  - avatar (string): URL to the customer’s avatar image.
    \n
  - gender (string): Customer's gender.
    \n
  \n
- seller_name (string): Name of the seller associated with the transfer.
  \n
- status (string): Current status of the stock transfer request (e.g., \"Accepted\").
  \n
- source_hub (object): Information about the source hub.
  \n
  - name (string): Name of the source hub.
    \n
  - code (string): Code of the source hub.
    \n
  \n
- destination_hub (object): Information about the destination hub.
  \n
  - name (string): Name of the destination hub.
    \n
  - code (string): Code of the destination hub.
    \n
  \n
- order_items (array): List of items in the stock transfer.
  \n
  - name (string): Name of the item.
    \n
  - sku_code (string): SKU code of the item.
    \n
  - quantity (integer): Quantity of the item being transferred.
    \n
  \n
- created_at (string): Timestamp when the request was created.
  \n
- created_by (string): User who created the request.
  \n
- updated_at (string): Timestamp when the request was last updated.
  \n
- updated_by (string): User who last updated the request.
  \n
\n
meta (object or null): Any additional metadata related to the request; null if not applicable.
\n

\n","urlObject":{"path":["sales-channel","public","v1","orders","sto","requests",":sto_request_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"sto_id_27651","key":"sto_request_id"}]}},"response":[{"id":"0dbd284c-d477-41bf-87cd-b2c77a1c8880","name":"Get Stock Transfer Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/sto/requests/:sto_request_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders","sto","requests",":sto_request_id"],"variable":[{"key":"sto_request_id","value":"sto_id_27651"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 12 Oct 2024 04:45:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"e52c48c5-4306-4fb1-a09a-cce6e3efce77"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d1470763f153928-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"sto_request_id\": \"sto_id_27651\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Shubhra\",\n \"status\": \"Accepted\",\n \"source_hub\": {\n \"name\": \"Shubhra\",\n \"code\": \"Shubhra001\"\n },\n \"destination_hub\": {\n \"name\": \"Shubhra Testing\",\n \"code\": \"SHUBHRA\"\n },\n \"order_items\": [\n {\n \"name\": \"samsung190\",\n \"sku_code\": \"samsung190\",\n \"quantity\": 2\n }\n ],\n \"created_at\": \"Oct 12, 2024 04:36:26 AM\",\n \"created_by\": \"Ritik\",\n \"updated_at\": \"Oct 12, 2024 04:36:46 AM\",\n \"updated_by\": \"Ritik\"\n },\n \"meta\": null\n}"}],"_postman_id":"9b072b16-ce13-4c36-b0cd-d514c448281d"}],"id":"9abad3d2-4679-4d43-acad-04e6ecc08f94","_postman_id":"9abad3d2-4679-4d43-acad-04e6ecc08f94","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Stock Transfer Order","item":[{"name":"GetStockOrder","id":"3758aeaa-c444-4263-b93f-b192a4054647","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/orders/sto/:sto_id","description":"

STO Order Details Response Payload

Root Level Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
is_success	Boolean	Indicates whether the API request was successful
status_code	Integer	HTTP status code returned by the API
data	Object	Contains stock transfer order details
meta	Object	Null

data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
seller_name	String	Name of the seller
sto_number	String	Unique Stock Transfer Order number
status	String	Current status of the STO (e.g., Received)
total_amount	Number	Total monetary value of the STO
currency	String	Currency code (e.g., SAR)
created_at	String (ISO)	Timestamp when the STO was created
created_by	String	User who created the STO
updated_at	String (ISO)	Timestamp of the last update
updated_by	String	Null

order_details Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
quantity	Integer	Total quantity in the STO
ordered_quantity	Integer	Quantity ordered
received_quantity	Integer	Quantity received
packed_quantity	Integer	Quantity packed
total_sku_count	Integer	Total number of SKUs in the STO

stock_transfer_order_items Array

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
stock_transfer_order_items	Array	List of items in the STO

Item Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
quantity	Integer	Quantity ordered for the SKU
received_quantity	Integer	Quantity received for the SKU
packed_quantity	Integer	Quantity packed for the SKU
unit_price	Number	Unit price of the SKU
sku	Object	SKU details

sku Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
name	String	Name of the SKU
seller_sku_id	String	Unique identifier of the SKU
seller_sku_code	String	Seller-defined SKU code
package_type	String	Packaging type (e.g., ea)

","urlObject":{"path":["sales-channel","public","v1","orders","sto",":sto_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"STO_1764135531107253595_22","key":"sto_id"}]}},"response":[{"id":"1727eae0-4bfe-400e-a49a-6f8e5d63b680","name":"GetStockOrder","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/sto/:sto_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders","sto",":sto_id"],"variable":[{"key":"sto_id","value":"STO_1764135531107253595_22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 12 Oct 2024 04:42:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"64a36dac-8bc4-47d2-a34c-b7466ace0362"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d146c2a9e623b4d-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"seller_name\": \"abc\",\n \"source_hub\": {\n \"name\": \"Dhruv Location On\",\n \"type\": \"warehouse\",\n \"code\": \"locon\"\n },\n \"destination_hub\": {\n \"name\": \"Dhruv Location Off\",\n \"type\": \"warehouse\",\n \"code\": \"locoff\"\n },\n \"order_details\": {\n \"quantity\": 0,\n \"ordered_quantity\": 0,\n \"received_quantity\": 0,\n \"packed_quantity\": 0,\n \"total_sku_count\": 0\n },\n \"sto_number\": \"STO_1764135531107253595_22\",\n \"status\": \"Recieved\",\n \"stock_transfer_order_items\": [\n {\n \"sku\": {\n \"name\": \"uiaasdj\",\n \"seller_sku_id\": \"68b57ec20047d0a1b5247698\",\n \"seller_sku_code\": \"6302592\",\n \"package_type\": \"ea\"\n },\n \"quantity\": 1,\n \"received_quantity\": 1,\n \"packed_quantity\": 1,\n \"unit_price\": 0\n }\n ],\n \"total_amount\": 0,\n \"currency\": \"SAR\",\n \"created_at\": \"2025-11-26T13:05:44.517988Z\",\n \"created_by\": \"Dhruv Mishra\",\n \"updated_at\": \"2025-11-26T13:13:37.392618Z\",\n \"updated_by\": null\n },\n \"meta\": null\n}"}],"_postman_id":"3758aeaa-c444-4263-b93f-b192a4054647"},{"name":"GetStockOrders","id":"48bc3ba0-8a9b-4da2-8ba7-4fab480b9e10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/orders/sto/hubs/:hub_code?page=1&per_page=100&sto_request_ids=sto_id_27651","description":"

Get Stock Transfer Orders API Documentation

Overview

This API endpoint retrieves detailed information about stock transfer orders and requires a valid destination hub code—the hub specified in the stock transfer request where receiving will occur—which must be powered through the Omniful system. You can also use filters to narrow down the results. The available filters are:

sto_request_id: Filter by a single stock transfer request ID.
\n
sto_request_ids: Filter by multiple stock transfer request IDs.
\n
sto_number: Filter by a single stock transfer order number.
\n
sto_numbers: Filter by multiple stock transfer order numbers.
\n

Response Fields Explained

Field Name	Type	Description
is_success	Boolean	Indicates whether the API request was successful.
status_code	Integer	The HTTP status code returned by the API.
data	Object	Contains detailed information about the stock transfer order.
data.sto_id	String	The unique identifier for the stock transfer order.
data.customer	Object	Information about the customer associated with the transfer.
data.customer.first_name	String	The customer's first name.
data.customer.last_name	String	The customer's last name.
data.customer.mobile	String	The customer's mobile number.
data.customer.mobile_code	String	The country calling code for the customer's mobile number.
data.customer.email	String	The customer's email address.
data.customer.avatar	String	URL to the customer's avatar image.
data.customer.gender	String	The customer's gender.
data.seller_name	String	The name of the seller handling the transfer.
data.status	String	The current status of the stock transfer order (for example, \"Accepted\").
data.source_hub	Object	Details about the hub from which the stock is being transferred.
data.source_hub.name	String	The name of the source hub.
data.source_hub.code	String	The code of the source hub.
data.destination_hub	Object	Details about the hub where the stock is being sent.
data.destination_hub.name	String	The name of the destination hub.
data.destination_hub.code	String	The code of the destination hub.
data.order_items	Array	A list of items included in the stock transfer order.
data.order_items.name	String	The name of the item.
data.order_items.sku_code	String	The SKU code for the item.
data.order_items.quantity	Integer	The quantity of the item being transferred.
data.created_at	String	The timestamp when the request was created (in ISO format).
data.created_by	String	The name of the user who created the request.
data.updated_at	String	The timestamp when the request was last updated (in ISO format).
data.updated_by	String	The name of the user who last updated the request.
meta	Object	Additional metadata, such as pagination details; null if not applicable.

","urlObject":{"path":["sales-channel","public","v1","orders","sto","hubs",":hub_code"],"host":["{{base_url}}"],"query":[{"description":{"content":"

Pagination

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

pagination of data to show per page.

\n","type":"text/plain"},"key":"per_page","value":"100"},{"disabled":true,"description":{"content":"

Unique Identifier for the STO Id you want to fetch data for.

\n","type":"text/plain"},"key":"sto_request_id","value":"sto_id_27651"},{"description":{"content":"

Unique Identifiers for the STO IDs you want to fetch data for.

\n","type":"text/plain"},"key":"sto_request_ids","value":"sto_id_27651"}],"variable":[{"description":{"content":"

Unique identifier of the HUB for which you want to view Stock Transfer Orders.

\n","type":"text/plain"},"type":"any","value":"SHUBHRA","key":"hub_code"}]}},"response":[{"id":"d5994a82-d80d-48b1-b0a9-dc30b6a5d330","name":"GetStockOrders","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/orders/sto/hubs/:hub_code?page=1&per_page=100","host":["{{base_url}}"],"path":["sales-channel","public","v1","orders","sto","hubs",":hub_code"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"100"},{"key":"sto_request_id","value":"sto_id_27651","disabled":true},{"key":"sto_request_ids","value":"sto_id_27651","disabled":true}],"variable":[{"key":"hub_code","value":"locoff"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 12 Oct 2024 04:43:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"f7ece9e0-f2bc-4a26-aa73-965de6494ad8"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d146dbb48d48f2c-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"sto_request_id\": \"STO_1764135531107253595_22\",\n \"sto_id\": \"STO_1764135531107253595_22\",\n \"seller_name\": \"abc\",\n \"destination_hub_code\": \"locoff\",\n \"source_hub_code\": \"locon\",\n \"sto_number\": \"STO_1764135531107253595_22\",\n \"status\": \"Recieved\",\n \"awb\": \"646017641623449121\",\n \"shipping_partner_tag\": \"manual\",\n \"created_at\": \"Nov 26, 2025 01:05:44 PM\",\n \"created_by\": \"Dhruv Mishra\",\n \"updated_at\": \"Nov 26, 2025 01:13:37 PM\",\n \"updated_by\": null,\n \"source_hub\": {\n \"name\": \"Dhruv Location On\",\n \"type\": \"warehouse\",\n \"code\": \"locon\"\n },\n \"destination_hub\": {\n \"name\": \"Dhruv Location Off\",\n \"type\": \"warehouse\",\n \"code\": \"locoff\"\n },\n \"number_of_items\": 1,\n \"packed_quantity\": 1,\n \"is_delivered\": true,\n \"received_quantity\": 1\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"}],"_postman_id":"48bc3ba0-8a9b-4da2-8ba7-4fab480b9e10"}],"id":"3db2046c-64e6-4998-a4af-d67573dc85d4","_postman_id":"3db2046c-64e6-4998-a4af-d67573dc85d4","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Seller Webhook Events","item":[{"name":"Order Create Event","id":"22ce8b18-2318-4044-898a-d35be5fc92f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"webhook-secret-key","value":"","type":"text"},{"key":"webhook-event","value":"order.create.event","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event_name\": \"order.create.event\",\n \"data\": {\n \"order_id\": \"test-omniful_65_28\",\n \"order_alias\": \"shubhra-alias\",\n \"omniful_order_id\": \"67ad762d8daa01cfd78d2fdc\",\n \"seller_code\": \"5917\",\n \"order_status\": \"created\",\n \"hub_code\": \"HUB00851\",\n \"sales_channel\": {\n \"name\": \"Shopify\",\n \"tag\": \"shopify\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/sales-channel/shopify-logo.svg\"\n },\n \"order_items\": [\n {\n \"sku_code\": \"SKU-TV-123\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"total\": 1,\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"custom_labels\": [\n \"custom_manual1\",\n \"custom_manual2\",\n \"custom_manual3\"\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": \"24.7136\",\n \"longitude\": \"46.6753\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-123456789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"02\",\n \"country_code\": \"SA\",\n \"latitude\": \"21.4225\",\n \"longitude\": \"39.8262\",\n \"national_address_code\": \"\"\n },\n \"slot\": {\n \"delivery_date\": \"12012025\",\n \"start_time\": 1600,\n \"end_time\": 2359\n },\n \"order_created_at\": \"2025-02-13T04:33:48.991Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"cod_fee\", // cod_fee, return_fee, return_shipment_fee, shipment_fee, platform_fee\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"exchange_rate\": {\n \"order_currency\": \"OMR\",\n \"store_currency\": \"SAR\",\n \"rate\": 9.754026647524976\n }\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+966-1234567890\",\n \"mobile_code\": \"+966\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\"\n },\n \"shipment\": {\n \"shipment_created_at\": \"0001-01-01T00:00:00Z\",\n \"order_delivered_at\": \"0001-01-01T00:00:00Z\",\n \"order_shipped_at\": \"0001-01-01T00:00:00Z\",\n \"delivery_status\": \"\",\n \"courier_partner\": {\n \"name\": \"\",\n \"tag\": \"\"\n }\n },\n \"payment_method\": \"prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"type\": \"b2b\",\n \"tags\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"Your-Webhook-URL","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"host":["Your-Webhook-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"22ce8b18-2318-4044-898a-d35be5fc92f7"},{"name":"Order Update Event","id":"77b4e1f0-e3d6-4684-8b0c-36d3491562c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"webhook-secret-key","value":"","type":"text"},{"key":"webhook-event","value":"order.update.event","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event_name\": \"order.update.event\",\n \"data\": {\n \"id\": \"68932b510fa4db33df655ef6\",\n \"order_id\": \"Testing-bulk-109\",\n \"order_alias\": \"Ref09\",\n \"omniful_order_id\": \"68932b510fa4db33df655ef6\",\n \"seller_code\": \"N-SELLER\",\n \"order_status\": \"new_order\",\n \"store_name\": \"\",\n \"hub_code\": \"omslocationof\",\n \"sales_channel\": {\n \"name\": \"Shopify\",\n \"tag\": \"shopify\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/sales-channel/shopify-logo.svg\"\n },\n \"order_items\": [\n {\n \"sku_code\": \"pen\",\n \"name\": \"\",\n \"display_price\": 150,\n \"selling_price\": 125,\n \"item_barcodes\": null,\n \"quantity\": 1,\n \"picked_quantity\": 0,\n \"packed_quantity\": 0,\n \"tax_percent\": 10,\n \"tax\": 2.5,\n \"unit_price\": 75,\n \"subtotal\": 0,\n \"total\": 150,\n \"discount\": 108,\n \"tax_inclusive\": false,\n \"sales_channel_order_item_id\": \"68932b510fa4db33df655ef5\"\n }\n ],\n \"total\": 1,\n \"labels\": [\n \"\"\n ],\n \"billing_address\": {\n \"address1\": \"134 Main St\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John Doe\",\n \"phone\": \"+966-597014791\",\n \"state\": \"SA\",\n \"country_code\": \"SA\",\n \"latitude\": \"0\",\n \"longitude\": \"0\"\n },\n \"shipping_address\": {\n \"address1\": \"134 Main St\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John Doe\",\n \"phone\": \"+966-597014791\",\n \"state\": \"SA\",\n \"state_code\": \"01\",\n \"country_code\": \"SA\",\n \"latitude\": \"0\",\n \"longitude\": \"0\"\n },\n \"slot\": {\n \"delivery_date\": \"25082025\"\n },\n \"order_created_at\": \"2025-08-06T10:15:45.713Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 150,\n \"shipping_price\": 36,\n \"shipping_refund\": 0,\n \"tax\": 2.5,\n \"discount\": 16,\n \"total\": 15,\n \"total_paid\": 15,\n \"payment_mode\": \"prepaid\",\n \"loyalty_discount\": 11,\n \"tax_percent\": 16.66,\n \"shipping_tax\": 15,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": true,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [],\n \"total_refunded\": 0,\n \"additional_charges\": [],\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"first_name\": \"John Doe\",\n \"last_name\": \"shang\",\n \"mobile\": \"+966-597014791\",\n \"mobile_code\": \"+966\",\n \"country_code\": \"SA\",\n \"country\": \"Saudi Arabia\",\n \"email\": \"john.doe@example.com\"\n },\n \"shipment\": {\n \"shipment_created_at\": \"\",\n \"order_delivered_at\": \"\",\n \"order_shipped_at\": \"\",\n \"awb_number\": \"\",\n \"awb_label\": \"\",\n \"tracking_url\": \"\",\n \"delivery_status\": \"\",\n \"shipping_partner_tag\": \"\",\n \"shipping_partner_name\": \"\",\n \"shipping_partner\": \"\",\n \"number_of_boxes\": 0,\n \"weight\": 0,\n \"remarks\": \"\",\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"payment_method\": \"prepaid\",\n \"is_cash_on_delivery\": false,\n \"cancel_reason\": \"\",\n \"partial_picking\": false,\n \"require_shipping\": false,\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"\",\n \"no_of_boxes\": 0,\n \"meta_data\": {\n \"on_hold_inventory_reservation_reasons\": [\n \"inventory_not_present\"\n ],\n \"s3_file_uri\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/orders/bulk-csv/7a0f5c4572368a7fd8504fc78568c6891754475218.text/csv\"\n },\n \"type\": \"b2c\",\n \"tags\": [\n {\n \"id\": \"6950f325c37dff5880ed5bf6\",\n \"name\": \"temp1\",\n \"color\": \"#222222\"\n },\n {\n \"id\": \"698c583b9e19bccca80669ae\",\n \"name\": \"OmniShip test\",\n \"color\": \"#222222\"\n }\n ],\n \"parent_order_id\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"Your-Webhook-URL","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"host":["Your-Webhook-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"77b4e1f0-e3d6-4684-8b0c-36d3491562c1"},{"name":"Order Shipment Create Event","id":"fe944ce1-a624-42fa-b10f-03df22ad962d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"webhook-secret-key","value":"","type":"text"},{"key":"webhook-event","value":"order.shipment.event","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event_name\": \"order.shipment.event\",\n \"data\": {\n \"order_id\": \"STO_1739423806322146097_406\",\n \"order_alias\": \"\",\n \"omniful_order_id\": \"67ad80574ed594fed25d4947\",\n \"seller_code\": \"5917\",\n \"order_status\": \"ready_to_ship\",\n \"hub_code\": \"HUB00851\",\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"quantity\": 10,\n \"picked_quantity\": 10,\n \"packed_quantity\": 10\n }\n ],\n \"total\": 10,\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"custom_labels\": [\n \"custom_manual1\",\n \"custom_manual2\",\n \"custom_manual3\"\n ],\n \"billing_address\": {\n \"address1\": \"Riyadh\",\n \"address2\": \"Al Olaya\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Location Inventory On\",\n \"phone\": \"+966-7044063694\",\n \"state\": \"Riyadh Region\",\n \"zip\": \"12251\",\n \"country_code\": \"SA\",\n \"latitude\": \"24.713552474975586\",\n \"longitude\": \"46.675296783447266\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"Riyadh\",\n \"address2\": \"Al Olaya\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Location Inventory On\",\n \"phone\": \"+966-7044063694\",\n \"state\": \"Riyadh Region\",\n \"zip\": \"12251\",\n \"country_code\": \"SA\",\n \"latitude\": \"24.713552474975586\",\n \"longitude\": \"46.675296783447266\",\n \"national_address_code\": \"\"\n },\n \"slot\": {},\n \"order_created_at\": \"2025-02-13T05:17:11.006Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 0,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"total\": 0,\n \"total_paid\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"cod_fee\", // cod_fee, return_fee, return_shipment_fee, shipment_fee, platform_fee\n \"value\": 0,\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"exchange_rate\": {\n \"order_currency\": \"OMR\",\n \"store_currency\": \"SAR\",\n \"rate\": 9.754026647524976\n }\n },\n \"customer\": {\n \"first_name\": \"Arko\",\n \"mobile\": \"+966-544063694\",\n \"mobile_code\": \"+966\"\n },\n \"shipment\": {\n \"shipment_created_at\": \"2025-02-13T05:20:30.854253448Z\",\n \"order_delivered_at\": \"0001-01-01T00:00:00Z\",\n \"order_shipped_at\": \"0001-01-01T00:00:00Z\",\n \"awb_number\": \"22181739424030\",\n \"delivery_status\": \"ready_to_ship\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"number_of_boxes\": 1,\n \"weight\": 1,\n \"shipping_account\": {\n \"id\": \"c79430ae-2f7b-4452-8f05-b9d2ba20ffec\",\n \"name\": \"example\"\n },\n \"courier_partner\": {\n \"name\": \"\",\n \"tag\": \"\"\n }\n },\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"type\": \"sto\",\n \"tags\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"Your-Webhook-URL","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"host":["Your-Webhook-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe944ce1-a624-42fa-b10f-03df22ad962d"},{"name":"Stock Transfer Order Request Approve Event","id":"8c731c56-557c-4285-86dc-7ad54cb1af1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"webhook-secret-key","value":"","type":"text"},{"key":"webhook-event","value":"order.stock_transfer_request.event","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event_name\": \"sto.request-approve.event\",\n \"data\": {\n \"sto_request_id\": \"sto_id_1ec\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\"\n },\n \"seller\": {\n \"name\": \"abc\",\n \"code\": \"974\"\n },\n \"status\": \"accepted\",\n \"source_hub\": {\n \"name\": \"Dhruv Location Off\",\n \"code\": \"locoff\",\n \"type\": \"warehouse\"\n },\n \"destination_hub\": {\n \"name\": \"Dhruv Location On\",\n \"code\": \"locon\",\n \"type\": \"warehouse\"\n },\n \"order_items\": [\n {\n \"sku_code\": \"6302592\",\n \"quantity\": 2,\n \"approved_quantity\": 2\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"Your-Webhook-URL","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"host":["Your-Webhook-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c731c56-557c-4285-86dc-7ad54cb1af1d"},{"name":"Stock Transfer Order Request Recieved Event","id":"ee2802b7-ff4a-45b8-8298-48dc42a5ae6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"webhook-secret-key","value":"","type":"text"},{"key":"webhook-event","value":"order.stock_transfer_request.event","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event_name\": \"sto.received.event\",\n \"data\": {\n \"sto_request_id\": \"sto_id_1ec\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-7044063694\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\"\n },\n \"seller\": {\n \"name\": \"abc\",\n \"code\": \"974\"\n },\n \"status\": \"accepted\",\n \"source_hub\": {\n \"name\": \"Dhruv Location Off\",\n \"code\": \"locoff\",\n \"type\": \"warehouse\"\n },\n \"destination_hub\": {\n \"name\": \"Dhruv Location On\",\n \"code\": \"locon\",\n \"type\": \"warehouse\"\n },\n \"order_items\": [\n {\n \"sku_code\": \"6302592\",\n \"quantity\": 2,\n \"approved_quantity\": 2\n }\n ],\n \"received_at\": \"2026-02-05T10:21:20.25Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"Your-Webhook-URL","description":"

\n
Note: STO event webhooks are only triggered when the STO is generated by a sales channel.
\n

In the purchase order webhook payload, a maximum of 200 items will be included.

If the purchase order contains more than 200 items, the remaining items must be retrieved using the APIs.

In the purchase order webhook payload, a maximum of 200 items will be included.

If the purchase order contains more than 200 items, the remaining items must be retrieved using the APIs.

entity_identifier, adjusted_quantity and reason are included only for inventory adjustment webhook events (conversion or dispose). These webhook events are triggered when a user performs an inventory adjustment in the Hub Operations app using the “Adjust Inventory” feature:

dispose — generated when a user disposes inventory.
\n
conversion — generated when a user marks inventory as failed.
\n

📌 Webhook Payload Reference

Overview

This section provides sample webhook payloads for all available webhooks. You can refer to these payloads to understand the structure and expected data for each event.

🔹 How to Use

Review the sample webhook payloads to understand the data format.
\n
Use them as a reference when setting up webhook listeners in your system.
\n
Ensure your application can handle incoming webhook requests and parse the payload accordingly.
\n

For detailed webhook event descriptions and payload samples, refer to the following Documentation. 🚀

🔐 Custom Headers

Custom HTTP headers can be added to webhook events to support advanced use cases such as authentication, request routing, or internal tracking.

✨ Key Capabilities

Add up to 2 custom headers per webhook event
\n
Each header consists of a key–value pair
\n
These headers are sent with every webhook request for the configured event
\n

📏 Constraints

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Limit
Maximum custom headers	2
Header key max length	50 characters
Header value max length	4500 characters

🚫 Restricted Header Keys

For security and system integrity reasons, custom header keys must NOT use any of the following reserved headers:

x-omniful-request-id\nx-omniful-channel-name\nwebhook-secret-key\nwebhook-event\ntracestate\ntraceparent\nnewrelic\n

📘 Status Code Reference (order_status)

✅ Order Status Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Label	Status Code
On Hold	`on_hold`
Hub Assigned	`hub_assigned`
New Order	`new_order`
Picked	`picked`
Packed	`packed`
Ready To Ship	`ready_to_ship`
Shipped	`shipped`
Delivered	`delivered`
Cancelled	`cancelled`

🔁 Return Status Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Label	Status Code
New Return Request	`new_return_request`
Return Request Approved	`return_request_approved`
Return Request Rejected	`return_request_rejected`
Return Order Initiated	`return_initiated`
Return Shipment Created	`return_shipment_created`
Return Order Arrived At Hub	`return_order_arrived_at_hub`
Return Order QC Processed	`return_order_qc_processed`
Return Order Picked Up	`return_order_picked_up`
Return Order Cancelled	`return_order_cancelled`
Return Order Completed	`return_order_completed`
Return To Origin	`return_to_origin`

","_postman_id":"3cd8c4e8-1fcd-442a-9ffe-c2c77c5b546a","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Get Webhooks","id":"227aba2a-123c-4230-b83e-5dadbf41c99d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/webhooks","urlObject":{"path":["sales-channel","public","v1","webhooks"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5612f532-aced-4793-9a9a-1cf9d7efdf10","name":"Get Webhooks","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Oct 2024 12:07:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"60d5675a-86db-4615-85d9-30b09c604619"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d79d893fcb420c0-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"topic\": \"product_webhook\",\n \"webhook_url\": \"https://webhook.site/e229dfa0-66f6-4be8-8cd4-e95674888431\",\n \"is_enable\": true\n },\n {\n \"topic\": \"inventory_webhook\",\n \"webhook_url\": \"https://webhook.site/e229dfa0-66f6-4be8-8cd4-e95674888431\",\n \"is_enable\": true\n },\n {\n \"topic\": \"delivery_zone_webhook\",\n \"webhook_url\": \"https://webhook.site/e229dfa0-66f6-4be8-8cd4-e95674888431\",\n \"is_enable\": true\n },\n {\n \"topic\": \"purchase_order_webhook\",\n \"webhook_url\": \"https://webhook.site/e229dfa0-66f6-4be8-8cd4-e95674888431\",\n \"is_enable\": true\n },\n {\n \"topic\": \"shipment_order_webhook\",\n \"webhook_url\": \"https://webhook.site/e229dfa0-66f6-4be8-8cd4-e95674888431\",\n \"is_enable\": true\n },\n {\n \"topic\": \"stock_transfer_request_webhook\",\n \"webhook_url\": \"https://webhook.site/f5f745f0-d687-4e14-80ab-1c892d9868f5\",\n \"is_enable\": true\n },\n {\n \"topic\": \"inwarding_webhook\",\n \"webhook_url\": \"https://omniful.ai\",\n \"is_enable\": false\n },\n {\n \"topic\": \"order_webhook\",\n \"webhook_url\": \"https://webhook.site/a4f463b3-4e18-4071-bac2-3249e2270499\",\n \"is_enable\": true\n }\n ],\n \"meta\": null\n}"}],"_postman_id":"227aba2a-123c-4230-b83e-5dadbf41c99d"},{"name":"Register Webhooks","id":"cbec6555-d1c7-4cdd-8dfa-274258509c82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"topic\": \"inwarding_webhook\",\n \"webhook_url\": \"https://omniful.ai\",\n \"is_enable\": false,\n \"custom_headers\": [\n {\n \"key\": \"X-AUTH-TOKEN\",\n \"value\": \"New_token\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/webhooks","description":"

Description: This endpoint allows clients to add or update webhook configurations for various topics. Each topic corresponds to a specific webhook type defined in the system.

Request Body:

The request body should be a JSON object containing the following fields:

topic: A string representing the webhook topic. This must match one of the predefined webhook types.
\n
webhook_url: A string containing the URL where the webhook notifications should be sent.
\n
is_enable: A boolean indicating whether the webhook is enabled or not.
\n

Valid Topics:

order_webhook
\n
product_webhook
\n
inventory_webhook
\n
delivery_zone_webhook
\n
purchase_order_webhook
\n
shipment_order_webhook
\n
stock_transfer_request_webhook
\n
inwarding_webhook
\n

\n","urlObject":{"path":["sales-channel","public","v1","webhooks"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d9c00e7f-f440-4135-9d02-549080bb653f","name":"Upsert Webhooks","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"topic\": \"inwarding_webhook\",\n \"webhook_url\": \"https://omniful.ai\",\n \"is_enable\": false,\n \"custom_headers\": [\n {\n \"key\": \"X-AUTH-TOKEN\",\n \"value\": \"New_token\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Oct 2024 12:06:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"f176be7a-afde-4086-985b-fbe853182922"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d79d80a8db7c9b5-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success: The webhook configurations were successfully updated.\"\n },\n \"meta\": null\n}"}],"_postman_id":"cbec6555-d1c7-4cdd-8dfa-274258509c82"}],"id":"4a1579c9-eef7-43ee-a0a7-ff4ef3305cdf","_postman_id":"4a1579c9-eef7-43ee-a0a7-ff4ef3305cdf","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Seller Integrations","item":[{"name":"Get Seller Integrations","id":"6a2f1cda-2119-4967-8ca8-d0db0a6935a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/channels/integrations?page=1&per_page=10","description":"

Fetches all the stores integrated with the seller’s account, including metadata like platform type, store name, and activation status.

📘 Response Object

IntegratedStore Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
integration_id	String	Unique identifier for the store integration.
tag	String	Type of integration (e.g., shopify, custom).
store_entity	String	Store-specific identifier on the platform (if any).
name	String	Store name given by the seller.
is_active	Boolean	Indicates if the store integration is currently active.
created_at	String	Timestamp when the store integration was created.

Meta Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
current_page	Integer	Current page in pagination.
per_page	Integer	Number of records per page.
last_page	Integer	Last page number.
total	Integer	Total number of integrated stores.

Fetches detailed information of a specific store integration using the integration_id.

🔸 Path Variable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Type	Description
integration_id	String	Unique identifier of the integrated store

📘 Response Object

IntegratedStore Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Description
integration_id	String	Unique identifier for the store integration.
tag	String	Type of integration (e.g., shopify, custom).
store_entity	String	Store-specific identifier on the platform (if any).
name	String	Store name given by the seller.
is_active	Boolean	Indicates if the store integration is currently active.
created_at	String	Timestamp when the store integration was created.

This folder includes APIs to fetch all integrated stores for a seller and retrieve detailed store information by store ID. Useful for listing and managing integrations with platforms like Shopify, WooCommerce, or custom setups.

\n","_postman_id":"4e714065-98d8-4fb7-8a53-d37739760c94","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Courier Partners","item":[{"name":"Get Courier Partners","id":"53aa9d12-3525-42b0-b430-c5021084b9f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/courier_partners","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"path":["sales-channel","public","v1","courier_partners"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

Page number of response

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Number of responses per page

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

Unique identifier of Courier Partner

\n","type":"text/plain"},"key":"tag","value":"atheryoun"},{"disabled":true,"description":{"content":"

Name filter of the courier partner

\n","type":"text/plain"},"key":"name","value":"a"}],"variable":[]}},"response":[{"id":"5a6de532-0549-4c48-8477-84d15c8a7721","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/courier_partners?page=1&per_page=10&tag=atheryoun&name=a","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","courier_partners"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"},{"key":"tag","value":"atheryoun"},{"key":"name","value":"a"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 06 Oct 2025 10:13:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"d14b0e9e-ab46-4929-a20e-c1ea9dc9eeeb"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"98a462f5fe117fb6-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"name\": \"Atheryoun\",\n \"tag\": \"atheryoun\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/courier-partner/atheryoun-logo.jpg\",\n \"status\": \"active\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 10,\n \"total\": 1\n }\n}"}],"_postman_id":"53aa9d12-3525-42b0-b430-c5021084b9f9"}],"id":"13790b66-9718-4f20-b8e7-6a059ae36762","_postman_id":"13790b66-9718-4f20-b8e7-6a059ae36762","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Retrieve Access Token","id":"69494a2b-6c76-428c-9408-26206651faf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"refresh_token\": \"\", // Your refresh token from the Dashboard\n \"client_id\": \"\", // Your client ID from the Dashboard\n \"client_secret\": \"\", // Your client secret from the Dashboard\n \"grant_type\": \"refresh_token\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/token","description":"

This API allows you to obtain a new access token and refresh token using a refresh token grant type. Access tokens are short-lived tokens that grant access to specific resources or actions within an API, while refresh tokens are used to request new access tokens without requiring the user to re-authenticate.

Upon sending this request to the Omniful API, you will receive a response containing the new access token and refresh token, which you can then use to access protected resources and perform authorized actions on behalf of the authenticated user.

The APIs and Webhooks in this section are designed to Create, Read, Update, or Delete data related to a seller and their custom sales channel applications. These endpoints provide seamless integration capabilities, allowing sellers to manage their products, orders, inventory, and other key business operations within the Omniful platform.

Note: For all operations in the KSA region, the national_address_code field must be included inside every request’s address object. This is mandatory across all APIs in this folder.

⚡ Rate Limiting

To ensure fair usage and performance stability, Omniful APIs have a default rate limit of:

✅ 60 requests per minute

📌 Exceeding the limit may result in temporary API restrictions.

Refer to the API documentation below for detailed endpoints and usage guidelines. 🚀

\n","_postman_id":"66865a26-649e-4d85-8302-febff8568103","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Tenant APIs","item":[{"name":"Seller","item":[{"name":"Get Sellers","id":"bde2bc2c-352d-426d-8afc-f307ae733161","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers?page=1&per_page=10&is_active=true&include_all_sellers=true","description":"

Description

Retrieves a paginated list of sellers belonging to the tenant. Use this endpoint when you need to fetch sellers by filters such as seller code, name, or email.

Parameters

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example
`page`	integer	True	`1`
`per_page`	integer	True	`10`
`email`	string	False	`store@saudielectronics.com`
`seller_codes`	array[string]	False	`seller_codes=GP-803&seller_codes=SG-333`
`name`	string	False	`Saudi`
`is_active`	boolean	False	`true`
`include_all_sellers`	boolean	False	`true`

Filters & Pagination

Filters supported: email, seller_codes, name, is_active
\n
Sorting: Not supported
\n
Pagination behavior:
\n
- page + per_page , Where page represents the page number of response and per_page represents number of response items per page.
  \n
- Response includes pagination metadata: current_page, last_page, per_page, total
  \n
\n

Page number of response

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Filter sellers by email.

\n","type":"text/plain"},"key":"email","value":"store@saudielectronics.com"},{"disabled":true,"description":{"content":"

Filter by one or more seller codes.

\n","type":"text/plain"},"key":"seller_codes","value":"GP-803"},{"disabled":true,"description":{"content":"

Filter by one or more seller codes.

\n","type":"text/plain"},"key":"seller_codes","value":"SG-333"},{"disabled":true,"description":{"content":"

Filter sellers by name.

\n","type":"text/plain"},"key":"name","value":"Saudi"},{"description":{"content":"

Number of responses per page

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

This filter only works when include_all_sellers is enabled

\n","type":"text/plain"},"key":"is_active","value":"true"},{"description":{"content":"

If this key is enabled, reponse will include both active and inactive sellers

\n","type":"text/plain"},"key":"include_all_sellers","value":"true"}],"variable":[]}},"response":[{"id":"6cafa5af-c11d-4140-8042-22ad2fccfbf5","name":"Get Sellers","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers?page=1&per_page=10","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers"],"query":[{"key":"page","value":"1","description":"Page number for pagination."},{"key":"email","value":"store@saudielectronics.com","description":"Filter sellers by email.","disabled":true},{"key":"seller_codes","value":"GP-803","description":"Filter by one or more seller codes.","disabled":true},{"key":"seller_codes","value":"SG-333","description":"Filter by one or more seller codes.","disabled":true},{"key":"name","value":"Saudi","description":"Filter sellers by name.","disabled":true},{"key":"per_page","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 07:45:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"2f1d9ba0-3daa-4c06-8474-e53b3784515e"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913c662f89cad6b7-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"guid\": \"01HVQTFQB0GR0R7A19QJPXAKZQ\",\n \"name\": \"amar\",\n \"phone\": \"3156545852\",\n \"email\": \"amar@gmail.com\",\n \"code\": \"45654\",\n \"is_active\": true,\n \"address\": {\n \"country\": {\n \"name\": \"Bahrain\",\n \"code\": \"BH\"\n },\n \"state\": {\n \"name\": \"Bahrain\",\n \"code\": \"BH\"\n },\n \"city\": {\n \"name\": \"A'ali\"\n },\n \"postal_code\": \"\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"address_line1\": \"Peshawar\",\n \"address_line2\": \"Hayatabad\",\n \"national_address_code\": \"\",\n \"created_at\": \"2024-04-18T05:22:19.629151Z\",\n \"created_by\": \"589\",\n \"updated_at\": \"2024-04-18T05:22:19.629151Z\",\n \"updated_by\": \"\",\n \"deleted_at\": null\n },\n \"created_at\": \"2024-04-18T05:22:19.621933Z\",\n \"created-by\": \"Demo 3PL\",\n \"updated_at\": \"2024-04-18T05:22:19.633815Z\",\n \"updated_by\": \"Demo 3PL\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 453,\n \"per_page\": 1,\n \"total\": 453\n }\n}"}],"_postman_id":"bde2bc2c-352d-426d-8afc-f307ae733161"},{"name":"Get Single Seller","id":"62b1cdfd-16af-4a6a-b397-627827b62ce8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code","description":"

Description

Retrieves details of a single seller belonging to the tenant. Use this endpoint when you need to fetch a seller using their seller_code.

Parameters

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example
`seller_code`	string	True	`seller_codes=GP-803`

The unique seller code used to fetch details of a specific seller.

\n","type":"text/plain"},"type":"any","value":"DL-048","key":"seller_code"}]}},"response":[{"id":"d3e65f6b-e016-4f7d-b5ce-a0d7c868df96","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code"],"variable":[{"key":"seller_code","value":"Test-hj","description":"The unique seller code used to fetch details of a specific seller."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:00:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"3e817a68-e5d3-4227-a053-2f30a9056edd"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913b743cb86007d5-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"guid\": \"01KC64R46N4CC4RYZSEFA8JD9F\",\n \"name\": \"Saudi Electronics Store\",\n \"phone\": \"501234567\",\n \"email\": \"wew@saudielectronics.com\",\n \"code\": \"Test-hj\",\n \"address\": {\n \"country\": {\n \"name\": \"Saudi Arabia\",\n \"code\": \"SA\"\n },\n \"state\": {\n \"name\": \"Riyadh Region\",\n \"code\": \"01\"\n },\n \"city\": {\n \"name\": \"Riyadh\"\n },\n \"postal_code\": \"12214\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"address_line1\": \"King Fahd Road\",\n \"address_line2\": \"Al Olaya District\",\n \"national_address_code\": \"code\",\n \"created_at\": \"2025-12-11T07:24:30.313992Z\",\n \"created_by\": \"4508\",\n \"updated_at\": \"2025-12-11T07:25:24.437864Z\",\n \"updated_by\": \"\",\n \"deleted_at\": null\n },\n \"created_at\": \"2025-12-11T07:24:30.304545Z\",\n \"created-by\": \"Dhruv Bhatt\",\n \"updated_at\": \"2025-12-11T07:25:24.446693Z\",\n \"updated_by\": \"\"\n },\n \"meta\": null\n}"},{"id":"551f4d3f-ad29-4743-9cf2-b5613ad336ab","name":"Invalid Seller Code","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code"],"variable":[{"key":"seller_code","value":"DL-0484","description":"The unique seller code used to fetch details of a specific seller."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:01:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"41921e70-a017-42a2-827f-860b48317c61"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913b7557488d6ca0-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 403,\n \"error\": {\n \"message\": \"You are not authorised to perform this action\"\n }\n}"}],"_postman_id":"62b1cdfd-16af-4a6a-b397-627827b62ce8"},{"name":"Create Seller","id":"dffd48b3-6954-4db8-bc05-1710cab4c1ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Omniful Electronics Store\",\n \"phone\": \"501234565\",\n \"code\": \"Test-hj\",\n \"country_code\": \"SA\",\n \"country_calling_code\": \"+966\",\n \"email\": \"23ewdew4@saudielectronics.com\",\n \"address\": {\n \"address_line1\": \"King Fahd Road\",\n \"address_line2\": \"Al Olaya District\",\n \"city_name\": \"Riyadh\",\n \"country_name\": \"Saudi Arabia\",\n \"national_address_code\" : \"nac_1234\",\n \"postal_code\": \"12214\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers","description":"

Description

Creates a new seller under the authenticated Omniful tenant. Use this endpoint when onboarding a new seller.The endpoint returns the created Seller ID on success.

Parameters

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example
`name`	string	True	`\"Omniful Electronics Store\"`
`phone`	string	True	`\"501234567\"`
`code`	string	True	`\"Test-123\"`
`country_code`	string	True	`\"SA\"`
`country_calling_code`	string	True	`\"+966\"`
`email`	string	True	`\"omniful@saudielectronics.com\"`
`address`	object	True	`{...}`

address object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Validation
`address_line1`	string	True	`\"King Fahd Road\"`	Max 255 chars
`address_line2`	string	False	`\"Al Olaya District\"`	Max 255 chars
`city_name`	string	True	`\"Riyadh\"`	Max 255 chars
`country_name`	string	True	`\"Saudi Arabia\"`	Max 255 chars
`postal_code`	string	False	`\"12214\"`	Alphanumeric
`national_address_code`	string	False	`\"nac_1234\"`	Max 20 chars

Description

Updates an existing seller under the authenticated Omniful tenant.

Use this endpoint when modifying seller details such as name, phone number, or address.

The endpoint returns the updated Seller ID on success.

Parameters

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example
`name`	string	True	`\"Saudi Electronics Store\"`
`phone`	string	True	`\"501234567\"`
`country_code`	string	True	`\"SA\"`
`country_calling_code`	string	True	`\"+966\"`
`email`	string	True	`\"omniful@saudielectronics.com\"`
`address`	object	True	`{...}`

address object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example
`address_line1`	string	True	`\"King Fahd Road\"`
`address_line2`	string	False	`\"Al Olaya District\"`
`city_name`	string	True	`\"Riyadh\"`
`country_name`	string	True	`\"Saudi Arabia\"`
`postal_code`	string	False	`\"12214\"`
`national_address_code`	string	False	`\"nac_1234\"`

The unique seller code of the seller to be updated.

\n","type":"text/plain"},"type":"any","value":"DL-048","key":"seller_code"}]}},"response":[{"id":"7fd88f98-4ce4-46ff-9862-727a1df5880f","name":"Invalid Request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Saudi Electronics Store\",\n \"phone\": \"501234567\",\n \"country_code\": \"SA\",\n \"country_calling_code\": \"+966\",\n \"address\": {\n \"address_line1\": \"King Fahd Road\",\n \"address_line2\": \"Al Olaya District\",\n \"city_name\": \"Riyadh\",\n \"country_name\": \"Saudi Arabia\",\n \"postal_code\": \"12214\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code"],"variable":[{"key":"seller_code","value":"DL-048","description":"The unique seller code of the seller to be updated."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:26:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"e231d59c-cfaf-4d5c-990a-02db287f1c00"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913b9ac55b5d59bc-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"Email cannot be empty\"\n }\n}"},{"id":"d04169ba-3d7d-4b3d-ad22-235f744ab81b","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Saudi Electronics Store\",\n \"phone\": \"501234567\",\n \"country_code\": \"SA\",\n \"country_calling_code\": \"+966\",\n \"email\": \"wew@saudielectronics.com\",\n \"address\": {\n \"address_line1\": \"King Fahd Road\",\n \"address_line2\": \"Al Olaya District\",\n \"city_name\": \"Riyadh\",\n \"country_name\": \"Saudi Arabia\",\n \"postal_code\": \"12214\",\n \"national_address_code\" : \"code\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code"],"variable":[{"key":"seller_code","value":"DL-048","description":"The unique seller code of the seller to be updated."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Seller updated successfully\",\n \"meta\": null\n}\n"}],"_postman_id":"83a61347-2dda-42dc-81ac-d5806d687f1a"}],"id":"920fe854-6b17-4b10-b163-59f8e02917c4","description":"

📌 Overview

The Seller APIs in Omniful allow users to manage seller-related operations, including fetching seller details, creating new sellers, and updating seller information. These APIs are designed to facilitate tenant-level operations, allowing businesses to efficiently manage multiple sellers within their system.

📋 Common Fields Across Seller APIs

The following table provides a detailed explanation of key fields used across all Seller APIs.

Field	Type	Description
`id`	`string`	Unique identifier assigned to the seller in Omniful.
`guid`	`string`	Global Unique Identifier (GUID) for the seller.
`tenant_id`	`integer`	Tenant ID to which the seller is associated.
`name`	`string`	Seller’s registered name.
`phone`	`string`	Seller’s contact phone number.
`email`	`string`	Official email address of the seller.
`code`	`string`	Unique seller code assigned by Omniful.
`status_code`	`string`	Current status of the seller (e.g., `Active`, `Inactive`).
`address_id`	`integer`	Unique identifier of the seller’s address in Omniful.
`address.address_line1`	`string`	Primary address of the seller.
`address.address_line2`	`string`	Additional address details (if applicable).
`address.city_name`	`string`	City where the seller operates.
`address.country_name`	`string`	Country where the seller is operates.
`address.postal_code`	`string`	Postal or ZIP code for the seller’s address.
`country_code`	`string`	Two-letter country code (e.g., `SA` for Saudi Arabia).
`country_calling_code`	`string`	Country calling code (e.g., `+966`).
`created_at`	`string`	Timestamp indicating when the seller was created.
`updated_at`	`string`	Timestamp indicating the last update to the seller record.
`created_by`	`string`	Name of the user or system that created the seller.
`updated_by`	`string`	Name of the user or system that last updated the seller record.

\n","_postman_id":"920fe854-6b17-4b10-b163-59f8e02917c4","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"SKUs","item":[{"name":"Get SKUs","id":"22c6c224-98c8-4660-900d-0133b255ef1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/skus?page=1&per_page=10","description":"

Description

Retrieves a paginated list of SKUs associated with a specific seller in the Seller Master Catalog.

Parameters

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example
`seller_code`	string	True	`\"KO-SE-1\"`

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example
`page`	integer	False	`1`
`per_page`	integer	False	`10`

Filters & pagination

Filters supported:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Query Parameter	Type
`sku_code`	`string`
`sku_codes`	`[]string`
`updated_at_start_date`	`string`
`updated_at_end_date`	`string`
`query`	`string`
`include_inventory`	`bool`
`hub_code`	`string`

Sorting: Not supported
\n
Pagination behavior:
\n
- page + per_page , Where page represents the page number of response and per_page represents number of response items per page.
  \n
- Response includes pagination metadata: current_page, last_page, per_page, total
  \n
\n

full text search query

\n","type":"text/plain"},"key":"query","value":"parle"},{"disabled":true,"description":{"content":"

If true, inventory details will be fetched for corresponding hub

\n","type":"text/plain"},"key":"include_inventory","value":"true"},{"disabled":true,"description":{"content":"

Code for the hub whose inventory is to be fetched

\n","type":"text/plain"},"key":"hub_code","value":"2134"}],"variable":[{"type":"any","value":"KO-SE-1","key":"seller_code"}]}},"response":[{"id":"2489d526-02ca-49af-91af-8e71cdd87ccb","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/skus?page=1&per_page=10","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","skus"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"},{"key":"sku_code","value":"srv-sku-9","disabled":true},{"key":"sku_codes","value":"srv-sku-9","disabled":true},{"key":"sku_codes","value":"srv-sku-8","disabled":true},{"key":"updated_at_start_date","value":"12-01-2025","disabled":true},{"key":"updated_at_end_date","value":"10-02-2025","disabled":true}],"variable":[{"key":"seller_code","value":"KO-SE-1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:16:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"3321ab3b-295d-4ebb-bb03-60631d5f00f8"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913b8b6089096fa1-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"name\": \"Variant-SKU-RED\",\n \"description\": \"\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"simple\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"cm\"\n }\n },\n \"sku_code\": \"Variant-SKU-RED\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": null,\n \"cost\": 0,\n \"retail_price\": 0,\n \"selling_price\": 0,\n \"display_selling_price\": \"\",\n \"display_retail_price\": \"\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-17T08:05:43.849Z\",\n \"updated_at\": \"2025-02-17T08:05:43.848Z\",\n \"tax_inclusive\": {\n \"selling_price\": true\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n },\n {\n \"name\": \"Variant-SKU-Blue\",\n \"description\": \"\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"simple\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"cm\"\n }\n },\n \"sku_code\": \"Variant-SKU-Blue\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": null,\n \"cost\": 0,\n \"retail_price\": 0,\n \"selling_price\": 0,\n \"display_selling_price\": \"\",\n \"display_retail_price\": \"\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-17T08:05:05.584Z\",\n \"updated_at\": \"2025-02-17T08:05:05.584Z\",\n \"tax_inclusive\": {\n \"selling_price\": true\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n },\n {\n \"name\": \"RedBull\",\n \"description\": \"RedBull\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"\"\n }\n },\n \"sku_code\": \"RedBull\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [\n {\n \"default\": \"https://images.unsplash.com/photo-1629203849820-fdd70d49c38e?w=500&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8Mnx8cGVwc2l8ZW58MHx8MHx8fDA%3D\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"attributes\": [],\n \"barcodes\": null,\n \"cost\": 0,\n \"retail_price\": 0,\n \"selling_price\": 10,\n \"display_selling_price\": \"10.00 SAR\",\n \"display_retail_price\": \"\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-10T10:47:10.461Z\",\n \"updated_at\": \"2025-02-10T10:47:10.461Z\",\n \"tax_inclusive\": {\n \"selling_price\": false\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n },\n {\n \"name\": \"Testing Options\",\n \"description\": \"Testing Options\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"\"\n }\n },\n \"sku_code\": \"testing-options-variant-2\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [\n {\n \"default\": \"https://d2437wyspjsc40.cloudfront.net/75cc8f2a-4419-4fb2-97ea-4c18957de480/fa3e0302-ab2d-4e15-84a7-c297d8f412cb-SxS.webp\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"attributes\": [\n {\n \"name\": \"Color\",\n \"sku_attribute_variation\": {\n \"name\": \"medium\"\n }\n }\n ],\n \"barcodes\": null,\n \"cost\": 0,\n \"retail_price\": 0,\n \"selling_price\": 1234,\n \"display_selling_price\": \"1234.00 SAR\",\n \"display_retail_price\": \"\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-10T10:47:10.461Z\",\n \"updated_at\": \"2025-02-10T10:47:10.461Z\",\n \"tax_inclusive\": {\n \"selling_price\": false\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n },\n {\n \"name\": \"Iphone 15 Edited\",\n \"description\": \"Iphone 15 Edited\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"\"\n }\n },\n \"sku_code\": \"3666219590991\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [\n {\n \"default\": \"https://media.istockphoto.com/id/2060559152/photo/deep-fake-deepfake-and-ai-artificial-intelligence-video-editing-technology-face-of-a-person.webp?b=1&s=170667a&w=0&k=20&c=q3qtIHreHnQBN_hsmw5q2tH44lJapDz3s1UotTHFjVA=\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"attributes\": [],\n \"barcodes\": null,\n \"cost\": 0,\n \"retail_price\": 0,\n \"selling_price\": 200,\n \"display_selling_price\": \"200.00 SAR\",\n \"display_retail_price\": \"\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-10T10:47:10.461Z\",\n \"updated_at\": \"2025-02-10T10:47:10.461Z\",\n \"tax_inclusive\": {\n \"selling_price\": false\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n },\n {\n \"name\": \"Iphone 15 Edited\",\n \"description\": \"Iphone 15 Edited\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"\"\n }\n },\n \"sku_code\": \"3666219590076\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [\n {\n \"default\": \"https://media.istockphoto.com/id/2060559152/photo/deep-fake-deepfake-and-ai-artificial-intelligence-video-editing-technology-face-of-a-person.webp?b=1&s=170667a&w=0&k=20&c=q3qtIHreHnQBN_hsmw5q2tH44lJapDz3s1UotTHFjVA=\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"attributes\": [],\n \"barcodes\": null,\n \"cost\": 0,\n \"retail_price\": 0,\n \"selling_price\": 234,\n \"display_selling_price\": \"234.00 SAR\",\n \"display_retail_price\": \"\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-10T10:47:10.461Z\",\n \"updated_at\": \"2025-02-10T10:47:10.461Z\",\n \"tax_inclusive\": {\n \"selling_price\": false\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n },\n {\n \"name\": \"Apple 20W Type C\",\n \"description\": \"\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"\"\n }\n },\n \"sku_code\": \"nggsdhsdjdd\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [\n {\n \"default\": \"https://d2437wyspjsc40.cloudfront.net/75cc8f2a-4419-4fb2-97ea-4c18957de480/638526fa-7fd7-404e-89a7-01bb1ed6e9e3-SxS.webp\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"attributes\": [],\n \"barcodes\": null,\n \"cost\": 0,\n \"retail_price\": 0,\n \"selling_price\": 12,\n \"display_selling_price\": \"12.00 SAR\",\n \"display_retail_price\": \"\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-10T10:47:10.461Z\",\n \"updated_at\": \"2025-02-10T10:47:10.461Z\",\n \"tax_inclusive\": {\n \"selling_price\": false\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n },\n {\n \"name\": \"ALproduct1\",\n \"description\": \"\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"simple\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"cm\"\n }\n },\n \"sku_code\": \"6241902930048\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": null,\n \"cost\": 0,\n \"retail_price\": 0,\n \"selling_price\": 13,\n \"display_selling_price\": \"13.00 SAR\",\n \"display_retail_price\": \"\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-06T10:05:22.65Z\",\n \"updated_at\": \"2025-02-06T10:05:22.65Z\",\n \"tax_inclusive\": {\n \"selling_price\": true\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n },\n {\n \"name\": \"KOH COCONUT WATER 350ML\",\n \"description\": \"KOH COCONUT WATER 350ML\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"simple\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"\"\n }\n },\n \"sku_code\": \"sku-3115\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [\n {\n \"default\": \"https://alsadhanimages.blob.core.windows.net/alsadhanimages/845163056422.jpg\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"attributes\": [],\n \"barcodes\": [\n \"sku-3115\"\n ],\n \"cost\": 31,\n \"retail_price\": 31,\n \"selling_price\": 134,\n \"display_selling_price\": \"134.00 SAR\",\n \"display_retail_price\": \"31.00 SAR\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-01-20T11:59:32.391Z\",\n \"updated_at\": \"2025-01-20T12:01:43.272Z\",\n \"tax_inclusive\": {\n \"selling_price\": false\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n },\n {\n \"name\": \"KOH COCONUT WATER 1LTR\",\n \"description\": \"KOH COCONUT WATER 1LTR\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"simple\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"\"\n }\n },\n \"sku_code\": \"sku-3114\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [\n {\n \"default\": \"https://alsadhanimages.blob.core.windows.net/alsadhanimages/845163046539.jpg\",\n \"thumbnail\": \"\",\n \"medium\": \"\",\n \"large\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n ],\n \"attributes\": [],\n \"barcodes\": [\n \"sku-3114\"\n ],\n \"cost\": 45,\n \"retail_price\": 45,\n \"selling_price\": 53,\n \"display_selling_price\": \"53.00 SAR\",\n \"display_retail_price\": \"45.00 SAR\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"Saudi Arabia\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-01-20T11:59:32.391Z\",\n \"updated_at\": \"2025-01-20T12:01:43.272Z\",\n \"tax_inclusive\": {\n \"selling_price\": false\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 7239,\n \"per_page\": 10,\n \"total\": 72383\n }\n}"},{"id":"352e2cd7-c3e4-4491-931a-f25edf42b718","name":"Success (Inventory)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTgzNjQ4MjgsImp0aSI6ImI2NDUyYTBlLWZkYWYtNDBlYi05NjRkLTI1OGFmN2E1YjIwNiIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRDb2RlIjoiMzcxODEyNDk2OCIsIlRlbmFudElEIjoiIiwiVXNlcklEIjoiNTYyOCIsIlVzZXJOYW1lIjoiSGluaXNoIEJhbnNhbCIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjEyMH19LCJ0b2tlbl90eXBlIjoiQmVhcmVyIn0.SUhsS9bmE9bfPb4mX9sOl6W9tyrK_fiSHO6vmmVWwoLzzRsn3Z9jqhgEi1V-1Z9xXsyIPzUtuPJ3oDQTvLNDwzx4eS5Sf0ZhpcI4dE-iA1EkzIzssr2dHMiHZxGjIoBlq8Wwqu4Bhe0NnEOgUHddReTKq40OBBp-44CvgHVZvjm-VPwqN9lvPOljag5fsMQzgeN3aH66v3X0ajdBtAoTXyqZDgd2kRCfHneoGPMrKSOvjByGgsx9GU3qmKu126ZnAufrjvVWk9W26SMmJrg73to8kRfWhJ0jS5F7Kr45mKZFn_6tEDLDxpCq07TaAm-DD-M0GhZdPTW7H9wWx20tt9-55r_KbhWIqPtjH7vRQ4Rdyimx8BYYz7HVlQOuji6VvpQ1ge23KrKzyhBptqO-_6Arpbfj42ewOViFOEL2w6h6t9DRrqNoxG13Jm3ZQYQJf2_Vpt8l2iuEPxSaqI_5_upsLXUt8RhS99vaZ_XXOgMayh7NvVVpbmmUTdfpQ-epZEfInp_2emJu3NFKEjugpANzcdp8fvAKqjTDimhIL59R4HwP2dmTyGWmSx3_VQqJiRQtvA-2yH91pbIwE2hUVQJv5-o2bO4GHaiBNUkjxSQE3e6qnN2H7kxa4j9-ik4YvMPaUtX1XAwXxtkUOR_jKuk4qEd9gZB8gKaV7v9ZWfE"}],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/12/skus?page=1&per_page=10&include_inventory=true&sku_code=6241902930048&hub_code=IOFPRod","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","tenants","sellers","12","skus"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"},{"key":"sku_code","value":"srv-sku-9","disabled":true},{"key":"sku_codes","value":"srv-sku-9","disabled":true},{"key":"sku_codes","value":"srv-sku-8","disabled":true},{"key":"updated_at_start_date","value":"12-01-2025","disabled":true},{"key":"updated_at_end_date","value":"10-02-2025","disabled":true},{"key":"query","value":"parle","description":"full text search query","type":"text","disabled":true},{"key":"include_inventory","value":"true","description":"If true, inventory details will be fetched for corresponding hub"},{"key":"hub_code","value":"2134","description":"Code for the hub whose inventory is to be fetched","type":"text","disabled":true},{"key":"sku_code","value":"6241902930048"},{"key":"hub_code","value":"IOFPRod"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 30 Aug 2025 05:50:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"fabc5e7f-4573-4ee3-9738-5db7e97bf483"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9772022d0ed65a1d-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"name\": \"alprod\",\n \"description\": \"testing product .\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"simple\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"cm\"\n }\n },\n \"sku_code\": \"6241902930048\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": [\n \"RUH2237107822\"\n ],\n \"cost\": 0,\n \"retail_price\": 43,\n \"selling_price\": 76,\n \"display_selling_price\": \"76.00 SAR\",\n \"display_retail_price\": \"43.00 SAR\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-11T06:52:36.938Z\",\n \"updated_at\": \"2025-02-11T09:05:13.051Z\",\n \"tax_inclusive\": {\n \"selling_price\": true\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": [],\n \"metadata\": {\n \"assembled_part_count\": 0\n },\n \"hub_inventory\": [\n {\n \"hub_code\": \"IOFPRod\",\n \"sku_code\": \"6241902930048\",\n \"available_quantity\": 8000,\n \"sku_name\": \"alprod\",\n \"quantity_on_hand\": 8000,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 8000,\n \"quantity_location_fail_inventory_sum\": 0,\n \"updated_at\": \"\"\n }\n ]\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 10,\n \"total\": 1\n }\n}"}],"_postman_id":"22c6c224-98c8-4660-900d-0133b255ef1b"},{"name":"Get Single SKU","id":"a14eb395-d7f8-4c8a-bbc5-15cd80c855e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/skus/:sku_code","description":"

Description

Retrieves detailed information for a specific SKU belonging to a seller in the Seller Master Catalog.

Parameters

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example
`seller_code`	string	True	`\"KO-SE-1\"`
`sku_code`	string	True	`\"srv-sku-12\"`

Filters & pagination

Filters supported:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Query Parameter	Type
`include_inventory`	`bool`
`hub_code`	`string`

Sorting: Not supported
\n
Pagination behavior:
\n
- page + per_page , Where page represents the page number of response and per_page represents number of response items per page.
  \n
- Response includes pagination metadata: current_page, last_page, per_page, total
  \n
\n

If true, inventory details will be fetched for corresponding hub

\n","type":"text/plain"},"key":"include_inventory","value":"true"},{"disabled":true,"description":{"content":"

Code for the hub whose inventory details are to be fetched

\n","type":"text/plain"},"key":"hub_code","value":"2134"}],"variable":[{"type":"any","value":"KO-SE-1","key":"seller_code"},{"type":"any","value":"srv-sku-12","key":"sku_code"}]}},"response":[{"id":"214e2885-c13c-4f30-bd24-689aa42e4195","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/skus/:sku_code","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","skus",":sku_code"],"variable":[{"key":"seller_code","value":"KO-SE-1"},{"key":"sku_code","value":"Variant-SKU-RED"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:17:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"ba4f1e91-4063-459b-b4ae-a6afe69eeb18"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913b8c9eaa920664-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"name\": \"Variant-SKU-RED\",\n \"description\": \"\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"simple\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"cm\"\n }\n },\n \"sku_code\": \"Variant-SKU-RED\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": null,\n \"cost\": 0,\n \"retail_price\": 0,\n \"selling_price\": 0,\n \"display_selling_price\": \"\",\n \"display_retail_price\": \"\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-17T08:05:43.849Z\",\n \"updated_at\": \"2025-02-17T08:05:43.848Z\",\n \"tax_inclusive\": {\n \"selling_price\": true\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": []\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"},{"id":"2ef7740a-b22e-4a50-9837-0083080c5a5e","name":"Success (Inventory)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTgzNjQ4MjgsImp0aSI6ImI2NDUyYTBlLWZkYWYtNDBlYi05NjRkLTI1OGFmN2E1YjIwNiIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRDb2RlIjoiMzcxODEyNDk2OCIsIlRlbmFudElEIjoiIiwiVXNlcklEIjoiNTYyOCIsIlVzZXJOYW1lIjoiSGluaXNoIEJhbnNhbCIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjEyMH19LCJ0b2tlbl90eXBlIjoiQmVhcmVyIn0.SUhsS9bmE9bfPb4mX9sOl6W9tyrK_fiSHO6vmmVWwoLzzRsn3Z9jqhgEi1V-1Z9xXsyIPzUtuPJ3oDQTvLNDwzx4eS5Sf0ZhpcI4dE-iA1EkzIzssr2dHMiHZxGjIoBlq8Wwqu4Bhe0NnEOgUHddReTKq40OBBp-44CvgHVZvjm-VPwqN9lvPOljag5fsMQzgeN3aH66v3X0ajdBtAoTXyqZDgd2kRCfHneoGPMrKSOvjByGgsx9GU3qmKu126ZnAufrjvVWk9W26SMmJrg73to8kRfWhJ0jS5F7Kr45mKZFn_6tEDLDxpCq07TaAm-DD-M0GhZdPTW7H9wWx20tt9-55r_KbhWIqPtjH7vRQ4Rdyimx8BYYz7HVlQOuji6VvpQ1ge23KrKzyhBptqO-_6Arpbfj42ewOViFOEL2w6h6t9DRrqNoxG13Jm3ZQYQJf2_Vpt8l2iuEPxSaqI_5_upsLXUt8RhS99vaZ_XXOgMayh7NvVVpbmmUTdfpQ-epZEfInp_2emJu3NFKEjugpANzcdp8fvAKqjTDimhIL59R4HwP2dmTyGWmSx3_VQqJiRQtvA-2yH91pbIwE2hUVQJv5-o2bO4GHaiBNUkjxSQE3e6qnN2H7kxa4j9-ik4YvMPaUtX1XAwXxtkUOR_jKuk4qEd9gZB8gKaV7v9ZWfE"}],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/12/skus/6241902930048?include_inventory=true&hub_code=IOFPRod","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","tenants","sellers","12","skus","6241902930048"],"query":[{"key":"include_inventory","value":"true","description":"If true, inventory details will be fetched for corresponding hub"},{"key":"hub_code","value":"IOFPRod","description":"Code for the hub whose inventory details are to be fetched"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 30 Aug 2025 05:58:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"1f0ce741-4869-4f36-b098-d9a604a40010"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"97720e749bf891aa-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"name\": \"alprod\",\n \"description\": \"testing product .\",\n \"category\": [],\n \"product\": {\n \"name\": \"\",\n \"handling_type\": \"\",\n \"unit\": \"\",\n \"type\": \"simple\",\n \"description\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"length\": 0,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 0,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 0,\n \"unit\": \"cm\"\n }\n },\n \"sku_code\": \"6241902930048\",\n \"handling_type\": \"\",\n \"type\": \"simple\",\n \"status\": \"active\",\n \"unit\": \"\",\n \"currency\": \"SAR\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": [\n \"RUH2237107822\"\n ],\n \"cost\": 0,\n \"retail_price\": 43,\n \"selling_price\": 76,\n \"display_selling_price\": \"76.00 SAR\",\n \"display_retail_price\": \"43.00 SAR\",\n \"cutoff_price\": 0,\n \"country_of_origin\": \"\",\n \"is_weighted\": false,\n \"is_perishable\": false,\n \"configuration\": {\n \"weight\": {\n \"min\": \"\",\n \"max\": \"\",\n \"type\": \"\"\n }\n },\n \"created_at\": \"2025-02-11T06:52:36.938Z\",\n \"updated_at\": \"2025-02-11T09:05:13.051Z\",\n \"tax_inclusive\": {\n \"selling_price\": true\n },\n \"tax_percentage\": {\n \"selling_price\": 0\n },\n \"sku_tags\": [],\n \"metadata\": {\n \"assembled_part_count\": 0\n },\n \"hub_inventory\": [\n {\n \"hub_code\": \"IOFPRod\",\n \"sku_code\": \"6241902930048\",\n \"available_quantity\": 8000,\n \"sku_name\": \"alprod\",\n \"quantity_on_hand\": 8000,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 8000,\n \"quantity_location_fail_inventory_sum\": 0,\n \"updated_at\": \"\"\n }\n ]\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"}],"_postman_id":"a14eb395-d7f8-4c8a-bbc5-15cd80c855e9"},{"name":"Create SKUs","id":"8ab3fd3c-0e27-4568-9275-d838a30c5f67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"ALU 3432423\",\n \"description\": \"This is a sample product description.\",\n \"sku_code\": \"srv-sku-12\",\n \"barcodes\": [\n \"new-sku-barcode-7aaa-12\"\n ],\n \"images\": [\n {\n \"default\": \"https://m.media-amazon.com/images/I/71bmtncxa+L._AC_SX679_.jpg\"\n }\n ],\n \"type\": \"simple\",\n \"status\": \"live\",\n \"brand\": \"Sample Brand\",\n \"country_of_origin\": \"Sample Country\",\n \"weight\": {\n \"value\": 5,\n \"uom\": \"ea\" // Any Unit of Measurement other than \"ea\" will be treated as \"ea\" unless weighted configuration is enabled for the tenant.\n },\n \"uom\": \"ea\",\n \"dimensions\": {\n \"length\": {\n \"length\": 10,\n \"unit\": \"cm\"\n },\n \"breadth\": {\n \"breadth\": 5,\n \"unit\": \"cm\"\n },\n \"height\": {\n \"height\": 15,\n \"unit\": \"cm\"\n }\n },\n \"currency\": \"SAR\",\n \"retail_price\": 49.99,\n \"selling_price\": 39.99,\n \"is_perishable\": true\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/skus","description":"

Description

Creates one or more SKUs for a specific seller in the Seller Master Catalog. Use this endpoint when onboarding new SKUs into the seller’s Master Catalog. The endpoint returns the created SKU IDs on success.

📌 Required fields for Creating a Master SKU:

name: Name of the SKU, for example, \"42 inch LED TV\".
\n
sku_code: A unique code that identifies the SKU, for example, \"SKU-TV-123\"
\n
type: Specifies the type of the SKU, which can be \"simple\" or \"bundle\".
\n

Parameters

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example	Validation / Default
`seller_code`	string	True	`\"KO-SE-1\"`	Must be a valid existing seller code

Body Parameters

Body is an array of SKU objects.

Name	Type	Required	Example
`name`	string	True	`\"ALU 3432423\"`
`description`	string	False	`\"This is a sample product description.\"`
`sku_code`	string	True	`\"srv-sku-12\"`
`barcodes`	array[string]	False	`[\"new-sku-barcode-7aaa-12\"]`
`images`	array[object]	False	`[{\"default\": \"\"}]`
`type`	string	False	`\"simple\",\"bundle\"`
`status`	string	False	`\"active\"`
`brand`	string	False	`\"Sample Brand\"`
`country_of_origin`	string	False	`\"Sample Country\"`
`weight`	object	False	`{ \"value\": 5, \"uom\": \"ea\" }`
`uom`	string	False	`\"ea\"`
`dimensions`	object	False	`{length: {...}, breadth: {...}, height: {...}}`
`currency`	string	False	`\"SAR\"`
`retail_price`	number	False	`49.99`
`selling_price`	number	False	`39.99`
`is_perishable`	boolean	False	`true`

dimensions object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example
`length.length`	number	False	`10`
`length.unit`	string	False	`\"cm\"`
`breadth.breadth`	number	False	`5`
`breadth.unit`	string	False	`\"cm\"`
`height.height`	number	False	`15`
`height.unit`	string	False	`\"cm\"`

Description

Updates an existing SKU for a specific seller in the Seller Master Catalog. Use this endpoint when modifying SKU attributes such as name, description, barcode, pricing, status, dimensions, or perishable settings. The endpoint returns the updated SKU ID on success.

📌 Required fields for Updating a Master SKU:

sku_code: A unique code that identifies the SKU, for example, \"SKU-TV-123\"
\n
type: Specifies the type of the SKU, which can be \"simple\" or \"bundle\".
\n

Parameters

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example
`seller_code`	string	True	`\"KO-SE-1\"`
`sku_code`	string	True	`\"srv-sku-12\"`

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example
`name`	string	True	`\"ALU 4\"`
`description`	string	False	`\"This is a updated product description.\"`
`barcodes`	array[string]	False	`[\"new-barcode\"]`
`images`	array[object]	False	`[{\"default\": \"\"}]`
`type`	string	False	`\"simple\"`
`status`	string	False	`\"active\"`
`brand`	string	False	`\"Sample Brand\"`
`country_of_origin`	string	False	`\"Sample Country\"`
`weight`	object	False	`{ \"value\": 5, \"uom\": \"ea\" }`
`uom`	string	False	`\"ea\"`
`dimensions`	object	False	`{...}`
`retail_price`	number	False	`49.99`
`selling_price`	number	False	`39.99`
`is_perishable`	boolean	False	`true`

dimensions object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example
`length.length`	number	False	`10`
`length.unit`	string	False	`\"cm\"`
`breadth.breadth`	number	False	`5`
`breadth.unit`	string	False	`\"cm\"`
`height.height`	number	False	`15`
`height.unit`	string	False	`\"cm\"`

The SKUs folder contains all APIs related to managing product SKUs for a seller.

These APIs allow partners and developers to create, retrieve, update, and manage SKUs in the seller’s Master Catalog.

SKUs are a core part of Omniful’s catalog management system, enabling sellers to define SKU details, pricing, dimensions, images, and attributes in a structured, channel-ready format.

📌 Overview

SKUs (Stock Keeping Units) represent items that sellers fulfil and ship through Omniful.

The APIs in this folder help you:

Create new SKUs under a seller
\n
List SKUs belonging to a seller
\n
Retrieve detailed information for a single SKU
\n
Update existing SKUs (pricing, status, barcodes, attributes, etc.)
\n

📌 Key Concepts

SKU Code

A unique identifier for each SKU (e.g., \"SKU-TV-123\").

This must be unique at the seller level.

SKU Types

simple – standalone products
\n
bundle (kits) – grouped or packaged products
\n

SKU Status Values

Represents the SKU’s workflow stage:

active
\n
inactive
\n

📋 Common Fields Across SKU APIs

The following table provides a detailed explanation of key fields used across all SKU-related APIs in the Omniful Sales Channel ecosystem.

Field	Type	Description
id	integer	Unique identifier assigned to the SKU in Omniful.
sku_code	string	Unique SKU code used to identify the product at the seller level.
seller_code	string	Code of the seller to whom the SKU belongs.
name	string	Display name/title of the SKU.
description	string	Detailed description of the SKU.
type	string	SKU type — `simple` or `bundle`. Determines product structure.
status	string	Current SKU status (`active`,`inactive`).
brand	string	Brand associated with the SKU.
country_of_origin	string	Country where the SKU was manufactured or sourced.
barcodes	array[string]	List of barcodes associated with the SKU. Multiple barcodes are supported.
images	array[object]	List of product images. Can include a `default` image URL.
weight.value	number	Weight of the product.
weight.uom	string	Unit of measurement for weight (e.g., `kg`, `g`, `lb`, `ea`).
uom	string	Default UOM used for selling or inventory (e.g., `ea`).
dimensions.length.length	number	Length of the SKU.
dimensions.length.unit	string	Unit for length (e.g., `cm`, `in`).
dimensions.breadth.breadth	number	Breadth/width of the SKU.
dimensions.breadth.unit	string	Unit for breadth.
dimensions.height.height	number	Height of the SKU.
dimensions.height.unit	string	Unit for height.
currency	string	Currency code used for SKU prices (e.g., `SAR`, `AED`).
retail_price	number	Maximum Retail Price (MRP) of the SKU.
selling_price	number	Actual selling price used in transactions.
cost_price	number	Cost price of the item (if applicable).
is_perishable	boolean	Indicates whether the SKU has a perishable nature.
handling_type	string	Handling requirements such as `hot` or `cold` (if required by marketplace).
created_at	string	Timestamp when the SKU record was created.
updated_at	string	Timestamp indicating the last update to the SKU.
created_by	string	User/system who created the SKU.
updated_by	string	User/system who last updated the SKU.

","_postman_id":"78b7f9e6-dbae-4209-bd6c-02bbc1ffc1d3","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Hubs","item":[{"name":"Create Hub","id":"b75ab111-27aa-4a02-b24b-eda41b6c7078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Dark_str_1\",\n \"code\": \"Dark_sst\",\n \"type\": \"dark_store\",\n \"email\": \"hub-location-off@gmail.com\",\n \"address\": {\n \"address_line1\": \"19 ش النهضة النهضة النهضة 1 مركز صحارى\",\n \"address_line2\": \"19 ش النهضة النهضة النهضة 1 مركز صحارى\",\n \"state_name\": \"\",\n \"city_name\": \"Riyadh\",\n \"postal_code\": \"00000\",\n \"latitude\": 25.2709141,\n \"longitude\": 55.300312,\n \"country\": {\n \"name\": \"Saudi Arabia\",\n \"code\": \"SA\"\n },\n \"additional_number\": \"1233\",\n \"area\": \"mera area\",\n \"national_address_code\": \"RAFC1231\",\n \"building_number\": \"1234\",\n \"street\": \"123 Main St\"\n },\n \"working_hours\": {\n \"monday\": [\n {\n \"start_time\": 900,\n \"end_time\": 2359\n }\n ],\n \"tuesday\": [\n {\n \"start_time\": 900,\n \"end_time\": 2359\n }\n ],\n \"wednesday\": [\n {\n \"start_time\": 800,\n \"end_time\": 2359\n }\n ],\n \"thursday\": [\n {\n \"start_time\": 800,\n \"end_time\": 2359\n }\n ],\n \"friday\": [\n {\n \"start_time\": 600,\n \"end_time\": 2359\n }\n ],\n \"saturday\": [\n {\n \"start_time\": 700,\n \"end_time\": 2359\n }\n ],\n \"sunday\": [\n {\n \"start_time\": 500,\n \"end_time\": 2359\n }\n ]\n },\n \"configuration\": {\n \"location_inventory\": {\n \"enabled\": true\n },\n \"inwarding_configuration\": {\n \"auto_generate_serialised_barcode\": true\n },\n \"stock_transfer_order\": {\n \"enabled\": false\n },\n \"hub_location_mapping\": {\n \"bins_enabled\": false,\n \"rack_enabled\": false,\n \"zone_enabled\": false,\n \"aisle_enabled\": false,\n \"floor_enabled\": false,\n \"shelf_enabled\": false\n },\n \"adjust_inventory\": {\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": true\n },\n \"gate_entry\": {\n \"enabled\": true\n },\n \"bulk_ship_configuration\": {\n \"picker_capacity\": 5\n },\n \"picking\": {\n \"enabled\": true,\n \"cart_capacity\": 10,\n \"picker_capacity\": 10,\n \"bin_scan_enabled\": true,\n \"single_order_tags\": [\n {\n \"name\": \"create tags\"\n },\n {\n \"name\": \"test\"\n },\n {\n \"name\": \"prepaid\"\n }\n ],\n \"location_scan_enabled\": true,\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": true,\n \"multi_order_picking_type\": 3,\n \"single_order_picking_type\": 1,\n \"multi_order_picking_allowed\": true,\n \"single_order_picking_allowed\": true,\n \"multi_piece_picking_cart_association\": false,\n \"single_piece_picking_cart_association\": true\n },\n \"bin\": {\n \"enabled\": true\n },\n \"location_configuration\": {\n \"layout\": {\n \"bin\": {\n \"exist\": false,\n \"order\": 8,\n \"prefix\": \"B\",\n \"display_name\": \"Bin\"\n },\n \"hall\": {\n \"exist\": false,\n \"order\": 3,\n \"prefix\": \"H\",\n \"display_name\": \"Hall\"\n },\n \"rack\": {\n \"exist\": false,\n \"order\": 5,\n \"prefix\": \"R\",\n \"display_name\": \"Rack\"\n },\n \"aisle\": {\n \"exist\": false,\n \"order\": 4,\n \"prefix\": \"A\",\n \"display_name\": \"Aisle\"\n },\n \"floor\": {\n \"exist\": false,\n \"order\": 2,\n \"prefix\": \"F\",\n \"display_name\": \"Floor\"\n },\n \"shelf\": {\n \"exist\": false,\n \"order\": 6,\n \"prefix\": \"S\",\n \"display_name\": \"Shelf\"\n },\n \"location\": {\n \"exist\": false,\n \"order\": 7,\n \"prefix\": \"L\",\n \"display_name\": \"Location\"\n },\n \"custom_prefix\": {\n \"exist\": true,\n \"order\": 1,\n \"prefix\": \"P\",\n \"display_name\": \"Prefix\"\n }\n },\n \"enabled\": false\n },\n \"put_away\": {\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": true\n },\n \"expiry_configuration\": {\n \"include_near_expiry_items\": false\n },\n \"acceptable_shelf_life_validation\": {\n \"enabled\": false\n },\n \"schedule_order\": {\n \"time\": {\n \"hour\": \"0\",\n \"minute\": \"0\"\n },\n \"enabled\": false\n },\n \"cycle_count_configuration\": {\n \"blind_count\": false,\n \"update_inventory\": false,\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": true\n },\n \"packing_configuration\": {\n \"qc_enabled\": true,\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": true,\n \"automatic_shipment_creation\": false,\n \"auto_print_awb_on_all_items_scanned\": true\n },\n \"purchase_order\": {\n \"enabled\": true,\n \"over_receive_allowed\": true\n }\n },\n \"is_click_and_collect\": false,\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"phone_number\": \"9871627354\",\n \"timezone\": \"Asia/Kolkata\",\n \"currency\": {\n \"name\": \"Indian Rupee\",\n \"code\": \"INR\",\n \"display_name\": \"INR (Indian Rupee)\"\n },\n \"is_pos_enabled\": false,\n \"is_wms_enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs","description":"

Description

Creates a new hub within a tenant. Use this endpoint to register a warehouse, dark store, or fulfillment location with full configuration for inventory, picking, packing, cycle count, schedule order, and other operational behaviors.

On success, the endpoint returns the newly created Hub object.

📌 Required fields for creating a Hub:

name — Hub name
\n
code — Unique hub code
\n
type — Hub type (e.g., \"warehouse\", \"dark_store\")
\n
email — Valid email address
\n
phone_number, country_code, country_calling_code
\n
Complete address object
\n
Complete currency object
\n
Complete configuration object
\n
timezone
\n

📌 Additional Mandatory Fields for Saudi Arabia (KSA)
If the country is Saudi Arabia (KSA), the following address fields are mandatory:

national_address_code
\n
additional_number
\n
building_number
\n
area
\n
street
\n

Note
These fields are required to comply with Saudi National Address regulations, and requests will fail validation if they are missing when the country is set to KSA.

Top-Level Fields

Name	Type	Required	Example	Validation / Notes
name	string	True	`\"Dark_store_1\"`	Cannot be empty
code	string	True	`\"Dark_store_1\"`	Cannot be empty
type	string	True	`\"dark_store\"`	Cannot be empty
email	string	True	`\"hub-location-off@gmail.com\"`	Must be valid email
phone_number	string	True	`\"9871627354\"`	Cannot be empty
country_code	string	True	`\"IN\"`	Cannot be empty
country_calling_code	string	True	`\"+91\"`	Cannot be empty
timezone	string	True	`\"Asia/Kolkata\"`	Cannot be empty
currency	object	True	`{name, code, display_name}`	All fields required
working_hours	object	True	`{monday: [...]}`	At least 1 day must have hours
configuration	object	True	`{...}`	All nested sections required
is_click_and_collect	boolean	False	`false`	Optional
is_pos_enabled	boolean	False	`false`	Optional
is_wms_enabled	boolean	False	`true`	Optional

Address Object

Required.

Field	Type	Required	Example	Validation
address_line1	string	True	`\"B91 DLF Colony\"`	Cannot be empty
address_line2	string	True	`\"Sector 14\"`	Cannot be empty
latitude	float32	True	`28.471653`	Must be valid float32
longitude	float32	True	`77.050965`	Must be valid float32
city_name	string	True	`\"Lucknow\"`	Cannot be empty
state_name	string	False	`\"Haryana\"`	Optional
postal_code	string	False	`\"122001\"`	Optional
country.name	string	True	`\"India\"`	Cannot be empty
country.code	string	True	`\"IN\"`	Cannot be empty
national_address_code	string	Conditional	\"nac_1234\"	Required if `country.code = \"SA\"`
additional_number	string	Conditional	\"1233\"	Required if `country.code = \"SA\"`
building_number	string	Conditional	\"1234\"	Required if `country.code = \"SA\"`
area	string	Conditional	\"Al Olaya\"	Required if `country.code = \"SA\"`
street	string	Conditional	\"King Fahd Rd\"	Required if `country.code = \"SA\"`

Working Hours

Each weekday accepts an array of objects.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example
working_hours.monday	array[HubHour]	False	`[{\"start_time\":900,\"end_time\":2359}]`
working_hours.tuesday	array[HubHour]	False	Same
…	…	…	…

HubHour object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Notes
start_time	uint64	Required if day provided	UNIX timestamp (seconds)
end_time	uint64	Required if day provided	UNIX timestamp (seconds)

Configuration Object

Required.

All major sections must be present.

Below is a structured breakdown:

location_inventory

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example
enabled	boolean	True	`true`

stock_transfer_order

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example
enabled	boolean	True	`false`

hub_location_mapping

Enter if location_inventory is enabled

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	required
bins_enabled	boolean	True
rack_enabled	boolean	True
zone_enabled	boolean	True
aisle_enabled	boolean	True
floor_enabled	boolean	True
shelf_enabled	boolean	True

adjust_inventory

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
manual_barcode_allowed	boolean	True
enter_quantity_manually	boolean	True

gate_entry

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
enabled	boolean	True

bulk_ship_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Validation / Notes
picker_capacity	integer	True	Must be > 0

picking

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example
enabled	boolean	True	`true`
cart_capacity	integer	True	`10`
picker_capacity	integer	True	`10`
bin_scan_enabled	boolean	True	`true`
single_order_tags	array	True	`[{\"name\":\"prepaid\"}]`
location_scan_enabled	boolean	True
manual_barcode_allowed	boolean	True
enter_quantity_manually	boolean	True
multi_order_picking_type	integer	True
single_order_picking_type	integer	True
multi_order_picking_allowed	boolean	True
single_order_picking_allowed	boolean	True
multi_piece_picking_cart_association	boolean	True
single_piece_picking_cart_association	boolean	True

bin

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
enabled	boolean	True

location_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
layout	map	True
enabled	boolean	True

layout contains components like:
bin, hall, rack, aisle, floor, shelf, location, custom_prefix

each containing:

exist (boolean)
\n
order (integer)
\n
prefix (string)
\n
display_name (string)
\n

put_away

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
manual_barcode_allowed	boolean	True
enter_quantity_manually	boolean	True

expiry_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
include_near_expiry_items	boolean	True

acceptable_shelf_life_validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
enabled	boolean	True

schedule_order

Optional.

If provided, all fields required.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Example
enabled	boolean	`false`
time.hour	string	`\"0\"`
time.minute	string	`\"0\"`

cycle_count_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
blind_count	boolean	True
update_inventory	boolean	True
manual_barcode_allowed	boolean	True
enter_quantity_manually	boolean	True

packing_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
qc_enabled	boolean	True
manual_barcode_allowed	boolean	True
enter_quantity_manually	boolean	True
automatic_shipment_creation	boolean	True
auto_print_awb_on_all_items_scanned	boolean	True

purchase_order

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
enabled	boolean	True
over_receive_allowed	boolean	True

inwarding_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
auto_generate_serialised_barcode	boolean	False

\n","urlObject":{"path":["sales-channel","public","v1","tenants","hubs"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b36e3383-3298-4546-87e4-5e280e95fbba","name":"Create Hub","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTA1ODk0NTIsImp0aSI6ImQxYzVhNWM2LTcxNDAtNGRmMC1iNDgwLWUxMjZlZTMwNDZiOSIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRJRCI6IjMiLCJVc2VySUQiOiI5MyIsIlVzZXJOYW1lIjoiQWRhcnNoIFByYXNoYXIiLCJSYXRlTGltaXREZXRhaWxzIjp7IkVuYWJsZWQiOnRydWUsIlJlcXVlc3RzUGVyTWludXRlIjowfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.M08MnyL5ZlhtHbc5wH0eh5UKDLgZi2ZPifgBjqtsxpo4ha8SEnnBTtqXjX1VMauqX9RLIg_JYH6J1dba47uvnwJXtVx_YI6rxtxHQcS41FFVGcTdLRuKC36yCCpYO3fPcg3z2whBMce0gcKiuzqIcbskmvJbmn-9cSc50veioPyYLc8b4sRoHCzx4nRmp2VLfH_fYuFwDfeBvSE2eNg94SxUtj2qMxDLX7Ag3q6o-VEkeykWOfAhIhIHQwlFsEJl6GJR9f5kbNGH-RBIn86eS9g2TvbIDz7D2dmb9XIr_9XYnNFK8guNV7Nap8zgGYzE8xy662kQjbrrbgqbaedd-BWa5mZ6qPhvXAl5OCtdOiDc-OlMoiaKBC2PLLNCpVZaSWqJpoUPwV8kJcmu2_Qnh-6WeyCP6yhFC7ODw-qeOxf8lTMmeMDm0GX2BZVrE9lXQJuwDuCoT-nhndeqzQ7Jn28wiYiwCJqRaphpJ2uE1Z6i_isWemj98xCsVTRQGgBgToyCJsjww0OBil0PHpTrrt47Ya4XlMvauIZjuXDLSurABA71bnTkD2f6_9dlwQ-YUJveyWF2MaAzR0Id2Ne6OtWBmOOwMnkpiFDts4ggisPkneoVL1vM6ZGtYk73LuEIQmmOVBKkxbezob3gfgtsYAlRV5amgoDd6TT9jKc0Vco"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Dark_str_1\",\n \"code\": \"Dark_sst\",\n \"type\": \"dark_store\",\n \"email\": \"hub-location-off@gmail.com\",\n \"address\": {\n \"address_line1\": \"19 ش النهضة النهضة النهضة 1 مركز صحارى\",\n \"address_line2\": \"19 ش النهضة النهضة النهضة 1 مركز صحارى\",\n \"state_name\": \"\",\n \"city_name\": \"Riyadh\",\n \"postal_code\": \"00000\",\n \"latitude\": 25.2709141,\n \"longitude\": 55.300312,\n \"country\": {\n \"name\": \"Saudi Arabia\",\n \"code\": \"SA\"\n },\n \"additional_number\": \"1233\",\n \"area\": \"mera area\",\n \"national_address_code\": \"RAFC1231\",\n \"building_number\": \"1234\",\n \"street\": \"123 Main St\"\n },\n \"working_hours\": {\n \"monday\": [\n {\n \"start_time\": 900,\n \"end_time\": 2359\n }\n ],\n \"tuesday\": [\n {\n \"start_time\": 900,\n \"end_time\": 2359\n }\n ],\n \"wednesday\": [\n {\n \"start_time\": 800,\n \"end_time\": 2359\n }\n ],\n \"thursday\": [\n {\n \"start_time\": 800,\n \"end_time\": 2359\n }\n ],\n \"friday\": [\n {\n \"start_time\": 600,\n \"end_time\": 2359\n }\n ],\n \"saturday\": [\n {\n \"start_time\": 700,\n \"end_time\": 2359\n }\n ],\n \"sunday\": [\n {\n \"start_time\": 500,\n \"end_time\": 2359\n }\n ]\n },\n \"configuration\": {\n \"location_inventory\": {\n \"enabled\": true\n },\n \"inwarding_configuration\": {\n \"auto_generate_serialised_barcode\": true\n },\n \"stock_transfer_order\": {\n \"enabled\": false\n },\n \"hub_location_mapping\": {\n \"bins_enabled\": false,\n \"rack_enabled\": false,\n \"zone_enabled\": false,\n \"aisle_enabled\": false,\n \"floor_enabled\": false,\n \"shelf_enabled\": false\n },\n \"adjust_inventory\": {\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": true\n },\n \"gate_entry\": {\n \"enabled\": true\n },\n \"bulk_ship_configuration\": {\n \"picker_capacity\": 5\n },\n \"picking\": {\n \"enabled\": true,\n \"cart_capacity\": 10,\n \"picker_capacity\": 10,\n \"bin_scan_enabled\": true,\n \"single_order_tags\": [\n {\n \"name\": \"create tags\"\n },\n {\n \"name\": \"test\"\n },\n {\n \"name\": \"prepaid\"\n }\n ],\n \"location_scan_enabled\": true,\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": true,\n \"multi_order_picking_type\": 3,\n \"single_order_picking_type\": 1,\n \"multi_order_picking_allowed\": true,\n \"single_order_picking_allowed\": true,\n \"multi_piece_picking_cart_association\": false,\n \"single_piece_picking_cart_association\": true\n },\n \"bin\": {\n \"enabled\": true\n },\n \"location_configuration\": {\n \"layout\": {\n \"bin\": {\n \"exist\": false,\n \"order\": 8,\n \"prefix\": \"B\",\n \"display_name\": \"Bin\"\n },\n \"hall\": {\n \"exist\": false,\n \"order\": 3,\n \"prefix\": \"H\",\n \"display_name\": \"Hall\"\n },\n \"rack\": {\n \"exist\": false,\n \"order\": 5,\n \"prefix\": \"R\",\n \"display_name\": \"Rack\"\n },\n \"aisle\": {\n \"exist\": false,\n \"order\": 4,\n \"prefix\": \"A\",\n \"display_name\": \"Aisle\"\n },\n \"floor\": {\n \"exist\": false,\n \"order\": 2,\n \"prefix\": \"F\",\n \"display_name\": \"Floor\"\n },\n \"shelf\": {\n \"exist\": false,\n \"order\": 6,\n \"prefix\": \"S\",\n \"display_name\": \"Shelf\"\n },\n \"location\": {\n \"exist\": false,\n \"order\": 7,\n \"prefix\": \"L\",\n \"display_name\": \"Location\"\n },\n \"custom_prefix\": {\n \"exist\": true,\n \"order\": 1,\n \"prefix\": \"P\",\n \"display_name\": \"Prefix\"\n }\n },\n \"enabled\": false\n },\n \"put_away\": {\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": true\n },\n \"expiry_configuration\": {\n \"include_near_expiry_items\": false\n },\n \"acceptable_shelf_life_validation\": {\n \"enabled\": false\n },\n \"schedule_order\": {\n \"time\": {\n \"hour\": \"0\",\n \"minute\": \"0\"\n },\n \"enabled\": false\n },\n \"cycle_count_configuration\": {\n \"blind_count\": false,\n \"update_inventory\": false,\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": true\n },\n \"packing_configuration\": {\n \"qc_enabled\": true,\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": true,\n \"automatic_shipment_creation\": false,\n \"auto_print_awb_on_all_items_scanned\": true\n },\n \"purchase_order\": {\n \"enabled\": true,\n \"over_receive_allowed\": true\n }\n },\n \"is_click_and_collect\": false,\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"phone_number\": \"9871627354\",\n \"timezone\": \"Asia/Kolkata\",\n \"currency\": {\n \"name\": \"Indian Rupee\",\n \"code\": \"INR\",\n \"display_name\": \"INR (Indian Rupee)\"\n },\n \"is_pos_enabled\": false,\n \"is_wms_enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/hubs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Jun 2025 11:57:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"X-Omniful-Request-Id","value":"35038042-728e-4dac-be91-bf6a1052b79d"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"Cf-Ray","value":"94f9a6139a2f2720-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"name\": \"Dark_store_1\",\n \"code\": \"Dark_store_1\",\n \"type\": \"dark_store\",\n \"email\": \"hub-location-off@gmail.com\",\n \"is_active\": true,\n \"phone_number\": \"+91-9871627354\",\n \"timezone\": \"Asia/Kolkata\",\n \"currency\": {\n \"name\": \"Indian Rupee\",\n \"code\": \"INR\",\n \"display_name\": \"INR (Indian Rupee)\"\n },\n \"is_pos_enabled\": false,\n \"is_wms_enabled\": true\n },\n \"meta\": null\n}"}],"_postman_id":"b75ab111-27aa-4a02-b24b-eda41b6c7078"},{"name":"Update Hub","id":"20b8e5ad-4477-4b95-8e93-8a8e23bc02c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"dark_store\",\n \"address\": {\n \"address_line1\": \"B-91\",\n \"address_line2\": \"Road 14\",\n \"state_name\": \"Riyadh Principality\",\n \"city_name\": \"Riyadh\",\n \"postal_code\": \"122001\",\n \"latitude\": 28.471653,\n \"longitude\": 77.050965,\n \"country\": {\n \"name\": \"India\",\n \"code\": \"IN\"\n },\n \"national_address_code\": \"RAFC1231\",\n \"additional_number\": \"1233\",\n \"building_number\": \"1234\",\n \"area\": \"area 14\",\n \"street\": \"123 Main St\"\n },\n \"services\": [\"wms\",\"pos\"],\n \"working_hours\": {\n \"monday\": [\n {\n \"start_time\": 1000,\n \"end_time\": 2359\n }\n ],\n \"tuesday\": [\n {\n \"start_time\":600,\n \"end_time\": 2359\n }\n ],\n \"wednesday\": [\n {\n \"start_time\":800,\n \"end_time\": 2359\n }\n ],\n \"thursday\": [\n {\n \"start_time\":900,\n \"end_time\": 2359\n }\n ],\n \"friday\": [\n {\n \"start_time\":0,\n \"end_time\": 2359\n }\n ],\n \"saturday\": [\n {\n \"start_time\": 0,\n \"end_time\": 2359\n }\n ],\n \"sunday\": [\n {\n \"start_time\": 0,\n \"end_time\": 2359\n }\n ]\n },\n \"configuration\": {\n \"adjust_inventory\": {\n \"manual_barcode_allowed\": false,\n \"enter_quantity_manually\": false\n },\n \"inwarding_configuration\": {\n \"auto_generate_serialised_barcode\": true\n },\n \"gate_entry\": {\n \"enabled\": false\n },\n \"bulk_ship_configuration\": {\n \"picker_capacity\": 100\n },\n \"picking\": {\n \"enabled\": true,\n \"cart_capacity\": 9,\n \"picker_capacity\": 1,\n \"bin_scan_enabled\": true,\n \"single_order_tags\": [\n {\n\n \"name\": \"prepaid\"\n },\n {\n \"name\": \"test\"\n },\n {\n \"name\": \"create tags\"\n }\n ],\n \"location_scan_enabled\": false,\n \"manual_barcode_allowed\": false,\n \"enter_quantity_manually\": false,\n \"multi_order_picking_type\": 3,\n \"single_order_picking_type\": 2,\n \"multi_order_picking_allowed\": false,\n \"single_order_picking_allowed\": true,\n \"multi_piece_picking_cart_association\": false,\n \"single_piece_picking_cart_association\": false\n },\n \"put_away\": {\n \"manual_barcode_allowed\": false,\n \"enter_quantity_manually\": false\n },\n \"expiry_configuration\": {\n \"include_near_expiry_items\": false\n },\n \"acceptable_shelf_life_validation\": {\n \"enabled\": false\n },\n \"schedule_order\": {\n \"time\": {\n \"hour\": \"2\",\n \"minute\": \"45\"\n },\n \"enabled\": true\n },\n \"cycle_count_configuration\": {\n \"blind_count\": true,\n \"update_inventory\": true,\n \"manual_barcode_allowed\": false,\n \"enter_quantity_manually\": false\n },\n \"packing_configuration\": {\n \"qc_enabled\": true,\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": false,\n \"automatic_shipment_creation\": false,\n \"auto_print_awb_on_all_items_scanned\": false\n },\n \"purchase_order\": {\n \"enabled\": true,\n \"over_receive_allowed\": true\n }\n },\n \"is_click_and_collect\": false,\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"phone_number\": \"9871627354\",\n \"timezone\": \"Asia/Kolkata\",\n \"currency\": {\n \"name\": \"Indian Rupee\",\n \"code\": \"INR\",\n \"display_name\": \"INR (Indian Rupee)\"\n },\n \"created_by\": \"aryan gupta\",\n \"created_by_id\": \"21\",\n \"is_pos_enabled\": true,\n \"is_wms_enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs/Dark_store_1k","description":"

Description

Updates an existing tenant hub’s details and configuration.

Use this endpoint when you need to change a hub’s address, services (e.g., WMS/POS), working hours, or operational configurations (picking, packing, cycle count, etc.).

The endpoint performs a partial update: most fields are optional, but when an object is provided (like address, configuration.picking, etc.), the required fields inside that object must be present.

📌 Key things to know:

hub_code (in path) identifies which hub to update.
\n
Body fields are optional, but object-level groups are all-or-nothing:
\n
- If address is sent → all its required subfields must be present.
  \n
- If configuration.picking is sent → its subfields must satisfy validation, etc.
  \n
\n

📌 Additional Mandatory Fields for Saudi Arabia (KSA)
If the country is Saudi Arabia (KSA), the following address fields are mandatory:

national_address_code
\n
additional_number
\n
building_number
\n
area
\n
street
\n

Note
These fields are required to comply with Saudi National Address regulations, and requests will fail validation if they are missing when the country is set to KSA.

Parameters

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Example	Description
hub_code	string	True	`\"Dark_store_1\"`	Hub code identifier to update

Body Parameters

Body is a single Hub object.

All fields below are optional, unless otherwise specified.

However, if an object is provided (e.g. address, configuration.picking), all required fields inside that object must be present.

Top-Level Fields

Name	Type	Required	Example	Notes
type	string	False	`\"dark_store\"`	Hub type (e.g., `\"warehouse\"`, `\"dark_store\"`)
address	object	False	`{...}`	If provided, all required address fields must be present
services	array[string]	False	`[\"wms\",\"pos\"]`	List of services for this hub
working_hours	object	False	`{...}`	If a day is provided, its `start_time` and `end_time` are required
configuration	object	False	`{...}`	If a configuration section is provided, its inner fields must be valid
is_click_and_collect	boolean	False	`false`	Optional
country_calling_code	string	False	`\"+91\"`	Optional
country_code	string	False	`\"IN\"`	Optional
phone_number	string	False	`\"9871627354\"`	Optional
timezone	string	False	`\"Asia/Kolkata\"`	Optional
currency	object	False	`{...}`	If provided, all `currency` fields become required
created_by	string	False	`\"aryan gupta\"`	Typically set from JWT, but can be sent
created_by_id	string	False	`\"21\"`	Optional
is_pos_enabled	boolean	False	`true`	Optional
is_wms_enabled	boolean	False	`true`	Optional

Address Object

Required only if address is provided.

Field	Type	Required	Example	Validation / Notes
address.address_line1	string	Yes*	`\"B-91 DLF Colony\"`	Cannot be empty
address.address_line2	string	Yes*	`\"Sector 14\"`	Cannot be empty
address.latitude	float32	Yes*	`28.471653`	Must be valid float32
address.longitude	float32	Yes*	`77.050965`	Must be valid float32
address.city_name	string	Yes*	`\"Lucknow\"`	Cannot be empty
address.country.name	string	Yes*	`\"India\"`	Cannot be empty
address.country.code	string	Yes*	`\"IN\"`	Cannot be empty
address.postal_code	string	No	`\"122001\"`	Optional
address.state_name	string	No	`\"Haryana\"`	Optional
national_address_code	string	Conditional	\"nac_1234\"	Required if `country.code = \"SA\"`
additional_number	string	Conditional	\"1233\"	Required if `country.code = \"SA\"`
building_number	string	Conditional	\"1234\"	Required if `country.code = \"SA\"`
area	string	Conditional	\"Al Olaya\"	Required if `country.code = \"SA\"`
street	string	Conditional	\"King Fahd Rd\"	Required if `country.code = \"SA\"`

* Yes* = required if address is provided.

Services

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
services	array[string]	No	`[\"wms\",\"pos\"]`	List of enabled services for the hub

Working Hours

Required only if working_hours is provided.

If a specific day key exists, each item in that array must contain start_time and end_time.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example
working_hours.monday	array[HubHour]	No	`[{\"start_time\":1000,\"end_time\":2359}]`
working_hours.tuesday	array[HubHour]	No	`[{\"start_time\":600,\"end_time\":2359}]`
working_hours.wednesday	array[HubHour]	No	`[{\"start_time\":800,\"end_time\":2359}]`
working_hours.thursday	array[HubHour]	No	`[{\"start_time\":900,\"end_time\":2359}]`
working_hours.friday	array[HubHour]	No	`[{\"start_time\":0,\"end_time\":2359}]`
working_hours.saturday	array[HubHour]	No	`[{\"start_time\":0,\"end_time\":2359}]`
working_hours.sunday	array[HubHour]	No	`[{\"start_time\":0,\"end_time\":2359}]`

HubHour object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Notes
start_time	uint64	Yes*	Required if that day array is provided
end_time	uint64	Yes*	Required if that day array is provided

* Per-day, if the day exists in working_hours, each element in its list must have both start_time and end_time.

Configuration Object

Optional at root level.

If a specific configuration section is provided (e.g., configuration.picking), the inner fields must respect the validation rules.

configuration.adjust_inventory

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
configuration.adjust_inventory.manual_barcode_allowed	boolean	No	`false`	Optional
configuration.adjust_inventory.enter_quantity_manually	boolean	No	`false`	Optional

configuration.gate_entry

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
configuration.gate_entry.enabled	boolean	No	`false`	Optional

configuration.bulk_ship_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
configuration.bulk_ship_configuration.picker_capacity	integer	No	`100`	Optional

configuration.picking

If configuration.picking is included, all fields must be valid.

Field	Type	Required	Example	Notes
configuration.picking.enabled	boolean	No	`true`	Optional
configuration.picking.cart_capacity	integer	No	`9`	Optional
configuration.picking.picker_capacity	integer	No	`1`	Optional
configuration.picking.bin_scan_enabled	boolean	No	`true`	Optional
configuration.picking.single_order_tags	array	No	`[{\"name\":\"prepaid\"}]`	Can be empty
configuration.picking.location_scan_enabled	boolean	No	`false`	Optional
configuration.picking.manual_barcode_allowed	boolean	No	`false`	Optional
configuration.picking.enter_quantity_manually	boolean	No	`false`	Optional
configuration.picking.multi_order_picking_type	integer	No	`3`	Optional
configuration.picking.single_order_picking_type	integer	No	`2`	Optional
configuration.picking.multi_order_picking_allowed	boolean	No	`false`	Optional
configuration.picking.single_order_picking_allowed	boolean	No	`true`	Optional
configuration.picking.multi_piece_picking_cart_association	boolean	No	`false`	Optional
configuration.picking.single_piece_picking_cart_association	boolean	No	`false`	Optional

configuration.put_away

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
configuration.put_away.manual_barcode_allowed	boolean	No	`false`	Optional
configuration.put_away.enter_quantity_manually	boolean	No	`false`	Optional

configuration.expiry_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
configuration.expiry_configuration.include_near_expiry_items	boolean	No	`false`	Optional

configuration.acceptable_shelf_life_validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
configuration.acceptable_shelf_life_validation.enabled	boolean	No	`false`	Optional

configuration.schedule_order

If configuration.schedule_order is included, its internal fields are required as per validation.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example
configuration.schedule_order.time	object	No	`{hour:\"2\",minute:\"45\"}`
configuration.schedule_order.time.hour	string	No	`\"2\"`
configuration.schedule_order.time.minute	string	No	`\"45\"`
configuration.schedule_order.enabled	boolean	No	`true`

configuration.cycle_count_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
configuration.cycle_count_configuration.blind_count	boolean	No	`true`	Optional
configuration.cycle_count_configuration.update_inventory	boolean	No	`true`	Optional
configuration.cycle_count_configuration.manual_barcode_allowed	boolean	No	`false`	Optional
configuration.cycle_count_configuration.enter_quantity_manually	boolean	No	`false`	Optional

configuration.packing_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
configuration.packing_configuration.qc_enabled	boolean	No	`true`	Optional
configuration.packing_configuration.manual_barcode_allowed	boolean	No	`true`	Optional
configuration.packing_configuration.enter_quantity_manually	boolean	No	`false`	Optional
configuration.packing_configuration.automatic_shipment_creation	boolean	No	`false`	Optional
configuration.packing_configuration.auto_print_awb_on_all_items_scanned	boolean	No	`false`	Optional

configuration.purchase_order

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Notes
configuration.purchase_order.enabled	boolean	No	`true`	Optional
configuration.purchase_order.over_receive_allowed	boolean	No	`true`	Optional

configuration.inwarding_configuration

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
auto_generate_serialised_barcode	boolean	False

Currency Object

\n
Required only if currency is provided.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example
currency.name	string	No	`\"Indian Rupee\"`
currency.code	string	No	`\"INR\"`
currency.display_name	string	No	`\"INR (Indian Rupee)\"`

\n","urlObject":{"path":["sales-channel","public","v1","tenants","hubs","Dark_store_1k"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fd3a9efb-c3ec-4130-81a6-58c38242e633","name":"New Request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTA1ODk0NTIsImp0aSI6ImQxYzVhNWM2LTcxNDAtNGRmMC1iNDgwLWUxMjZlZTMwNDZiOSIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRJRCI6IjMiLCJVc2VySUQiOiI5MyIsIlVzZXJOYW1lIjoiQWRhcnNoIFByYXNoYXIiLCJSYXRlTGltaXREZXRhaWxzIjp7IkVuYWJsZWQiOnRydWUsIlJlcXVlc3RzUGVyTWludXRlIjowfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.M08MnyL5ZlhtHbc5wH0eh5UKDLgZi2ZPifgBjqtsxpo4ha8SEnnBTtqXjX1VMauqX9RLIg_JYH6J1dba47uvnwJXtVx_YI6rxtxHQcS41FFVGcTdLRuKC36yCCpYO3fPcg3z2whBMce0gcKiuzqIcbskmvJbmn-9cSc50veioPyYLc8b4sRoHCzx4nRmp2VLfH_fYuFwDfeBvSE2eNg94SxUtj2qMxDLX7Ag3q6o-VEkeykWOfAhIhIHQwlFsEJl6GJR9f5kbNGH-RBIn86eS9g2TvbIDz7D2dmb9XIr_9XYnNFK8guNV7Nap8zgGYzE8xy662kQjbrrbgqbaedd-BWa5mZ6qPhvXAl5OCtdOiDc-OlMoiaKBC2PLLNCpVZaSWqJpoUPwV8kJcmu2_Qnh-6WeyCP6yhFC7ODw-qeOxf8lTMmeMDm0GX2BZVrE9lXQJuwDuCoT-nhndeqzQ7Jn28wiYiwCJqRaphpJ2uE1Z6i_isWemj98xCsVTRQGgBgToyCJsjww0OBil0PHpTrrt47Ya4XlMvauIZjuXDLSurABA71bnTkD2f6_9dlwQ-YUJveyWF2MaAzR0Id2Ne6OtWBmOOwMnkpiFDts4ggisPkneoVL1vM6ZGtYk73LuEIQmmOVBKkxbezob3gfgtsYAlRV5amgoDd6TT9jKc0Vco"}],"body":{"mode":"raw","raw":"{\n \"type\": \"dark_store\",\n \"address\": {\n \"address_line1\": \"B-91 DLF Colony\",\n \"address_line2\": \"Sector 14\",\n \"state_name\": \"Haryana\",\n \"city_name\": \"Lucknow\",\n \"postal_code\": \"122001\",\n \"latitude\": 28.471653,\n \"longitude\": 77.050965,\n \"country\": {\n \"name\": \"India\",\n \"code\": \"IN\"\n },\n \"national_address_code\": \"code\"\n },\n \"services\": [\"wms\",\"pos\"],\n \"working_hours\": {\n \"monday\": [\n {\n \"start_time\": 1000,\n \"end_time\": 2359\n }\n ],\n \"tuesday\": [\n {\n \"start_time\":600,\n \"end_time\": 2359\n }\n ],\n \"wednesday\": [\n {\n \"start_time\":800,\n \"end_time\": 2359\n }\n ],\n \"thursday\": [\n {\n \"start_time\":900,\n \"end_time\": 2359\n }\n ],\n \"friday\": [\n {\n \"start_time\":0,\n \"end_time\": 2359\n }\n ],\n \"saturday\": [\n {\n \"start_time\": 0,\n \"end_time\": 2359\n }\n ],\n \"sunday\": [\n {\n \"start_time\": 0,\n \"end_time\": 2359\n }\n ]\n },\n \"configuration\": {\n \"adjust_inventory\": {\n \"manual_barcode_allowed\": false,\n \"enter_quantity_manually\": false\n },\n \"gate_entry\": {\n \"enabled\": false\n },\n \"bulk_ship_configuration\": {\n \"picker_capacity\": 100\n },\n \"picking\": {\n \"enabled\": true,\n \"cart_capacity\": 9,\n \"picker_capacity\": 1,\n \"bin_scan_enabled\": true,\n \"single_order_tags\": [\n {\n\n \"name\": \"prepaid\"\n },\n {\n \"name\": \"test\"\n },\n {\n \"name\": \"create tags\"\n }\n ],\n \"location_scan_enabled\": false,\n \"manual_barcode_allowed\": false,\n \"enter_quantity_manually\": false,\n \"multi_order_picking_type\": 3,\n \"single_order_picking_type\": 2,\n \"multi_order_picking_allowed\": false,\n \"single_order_picking_allowed\": true,\n \"multi_piece_picking_cart_association\": false,\n \"single_piece_picking_cart_association\": false\n },\n \"put_away\": {\n \"manual_barcode_allowed\": false,\n \"enter_quantity_manually\": false\n },\n \"expiry_configuration\": {\n \"include_near_expiry_items\": false\n },\n \"acceptable_shelf_life_validation\": {\n \"enabled\": false\n },\n \"schedule_order\": {\n \"time\": {\n \"hour\": \"2\",\n \"minute\": \"45\"\n },\n \"enabled\": true\n },\n \"cycle_count_configuration\": {\n \"blind_count\": true,\n \"update_inventory\": true,\n \"manual_barcode_allowed\": false,\n \"enter_quantity_manually\": false\n },\n \"packing_configuration\": {\n \"qc_enabled\": true,\n \"manual_barcode_allowed\": true,\n \"enter_quantity_manually\": false,\n \"automatic_shipment_creation\": false,\n \"auto_print_awb_on_all_items_scanned\": false\n },\n \"purchase_order\": {\n \"enabled\": true,\n \"over_receive_allowed\": true\n }\n },\n \"is_click_and_collect\": false,\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\",\n \"phone_number\": \"9871627354\",\n \"timezone\": \"Asia/Kolkata\",\n \"currency\": {\n \"name\": \"Indian Rupee\",\n \"code\": \"INR\",\n \"display_name\": \"INR (Indian Rupee)\"\n },\n \"created_by\": \"aryan gupta\",\n \"created_by_id\": \"21\",\n \"is_pos_enabled\": true,\n \"is_wms_enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/hubs/Dark_store_1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Jun 2025 11:58:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"X-Omniful-Request-Id","value":"b0f8f523-79d7-4328-bcf4-013f355d5d06"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"Cf-Ray","value":"94f9a7ceccd42012-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Hub updated successfully\",\n \"meta\": null\n}"}],"_postman_id":"20b8e5ad-4477-4b95-8e93-8a8e23bc02c7"},{"name":"Get Tenant Hubs","id":"cfe21e52-c94f-4488-b555-7c616413821b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs?include_address=true&per_page=10&page=2","description":"

Description

Retrieves a paginated list of hubs for a tenant.

Use this endpoint to search hubs using filters such as name, code, and to optionally include address details in the response.

This endpoint supports filters + pagination, and returns a structured list of hub objects.

Parameters

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Default	Example	Description
include_address	boolean	False	`false`	`true`	If true, hub address details are included in the response
code	string	False	-	`\"sc-2321\"`	Filter hubs by exact hub code
name	string	False	-	`\"ara\"`	Filter hubs by hub name (full or partial match)
per_page	integer	False	`10`	`10`	Number of records to return per page
page	integer	False	`1`	`2`	Page number for pagination

If user needs address in response, mark this field as true.

\n","type":"text/plain"},"key":"include_address","value":"true"},{"disabled":true,"description":{"content":"

code represents the hub code

\n","type":"text/plain"},"key":"code","value":"sc-2321"},{"disabled":true,"description":{"content":"

name represents the Hub name

\n","type":"text/plain"},"key":"name","value":"ara"},{"description":{"content":"

Number of hub details to be recieved per page

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

Page number of result.

\n","type":"text/plain"},"key":"page","value":"2"}],"variable":[]}},"response":[{"id":"41df64fa-111b-47af-9388-f91dd55ffeaa","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTgzNjQ4MjgsImp0aSI6ImI2NDUyYTBlLWZkYWYtNDBlYi05NjRkLTI1OGFmN2E1YjIwNiIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRDb2RlIjoiMzcxODEyNDk2OCIsIlRlbmFudElEIjoiIiwiVXNlcklEIjoiNTYyOCIsIlVzZXJOYW1lIjoiSGluaXNoIEJhbnNhbCIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjEyMH19LCJ0b2tlbl90eXBlIjoiQmVhcmVyIn0.SUhsS9bmE9bfPb4mX9sOl6W9tyrK_fiSHO6vmmVWwoLzzRsn3Z9jqhgEi1V-1Z9xXsyIPzUtuPJ3oDQTvLNDwzx4eS5Sf0ZhpcI4dE-iA1EkzIzssr2dHMiHZxGjIoBlq8Wwqu4Bhe0NnEOgUHddReTKq40OBBp-44CvgHVZvjm-VPwqN9lvPOljag5fsMQzgeN3aH66v3X0ajdBtAoTXyqZDgd2kRCfHneoGPMrKSOvjByGgsx9GU3qmKu126ZnAufrjvVWk9W26SMmJrg73to8kRfWhJ0jS5F7Kr45mKZFn_6tEDLDxpCq07TaAm-DD-M0GhZdPTW7H9wWx20tt9-55r_KbhWIqPtjH7vRQ4Rdyimx8BYYz7HVlQOuji6VvpQ1ge23KrKzyhBptqO-_6Arpbfj42ewOViFOEL2w6h6t9DRrqNoxG13Jm3ZQYQJf2_Vpt8l2iuEPxSaqI_5_upsLXUt8RhS99vaZ_XXOgMayh7NvVVpbmmUTdfpQ-epZEfInp_2emJu3NFKEjugpANzcdp8fvAKqjTDimhIL59R4HwP2dmTyGWmSx3_VQqJiRQtvA-2yH91pbIwE2hUVQJv5-o2bO4GHaiBNUkjxSQE3e6qnN2H7kxa4j9-ik4YvMPaUtX1XAwXxtkUOR_jKuk4qEd9gZB8gKaV7v9ZWfE"}],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/hubs?per_page=10&page=2","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","tenants","hubs"],"query":[{"key":"include_address","value":"true","disabled":true},{"key":"code","value":"","disabled":true},{"key":"name","value":"ara","disabled":true},{"key":"per_page","value":"10"},{"key":"page","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Sep 2025 12:13:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"df4d5c4c-6f7b-44fb-b7bd-26adc39d9dd1"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"979d672309e8e14a-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"name\": \"12\",\n \"code\": \"2345\",\n \"type\": \"dark_store\",\n \"email\": \"v@gmail.com\",\n \"is_active\": true,\n \"phone_number\": \"+966-567388288\",\n \"timezone\": \"Asia/Riyadh\",\n \"currency\": {\n \"name\": \"Saudi Riyal\",\n \"code\": \"SAR\",\n \"display_name\": \"SAR (Saudi Riyal)\"\n }\n },\n {\n \"name\": \"123\",\n \"code\": \"520\",\n \"type\": \"warehouse\",\n \"email\": \"123@a.com\",\n \"is_active\": true,\n \"phone_number\": \"+966-555555555\",\n \"timezone\": \"Asia/Riyadh\",\n \"currency\": {\n \"name\": \"Saudi Riyal\",\n \"code\": \"SAR\",\n \"display_name\": \"SAR (Saudi Riyal)\"\n }\n },\n {\n \"name\": \"1-RUHSL\",\n \"code\": \"678123\",\n \"type\": \"warehouse\",\n \"email\": \"sl@sl.com\",\n \"is_active\": true,\n \"phone_number\": \"+966-548238541\",\n \"timezone\": \"Asia/Riyadh\",\n \"currency\": {\n \"name\": \"Saudi Riyal\",\n \"code\": \"SAR\",\n \"display_name\": \"SAR (Saudi Riyal)\"\n }\n },\n {\n \"name\": \"236547683456\",\n \"code\": \"dfcgv\",\n \"type\": \"warehouse\",\n \"email\": \"2543678@gmail.com\",\n \"is_active\": true,\n \"phone_number\": \"+91-9876543210\",\n \"timezone\": \"Asia/Dubai\",\n \"currency\": {\n \"name\": \"Saudi Riyal\",\n \"code\": \"SAR\",\n \"display_name\": \"SAR (Saudi Riyal)\"\n }\n },\n {\n \"name\": \"3rd Circle\",\n \"code\": \"744\",\n \"type\": \"warehouse\",\n \"email\": \"3rdcircle@yahoo.com\",\n \"is_active\": true,\n \"phone_number\": \"+962-788647749\",\n \"timezone\": \"Asia/Amman\",\n \"currency\": {\n \"name\": \"United States dollar\",\n \"code\": \"USD\",\n \"display_name\": \"USD (United States dollar)\"\n }\n },\n {\n \"name\": \"5 testing hub\",\n \"code\": \"CHIKU\",\n \"type\": \"retail\",\n \"email\": \"testing@gmail.com\",\n \"is_active\": true,\n \"phone_number\": \"+91-7044567894\",\n \"timezone\": \"Asia/Jerusalem\",\n \"currency\": {\n \"name\": \"Saudi Riyal\",\n \"code\": \"SAR\",\n \"display_name\": \"SAR (Saudi Riyal)\"\n }\n },\n {\n \"name\": \"6\",\n \"code\": \"999\",\n \"type\": \"retail\",\n \"email\": \"wh@muhtaseb.com\",\n \"is_active\": true,\n \"phone_number\": \"+91-9876543210\",\n \"timezone\": \"Asia/Riyadh\",\n \"currency\": {\n \"name\": \"Saudi Riyal\",\n \"code\": \"SAR\",\n \"display_name\": \"SAR (Saudi Riyal)\"\n }\n },\n {\n \"name\": \"678\",\n \"code\": \"890\",\n \"type\": \"warehouse\",\n \"email\": \"pratik@gmail.com\",\n \"is_active\": true,\n \"phone_number\": \"+91-9039432006\",\n \"timezone\": \"Asia/Dubai\",\n \"currency\": {\n \"name\": \"Saudi Riyal\",\n \"code\": \"SAR\",\n \"display_name\": \"SAR (Saudi Riyal)\"\n }\n },\n {\n \"name\": \"A\",\n \"code\": \"15677\",\n \"type\": \"warehouse\",\n \"email\": \"a@g.com\",\n \"is_active\": true,\n \"phone_number\": \"+966-555555555\",\n \"timezone\": \"Asia/Riyadh\",\n \"currency\": {\n \"name\": \"Saudi Riyal\",\n \"code\": \"SAR\",\n \"display_name\": \"SAR (Saudi Riyal)\"\n }\n },\n {\n \"name\": \"aaaa\",\n \"code\": \"555\",\n \"type\": \"retail\",\n \"email\": \"a@a.com\",\n \"is_active\": true,\n \"phone_number\": \"+966-555555555\",\n \"timezone\": \"Asia/Riyadh\",\n \"currency\": {\n \"name\": \"Saudi Riyal\",\n \"code\": \"SAR\",\n \"display_name\": \"SAR (Saudi Riyal)\"\n }\n }\n ],\n \"meta\": {\n \"current_page\": 2,\n \"last_page\": 59,\n \"per_page\": 10,\n \"total\": 584\n }\n}"}],"_postman_id":"cfe21e52-c94f-4488-b555-7c616413821b"},{"name":"Get Hub details by hub_code","id":"4b13b19a-2ffc-4cee-8628-a156335242df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code","description":"

Description

Retrieves detailed information for a specific hub using its hub code.

Use this endpoint to fetch full hub metadata, including its core properties, operational settings, and optionally address details (if supported by backend defaults).

Parameters

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
hub_code	string	True	Unique identifier of the hub whose details are being retrieved

","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","hubs",":hub_code"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"Dark_store_1","key":"hub_code"}]}},"response":[{"id":"8ac82b53-e026-4ed1-bdb7-62c281ad784b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTA1ODk0NTIsImp0aSI6ImQxYzVhNWM2LTcxNDAtNGRmMC1iNDgwLWUxMjZlZTMwNDZiOSIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRJRCI6IjMiLCJVc2VySUQiOiI5MyIsIlVzZXJOYW1lIjoiQWRhcnNoIFByYXNoYXIiLCJSYXRlTGltaXREZXRhaWxzIjp7IkVuYWJsZWQiOnRydWUsIlJlcXVlc3RzUGVyTWludXRlIjowfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.M08MnyL5ZlhtHbc5wH0eh5UKDLgZi2ZPifgBjqtsxpo4ha8SEnnBTtqXjX1VMauqX9RLIg_JYH6J1dba47uvnwJXtVx_YI6rxtxHQcS41FFVGcTdLRuKC36yCCpYO3fPcg3z2whBMce0gcKiuzqIcbskmvJbmn-9cSc50veioPyYLc8b4sRoHCzx4nRmp2VLfH_fYuFwDfeBvSE2eNg94SxUtj2qMxDLX7Ag3q6o-VEkeykWOfAhIhIHQwlFsEJl6GJR9f5kbNGH-RBIn86eS9g2TvbIDz7D2dmb9XIr_9XYnNFK8guNV7Nap8zgGYzE8xy662kQjbrrbgqbaedd-BWa5mZ6qPhvXAl5OCtdOiDc-OlMoiaKBC2PLLNCpVZaSWqJpoUPwV8kJcmu2_Qnh-6WeyCP6yhFC7ODw-qeOxf8lTMmeMDm0GX2BZVrE9lXQJuwDuCoT-nhndeqzQ7Jn28wiYiwCJqRaphpJ2uE1Z6i_isWemj98xCsVTRQGgBgToyCJsjww0OBil0PHpTrrt47Ya4XlMvauIZjuXDLSurABA71bnTkD2f6_9dlwQ-YUJveyWF2MaAzR0Id2Ne6OtWBmOOwMnkpiFDts4ggisPkneoVL1vM6ZGtYk73LuEIQmmOVBKkxbezob3gfgtsYAlRV5amgoDd6TT9jKc0Vco"}],"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/hubs/JP-524"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 14 Jun 2025 12:03:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"X-Omniful-Request-Id","value":"78552ed4-e24e-49aa-abcc-9c17626c1719"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"Cf-Ray","value":"94f9af8fa8ece670-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"name\": \"JP-524\",\n \"code\": \"JP-524\",\n \"type\": \"warehouse\",\n \"layout_type\": \"customized\",\n \"address\": {\n \"country\": \"Saudi Arabia\",\n \"state\": \"Riyadh Principality\",\n \"city\": \"Riyadh\",\n \"postal_code\": \"122001\",\n \"latitude\": 28.47165298461914,\n \"longitude\": 77.05096435546875,\n \"address_line1\": \"abc riyadh\",\n \"address_line2\": \"near shop no 5\",\n \"national_address_code\": \"RAFC1231\",\n \"building_number\": \"1234\",\n \"additional_number\": \"1233\",\n \"street\": \"123 Main St\",\n \"area\": \"area 51\"\n },\n \"working_hours\": {\n \"monday\": [\n {\n \"start_time\": 1000,\n \"end_time\": 2359\n }\n ],\n \"tuesday\": [\n {\n \"start_time\": 600,\n \"end_time\": 2359\n }\n ],\n \"wednesday\": [\n {\n \"start_time\": 800,\n \"end_time\": 2359\n }\n ],\n \"thursday\": [\n {\n \"start_time\": 900,\n \"end_time\": 2359\n }\n ],\n \"friday\": [\n {\n \"end_time\": 2359\n }\n ],\n \"saturday\": [\n {\n \"end_time\": 2359\n }\n ],\n \"sunday\": [\n {\n \"end_time\": 2359\n }\n ]\n },\n \"is_active\": true,\n \"is_click_and_collect\": false,\n \"email\": \"hub-location-off@gmail.com\",\n \"phone_number\": \"9871627354\",\n \"country_calling_code\": \"+91\",\n \"timezone\": \"Asia/Kolkata\",\n \"configurations\": [\n {\n \"configuration_type\": \"gate_entry\",\n \"configuration_values\": {\n \"enabled\": false,\n \"update_allowed\": true\n }\n },\n {\n \"configuration_type\": \"bulk_ship_configuration\",\n \"configuration_values\": {\n \"picker_capacity\": 100,\n \"update_allowed\": true\n }\n },\n {\n \"configuration_type\": \"location_inventory\",\n \"configuration_values\": {\n \"enabled\": true,\n \"update_allowed\": false\n }\n },\n {\n \"configuration_type\": \"stock_transfer_order\",\n \"configuration_values\": {\n \"enabled\": false,\n \"update_allowed\": false\n }\n },\n {\n \"configuration_type\": \"hub_location_mapping\",\n \"configuration_values\": {\n \"aisle_enabled\": false,\n \"bins_enabled\": false,\n \"floor_enabled\": false,\n \"rack_enabled\": false,\n \"shelf_enabled\": false,\n \"update_allowed\": false,\n \"zone_enabled\": false\n }\n },\n {\n \"configuration_type\": \"bin\",\n \"configuration_values\": {\n \"enabled\": true,\n \"update_allowed\": false\n }\n },\n {\n \"configuration_type\": \"location_configuration\",\n \"configuration_values\": {\n \"enabled\": false,\n \"layout\": {\n \"aisle\": {\n \"display_name\": \"Aisle\",\n \"exist\": false,\n \"order\": 4,\n \"prefix\": \"A\"\n },\n \"bin\": {\n \"display_name\": \"Bin\",\n \"exist\": false,\n \"order\": 8,\n \"prefix\": \"B\"\n },\n \"custom_prefix\": {\n \"display_name\": \"Prefix\",\n \"exist\": true,\n \"order\": 1,\n \"prefix\": \"P\"\n },\n \"floor\": {\n \"display_name\": \"Floor\",\n \"exist\": false,\n \"order\": 2,\n \"prefix\": \"F\"\n },\n \"hall\": {\n \"display_name\": \"Hall\",\n \"exist\": false,\n \"order\": 3,\n \"prefix\": \"H\"\n },\n \"location\": {\n \"display_name\": \"Location\",\n \"exist\": false,\n \"order\": 7,\n \"prefix\": \"L\"\n },\n \"rack\": {\n \"display_name\": \"Rack\",\n \"exist\": false,\n \"order\": 5,\n \"prefix\": \"R\"\n },\n \"shelf\": {\n \"display_name\": \"Shelf\",\n \"exist\": false,\n \"order\": 6,\n \"prefix\": \"S\"\n }\n },\n \"update_allowed\": false\n }\n },\n {\n \"configuration_type\": \"assembly_configuration\",\n \"configuration_values\": {\n \"picker_capacity\": 100\n }\n },\n {\n \"configuration_type\": \"adjust_inventory\",\n \"configuration_values\": {\n \"enter_quantity_manually\": false,\n \"manual_barcode_allowed\": false,\n \"update_allowed\": true\n }\n },\n {\n \"configuration_type\": \"picking\",\n \"configuration_values\": {\n \"bin_scan_enabled\": true,\n \"cart_capacity\": 9,\n \"deduct_available_on_not_found\": false,\n \"enabled\": true,\n \"enter_quantity_manually\": false,\n \"exclude_single_sku_bulk_ship_order\": false,\n \"location_scan_enabled\": false,\n \"manual_barcode_allowed\": false,\n \"multi_order_picking_allowed\": false,\n \"multi_order_picking_type\": 3,\n \"multi_piece_picking_cart_association\": false,\n \"picker_capacity\": 1,\n \"single_order_picking_allowed\": true,\n \"single_order_picking_type\": 1,\n \"single_order_tags\": [\n {\n \"color\": \"\",\n \"id\": \"\",\n \"name\": \"prepaid\"\n },\n {\n \"color\": \"\",\n \"id\": \"\",\n \"name\": \"test\"\n },\n {\n \"color\": \"\",\n \"id\": \"\",\n \"name\": \"create tags\"\n }\n ],\n \"single_piece_per_sku_bulk_ship_enabled\": false,\n \"single_piece_picking_cart_association\": false,\n \"single_sku_bulk_ship_enabled\": false,\n \"single_sku_bulk_ship_picker_capacity\": 0,\n \"update_allowed\": true\n }\n },\n {\n \"configuration_type\": \"put_away\",\n \"configuration_values\": {\n \"enter_quantity_manually\": false,\n \"manual_barcode_allowed\": false,\n \"update_allowed\": true\n }\n },\n {\n \"configuration_type\": \"expiry_configuration\",\n \"configuration_values\": {\n \"include_near_expiry_items\": false,\n \"update_allowed\": true\n }\n },\n {\n \"configuration_type\": \"acceptable_shelf_life_validation\",\n \"configuration_values\": {\n \"enabled\": false,\n \"update_allowed\": true\n }\n },\n {\n \"configuration_type\": \"schedule_order\",\n \"configuration_values\": {\n \"enabled\": true,\n \"time\": {\n \"hour\": \"2\",\n \"minute\": \"45\"\n },\n \"update_allowed\": true\n }\n },\n {\n \"configuration_type\": \"cycle_count_configuration\",\n \"configuration_values\": {\n \"blind_count\": true,\n \"enter_quantity_manually\": false,\n \"manual_barcode_allowed\": false,\n \"update_allowed\": true,\n \"update_inventory\": true\n }\n },\n {\n \"configuration_type\": \"packing_configuration\",\n \"configuration_values\": {\n \"auto_print_awb_on_all_items_scanned\": false,\n \"automatic_shipment_creation\": false,\n \"enter_quantity_manually\": false,\n \"manual_barcode_allowed\": true,\n \"packing_station_enabled\": false,\n \"qc_enabled\": true,\n \"update_allowed\": true\n }\n },\n {\n \"configuration_type\": \"purchase_order\",\n \"configuration_values\": {\n \"enabled\": true,\n \"over_receive_allowed\": true,\n \"update_allowed\": true\n }\n },\n {\n \"configuration_type\": \"inwarding_configuration\",\n \"configuration_values\": {\n \"auto_generate_serialised_barcode\": false,\n \"update_allowed\": false\n }\n }\n ],\n \"currency\": {\n \"name\": \"Indian Rupee\",\n \"code\": \"INR\",\n \"display_name\": \"INR (Indian Rupee)\"\n },\n \"is_location_inventory_enabled\": true,\n \"reasons\": [\n {\n \"reason_type\": \"damaged_item_picking\",\n \"reason_details\": [\n {\n \"title\": \"gbgbgbgbgb hnhnh\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"SADGDSFADF\",\n \"description\": \"\",\n \"system_defined\": false\n }\n ]\n },\n {\n \"reason_type\": \"grn_items\",\n \"reason_details\": [\n {\n \"title\": \"Below the minimum acceptable shelf life\",\n \"description\": \"\",\n \"system_defined\": true\n },\n {\n \"title\": \"Ineligible Item\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Broken\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Damaged\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"ecefef\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"gbgb\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"waaahh\",\n \"description\": \"\",\n \"system_defined\": false\n }\n ]\n },\n {\n \"reason_type\": \"picklist_picking\",\n \"reason_details\": [\n {\n \"title\": \"is this\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Expired j\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Wrong Items\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Not relevant to orde\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"ghghghgjjadd\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"dhhh\",\n \"description\": \"\",\n \"system_defined\": false\n }\n ]\n },\n {\n \"reason_type\": \"packing\",\n \"reason_details\": [\n {\n \"title\": \"Damaged Item\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Expired\",\n \"description\": \"Expired\",\n \"system_defined\": true\n },\n {\n \"title\": \"gbgb\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"hnhnhnhn\",\n \"description\": \"\",\n \"system_defined\": false\n }\n ]\n },\n {\n \"reason_type\": \"picking_in_packing\",\n \"reason_details\": [\n {\n \"title\": \"Damaged\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Not Used hmm gbgbgb\",\n \"description\": \"\",\n \"system_defined\": false\n }\n ]\n }\n ],\n \"reason_details\": [\n {\n \"type\": \"damaged_item_picking\",\n \"reasons\": [\n {\n \"reason_type\": \"damaged_item_picking\",\n \"reason_details\": [\n {\n \"title\": \"gbgbgbgbgb hnhnh\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"SADGDSFADF\",\n \"description\": \"\",\n \"system_defined\": false\n }\n ]\n }\n ]\n },\n {\n \"type\": \"grn_items\",\n \"reasons\": [\n {\n \"reason_type\": \"grn_items\",\n \"reason_details\": [\n {\n \"title\": \"Below the minimum acceptable shelf life\",\n \"description\": \"\",\n \"system_defined\": true\n },\n {\n \"title\": \"Ineligible Item\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Broken\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Damaged\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"ecefef\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"gbgb\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"waaahh\",\n \"description\": \"\",\n \"system_defined\": false\n }\n ]\n }\n ]\n },\n {\n \"type\": \"picklist_picking\",\n \"reasons\": [\n {\n \"reason_type\": \"picklist_picking\",\n \"reason_details\": [\n {\n \"title\": \"is this\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Expired j\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Wrong Items\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Not relevant to orde\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"ghghghgjjadd\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"dhhh\",\n \"description\": \"\",\n \"system_defined\": false\n }\n ]\n }\n ]\n },\n {\n \"type\": \"packing\",\n \"reasons\": [\n {\n \"reason_type\": \"packing\",\n \"reason_details\": [\n {\n \"title\": \"Damaged Item\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Expired\",\n \"description\": \"Expired\",\n \"system_defined\": true\n },\n {\n \"title\": \"gbgb\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"hnhnhnhn\",\n \"description\": \"\",\n \"system_defined\": false\n }\n ]\n },\n {\n \"reason_type\": \"picking_in_packing\",\n \"reason_details\": [\n {\n \"title\": \"Damaged\",\n \"description\": \"\",\n \"system_defined\": false\n },\n {\n \"title\": \"Not Used hmm gbgbgb\",\n \"description\": \"\",\n \"system_defined\": false\n }\n ]\n }\n ]\n }\n ],\n \"meta_data\": {\n \"external_hub_name\": \"\",\n \"is_external_hub\": false,\n \"is_pos_enabled\": true,\n \"is_wms_enabled\": true\n },\n \"services\": [\n \"wms\",\n \"pos\"\n ]\n },\n \"meta\": null\n}"}],"_postman_id":"4b13b19a-2ffc-4cee-8628-a156335242df"},{"name":"Bulk update tenant hub mapping","id":"b57ed2b0-a412-4a90-954a-5208a8751c1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"hub_mappings\": [\n {\n \"hub_code\": \"Example-hub-22\",\n \"is_active\": false\n },\n {\n \"hub_code\": \"00\",\n \"is_active\": false\n },\n {\n \"hub_code\": \"wfrefr\",\n \"is_active\": false\n },\n {\n \"hub_code\": \"0000test1\",\n \"is_active\": false\n }\n ]\n}\n"},"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs/bulk_update","description":"

Description

Allows updating specific fields for multiple hubs in a single request.

Use this endpoint when you need to activate/deactivate multiple hubs or apply batch updates to hub-level properties without calling individual update APIs.

Only the fields included for each hub in the hub_mappings array will be updated.

Body Parameters

Body is a single object containing an array of hub updates.

hub_mappings (Array of Hub Mapping Objects)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
hub_mappings	array[object]	True	List of hub update entries. Each entry represents a hub to update.

Hub Mapping Object Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Example	Description
hub_code	string	True	`\"Example-hub-22\"`	Unique hub identifier to update
is_active	boolean	True	`false`	flag to activate or deactivate a hub

Only fields included within each hub mapping object will be updated.
Fields not included will remain unchanged.

The Hubs folder contains all APIs related to managing operational locations (hubs) for a tenant – such as warehouses, dark stores, and retail stores.

These APIs allow partners and developers to create hubs, list existing hubs, retrieve detailed hub configurations, and bulk update hub status in a consistent, tenant-wide way.

Hubs are a core part of Omniful’s fulfillment network, acting as the physical locations from which inventory is stored, picked, packed, and shipped.

📌 Overview

Hubs represent the locations where operations happen in Omniful (storage, picking, packing, handover, POS, etc.).

The APIs in this folder help you:

Create new hubs for a tenant (with address, working hours, and configuration).
\n
List hubs belonging to a tenant with filters and pagination.
\n
Retrieve detailed configuration for a specific hub via hub_code.
\n
Bulk update hub status (e.g., activate/deactivate multiple hubs).
\n

Typical use cases:

Onboarding a new warehouse / dark store network.
\n
Building hub selector components in internal tools.
\n
Enabling/disabling hubs in bulk during rollouts or maintenance.
\n

\n","_postman_id":"223ca70b-aa15-411a-adeb-e63310fee0ac","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Orders","item":[{"name":"Get Orders","id":"451a0471-4b5b-49f0-a5dd-d8c4ca640555","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders?page=1&per_page=20","description":"

Description

Retrieve a paginated list of orders for a specific seller.

You can filter results using multiple optional query parameters such as order ID, customer details, AWB number, SKU code, status, types, and date range.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`seller_code`	string	Yes	Unique seller identifier in Omniful.

Query Parameters

Name	Type	Required	Description
`page`	integer	No	Page number for pagination (default: 1).
`per_page`	integer	No	Number of records per page (default: 20).
`order_id`	string	No	Filter by order ID.
`customer_name`	string	No	Filter by customer name.
`customer_email`	string	No	Filter by customer email.
`status`	string	No	Filter by order status (e.g., `delivered`).
`types`	string	No	Filter by order type (e.g., `b2b`).
`customer_id`	string	No	Filter by customer ID.
`awb_number`	string	No	Filter by AWB number.
`order_alias`	string	No	Filter by order alias.
`omniful_order_id`	string	No	Filter by internal Omniful order ID.
`customer_phone_number`	string	No	Filter by phone number.
`sku_code`	string	No	Filter by SKU code in order items.
`created_from`	date (YYYY-MM-DD)	No	Filter from order creation date.
`created_to`	date (YYYY-MM-DD)	No	Filter until order creation date.

Notes

All filters are optional.
\n
Pagination defaults to page=1 and per_page=20 if not provided.
\n
Empty query values (e.g., customer_id=) are ignored.
\n
Combining multiple filters narrows the results further.
\n

The page number for pagination.

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of records per page (can not be more than 100)

\n","type":"text/plain"},"key":"per_page","value":"20"},{"disabled":true,"description":{"content":"

The unique identifier for the order

\n","type":"text/plain"},"key":"order_id","value":"24530"},{"disabled":true,"description":{"content":"

Mandatory if using created_to. Filters orders by customer name.

\n","type":"text/plain"},"key":"customer_name","value":"John"},{"disabled":true,"description":{"content":"

Mandatory if using created_from. Filters orders by customer email.

\n","type":"text/plain"},"key":"customer_email","value":"sourav.supplier@omniful.id"},{"disabled":true,"description":{"content":"

Filters orders by Omniful order status (e.g., on_hold).

\n","type":"text/plain"},"key":"status","value":"delivered"},{"disabled":true,"description":{"content":"

Specifies the order type (e.g., b2b or 'b2c')

\n","type":"text/plain"},"key":"types","value":"b2b"},{"disabled":true,"description":{"content":"

Filters orders by customer ID

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

AWB number of a order

\n","type":"text/plain"},"key":"awb_number","value":"AWB123456787"},{"disabled":true,"description":{"content":"

order alias

\n","type":"text/plain"},"key":"order_alias","value":"order-alias-127"},{"disabled":true,"description":{"content":"

Filter based on omniful order id.

\n","type":"text/plain"},"key":"omniful_order_id","value":"6867bff01fc150b5fc2241bc"},{"disabled":true,"description":{"content":"

Enter the exact phone number (without country code) or If country code is to be included then, Phone format: Use %2B- (e.g., %2B966-524432433).\ni.e.\"+\" must always be encoded as %2B.

\n","type":"text/plain"},"key":"customer_phone_number","value":"8978765476"},{"disabled":true,"description":{"content":"

Filter based on SKU code

\n","type":"text/plain"},"key":"sku_code","value":"348274938"},{"disabled":true,"description":{"content":"

Filter Based on Order Created Date Range. Default value is (created_to - 90 days). Additionally, created_to - created_from should not exceed 90 days.

\n","type":"text/plain"},"key":"created_from","value":"2024-02-20"},{"disabled":true,"description":{"content":"

Filter Based on Order Updated Date Range. Default value today. Additionally, created_to - created_from should not exceed 90 days.

\n","type":"text/plain"},"key":"created_to","value":"2024-02-23"},{"disabled":true,"description":{"content":"

Filter Based on Order Updated Date Range

\n","type":"text/plain"},"key":"updated_to","value":"2024-03-28"},{"disabled":true,"description":{"content":"

Filter Based on Order Updated Date Range

\n","type":"text/plain"},"key":"updated_from","value":"2024-01-21"}],"variable":[{"type":"any","value":"","key":"seller_code"}]}},"response":[{"id":"5043d995-0252-4219-89e2-c4fdd36b3f39","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders?page=1&per_page=1","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders"],"query":[{"key":"page","value":"1","description":"The page number for pagination."},{"key":"per_page","value":"1","description":"Number of records per page (can not be more than 100)"},{"key":"order_id","value":"24530","description":"The unique identifier for the order","disabled":true},{"key":"customer_name","value":"John","description":"Mandatory if using `created_to`. Filters orders by customer name.","disabled":true},{"key":"customer_email","value":"sourav.supplier@omniful.id","description":"Mandatory if using `created_from`. Filters orders by customer email.","disabled":true},{"key":"status","value":"delivered","description":"Filters orders by Omniful order status (e.g., `on_hold`).","disabled":true},{"key":"types","value":"b2b","description":"Specifies the order type (e.g., `b2b` or 'b2c')","disabled":true},{"key":"customer_id","value":"","description":"Filters orders by customer ID","disabled":true}],"variable":[{"key":"seller_code","value":"974","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:28:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"123b7445-411f-407d-8853-8f59c7506149"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913b9d804b710818-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"69bb97dcfafcde472db01bef\",\n \"order_id\": \"12345657898754defrgtaswe\",\n \"order_alias\": \"order_omniful-alias\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"console\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Custom\",\n \"tag\": \"custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-19T06:29:48.479Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays veryyyy urgent\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69bb8f6c4d84599f5c84e6c6\",\n \"order_id\": \"12345657898754defrgtas\",\n \"order_alias\": \"order_omniful-alias\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"console\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Custom\",\n \"tag\": \"custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-19T05:53:48.489Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays veryyyy urgent\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69bb8f684d84599f5c84e6c3\",\n \"order_id\": \"32431ewdse\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-19T05:53:44.899Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 3,\n \"tax\": 69.9,\n \"discount\": 103,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69bab8bf6537a58b1f71ece5\",\n \"order_id\": \"12345657898754defrgt\",\n \"order_alias\": \"order_omniful-alias\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"console\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Custom\",\n \"tag\": \"custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-18T14:37:51.234Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays veryyyy urgent\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69bab4d76537a58b1f71ec80\",\n \"order_id\": \"note_test_134ty\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-18T14:21:11.03Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 3,\n \"tax\": 69.9,\n \"discount\": 103,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69b2c78db47e3ef10d8ca4a5\",\n \"order_id\": \"sale_wms\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-12T14:02:53.118Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69b2c7817fbdd7d30c9f6d28\",\n \"order_id\": \"sales2_wms\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-12T14:02:41.57Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"wms_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69b2c77e37d3e278a9bc5cb6\",\n \"order_id\": \"omni2_wms\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-12T14:02:38.821Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"wms_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69b2705cfc70a08700828bfe\",\n \"order_id\": \"omni_wms\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"packed\",\n \"display_status\": \"Packed\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-12T07:50:52.557Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"wms_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69b2704937d3e278a9bc4945\",\n \"order_id\": \"sales_wms\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"https://omniful.slack.com/archives/C08G2S1KJ84/p1773033726807059?thread_ts=1773033692.969059&cid=C08G2S1KJ84\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-565345322\",\n \"state\": \"Jeddah\",\n \"zip\": \"https://omniful.slack.com/archives/C08G2S1KJ84/p1773033726807059?thread_ts=1773033692.969059&cid=C08G2S1KJ84\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"RFCD2323\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-12T07:50:33.924Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69b263eefc70a08700828a23\",\n \"order_id\": \"sales\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-12T06:57:50.487Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69b263e8d6dfcc94da8313b9\",\n \"order_id\": \"sales_c\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-12T06:57:44.591Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69afdd47b4c0999f20e8c789\",\n \"order_id\": \"omni\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-10T08:58:47.618Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69afdc1670279d06931de680\",\n \"order_id\": \"omni_order\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"on_hold\",\n \"display_status\": \"On Hold\",\n \"seller_code\": \"974\",\n \"hub_code\": \"pjhubcode\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-10T08:53:42.629Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"shipment_created_at\": \"2026-03-10T08:54:18.06Z\",\n \"shipment_order_id\": \"69afdc3a7df107ad1d240103\",\n \"awb_number\": \"AWBMANUAL123451161888266133\",\n \"shipping_partner_status\": \"created\",\n \"delivery_status\": \"created\",\n \"awb_label\": \"https://example.link.com/shipping/b59de7e04cc5687_awb_label.pdf\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"tracking_url\": \"https://tracking.example.com/123456789\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"Manual\",\n \"tag\": \"manual\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"69afdc0870279d06931de67d\",\n \"order_id\": \"sc_order\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"on_hold\",\n \"display_status\": \"On Hold\",\n \"seller_code\": \"974\",\n \"hub_code\": \"pjhubcode\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-10T08:53:28.558Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"698ae1c0673be7393529b42d\",\n \"order_id\": \"Omniful_CHANNEL_2\",\n \"order_alias\": \"order-alias-127\",\n \"status_code\": \"shipped\",\n \"display_status\": \"Shipped\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"abc\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-02-10T07:44:00.35Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"shipment_created_at\": \"2026-03-10T09:06:40.542Z\",\n \"order_shipped_at\": \"2026-03-10T09:07:43.386Z\",\n \"shipment_order_id\": \"69afdf20abca69cd11fdcc0f\",\n \"awb_number\": \"AWBMANUAL12345116188826613ss\",\n \"shipping_partner_status\": \"dispatched\",\n \"delivery_status\": \"dispatched\",\n \"awb_label\": \"https://example.link.com/shipping/b59de7e04cc5687_awb_label.pdf\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"tracking_url\": \"https://tracking.example.com/123456789\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"Manual\",\n \"tag\": \"manual\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"698ae07e6c6e5ad84bd6cd24\",\n \"order_id\": \"newone\",\n \"order_alias\": \"order-alias\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-02-10T07:38:38.143Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"698ae02546c8b9d6b23fb4dd\",\n \"order_id\": \"myordeqr1\",\n \"order_alias\": \"order-alias\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-02-10T07:37:08.996Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"698adfae88335a9fd47f83eb\",\n \"order_id\": \"myorder1\",\n \"order_alias\": \"order-alias\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-02-10T07:35:10.473Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n {\n \"id\": \"698adf526c6e5ad84bd6cccc\",\n \"order_id\": \"bulk_32320921\",\n \"order_alias\": \"order-alias\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"locoff\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Tenant Custom\",\n \"tag\": \"tenant_custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/sales-channel/API+logo+trial+1.svg\"\n },\n \"source\": \"Sales Channel\",\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-02-10T07:33:38.266Z\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"sales_channel_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 2,\n \"per_page\": 20,\n \"total\": 28\n }\n}"}],"_postman_id":"451a0471-4b5b-49f0-a5dd-d8c4ca640555"},{"name":"Get Single Order","id":"921d090b-3fac-4f33-ac8d-71276647c2ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:id","description":"

Description

Retrieve full details of a specific order for a seller using the id which is the omniful order id.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`seller_code`	string	Yes	Unique identifier for the seller (e.g., `KO-SE-1`).
`id`	string	Yes	Unique internal Omniful order identifier used to fetch a specific order.

Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform.

\n","type":"text/plain"},"type":"any","value":"KO-SE-1","key":"seller_code"},{"type":"any","value":"67b4218b644dd44f6a101c28","key":"id"}]}},"response":[{"id":"275831cc-a99e-487e-baf8-1b6d5d4d9f3a","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:id","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders",":id"],"variable":[{"key":"seller_code","value":"974","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."},{"key":"id","value":"69bb97dcfafcde472db01bef"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:29:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"c73557d4-31d5-42b4-a7f1-cb6ec4f60b98"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913b9ef50fbfd471-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"69bb97dcfafcde472db01bef\",\n \"order_id\": \"order123\",\n \"order_alias\": \"order_omniful-alias\",\n \"status_code\": \"new_order\",\n \"display_status\": \"New Order\",\n \"seller_code\": \"974\",\n \"hub_code\": \"console\",\n \"store_name\": \"abc\",\n \"sales_channel\": {\n \"name\": \"Custom\",\n \"tag\": \"custom\",\n \"category\": \"SalesChannel\",\n \"logo_url\": \"https://staging-omniful-uploads.s3.me-south-1.amazonaws.com/sales-channel-logo/API.svg\"\n },\n \"source\": \"Sales Channel\",\n \"order_items\": [\n {\n \"sku_code\": \"6302592\",\n \"item_id\": \"6302592\",\n \"sales_channel_order_item_id\": \"6302592\",\n \"hs_code\": \"\",\n \"sku_id\": \"\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"substitute_seller_sku_codes\": null,\n \"serialised_sku_codes\": null,\n \"item_barcodes\": null,\n \"quantity\": 8,\n \"picked_quantity\": 0,\n \"packed_quantity\": 0,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 0,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"total\": 8,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"213\"\n },\n \"slot\": {},\n \"order_created_at\": \"2026-03-19T06:29:48.479Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"payment_mode\": \"Tabby\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n },\n \"cod_amount\": 0\n },\n \"payment_method\": \"Prepaid\",\n \"require_shipping\": true,\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"note\": \"Please deliver during weekdays veryyyy urgent\",\n \"type\": \"B2B\",\n \"driver_details\": {},\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n \"meta\": null\n}"}],"_postman_id":"921d090b-3fac-4f33-ac8d-71276647c2ad"},{"name":"Create Order","id":"9968554f-88ec-4af6-85f3-1a8567bc7966","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"order-127\",\n \"order_alias\": \"order-alias-127\",\n \"hub_code\": \"ONLS\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"1108322\",\n \"name\": \"iPhone 200\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-11-234-5678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"MKA\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"national_address_code\": \"\"\n },\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [\n {\n \"url\": \"https:://example.com/avatar1.jpg\",\n \"type\": \"image1\"\n },\n {\n \"url\": \"https:://example.com/avatar2.jpg\",\n \"type\": \"image2\"\n },\n {\n \"url\": \"https:://example.com/avatar3.jpg\",\n \"type\": \"image3\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"payment_method\": \"prepaid\",\n \"delivery_type\": \"normal_delivery\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"b2b\",\n \"meta_data\": {\n \"name\": \"Metadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id\",\n \"value\": \"12345\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n },\n {\n \"key\": \"status\",\n \"value\": \"shipped\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders","description":"

📌 Create Order API Overview

The Create Order API allows users to place new orders in Omniful by providing order details, customer information, shipping and billing addresses, invoice details, and payment information.

📝 Request Body Parameters

Key	Data Type	Description	Required
order_id	string	Must be a globally unique identifier for the order (e.g., \"order_0008\"). Cannot be reused if the order is deleted.	✅ Yes
order_alias	string	Secondary identifier for tracking in external systems (e.g., ERP or warehouse systems).	❌ No
hub_code	string	Code for the warehouse/fulfillment center that will handle this order. Ensure it matches a valid hub in your system.	✅ Yes
order_items	object	Array of items in this order. Must contain at least one item with complete product and pricing details.	✅ Yes
order_items.sku_code	string	Product’s unique SKU identifier, must match exactly with the product catalog.	✅ Yes
order_items.name	string	Product display name, used in the order summary and customer communications.	❌ No
order_items.display_price	number	Original product price before discounts. Used to show savings to the customer.	❌ No
order_items.selling_price	number	Final price charged after base discounts. Used for order calculations.	✅ Yes
order_items.is_substituted	boolean	Set to true if this is a substitution for the customer's original choice. Helps track substitutions.	❌ No
order_items.quantity	integer	Number of units ordered. Must be at least 1. Affects all price calculations.	✅ Yes
order_items.tax_percent	number	Tax rate for this item (e.g., 10 for 10%). Used to calculate the tax amount.	❌ No
order_items.tax	number	Calculated tax for this line item based on the selling price and quantity.	❌ No
order_items.unit_price	number	Price per unit, base price used for quantity calculations.	❌ No
order_items.subtotal	number	Line item total before tax and special discounts (unit_price × quantity).	❌ No
order_items.total	number	Final amount for the line item including all taxes and discounts.	❌ No
order_items.discount	number	Total discount applied to this item.	❌ No
order_items.tax_inclusive	boolean	If true, prices include tax. Important for tax calculations.	❌ No
billing_address	object	Address used for billing and tax calculations. Must be a valid physical address.	✅ Yes
billing_address.address1	string	Main address line (street number and name).	✅ Yes
billing_address.address2	string	Additional address details like apartment number, floor, or landmarks.	❌ No
billing_address.city	string	City name. Must be valid for the given state and country.	✅ Yes
billing_address.country	string	Full country name. Must match with country_code provided.	✅ Yes
billing_address.first_name	string	First name of the billing contact person.	❌ No
billing_address.last_name	string	Last name of the billing contact person.	❌ No
billing_address.phone	string	Contact number for billing issues.	❌ No
billing_address.state	string	Full state name. Must be valid for the given country.	❌ No
billing_address.zip	string	Postal code for the address.	❌ No
billing_address.state_code	string	Standard state/province code (e.g., \"RIY\" for Riyadh).	❌ No
billing_address.country_code	string	Two-letter ISO country code (e.g., \"SA\" for Saudi Arabia).	❌ No
billing_address.latitude	number	Optional GPS latitude for precise location.	❌ No
billing_address.longitude	number	Optional GPS longitude for precise location.	❌ No
billing_address.national_address_code	string	Optional national address code.	❌ No
shipping_address	object	Delivery address where the order will be sent.	✅ Yes
shipping_address.address1	string	Primary delivery address. Must be accurate for successful delivery.	✅ Yes
shipping_address.address2	string	Extra delivery instructions or landmark details.	❌ No
shipping_address.city	string	Delivery city. Must be within serviceable area.	✅ Yes
shipping_address.country	string	Delivery country name. Must match with your shipping rules.	✅ Yes
shipping_address.first_name	string	First name of person receiving delivery.	❌ No
shipping_address.last_name	string	Last name of person receiving delivery.	❌ No
shipping_address.phone	string	Contact number for delivery updates.	❌ No
shipping_address.state	string	Full state name for delivery.	❌ No
shipping_address.zip	string	Postal code for delivery location.	❌ No
shipping_address.state_code	string	Standard state code for delivery location.	❌ No
shipping_address.country_code	string	Two-letter country code for delivery location.	❌ No
shipping_address.latitude	number	Optional GPS latitude for precise location.	❌ No
shipping_address.longitude	number	Optional GPS longitude for precise location.	❌ No
shipping_address.national_address_code	string	Optional national address code.	❌ No
invoice	object	Contains all financial details and calculations for the order.	✅ Yes
invoice.currency	string	Three-letter currency code (e.g., \"USD\", \"SAR\").	✅ Yes
invoice.subtotal	number	Sum of all item prices before tax/discounts.	❌ No
invoice.shipping_price	number	Delivery fee charged to customer.	❌ No
invoice.shipping_refund	number	Any shipping fee refunded to customer.	❌ No
invoice.tax	number	Total tax amount for the order.	❌ No
invoice.discount	number	Total order level discounts (not including item discounts).	❌ No
invoice.total	number	Final order amount including all items, tax, shipping, and discounts.	✅ Yes
invoice.total_paid	number	Amount already received from customer.	❌ No
invoice.total_due	number	Remaining amount to be paid. Should be 0 for prepaid orders.	❌ No
invoice.total_refunded	number	Total amount refunded to customer from this order.	❌ No
invoice.payment_mode	string	How the customer paid (e.g., \"visa\", \"cash\",\"mada\", \"credit card\").	❌ No
invoice.tax_percent	number	Overall tax rate applied to order.	❌ No
invoice.shipping_tax	number	Tax amount specifically for the shipping fee.	❌ No
invoice.sub_total_tax_inclusive	boolean	Whether subtotal includes tax.	❌ No
invoice.sub_total_discount_inclusive	boolean	Whether subtotal includes discounts.	❌ No
invoice.shipping_tax_inclusive	boolean	Whether shipping fee includes tax.	❌ No
invoice.shipping_discount_inclusive	boolean	Whether shipping fee includes discounts.	❌ No
invoice.attachments	array	Optional files like invoices or gift receipts.	❌ No
invoice.attachments.url	string	URL to the attachment.	❌ No
invoice.attachments.type	string	Type of attachment (e.g., \"invoice\", \"receipt\").	❌ No
customer	object	Details about who placed the order.	✅ Yes
customer.id	string	Unique identifier for this customer in your system.	✅ Yes
customer.first_name	string	Customer's first name.	✅ Yes
customer.last_name	string	Customer's last name.	❌ No
customer.mobile	string	Mobile number for updates.	❌ No
customer.mobile_code	string	Country calling code with + prefix.	❌ No
customer.email	string	Customer’s email for order confirmations.	❌ No
customer.avatar	string	URL to customer’s profile image.	❌ No
customer.gender	string	Customer's gender, if provided.	❌ No
labels	array	Custom tags to categorize the order.	❌ No
slot	object	Selected delivery time window.	❌ No
slot.delivery_date	string	Delivery date in DDMMYYYY format.	❌ No
slot.start_time	integer	Delivery window start time in HHMM format.	❌ No
slot.end_time	integer	Delivery window end time in HHMM format.	❌ No
payment_method	string	Payment method chosen (e.g., \"prepaid\", \"postpaid\",\"pending\").	✅ Yes
delivery_type	string	Delivery Types supported. (e.g., click_and_collect, express_delivery, slot_delivery, normal_delivery)	❌ No
transactions	array	List of payment transactions for this order.	❌ No
transactions.transaction_id	string	Unique transaction ID.	❌ No
transactions.amount	number	Transaction amount.	❌ No
transactions.type	integer	Transaction type code (e.g., 1=payment, 2=refund).	❌ No
transactions.card_number	string	Masked card number.	❌ No
transactions.source_account	string	Source account for payment.	❌ No
transactions.destination_account	string	Destination account receiving payment.	❌ No
transactions.status	integer	Payment status code (e.g., 1=success, 0=pending).	❌ No
transactions.description	string	Human-readable explanation of the transaction.	❌ No
is_cash_on_delivery	boolean	Set to true if payment is collected during delivery.	✅ Yes
note	string	Special instructions for order handling.	❌ No
type	string	Order category (e.g., \"b2b\", \"b2c\").	✅ Yes
external_fields	array	Custom fields for external system integration.	❌ No
external_fields.key	string	Custom field name for external systems.	❌ No
external_fields.value	string	Custom field value.	❌ No
cancel_order_after_seconds	integer	Order auto-cancels after this many seconds.	❌ No

✅ Notes

Fields marked as ✅ Yes under \"Required\" must be included in the request.
\n
Geolocation fields (latitude, longitude) are optional but useful for delivery tracking.
\n
The payment_method should match an accepted payment type in the system.
\n
Ensure customer.id is valid if using an existing customer, or create a new customer by passing the required fields.
\n
The order_items array must contain at least one item to process the order.
\n

❓ Frequently Asked Questions (FAQs)

1️⃣ How do I force an order to a specific hub?

To manually route an order to a specific hub, provide the hub's unique code in the hub_code field.

Example: { \"hub_code\": \"HUB123\" }

2️⃣ What if payment details are missing?

If payment information is unavailable and you need to block shipment creation at the packing stage, set:
{ \"payment_method\": \"pending\" }

This ensures the shipment cannot be created until payment details are updated.

3️⃣ How do I create a shipment if the payment status is pending?

Set the payment status to \"pending\" when creating the order.
\n
Once the invoice details are received, update the order using the Update Order Invoice API.
\n
After updating the invoice, shipment creation will be enabled via the dashboard.
\n

Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform.

\n","type":"text/plain"},"type":"any","value":"KO-SE-1","key":"seller_code"}]}},"response":[{"id":"9b32bdb4-a2e0-4ae9-b6b7-2d335eea3229","name":"Create Order With Hub","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"order-123\",\n \"order_alias\": \"order-alias-123\",\n \"hub_code\": \"ONLS\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"srv-sku-10\",\n \"name\": \"iPhone 200\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-11-234-5678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"MKA\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"national_address_code\": \"\"\n },\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [\n {\n \"url\": \"https:://example.com/avatar1.jpg\",\n \"type\": \"image1\"\n },\n {\n \"url\": \"https:://example.com/avatar2.jpg\",\n \"type\": \"image2\"\n },\n {\n \"url\": \"https:://example.com/avatar3.jpg\",\n \"type\": \"image3\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"payment_method\": \"prepaid\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"b2b\",\n \"meta_data\": {\n \"name\": \"Metadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id\",\n \"value\": \"12345\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n },\n {\n \"key\": \"status\",\n \"value\": \"shipped\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders"],"variable":[{"key":"seller_code","value":"KO-SE-1","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:30:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"386cc3d6-b97a-4788-bc20-989e6e571bb4"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913ba09f8a8dd6b8-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"67b41b0ab3ac6dda2312c9ae\",\n \"order_id\": \"order-123\",\n \"order_alias\": \"order-alias-123\",\n \"status_code\": \"On Hold\",\n \"display_status\": \"On Hold\",\n \"seller_code\": \"KO-SE-1\",\n \"hub_code\": \"ONLS\",\n \"store_name\": \"ONLS\",\n \"source\": \"sales_channel\",\n \"order_items\": [\n {\n \"sku_code\": \"srv-sku-10\",\n \"hs_code\": \"\",\n \"sku_id\": \"\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"substitute_seller_sku_codes\": null,\n \"serialised_sku_codes\": null,\n \"item_barcodes\": null,\n \"quantity\": 1,\n \"picked_quantity\": 0,\n \"packed_quantity\": 0,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 768.9,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-123456789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"02\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {},\n \"order_created_at\": \"2025-02-18T05:30:50.448483629Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": null,\n \"attachments\": null\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+966-1234567890\",\n \"mobile_code\": \"+966\",\n \"country_code\": \"\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\",\n \"country\": \"\",\n \"country_calling_code\": \"\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"payment_method\": \"Prepaid\",\n \"delivery_type\": \"normal_delivery\",\n \"type\": \"b2b\",\n \"driver_details\": {},\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n \"meta\": null\n}"},{"id":"615e88f8-1272-4806-91ed-d3b72bbb681d","name":"Create Order With Hub Routing Options","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"order-124\",\n \"order_alias\": \"order-alias-124\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"srv-sku-10\",\n \"name\": \"iPhone 200\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-11-234-5678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"MKA\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"national_address_code\": \"\"\n },\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [\n {\n \"url\": \"https:://example.com/avatar1.jpg\",\n \"type\": \"image1\"\n },\n {\n \"url\": \"https:://example.com/avatar2.jpg\",\n \"type\": \"image2\"\n },\n {\n \"url\": \"https:://example.com/avatar3.jpg\",\n \"type\": \"image3\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"payment_method\": \"prepaid\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"b2b\",\n \"meta_data\": {\n \"name\": \"Metadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id\",\n \"value\": \"12345\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n },\n {\n \"key\": \"status\",\n \"value\": \"shipped\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders"],"variable":[{"key":"seller_code","value":"KO-SE-1","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:32:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"2f153429-af01-4341-a954-9815d808dc49"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913ba25bbeaa6fe3-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"67b41b51b3ac6dda2312c9b5\",\n \"order_id\": \"order-124\",\n \"order_alias\": \"order-alias-124\",\n \"status_code\": \"On Hold\",\n \"display_status\": \"On Hold\",\n \"seller_code\": \"KO-SE-1\",\n \"source\": \"sales_channel\",\n \"order_items\": [\n {\n \"sku_code\": \"srv-sku-10\",\n \"hs_code\": \"\",\n \"sku_id\": \"\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"substitute_seller_sku_codes\": null,\n \"serialised_sku_codes\": null,\n \"item_barcodes\": null,\n \"quantity\": 1,\n \"picked_quantity\": 0,\n \"packed_quantity\": 0,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 768.9,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"total\": 1,\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-112345678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-123456789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"02\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"slot\": {},\n \"order_created_at\": \"2025-02-18T05:32:01.314179854Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": null,\n \"attachments\": null\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+966-1234567890\",\n \"mobile_code\": \"+966\",\n \"country_code\": \"\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\",\n \"country\": \"\",\n \"country_calling_code\": \"\"\n },\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"payment_method\": \"Prepaid\",\n \"delivery_type\": \"normal_delivery\",\n \"type\": \"b2b\",\n \"driver_details\": {},\n \"expected_delivery_epoch\": 0,\n \"external_fields\": null,\n \"cancel_order_after_seconds\": 0\n },\n \"meta\": null\n}"},{"id":"82a68252-e2f7-4cfe-a12a-9011a7fc680c","name":"Order Already Exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"order-124\",\n \"order_alias\": \"order-alias-124\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"srv-sku-10\",\n \"name\": \"iPhone 200\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-11-234-5678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"MKA\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"national_address_code\": \"\"\n },\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [\n {\n \"url\": \"https:://example.com/avatar1.jpg\",\n \"type\": \"image1\"\n },\n {\n \"url\": \"https:://example.com/avatar2.jpg\",\n \"type\": \"image2\"\n },\n {\n \"url\": \"https:://example.com/avatar3.jpg\",\n \"type\": \"image3\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"payment_method\": \"prepaid\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"b2b\",\n \"meta_data\": {\n \"name\": \"Metadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id\",\n \"value\": \"12345\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n },\n {\n \"key\": \"status\",\n \"value\": \"shipped\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders"],"variable":[{"key":"seller_code","value":"KO-SE-1","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:32:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"68691149-f257-4091-8a49-ebd7a5c74089"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913ba2f08f9181b5-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"Order Already Exist\"\n }\n}"},{"id":"8b75e212-8bc5-4e24-9a75-6af9f0d8b543","name":"Invalid Hub Mapping","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"order-123\",\n \"order_alias\": \"order-alias-123\",\n \"hub_code\": \"ONLS4\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"srv-sku-10\",\n \"name\": \"iPhone 200\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-11-234-5678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"MKA\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"national_address_code\": \"\"\n },\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [\n {\n \"url\": \"https:://example.com/avatar1.jpg\",\n \"type\": \"image1\"\n },\n {\n \"url\": \"https:://example.com/avatar2.jpg\",\n \"type\": \"image2\"\n },\n {\n \"url\": \"https:://example.com/avatar3.jpg\",\n \"type\": \"image3\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"payment_method\": \"prepaid\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"b2b\",\n \"meta_data\": {\n \"name\": \"Metadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id\",\n \"value\": \"12345\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n },\n {\n \"key\": \"status\",\n \"value\": \"shipped\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders"],"variable":[{"key":"seller_code","value":"KO-SE-1","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:32:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"51a3438a-fda4-4463-91a4-206dd15dc31a"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913ba39b38af81b5-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"Invalid hub code.\"\n }\n}"},{"id":"6dd5cc23-e747-4bec-9274-d573d32d2f12","name":"Invalid Seller","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"order-123\",\n \"order_alias\": \"order-alias-123\",\n \"hub_code\": \"ONLS4\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"srv-sku-10\",\n \"name\": \"iPhone 200\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-11-234-5678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"MKA\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"national_address_code\": \"\"\n },\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [\n {\n \"url\": \"https:://example.com/avatar1.jpg\",\n \"type\": \"image1\"\n },\n {\n \"url\": \"https:://example.com/avatar2.jpg\",\n \"type\": \"image2\"\n },\n {\n \"url\": \"https:://example.com/avatar3.jpg\",\n \"type\": \"image3\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"payment_method\": \"prepaid\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"b2b\",\n \"meta_data\": {\n \"name\": \"Metadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id\",\n \"value\": \"12345\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n },\n {\n \"key\": \"status\",\n \"value\": \"shipped\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders"],"variable":[{"key":"seller_code","value":"KO-SE-2","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:33:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"e4b55123-95b8-44a2-b92d-3267e0c05fb7"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913ba402685f0587-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 403,\n \"error\": {\n \"message\": \"You are not authorised to perform this action\"\n }\n}"}],"_postman_id":"9968554f-88ec-4af6-85f3-1a8567bc7966"},{"name":"Cancel Order","id":"191b03a4-5eb0-47c7-bc67-83183fa09e05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cancel_reason\": \"The customer selected the wrong product.\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:id/cancel","description":"

Description

Cancel an existing order for a specific seller in Omniful.

This endpoint is used when an order needs to be cancelled due to customer request, incorrect product selection, or operational reasons.

Only orders in a cancellable state (e.g., not yet shipped or delivered) can be cancelled.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`seller_code`	string	Yes	Unique identifier for the seller (e.g., `KO-SE-2`).
`id`	string	Yes	Internal Omniful order ID of the order to be cancelled.

Request Body Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`cancel_reason`	string	No (recommended)	Human-readable explanation for why the order is being cancelled.

Notes

The order must be in a state that allows cancellation.
\n
This operation updates the order lifecycle and triggers cancellation workflows across OMS/WMS/TMS depending on configuration.
\n
If cancel_reason is not provided, the order will still be cancelled, but the reason will be stored as empty.
\n

Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform.

\n","type":"text/plain"},"type":"any","value":"KO-SE-2","key":"seller_code"},{"description":{"content":"

Unique internal Omniful order identifier used to fetch a specific order.

\n","type":"text/plain"},"type":"any","value":"67b33618694116d0824bb47e","key":"id"}]}},"response":[{"id":"e47a2c34-6a1e-42fd-a428-0287511ee25e","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cancel_reason\": \"The customer selected the wrong product.\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:id/cancel","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders",":id","cancel"],"variable":[{"key":"seller_code","value":"KO-SE-1","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."},{"key":"id","value":"67b33618694116d0824bb47e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:34:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"d0ee7d28-8b26-44fe-a9db-87f4daf590ef"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913ba56a4ffc8029-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Order cancelled successfully\",\n \"meta\": null\n}"},{"id":"ae130e97-7acf-4d51-bd9e-d7f6ea6c2cc8","name":"Invalid Seller","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cancel_reason\": \"The customer selected the wrong product.\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:id/cancel","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders",":id","cancel"],"variable":[{"key":"seller_code","value":"KO-SE-2","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."},{"key":"id","value":"67b33618694116d0824bb47e"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:36:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"86425509-0213-4f40-9386-2aea35ce3062"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913ba8dec9932fdf-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 403,\n \"error\": {\n \"message\": \"You are not authorised to perform this action\"\n }\n}"}],"_postman_id":"191b03a4-5eb0-47c7-bc67-83183fa09e05"},{"name":"Update Order","id":"92e79737-6310-4199-92c2-24b41eb155d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"order_000081\",\n \"hub_code\": \"ONLS\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"name\": \"iPhone 15 Pro\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 2,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Main Street\",\n \"city\": \"New York\",\n \"country\": \"United States\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"123-456-7890\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"state_code\": \"NY\",\n \"country_code\": \"US\",\n \"latitude\": 40.7128,\n \"longitude\": -74.0060,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 Elm Street\",\n \"city\": \"Los Angeles\",\n \"country\": \"United States\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"987-654-3210\",\n \"state\": \"CA\",\n \"zip\": \"90001\",\n \"state_code\": \"CA\",\n \"country_code\": \"US\",\n \"latitude\": 34.0522,\n \"longitude\": -118.2437,\n \"national_address_code\": \"\"\n },\n \"order_created_at\": \"2023-07-28T09:00:00Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"shipping_partner_name\": \"CourierX\",\n \"shipping_partner_tag\": \"courierx123\",\n \"awb_number\": \"AWB-456\",\n \"awb_label\": \"https://example.com/awb-label.jpg\",\n \"tracking_link\": \"https://example.com/tracking/456\"\n },\n \"labels\": [\n \"label4\",\n \"label5\",\n \"label6\"\n ],\n \"payment_method\": \"prepaid\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"meta_data\": {\n \"name\": \"detadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id_1\",\n \"value\": \"12347\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:id","description":"

📌 Update Order API - Overview

Users can update an order only if it is not in the \"packed\" state. Once an order reaches the packed stage, further modifications using this API are restricted.

This API ensures flexibility in managing orders before final processing while maintaining data integrity after packing.

📝 Request Body Parameters

Field	Data Type	Description	Required
order_id	string	The ID of the order you want to update. You can't change this value. Example: \"order_0003\".	✅ Yes
hub_code	string	The warehouse handling this order. Example: \"Shubhra001\".	✅ Yes
order_items	array	List of products in the order. You can update quantities, add or remove items.	✅ Yes
order_items.sku_code	string	The product's unique ID in your catalog. Ensure it exists before using it.	✅ Yes
order_items.name	string	The name that appears on the order for this product.	❌ No
order_items.display_price	number	The original price before any discounts.	❌ No
order_items.selling_price	number	The actual price charged for this item after basic discounts.	✅ Yes
order_items.is_substituted	boolean	Set to true if replacing the original item with something else.	❌ No
order_items.quantity	integer	How many of this item you want now. Must be 1 or more.	❌ No
order_items.tax_percent	number	The tax rate for this item (e.g., 10 for 10%).	❌ No
order_items.tax	number	The calculated tax amount for this item based on quantity and price.	❌ No
order_items.unit_price	number	Price per unit of the item.	❌ No
order_items.subtotal	number	Total cost before tax (unit_price × quantity).	❌ No
order_items.total	number	Final price including everything (tax, discounts, etc.).	❌ No
order_items.discount	number	How much discount is applied to this item.	❌ No
order_items.tax_inclusive	boolean	Set to true if prices include tax.	❌ No
billing_address.address1	string	Main billing street address.	❌ No
billing_address.city	string	City for billing.	❌ No
billing_address.country	string	Country for billing.	❌ No
billing_address.first_name	string	First name of the person being billed.	❌ No
billing_address.last_name	string	Last name of the person being billed.	❌ No
billing_address.phone	string	Phone number for billing questions.	❌ No
billing_address.state	string	State for billing.	❌ No
billing_address.zip	string	ZIP or postal code for billing.	❌ No
billing_address.state_code	string	Short code for the state (e.g., \"NY\" for New York).	❌ No
billing_address.country_code	string	Two-letter country code (e.g., \"US\" for United States).	❌ No
billing_address.latitude	number	Latitude for the address, if needed.	❌ No
billing_address.longitude	number	Longitude for the address, if needed.	❌ No
billing_address.national_address_code	string	National address code of the address, if needed.	❌ No
shipping_address.address1	string	Main delivery address.	❌ No
shipping_address.city	string	City for delivery.	❌ No
shipping_address.country	string	Country for delivery.	❌ No
shipping_address.first_name	string	First name of the person receiving the package.	❌ No
shipping_address.last_name	string	Last name of the person receiving the package.	❌ No
shipping_address.phone	string	Phone number to call for delivery.	❌ No
shipping_address.state	string	State for delivery.	❌ No
shipping_address.zip	string	ZIP or postal code for delivery.	❌ No
shipping_address.state_code	string	Short code for the delivery state.	❌ No
shipping_address.country_code	string	Two-letter code for delivery country.	❌ No
shipping_address.latitude	number	Latitude for delivery location, if needed.	❌ No
shipping_address.longitude	number	Longitude for delivery location, if needed.	❌ No
shipping_address.national_address_code	string	National address code of the address, if needed.	❌ No
order_created_at	string	The order’s creation time. Cannot be changed.	❌ No
invoice.currency	string	Currency used for the order (e.g., \"USD\"). Cannot be changed after creation.	❌ No
invoice.subtotal	number	Total cost of all items before any extras.	❌ No
invoice.shipping_price	number	Delivery charge.	❌ No
invoice.shipping_refund	number	Refund for shipping issues.	❌ No
invoice.tax	number	Total tax for the entire order.	❌ No
invoice.discount	number	Total discount applied to the order.	❌ No
invoice.total	number	Final total amount, including everything.	❌ No
invoice.total_paid	number	Total amount already received.	❌ No
invoice.total_due	number	Remaining amount to be paid.	❌ No
invoice.total_refunded	number	Total refunded to the customer.	❌ No
invoice.payment_mode	string	How the customer paid (e.g., \"visa\", \"cash\",\"mada\", \"credit card\").	❌ No
invoice.tax_percent	number	Overall tax rate applied to the order.	❌ No
invoice.shipping_tax	number	Tax applied to the shipping cost.	❌ No
invoice.sub_total_tax_inclusive	boolean	Whether subtotal includes tax.	❌ No
invoice.sub_total_discount_inclusive	boolean	Whether subtotal includes discounts.	❌ No
invoice.shipping_tax_inclusive	boolean	Whether shipping includes tax.	❌ No
invoice.shipping_discount_inclusive	boolean	Whether shipping includes discounts.	❌ No
customer.first_name	string	Customer’s first name.	❌ No
customer.last_name	string	Customer’s last name.	❌ No
customer.mobile	string	Customer’s phone number without country code.	❌ No
customer.mobile_code	string	Country code for the phone (e.g., \"+1\" for US).	❌ No
customer.email	string	Customer’s email for order updates.	❌ No
customer.avatar	string	Link to customer’s profile picture.	❌ No
customer.gender	string	Customer’s gender, if provided.	❌ No
shipment.shipping_partner_name	string	Delivery company name.	❌ No
shipment.shipping_partner_tag	string	Internal code for the delivery company.	❌ No
shipment.awb_number	string	Tracking number for the package.	❌ No
shipment.awb_label	string	Link to download the shipping label.	❌ No
shipment.tracking_link	string	Link for customers to track their package.	❌ No
labels	array	Tags to categorize the order (e.g., [\"urgent\", \"fragile\"]).	❌ No
payment_method	string	Payment method used (e.g., \"prepaid\", \"postpaid\",\"pending\").	❌ No
is_cash_on_delivery	boolean	Set true if cash is collected on delivery.	❌ No
note	string	Special instructions or comments for the order.	❌ No
external_fields	array	Custom fields for system integration.	❌ No
external_fields.key	string	Name of the custom field.	❌ No
external_fields.value	string	Value of the custom field.	❌ No
cancel_order_after_seconds	integer	Auto-cancel the order after this many seconds. Use 0 for never auto-cancel.	❌ No

⚠ Key Points to Consider When Updating Orders

Only orders with the status \"on_hold\" can be updated.
\n
Ensure all required fields are correctly formatted before submitting the update request.
\n

Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform.

\n","type":"text/plain"},"type":"any","value":"KO-SE-1","key":"seller_code"},{"type":"any","value":"67b33618694116d0824bb47e","key":"id"}]}},"response":[{"id":"42d37eb2-9d8f-45df-bbe1-905308381e2f","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"order_000081\",\n \"hub_code\": \"ONLS\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"iPhone 15 Pro\",\n \"name\": \"iPhone 15 Pro\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 2,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Main Street\",\n \"city\": \"New York\",\n \"country\": \"United States\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"123-456-7890\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"state_code\": \"NY\",\n \"country_code\": \"US\",\n \"latitude\": 40.7128,\n \"longitude\": -74.0060,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 Elm Street\",\n \"city\": \"Los Angeles\",\n \"country\": \"United States\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"987-654-3210\",\n \"state\": \"CA\",\n \"zip\": \"90001\",\n \"state_code\": \"CA\",\n \"country_code\": \"US\",\n \"latitude\": 34.0522,\n \"longitude\": -118.2437,\n \"national_address_code\": \"\"\n },\n \"order_created_at\": \"2023-07-28T09:00:00Z\",\n \"invoice\": {\n \"currency\": \"USD\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false\n },\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"shipping_partner_name\": \"CourierX\",\n \"shipping_partner_tag\": \"courierx123\",\n \"awb_number\": \"AWB-456\",\n \"awb_label\": \"https://example.com/awb-label.jpg\",\n \"tracking_link\": \"https://example.com/tracking/456\"\n },\n \"labels\": [\n \"label4\",\n \"label5\",\n \"label6\"\n ],\n \"payment_method\": \"prepaid\",\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"meta_data\": {\n \"name\": \"detadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id_1\",\n \"value\": \"12347\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:id","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders",":id"],"variable":[{"key":"seller_code","value":"KO-SE-1","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."},{"key":"id","value":"67b33618694116d0824bb47e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:38:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"fceaef78-4d6b-412b-8a7e-aa077e0b6aa8"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913bac49e8c5581e-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Order updated successfully\",\n \"meta\": null\n}"}],"_postman_id":"92e79737-6310-4199-92c2-24b41eb155d3"},{"name":"Bulk Create Orders","id":"631fbfae-3b25-4bc2-b2b1-0f63a62511b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"order-127823523676\",\n \"order_alias\": \"order-alias-127\",\n \"hub_code\": \"ONLS\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"11083224\",\n \"name\": \"iPhone 200\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-11-234-5678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"MKA\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"national_address_code\": \"\"\n },\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [\n {\n \"url\": \"https:://example.com/avatar1.jpg\",\n \"type\": \"image1\"\n },\n {\n \"url\": \"https:://example.com/avatar2.jpg\",\n \"type\": \"image2\"\n },\n {\n \"url\": \"https:://example.com/avatar3.jpg\",\n \"type\": \"image3\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"payment_method\": \"prepaid\",\n \"transactions\": [\n {\n \"transaction_id\": \"123456\",\n \"amount\": 100.50,\n \"type\": 1,\n \"card_number\": \"4111111111111111\",\n \"source_account\": \"source_account_123\",\n \"destination_account\": \"destination_account_456\",\n \"status\": 1,\n \"description\": \"Payment for order #12345\"\n }\n ],\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"b2b\",\n \"meta_data\": {\n \"name\": \"Metadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id\",\n \"value\": \"12345\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n },\n {\n \"key\": \"status\",\n \"value\": \"shipped\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders/bulk","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","orders","bulk"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"974","key":"seller_code"}]}},"response":[{"id":"c8bccc0b-ce6c-49ff-8a91-0b96319144ca","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTgzNjQ4MjgsImp0aSI6ImI2NDUyYTBlLWZkYWYtNDBlYi05NjRkLTI1OGFmN2E1YjIwNiIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRDb2RlIjoiMzcxODEyNDk2OCIsIlRlbmFudElEIjoiIiwiVXNlcklEIjoiNTYyOCIsIlVzZXJOYW1lIjoiSGluaXNoIEJhbnNhbCIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjEyMH19LCJ0b2tlbl90eXBlIjoiQmVhcmVyIn0.SUhsS9bmE9bfPb4mX9sOl6W9tyrK_fiSHO6vmmVWwoLzzRsn3Z9jqhgEi1V-1Z9xXsyIPzUtuPJ3oDQTvLNDwzx4eS5Sf0ZhpcI4dE-iA1EkzIzssr2dHMiHZxGjIoBlq8Wwqu4Bhe0NnEOgUHddReTKq40OBBp-44CvgHVZvjm-VPwqN9lvPOljag5fsMQzgeN3aH66v3X0ajdBtAoTXyqZDgd2kRCfHneoGPMrKSOvjByGgsx9GU3qmKu126ZnAufrjvVWk9W26SMmJrg73to8kRfWhJ0jS5F7Kr45mKZFn_6tEDLDxpCq07TaAm-DD-M0GhZdPTW7H9wWx20tt9-55r_KbhWIqPtjH7vRQ4Rdyimx8BYYz7HVlQOuji6VvpQ1ge23KrKzyhBptqO-_6Arpbfj42ewOViFOEL2w6h6t9DRrqNoxG13Jm3ZQYQJf2_Vpt8l2iuEPxSaqI_5_upsLXUt8RhS99vaZ_XXOgMayh7NvVVpbmmUTdfpQ-epZEfInp_2emJu3NFKEjugpANzcdp8fvAKqjTDimhIL59R4HwP2dmTyGWmSx3_VQqJiRQtvA-2yH91pbIwE2hUVQJv5-o2bO4GHaiBNUkjxSQE3e6qnN2H7kxa4j9-ik4YvMPaUtX1XAwXxtkUOR_jKuk4qEd9gZB8gKaV7v9ZWfE"}],"body":{"mode":"raw","raw":"{\n \"orders\": [\n {\n \"order_id\": \"order-12782352367678\",\n \"order_alias\": \"order-alias-127\",\n \"hub_code\": \"ONLS\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"11083224\",\n \"name\": \"iPhone 200\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-11-234-5678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"MKA\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"national_address_code\": \"\"\n },\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [\n {\n \"url\": \"https:://example.com/avatar1.jpg\",\n \"type\": \"image1\"\n },\n {\n \"url\": \"https:://example.com/avatar2.jpg\",\n \"type\": \"image2\"\n },\n {\n \"url\": \"https:://example.com/avatar3.jpg\",\n \"type\": \"image3\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"payment_method\": \"prepaid\",\n \"transactions\": [\n {\n \"transaction_id\": \"123456\",\n \"amount\": 100.50,\n \"type\": 1,\n \"card_number\": \"4111111111111111\",\n \"source_account\": \"source_account_123\",\n \"destination_account\": \"destination_account_456\",\n \"status\": 1,\n \"description\": \"Payment for order #12345\"\n }\n ],\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"b2b\",\n \"meta_data\": {\n \"name\": \"Metadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id\",\n \"value\": \"12345\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n },\n {\n \"key\": \"status\",\n \"value\": \"shipped\"\n }\n ]\n },\n {\n \"order_id\": \"order-127823523676\",\n \"order_alias\": \"order-alias-127\",\n \"hub_code\": \"ONLS\",\n \"shipment_type\": \"sales_channel_generated\",\n \"order_items\": [\n {\n \"sku_code\": \"11083224\",\n \"name\": \"iPhone 200\",\n \"display_price\": 799,\n \"selling_price\": 699,\n \"is_substituted\": false,\n \"quantity\": 1,\n \"tax_percent\": 10,\n \"tax\": 69.9,\n \"unit_price\": 699,\n \"subtotal\": 699,\n \"total\": 768.9,\n \"discount\": 100,\n \"tax_inclusive\": true\n }\n ],\n \"billing_address\": {\n \"address1\": \"123 Al-Masjid Al-Haram Street\",\n \"address2\": \"Near Al-Faisaliah Tower\",\n \"city\": \"Riyadh\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+966-11-234-5678\",\n \"state\": \"Riyadh\",\n \"zip\": \"11564\",\n \"state_code\": \"RIY\",\n \"country_code\": \"SA\",\n \"latitude\": 24.7136,\n \"longitude\": 46.6753,\n \"national_address_code\": \"\"\n },\n \"shipping_address\": {\n \"address1\": \"456 King Abdulaziz Road\",\n \"address2\": \"Near Kingdom Centre\",\n \"city\": \"Jeddah\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-12-345-6789\",\n \"state\": \"Makkah\",\n \"zip\": \"21577\",\n \"state_code\": \"MKA\",\n \"country_code\": \"SA\",\n \"latitude\": 21.4225,\n \"longitude\": 39.8262,\n \"national_address_code\": \"\"\n },\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 699,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 69.9,\n \"discount\": 100,\n \"total\": 768.9,\n \"total_paid\": 768.9,\n \"total_due\": 0,\n \"total_refunded\": 0,\n \"payment_method\": \"Credit Card\",\n \"tax_percent\": 10,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": true,\n \"sub_total_discount_inclusive\": true,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"attachments\": [\n {\n \"url\": \"https:://example.com/avatar1.jpg\",\n \"type\": \"image1\"\n },\n {\n \"url\": \"https:://example.com/avatar2.jpg\",\n \"type\": \"image2\"\n },\n {\n \"url\": \"https:://example.com/avatar3.jpg\",\n \"type\": \"image3\"\n }\n ]\n },\n \"customer\": {\n \"id\": \"66ced351ffed27dec7c4072a\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+1\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"labels\": [\n \"label1\",\n \"label2\",\n \"label3\"\n ],\n \"slot\": {\n \"delivery_date\": \"18122024\",\n \"start_time\": 1100,\n \"end_time\": 1500\n },\n \"payment_method\": \"prepaid\",\n \"transactions\": [\n {\n \"transaction_id\": \"123456\",\n \"amount\": 100.50,\n \"type\": 1,\n \"card_number\": \"4111111111111111\",\n \"source_account\": \"source_account_123\",\n \"destination_account\": \"destination_account_456\",\n \"status\": 1,\n \"description\": \"Payment for order #12345\"\n }\n ],\n \"is_cash_on_delivery\": false,\n \"note\": \"Please deliver during weekdays\",\n \"type\": \"b2b\",\n \"meta_data\": {\n \"name\": \"Metadata\",\n \"has_options\": true\n },\n \"external_fields\": [\n {\n \"key\": \"order_id\",\n \"value\": \"12345\"\n },\n {\n \"key\": \"customer_name\",\n \"value\": \"John Doe\"\n },\n {\n \"key\": \"status\",\n \"value\": \"shipped\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/974/orders/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Sep 2025 12:29:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"2b31956a-ff3a-4417-9737-6651b0c41ab5"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"97a5bb92bb9e8016-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"job_id\": \"6664a81c-8a67-4618-bd80-2633ffb69cab\",\n \"message\": \"Order bulk creation job started successfully\",\n \"expires_in\": 86400\n },\n \"meta\": null\n}"}],"_postman_id":"631fbfae-3b25-4bc2-b2b1-0f63a62511b0"},{"name":"Get Order Logs","id":"20780b0c-3ee0-4a3a-8f6a-661bf04fc6eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:id/logs","description":"

Description

Retrieve full logs of a specific order for a seller using the id which is the omniful order id.

Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform.

\n","type":"text/plain"},"type":"any","value":"974","key":"seller_code"},{"description":{"content":"

Omniful Order Id

\n","type":"text/plain"},"type":"any","value":"698ae1c0673be7393529b42d","key":"id"}]}},"response":[{"id":"12b73342-c8ea-43de-a864-6a8112391834","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/974/orders/698ae1c0673be7393529b42d/logs"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 12 Mar 2026 12:44:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"690bb23d-3423-4e46-8979-54e0909c9aee"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9db2e391caab4d3d-FRA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"logs\": [\n {\n \"event\": \"New Order\",\n \"event_updated_by\": \"Tenant Custom\",\n \"event_updated_at\": \"Feb 10, 2026 07:44:00 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"Hub Assigned\",\n \"event_updated_by\": \"System\",\n \"event_updated_at\": \"Feb 10, 2026 07:44:01 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"In Picking\",\n \"event_updated_by\": \"Priyanshu Jha\",\n \"event_updated_at\": \"Mar 10, 2026 09:03:46 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"Picked\",\n \"event_updated_by\": \"Priyanshu Jha\",\n \"event_updated_at\": \"Mar 10, 2026 09:03:53 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"In Packing\",\n \"event_updated_by\": \"Priyanshu Jha\",\n \"event_updated_at\": \"Mar 10, 2026 09:03:58 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"Packed\",\n \"event_updated_by\": \"Priyanshu Jha\",\n \"event_updated_at\": \"Mar 10, 2026 09:04:48 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"Ready To Ship\",\n \"event_updated_by\": \"Tenant Custom Integration\",\n \"event_updated_at\": \"Mar 10, 2026 09:06:41 AM\",\n \"note\": \"\"\n },\n {\n \"event\": \"Shipped\",\n \"event_updated_by\": \"Tenant Custom Integration\",\n \"event_updated_at\": \"Mar 10, 2026 09:07:43 AM\",\n \"note\": \"\"\n }\n ]\n },\n \"meta\": null\n}"}],"_postman_id":"20780b0c-3ee0-4a3a-8f6a-661bf04fc6eb"}],"id":"b8c2f4a0-f03b-4bc7-8d30-83b5e2d18a94","description":"

🛒 Order API Documentation

📌 Overview

This document outlines the structure of the Order API request and response, explaining the meaning, type, and purpose of each key.

📋 Order Object Structure

🔹 Order Identification

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`order_id`	`string`	Unique identifier for the order in Omniful.
`order_alias`	`string`	Alternative reference name assigned to the order.
`hub_code`	`string`	Code of the fulfillment hub responsible for processing the order.
`seller_code`	`string`	Unique identifier assigned to the seller.
`store_name`	`string`	Name of the store where the order was placed.
`source`	`string`	Indicates where the order originated (e.g., Sales Channel, Manual).
`status_code`	`string`	Current status of the order (e.g., `On Hold`, `Shipped`).

📦 Order Items

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`order_items`	`array`	List of items included in the order.
`sku_code`	`string`	Unique Stock Keeping Unit (SKU) code for the item.
`name`	`string`	Product name as it appears in the store.
`display_price`	`number`	Original price of the item before applying any discount.
`selling_price`	`number`	Final price of the item after applying discounts.
`quantity`	`integer`	Number of units of this item ordered.
`tax_percent`	`number`	Tax percentage applied to this item.
`tax`	`number`	Total tax amount applied to the item.
`unit_price`	`number`	Price per unit of the item.
`subtotal`	`number`	Price before tax and discounts for this item.
`total`	`number`	Final payable amount for this item after tax and discount.

🏠 Address Information

📄 Billing Address (Customer's Payment Information)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`billing_address`	`object`	Contains billing details of the customer.
`address1`	`string`	Primary billing address.
`address2`	`string`	Secondary billing address (if applicable).
`city`	`string`	City where the order is billed.
`state`	`string`	State or region of the billing address.
`zip`	`string`	Postal code of the billing address.
`country`	`string`	Country of the billing address.
`phone`	`string`	Customer’s phone number for billing.
`national_address_code`	`string`	National address code of billing address

🚚 Shipping Address (Customer’s Delivery Information)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`shipping_address`	`object`	Contains shipping details for the order.
`address1`	`string`	Primary shipping address where the order will be delivered.
`address2`	`string`	Secondary shipping address (if applicable).
`city`	`string`	City where the order is being shipped.
`state`	`string`	State or region of the shipping address.
`zip`	`string`	Postal code of the shipping address.
`country`	`string`	Country of the shipping address.
`phone`	`string`	Customer’s phone number for shipping.
`national_address_code`	`string`	National address code of shipping address

🧾 Invoice Information (Order Payment Summary)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`invoice`	`object`	Contains invoice details for the order.
`currency`	`string`	Currency used for this order (e.g., USD, SAR).
`subtotal`	`number`	Total cost of all items before tax, discounts, or shipping.
`shipping_price`	`number`	Shipping cost for the order.
`tax`	`number`	Total tax amount applied to the order.
`discount`	`number`	Total discount applied to the order.
`total`	`number`	Final payable amount including all charges.
`total_paid`	`number`	Amount already paid by the customer.
`total_due`	`number`	Remaining balance the customer needs to pay.
`payment_method`	`string`	Payment mode (e.g., `Mada`, `Credit Card`).

👤 Customer Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`customer`	`object`	Contains customer details.
`first_name`	`string`	Customer’s first name.
`last_name`	`string`	Customer’s last name.
`mobile`	`string`	Customer’s mobile number.
`mobile_code`	`string`	Country code for the mobile number.
`email`	`string`	Customer’s email address.

🚛 Shipment Details (Delivery Processing)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`shipment_type`	`string`	Type of shipment (e.g., `omniful_generated`).
`delivery_type`	`string`	Type of delivery (e.g., `normal_delivery`).

💰 Payment Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`payment_method`	`string`	Payment method selected by the customer (e.g., `prepaid`, `COD`).

📝 Miscellaneous

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`note`	`string`	Additional notes or instructions related to the order.
`type`	`string`	The order category (e.g., `b2b`, `RTS`).

✅ Notes

order_id is the primary reference for tracking and retrieving orders.
\n
Use Omniful Order ID instead of sales channel IDs for consistency.
\n
Orders can be fetched using the Get Orders API.
\n

For further details, refer to the Sample API Request Response Below.

\n","_postman_id":"b8c2f4a0-f03b-4bc7-8d30-83b5e2d18a94","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Shipment","item":[{"name":"Trigger Automatic Shipment Creation","id":"8f06b346-8a31-43b5-81fc-80063382db0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number_of_boxes\": 1,\n \"weight\": 1.2,\n \"remarks\": \"Please handle shipment carefully,\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:id/shipment","description":"

This API endpoint is used to trigger the automatic creation of a shipment for a specific order within the Omniful platform. The shipment is generated when the details for a given order are provided, such as the number of boxes, weight, and any special remarks. This is used when the shipments are to be generated automatically by Omniful.

This API endpoint is used to update an existing shipment for a specific order within the Omniful platform. It allows you to modify shipment details such as shipping partner information, tracking URL, package details (e.g., dimensions, weight), and courier partner information. This is typically used to update shipment details after the initial creation by Sales Channel only.

This API is used to update shipment status when shipment type of the order is sales_channel_generated & omniful_generated.

Allowed Shipment Status: [ dispatched, out_for_delivery, in_transit, delivered, return_to_origin]

Creates a manual shipment for an existing order by attaching tracking, AWB, and package details.
Can be created only for order with the shipment type: omniful_generated

mandatory if using created_to

\n","type":"text/plain"},"key":"created_from","value":"31-01-2025"},{"disabled":true,"description":{"content":"

mandatory if using created_from

\n","type":"text/plain"},"key":"created_to","value":"10-02-2025"},{"disabled":true,"description":{"content":"

ordered, recieved, closed, partially_recieved

\n","type":"text/plain"},"key":"order_status","value":"ordered"},{"disabled":true,"key":"seller_code","value":"SG-333"}],"variable":[{"type":"any","value":"ONLS","key":"hub_code"}]}},"response":[{"id":"1eccf175-d269-4fd1-9750-9e620ed7129a","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/purchase_orders?page=1&per_page=30&created_to=10-02-2025","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","hubs",":hub_code","purchase_orders"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"30"},{"key":"reference_purchase_order_id","value":"po-ref-45642","disabled":true},{"key":"created_from","value":"31-01-2025","description":"mandatory if using created_to","disabled":true},{"key":"created_to","value":"10-02-2025","description":"mandatory if using created_from"},{"key":"order_status","value":"ordered","description":"ordered, recieved, closed, partially_recieved","disabled":true},{"key":"seller_code","value":"SG-333","disabled":true}],"variable":[{"key":"hub_code","value":"INDIAN_HUB8"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Omniful-Request-Id","value":"fb808fc6-e834-4ead-8069-06fe098e4d95"},{"key":"Date","value":"Wed, 12 Feb 2025 10:59:45 GMT"},{"key":"Content-Length","value":"1318"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"seller_name\": \"Saudi Electronics Store\",\n \"hub_code\": \"INDIAN_HUB8\",\n \"purchase_order_id\": \"PO-LO1-3\",\n \"reference_purchase_order_id\": \"po-ref-45644\",\n \"supplier_name\": \"Srv\",\n \"status\": \"ordered\",\n \"type\": \"standard\",\n \"total_amount\": 114.4,\n \"gate_entry_status\": false,\n \"currency\": \"SAR\",\n \"shipping\": {},\n \"item_number\": 11,\n \"remark\": \"Ritik\",\n \"created_at\": \"2025-02-12T15:02:42.831752+05:30\",\n \"updated_at\": \"2025-02-12T15:02:42.831752+05:30\"\n },\n {\n \"seller_name\": \"Sourav Seller\",\n \"hub_code\": \"INDIAN_HUB8\",\n \"purchase_order_id\": \"PO-LO1-2\",\n \"reference_purchase_order_id\": \"po-ref-45642\",\n \"supplier_name\": \"Srv\",\n \"status\": \"ordered\",\n \"type\": \"standard\",\n \"total_amount\": 114.4,\n \"gate_entry_status\": false,\n \"currency\": \"SAR\",\n \"shipping\": {},\n \"item_number\": 11,\n \"remark\": \"Ritik\",\n \"created_at\": \"2025-02-12T12:07:57.13759+05:30\",\n \"updated_at\": \"2025-02-12T12:07:57.13759+05:30\"\n },\n {\n \"seller_name\": \"Sourav Seller\",\n \"hub_code\": \"INDIAN_HUB8\",\n \"purchase_order_id\": \"PO-LO1-1\",\n \"reference_purchase_order_id\": \"po-ref-45643\",\n \"supplier_name\": \"Srv\",\n \"status\": \"ordered\",\n \"type\": \"standard\",\n \"total_amount\": 135.2,\n \"gate_entry_status\": false,\n \"currency\": \"SAR\",\n \"shipping\": {},\n \"item_number\": 13,\n \"remark\": \"Ritik\",\n \"created_at\": \"2025-02-12T11:58:41.914649+05:30\",\n \"updated_at\": \"2025-02-12T11:58:41.914649+05:30\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 30,\n \"total\": 3\n }\n}"}],"_postman_id":"83842192-c0e0-42dc-b7b0-5262987f0cae"},{"name":"Get Single Purchase Order","id":"0253de45-7f4e-43aa-9073-2aff8891a2bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/purchase_orders/:purchase_order_id","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","hubs",":hub_code","purchase_orders",":purchase_order_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"INDIAN_HUB8","key":"hub_code"},{"type":"any","value":"PO-LO1-2","key":"purchase_order_id"}]}},"response":[{"id":"18abd8bc-f890-481d-b44e-dd044f17a81a","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/purchase_orders/:purchase_order_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","hubs",":hub_code","purchase_orders",":purchase_order_id"],"variable":[{"key":"hub_code","value":"INDIAN_HUB8"},{"key":"purchase_order_id","value":"PO-LO1-2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Omniful-Request-Id","value":"b6f6252d-5b93-4a6d-bfab-cbee1967ad0e"},{"key":"Date","value":"Wed, 12 Feb 2025 11:07:56 GMT"},{"key":"Content-Length","value":"1191"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"purchase_order_id\": \"PO-LO1-3\",\n \"order_details\": {\n \"quantity\": 11,\n \"grn_pass_quantity\": 0,\n \"grn_fail_quantity\": 0,\n \"put_away_pass_quantity\": 0,\n \"put_away_fail_quantity\": 0\n },\n \"seller\": {\n \"name\": \"Saudi Electronics Store\",\n \"phone\": \"501234567\",\n \"email\": \"store@saudielectronics.com\"\n },\n \"hub_code\": \"INDIAN_HUB8\",\n \"supplier\": {\n \"name\": \"Srv\",\n \"phone\": \"SA-+966-512345678\",\n \"email\": \"sourav.supplier2@omniful.in\"\n },\n \"status\": \"ordered\",\n \"total_amount\": 114.4,\n \"currency\": \"SAR\",\n \"item_number\": 1,\n \"remark\": \"Ritik\",\n \"purchase_order_items\": [\n {\n \"id\": 3,\n \"tenant_id\": \"\",\n \"seller_id\": \"\",\n \"hub_id\": 1,\n \"purchase_order_id\": 3,\n \"sku\": {\n \"name\": \"ALU 3432423\",\n \"seller_sku_id\": \"67ac6a8a35b1f09033cf859a\",\n \"seller_sku_code\": \"srv-sku-12\",\n \"images\": [\n {\n \"url\": \"https://m.media-amazon.com/images/I/71bmtncxa+L._AC_SX679_.jpg\",\n \"type\": \"\"\n }\n ],\n \"attributes\": [],\n \"package_type\": \"ea\"\n },\n \"quantity\": 11,\n \"unit_price\": 10.4,\n \"child_purchase_order_items\": [],\n \"updated_at\": \"2025-02-12T15:02:42.835302Z\",\n \"opened_quantity\": 0,\n \"received_quantity\": 0\n }\n ],\n \"grn_details\": [],\n \"expected_receiving_date\": [],\n \"created_at\": \"2025-02-12T15:02:42.831752+05:30\",\n \"created_by\": \"Saudi Electronics Store\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"}],"_postman_id":"0253de45-7f4e-43aa-9073-2aff8891a2bc"},{"name":"Create Purchase Order","id":"208c5860-25c6-4ecb-8039-2529ed837d88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"supplier_email\": \"r@14.com\",\n \"seller_code\" : \"KO-SE-1\",\n \"supplier_code\" : \"UR-716\",\n \"over_receive_allowed\" : true,\n \"purchase_order_items\": [\n {\n \"sku_code\": \"1108322\",\n \"quantity\": 1,\n \"unit_price\": 10.4\n }\n ],\n \"remark\": \"Inwarding\",\n \"reference_purchase_order_id\": \"po-ref-45646\",\n \"currency\": \"SAR\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/purchase_orders","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","hubs",":hub_code","purchase_orders"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"ONLS","key":"hub_code"}]}},"response":[{"id":"5f9d4197-b2ff-42f4-817e-7140cdb8b2dd","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"supplier_email\": \"r@14.com\",\n \"seller_code\" : \"KO-SE-1\",\n \"supplier_code\" : \"UR-716\",\n \"over_receive_allowed\" : true,\n \"purchase_order_items\": [\n {\n \"sku_code\": \"1108322\",\n \"quantity\": 1,\n \"unit_price\": 10.4\n }\n ],\n \"remark\": \"Inwarding\",\n \"reference_purchase_order_id\": \"po-ref-45646\",\n \"currency\": \"SAR\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/purchase_orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","hubs",":hub_code","purchase_orders"],"variable":[{"key":"hub_code","value":"ONLS"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 06:35:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"c64069f0-faa5-4319-9e5d-cfc2538208af"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913bffefee7b3970-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"purchase_order_id\": \"PO-PI6-2\",\n \"reference_purchase_order_id\": \"po-ref-45646\"\n },\n \"meta\": null\n}"},{"id":"e126846d-3f28-4116-bb86-caa484158d95","name":"Purchase Order Not Enabled","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"supplier_email\": \"sourav.supplier@omniful.in\",\n \"seller_code\" : \"KO-SE-1\",\n \"purchase_order_items\": [\n {\n \"sku_code\": \"srv-sku-10\",\n \"quantity\": 1,\n \"unit_price\": 10.4\n }\n ],\n \"remark\": \"Ritik\",\n \"reference_purchase_order_id\": \"po-ref-45645\",\n \"currency\": \"SAR\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/purchase_orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","hubs",":hub_code","purchase_orders"],"variable":[{"key":"hub_code","value":"ONLS"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 06:32:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"154"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"7ffd7d1a-5ac6-4e76-abdb-b5304cdc089c"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913bfb4ab898c995-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"Purchase order for this hub is not enabled. Please enable purchase order settings to proceed.\"\n }\n}"}],"_postman_id":"208c5860-25c6-4ecb-8039-2529ed837d88"},{"name":"Update Purchase Order","id":"96d9daf7-c605-4095-9b89-9be9be277af2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"remark\": \"\",\n \"awb\": \"\",\n \"over_receive_allowed\": true,\n \"purchase_order_items\": [\n {\n \"sku_code\": \"srv-sku-10\",\n \"quantity\": 27,\n \"unit_price\": 31\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/purchase_orders/:purchase_order_id","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","hubs",":hub_code","purchase_orders",":purchase_order_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"INDIAN_HUB8","key":"hub_code"},{"type":"any","value":"PO-LO1-2","key":"purchase_order_id"}]}},"response":[{"id":"221efcdd-a644-46fd-81c3-8bc2e444dd3b","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"remark\": \"\",\n \"awb\": \"\",\n \"over_receive_allowed\": true,\n \"purchase_order_items\": [\n {\n \"sku_code\": \"srv-sku-9\",\n \"quantity\": 270,\n \"unit_price\": 31\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/purchase_orders/:purchase_order_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","hubs",":hub_code","purchase_orders",":purchase_order_id"],"variable":[{"key":"hub_code","value":"INDIAN_HUB8"},{"key":"purchase_order_id","value":"PO-LO1-2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Omniful-Request-Id","value":"1907b431-927a-4b56-8d55-587793138ceb"},{"key":"Date","value":"Wed, 12 Feb 2025 11:16:57 GMT"},{"key":"Content-Length","value":"94"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Purchase order updated successfully\",\n \"meta\": null\n}"}],"_postman_id":"96d9daf7-c605-4095-9b89-9be9be277af2"}],"id":"a8c06d79-fc09-4b04-bd62-3dea649685c2","_postman_id":"a8c06d79-fc09-4b04-bd62-3dea649685c2","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Cycle Count","item":[{"name":"Get Cycle Counts","id":"7d1109f5-a058-42a6-ad2e-e345db81e56c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/hubs/:hub_code/cycle_counts?page=1&per_page=100&created_from=2025-03-02 15:04:05&created_to=2025-03-04 15:04:05&timezone=UTC","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","hubs",":hub_code","cycle_counts"],"host":["{{base_url}}"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"100"},{"description":{"content":"

Use this parameter to specify the starting date and time from which you want to retrieve cycle counts. This helps you fetch cycle counts from a specific point in time. (Format: YYYY-MM-DD HH:MM:SS)

Note: This value is required to apply filter If this value is provided empty then filter will not be applied.

\n","type":"text/plain"},"key":"created_from","value":"2025-03-02 15:04:05"},{"description":{"content":"

Use this parameter to define the end date and time until which you want to fetch cycle counts. This ensures you retrieve cycle counts data within a specific time range. (Format: YYYY-MM-DD HH:MM:SS)

\n","type":"text/plain"},"key":"created_to","value":"2025-03-04 15:04:05"},{"description":{"content":"

Specify the timezone in which you want the cycle counts timestamps to be returned. If no timezone is provided, the system defaults to UTC. Example: Asia/Riyadh.

\n","type":"text/plain"},"key":"timezone","value":"UTC"}],"variable":[{"type":"any","value":"ONLS","key":"hub_code"}]}},"response":[{"id":"b6f79b21-9f83-446a-aab8-dd5d1e6fd7b3","name":"Get Cycle Counts","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/hubs/:hub_code/cycle_counts","host":["{{base_url}}"],"path":["sales-channel","public","v1","hubs",":hub_code","cycle_counts"],"variable":[{"key":"hub_code","value":"Shubhra001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 Jan 2025 07:09:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"b77dc400-3f5d-47cf-8a1a-f5861087ef73"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8fe21eacba1539a4-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"cycle_count_id\": \"CC-DE165-1\",\n \"name\": \"Test\",\n \"status\": \"Completed\",\n \"due_date\": \"2025-01-08\",\n \"discrepancies\": true,\n \"created_by\": \"Shubra\",\n \"created_at\": \"Jan 07, 2025 07:08:38 AM\",\n \"blind_count\": false,\n \"seller_code\": \"2727\",\n \"mode\": \"web\",\n \"cycle_count_cancellable\": false\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"}],"_postman_id":"7d1109f5-a058-42a6-ad2e-e345db81e56c"},{"name":"Get Cycle Counts SKUs","id":"58264d93-36f8-481d-9b07-1ce98b3e070a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/hubs/:hub_code/cycle_counts/:cycle_count_id/skus","urlObject":{"path":["sales-channel","public","v1","hubs",":hub_code","cycle_counts",":cycle_count_id","skus"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"Shubhra001","key":"hub_code"},{"type":"any","value":"CC-DE165-1","key":"cycle_count_id"}]}},"response":[{"id":"ec46a735-a364-4f83-b2bf-fb8c26024b21","name":"Get Cycle Counts SKUs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/hubs/:hub_code/cycle_counts/:cycle_count_id/skus","host":["{{base_url}}"],"path":["sales-channel","public","v1","hubs",":hub_code","cycle_counts",":cycle_count_id","skus"],"variable":[{"key":"hub_code","value":"Shubhra001"},{"key":"cycle_count_id","value":"CC-DE165-1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 Jan 2025 07:09:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"dbc63527-78aa-4e0f-b2b0-a33e424c269d"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8fe21f3b9d04c584-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"status\": \"inventory_update\",\n \"expected_count\": 1229,\n \"actual_count\": 1,\n \"recount_actual_quantity\": 0,\n \"discrepancy\": true,\n \"location\": {\n \"barcode\": \"\",\n \"name\": \"\"\n },\n \"bin\": {\n \"barcode\": \"\"\n },\n \"sku\": {\n \"name\": \"samsung190\",\n \"seller_sku_code\": \"samsung190\",\n \"images\": [],\n \"attributes\": [],\n \"is_batch_required\": false,\n \"is_serialised\": false,\n \"barcodes\": null,\n \"seller_code\": \"2727\"\n },\n \"batch\": {\n \"external_batch_id\": null,\n \"expiry_date\": null,\n \"manufacture_date\": null\n },\n \"assigned_user\": {\n \"name\": \"Shubra\"\n },\n \"recount_user\": {\n \"name\": \"\"\n }\n },\n {\n \"status\": \"inventory_update\",\n \"expected_count\": 1011,\n \"actual_count\": 1,\n \"recount_actual_quantity\": 0,\n \"discrepancy\": true,\n \"location\": {\n \"barcode\": \"\",\n \"name\": \"\"\n },\n \"bin\": {\n \"barcode\": \"\"\n },\n \"sku\": {\n \"name\": \"iPhone 15 Pro\",\n \"seller_sku_code\": \"iPhone 15 Pro\",\n \"images\": [],\n \"attributes\": [],\n \"is_batch_required\": false,\n \"is_serialised\": false,\n \"barcodes\": null,\n \"seller_code\": \"2727\"\n },\n \"batch\": {\n \"external_batch_id\": null,\n \"expiry_date\": null,\n \"manufacture_date\": null\n },\n \"assigned_user\": {\n \"name\": \"Shubra\"\n },\n \"recount_user\": {\n \"name\": \"\"\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 2\n }\n}"}],"_postman_id":"58264d93-36f8-481d-9b07-1ce98b3e070a"}],"id":"479fa7cf-0bab-4d69-8d33-5d573d2b581d","_postman_id":"479fa7cf-0bab-4d69-8d33-5d573d2b581d","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Billing","item":[{"name":"Contract","item":[{"name":"Get Contracts","id":"863bd1fd-05cf-4e40-997e-0899391841b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/billings/contracts?page=1&per_page=30","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","billings","contracts"],"host":["{{base_url}}"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"30"},{"disabled":true,"key":"is_inactive","value":"true"},{"disabled":true,"description":{"content":"

mandatory if using created_from

\n","type":"text/plain"},"key":"end_date","value":"10-02-2025"},{"disabled":true,"description":{"content":"

use multiple

\n","type":"text/plain"},"key":"hub_codes","value":"INDIAN_HUB8"},{"disabled":true,"description":{"content":"

use multiple

\n","type":"text/plain"},"key":"hub_codes","value":""},{"disabled":true,"key":"seller_code","value":"SG-333"}],"variable":[]}},"response":[{"id":"81d4fb8c-367f-4b3a-99f3-02f557ede8bf","name":"Get Contracts","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/billings/contracts?page=1&per_page=30","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","billings","contracts"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"30"},{"key":"is_inactive","value":"true","disabled":true},{"key":"end_date","value":"10-02-2025","description":"mandatory if using created_from","disabled":true},{"key":"hub_codes","value":"INDIAN_HUB8","description":"use multiple ","disabled":true},{"key":"hub_codes","value":"","description":"use multiple ","disabled":true},{"key":"seller_code","value":"SG-333","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 Feb 2025 15:16:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"2e2b65ec-d021-4881-b148-cb91c1e9373f"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"91473895dc3a0820-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"67b5b2f63a33cd2a62256c7f\",\n \"name\": \"Contract 2024\",\n \"seller_code\": \"\",\n \"hub_codes\": [],\n \"billing_profile\": {\n \"id\": \"67b47622c6631bf1bbc5d7fe\",\n \"name\": \"BPR123456\"\n },\n \"is_active\": true,\n \"start_date\": \"Feb 19, 2025 10:31:18 AM\",\n \"end_date\": \"Jan 01, 0001 12:00:00 AM\",\n \"created_at\": \"Feb 19, 2025 10:31:18 AM\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"}],"_postman_id":"863bd1fd-05cf-4e40-997e-0899391841b3"},{"name":"Get Single Contract","id":"fe1bd3b1-4424-499a-89e2-112fb17fad9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/billings/contracts/:id","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","billings","contracts",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"67b5b2f63a33cd2a62256c7f","key":"id"}]}},"response":[],"_postman_id":"fe1bd3b1-4424-499a-89e2-112fb17fad9d"},{"name":"Create Contract","id":"d0948be8-4583-4708-b209-81004046cd7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Contract 2024\", // Required\n \"billing_profile_name\": \"BPR123456\", // Required\n \"is_all_hubs\": false,\n \"hub_codes\": [\"ONLS\"],\n \"due_date\": 15, // Required\n \"seller_code\": \"Test-123\" // Required\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/billings/contracts","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","billings","contracts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3489147f-5e19-4b0e-877e-f37d0f512ada","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Contract 2024\", // Required\n \"billing_profile_name\": \"BPR123456\", // Required\n \"is_all_hubs\": false,\n \"hub_codes\": [\"ONLS\"],\n \"due_date\": 15, // Required\n \"seller_code\": \"Test-123\" // Required\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/billings/contracts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 Feb 2025 10:31:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"31e1c937-279e-4535-81d2-666dd8414323"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"91459620594c8be2-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Contract created successfully\",\n \"meta\": null\n}"}],"_postman_id":"d0948be8-4583-4708-b209-81004046cd7e"},{"name":"Terminate Contract","id":"0d2d2e7b-c1e7-4974-9420-30dfef27bfdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/billings/contracts/:id/terminate","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","billings","contracts",":id","terminate"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"67b5b2f63a33cd2a62256c7f","key":"id"}]}},"response":[],"_postman_id":"0d2d2e7b-c1e7-4974-9420-30dfef27bfdd"}],"id":"c2d985a2-ff3a-43de-9dbc-08bfdea2b9dd","_postman_id":"c2d985a2-ff3a-43de-9dbc-08bfdea2b9dd","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Get Bills","id":"9e62823b-3783-4dc4-8d96-f0eba9caf9f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/bills?page=1&per_page=30&seller_code=DE-SE-15","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","bills"],"host":["{{base_url}}"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"30"},{"key":"seller_code","value":"DE-SE-15"}],"variable":[]}},"response":[{"id":"54148dc5-6a0b-4e26-b83b-445931963e3a","name":"Get Bills","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/bills?page=1&per_page=30","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","bills"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"30"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Oct 2024 08:58:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"43e3e28a-65e2-4a18-a63e-cf265159156d"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8cecb12f4f00c96a-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"name\": \"BILL-MN-1-4\",\n \"seller\": {\n \"name\": \"MNoor [Seller]\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"https://omniful-staging-uploads.s3.amazonaws.com/billing/bill/pdf/2ccf3118-8fa6-4fbb-8b1c-0a7d36f37a0f_341_670399952f1834ddf510bdfa.pdf\",\n \"contract_name\": \"mnoor\",\n \"period_start_date\": \"Sep 04, 2024 12:00:00 AM\",\n \"period_end_date\": \"Oct 03, 2024 11:59:59 PM\",\n \"due_date\": \"Oct 12, 2024 08:19:33 AM\",\n \"created_at\": \"Oct 07, 2024 08:19:33 AM\"\n },\n {\n \"name\": \"BILL-MN-1-3\",\n \"seller\": {\n \"name\": \"MNoor [Seller]\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"mnoor\",\n \"period_start_date\": \"Oct 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Oct 02, 2024 11:59:59 PM\",\n \"due_date\": \"Oct 08, 2024 07:31:55 AM\",\n \"created_at\": \"Oct 03, 2024 07:31:55 AM\"\n },\n {\n \"name\": \"BILL-MN-1-2\",\n \"seller\": {\n \"name\": \"MNoor [Seller]\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"mnoor\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 07, 2024 12:31:11 PM\",\n \"created_at\": \"Oct 02, 2024 12:31:11 PM\"\n },\n {\n \"name\": \"BILL-00001-5\",\n \"seller\": {\n \"name\": \"Ibrahim-Seller\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"IbrahimWH001\",\n \"name\": \"Ibrahim-WH\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Ibrahim1\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 03, 2024 12:31:09 PM\",\n \"created_at\": \"Oct 02, 2024 12:31:09 PM\"\n },\n {\n \"name\": \"BILL-MS-037-7\",\n \"seller\": {\n \"name\": \"3PL Fulfillment 8\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"000 Seamless Retail\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"qq\",\n \"name\": \"Q-TEST\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"TTT\",\n \"name\": \"TEST 1234\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub2\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"111222333\",\n \"name\": \"dabllah1\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"111222333444\",\n \"name\": \"dabllah12\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"bbbb\",\n \"name\": \"Locations print\"\n },\n {\n \"code\": \"amaterasu\",\n \"name\": \"Amaterasu\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"QQQ\",\n \"name\": \"AL-CO-Q\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"027\",\n \"name\": \"Laverne Training\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"123654234\",\n \"name\": \"ADab\"\n },\n {\n \"code\": \"ASH01\",\n \"name\": \"Ashar Warehouse\"\n },\n {\n \"code\": \"ruh123\",\n \"name\": \"RUH123\"\n },\n {\n \"code\": \"flexp\",\n \"name\": \"Flexp\"\n },\n {\n \"code\": \"SRYD\",\n \"name\": \"Startlinks Riyadh\"\n },\n {\n \"code\": \"RUH1\",\n \"name\": \"ruh\"\n },\n {\n \"code\": \"prolotest\",\n \"name\": \"Prolo training\"\n },\n {\n \"code\": \"1309S\",\n \"name\": \"KIMIS\"\n },\n {\n \"code\": \"PO0980\",\n \"name\": \"KIMIS12\"\n },\n {\n \"code\": \"111222\",\n \"name\": \"Dabllah\"\n },\n {\n \"code\": \"1234567\",\n \"name\": \"dab\"\n },\n {\n \"code\": \"19dffg\",\n \"name\": \"abdul\"\n },\n {\n \"code\": \"1233321\",\n \"name\": \"ddd\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n },\n {\n \"code\": \"002544\",\n \"name\": \"ETX1\"\n },\n {\n \"code\": \"IbrahimWH001\",\n \"name\": \"Ibrahim-WH\"\n },\n {\n \"code\": \"12344321\",\n \"name\": \"Al-besher\"\n },\n {\n \"code\": \"test001\",\n \"name\": \"Testing-Hub\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"shoga2\",\n \"name\": \"Shoga\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"2131\",\n \"name\": \"operation - Reefi online\"\n },\n {\n \"code\": \"501\",\n \"name\": \"ABC\"\n },\n {\n \"code\": \"201010101\",\n \"name\": \"Muntazir Hub 4\"\n },\n {\n \"code\": \"99999\",\n \"name\": \"MonksTestingHub\"\n },\n {\n \"code\": \"skj9\",\n \"name\": \"ss\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"sss\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 09, 2024 12:31:08 PM\",\n \"created_at\": \"Oct 02, 2024 12:31:08 PM\"\n },\n {\n \"name\": \"BILL-DE-SE-15-386\",\n \"seller\": {\n \"name\": \"Abdullah\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Fulfillment serves11111\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 09, 2024 12:31:06 PM\",\n \"created_at\": \"Oct 02, 2024 12:31:06 PM\"\n },\n {\n \"name\": \"BILL-FR-836-2\",\n \"seller\": {\n \"name\": \"3PL Fulfillment 7\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Storage Station_1\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 12, 2024 12:31:03 PM\",\n \"created_at\": \"Oct 02, 2024 12:31:03 PM\"\n },\n {\n \"name\": \"BILL-AT-955-2\",\n \"seller\": {\n \"name\": \"3PL fulfillment 3\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"TEST ACCOUNTS\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 09, 2024 12:31:02 PM\",\n \"created_at\": \"Oct 02, 2024 12:31:02 PM\"\n },\n {\n \"name\": \"BILL-MS-037-6\",\n \"seller\": {\n \"name\": \"3PL Fulfillment 8\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"00 Seamless Retail\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"qq\",\n \"name\": \"Q-TEST\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"TTT\",\n \"name\": \"TEST 1234\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"bbbb\",\n \"name\": \"Locations print\"\n },\n {\n \"code\": \"amaterasu\",\n \"name\": \"Amaterasu\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"QQQ\",\n \"name\": \"AL-CO-Q\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"027\",\n \"name\": \"Laverne Training\"\n },\n {\n \"code\": \"ASH01\",\n \"name\": \"Ashar Warehouse\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n },\n {\n \"code\": \"ruh123\",\n \"name\": \"RUH123\"\n },\n {\n \"code\": \"SRYD\",\n \"name\": \"Startlinks Riyadh\"\n },\n {\n \"code\": \"RUH1\",\n \"name\": \"ruh\"\n },\n {\n \"code\": \"prolotest\",\n \"name\": \"Prolo training\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Test2\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Nov 01, 2024 12:31:01 PM\",\n \"created_at\": \"Oct 02, 2024 12:31:01 PM\"\n },\n {\n \"name\": \"BILL-MS-037-5\",\n \"seller\": {\n \"name\": \"3PL Fulfillment 8\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"00 Seamless Retail\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"qq\",\n \"name\": \"Q-TEST\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"TTT\",\n \"name\": \"TEST 1234\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"bbbb\",\n \"name\": \"Locations print\"\n },\n {\n \"code\": \"amaterasu\",\n \"name\": \"Amaterasu\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"QQQ\",\n \"name\": \"AL-CO-Q\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"027\",\n \"name\": \"Laverne Training\"\n },\n {\n \"code\": \"ASH01\",\n \"name\": \"Ashar Warehouse\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n },\n {\n \"code\": \"ruh123\",\n \"name\": \"RUH123\"\n },\n {\n \"code\": \"SRYD\",\n \"name\": \"Startlinks Riyadh\"\n },\n {\n \"code\": \"RUH1\",\n \"name\": \"ruh\"\n },\n {\n \"code\": \"prolotest\",\n \"name\": \"Prolo training\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Automyze Client 1\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 16, 2024 12:30:59 PM\",\n \"created_at\": \"Oct 02, 2024 12:30:59 PM\"\n },\n {\n \"name\": \"BILL-LB-349-2\",\n \"seller\": {\n \"name\": \"3PL Fulfillment 2\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Testing 1\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 09, 2024 12:30:57 PM\",\n \"created_at\": \"Oct 02, 2024 12:30:57 PM\"\n },\n {\n \"name\": \"BILL-12-7\",\n \"seller\": {\n \"name\": \"21\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"00 Seamless Retail\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Fulfillment serves-ac\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 12, 2024 12:30:54 PM\",\n \"created_at\": \"Oct 02, 2024 12:30:54 PM\"\n },\n {\n \"name\": \"BILL-EX-637-197\",\n \"seller\": {\n \"name\": \"3PL Fulfillment 10\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"00 Seamless Retail\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Fulfillment serves\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 12, 2024 12:30:50 PM\",\n \"created_at\": \"Oct 02, 2024 12:30:50 PM\"\n },\n {\n \"name\": \"BILL-EX-637-196\",\n \"seller\": {\n \"name\": \"3PL Fulfillment 10\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Test Contract2\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 12:00:00 AM\",\n \"due_date\": \"Oct 22, 2024 12:30:47 PM\",\n \"created_at\": \"Oct 02, 2024 12:30:47 PM\"\n },\n {\n \"name\": \"BILL-MN-1-1\",\n \"seller\": {\n \"name\": \"MNoor [Seller]\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"mnoor\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 30, 2024 11:59:59 PM\",\n \"due_date\": \"Oct 07, 2024 08:22:23 AM\",\n \"created_at\": \"Oct 02, 2024 08:22:23 AM\"\n },\n {\n \"name\": \"BILL-00001-4\",\n \"seller\": {\n \"name\": \"Ibrahim-Seller\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"IbrahimWH001\",\n \"name\": \"Ibrahim-WH\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Ibrahim1\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Oct 01, 2024 11:59:59 PM\",\n \"due_date\": \"Oct 03, 2024 08:20:02 AM\",\n \"created_at\": \"Oct 02, 2024 08:20:02 AM\"\n },\n {\n \"name\": \"BILL-00001-3\",\n \"seller\": {\n \"name\": \"Ibrahim-Seller\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"IbrahimWH001\",\n \"name\": \"Ibrahim-WH\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Ibrahim-test-2\",\n \"period_start_date\": \"Aug 04, 2024 12:00:00 AM\",\n \"period_end_date\": \"Oct 01, 2024 11:59:59 PM\",\n \"due_date\": \"Oct 03, 2024 06:46:53 AM\",\n \"created_at\": \"Oct 02, 2024 06:46:53 AM\"\n },\n {\n \"name\": \"BILL-00001-2\",\n \"seller\": {\n \"name\": \"Ibrahim-Seller\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"IbrahimWH001\",\n \"name\": \"Ibrahim-WH\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"https://omniful-staging-uploads.s3.amazonaws.com/billing/bill/pdf/bc4a3664-43bb-4ad5-9938-8735e31b833f_756_66fcead38de6819b3ecfa54d.pdf\",\n \"contract_name\": \"Ibrahim-Test\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Oct 01, 2024 11:59:59 PM\",\n \"due_date\": \"Oct 03, 2024 06:40:19 AM\",\n \"created_at\": \"Oct 02, 2024 06:40:19 AM\"\n },\n {\n \"name\": \"BILL-00001-1\",\n \"seller\": {\n \"name\": \"Ibrahim-Seller\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"IbrahimWH001\",\n \"name\": \"Ibrahim-WH\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Ibrahim-Test\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Oct 01, 2024 11:59:59 PM\",\n \"due_date\": \"Oct 03, 2024 06:19:31 AM\",\n \"created_at\": \"Oct 02, 2024 06:19:31 AM\"\n },\n {\n \"name\": \"BILL-12-6\",\n \"seller\": {\n \"name\": \"21\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"00 Seamless Retail\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Fulfillment serves-ac\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 15, 2024 11:59:59 PM\",\n \"due_date\": \"Oct 10, 2024 03:47:45 PM\",\n \"created_at\": \"Sep 30, 2024 03:47:45 PM\"\n },\n {\n \"name\": \"BILL-12-5\",\n \"seller\": {\n \"name\": \"21\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"00 Seamless Retail\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"overdue\",\n \"pdf\": \"https://omniful-staging-uploads.s3.amazonaws.com/billing/bill/pdf/df08717d-2d97-4c65-bb74-d68bcda1ad17_261_66e1df17be02e244698adaef.pdf\",\n \"contract_name\": \"Fulfillment serves-ac\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 10, 2024 11:59:59 PM\",\n \"due_date\": \"Sep 21, 2024 06:19:03 PM\",\n \"created_at\": \"Sep 11, 2024 06:19:03 PM\"\n },\n {\n \"name\": \"BILL-12-4\",\n \"seller\": {\n \"name\": \"21\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"00 Seamless Retail\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Fulfillment serves-ac\",\n \"period_start_date\": \"Aug 05, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 10, 2024 11:59:59 PM\",\n \"due_date\": \"Sep 21, 2024 06:10:49 PM\",\n \"created_at\": \"Sep 11, 2024 06:10:49 PM\"\n },\n {\n \"name\": \"BILL-12-3\",\n \"seller\": {\n \"name\": \"21\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"00 Seamless Retail\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Fulfillment serves-ac\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 10, 2024 11:59:59 PM\",\n \"due_date\": \"Sep 21, 2024 05:52:46 PM\",\n \"created_at\": \"Sep 11, 2024 05:52:46 PM\"\n },\n {\n \"name\": \"BILL-MS-037-4\",\n \"seller\": {\n \"name\": \"3PL Fulfillment 8\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"000 Seamless Retail\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"qq\",\n \"name\": \"Q-TEST\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"TTT\",\n \"name\": \"TEST 1234\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub2\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"111222333\",\n \"name\": \"dabllah1\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"111222333444\",\n \"name\": \"dabllah12\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"bbbb\",\n \"name\": \"Locations print\"\n },\n {\n \"code\": \"amaterasu\",\n \"name\": \"Amaterasu\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"QQQ\",\n \"name\": \"AL-CO-Q\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"027\",\n \"name\": \"Laverne Training\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"123654234\",\n \"name\": \"ADab\"\n },\n {\n \"code\": \"ASH01\",\n \"name\": \"Ashar Warehouse\"\n },\n {\n \"code\": \"ruh123\",\n \"name\": \"RUH123\"\n },\n {\n \"code\": \"flexp\",\n \"name\": \"Flexp\"\n },\n {\n \"code\": \"SRYD\",\n \"name\": \"Startlinks Riyadh\"\n },\n {\n \"code\": \"RUH1\",\n \"name\": \"ruh\"\n },\n {\n \"code\": \"prolotest\",\n \"name\": \"Prolo training\"\n },\n {\n \"code\": \"1309S\",\n \"name\": \"KIMIS\"\n },\n {\n \"code\": \"PO0980\",\n \"name\": \"KIMIS12\"\n },\n {\n \"code\": \"111222\",\n \"name\": \"Dabllah\"\n },\n {\n \"code\": \"1234567\",\n \"name\": \"dab\"\n },\n {\n \"code\": \"19dffg\",\n \"name\": \"abdul\"\n },\n {\n \"code\": \"1233321\",\n \"name\": \"ddd\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n },\n {\n \"code\": \"002544\",\n \"name\": \"ETX1\"\n },\n {\n \"code\": \"IbrahimWH001\",\n \"name\": \"Ibrahim-WH\"\n },\n {\n \"code\": \"12344321\",\n \"name\": \"Al-besher\"\n },\n {\n \"code\": \"test001\",\n \"name\": \"Testing-Hub\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"shoga2\",\n \"name\": \"Shoga\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"2131\",\n \"name\": \"operation - Reefi online\"\n },\n {\n \"code\": \"501\",\n \"name\": \"ABC\"\n },\n {\n \"code\": \"201010101\",\n \"name\": \"Muntazir Hub 4\"\n },\n {\n \"code\": \"99999\",\n \"name\": \"MonksTestingHub\"\n },\n {\n \"code\": \"skj9\",\n \"name\": \"ss\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n }\n ],\n \"status\": \"overdue\",\n \"pdf\": \"https://omniful-staging-uploads.s3.amazonaws.com/billing/bill/pdf/30cd70b3-6bf9-4041-8fba-fe62e95ff096_115_66e1575fbe02e244698ad966.pdf\",\n \"contract_name\": \"sss\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 10, 2024 11:59:59 PM\",\n \"due_date\": \"Sep 18, 2024 08:39:59 AM\",\n \"created_at\": \"Sep 11, 2024 08:39:59 AM\"\n },\n {\n \"name\": \"BILL-12-2\",\n \"seller\": {\n \"name\": \"21\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"00 Seamless Retail\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"overdue\",\n \"pdf\": \"https://omniful-staging-uploads.s3.amazonaws.com/billing/bill/pdf/e2bac7ca-118a-4d4b-a423-686b70b39041_261_66e03b0fb63d5ed029edc9cb.pdf\",\n \"contract_name\": \"Fulfillment serves-ac\",\n \"period_start_date\": \"Sep 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Sep 09, 2024 12:00:00 AM\",\n \"due_date\": \"Sep 20, 2024 12:26:55 PM\",\n \"created_at\": \"Sep 10, 2024 12:26:55 PM\"\n },\n {\n \"name\": \"BILL-MS-037-3\",\n \"seller\": {\n \"name\": \"3PL Fulfillment 8\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"poiuytrertyuiop43243\",\n \"name\": \"Z9\"\n },\n {\n \"code\": \"seamlessretail\",\n \"name\": \"000 Seamless Retail\"\n },\n {\n \"code\": \"GHUb\",\n \"name\": \"GHUb\"\n },\n {\n \"code\": \"23412\",\n \"name\": \"Z58\"\n },\n {\n \"code\": \"001\",\n \"name\": \"RUYADH 12\"\n },\n {\n \"code\": \"2121212124vdf\",\n \"name\": \"Z12\"\n },\n {\n \"code\": \"444\",\n \"name\": \"Z31\"\n },\n {\n \"code\": \"CMSJED\",\n \"name\": \"Z34\"\n },\n {\n \"code\": \"123456\",\n \"name\": \"Z40\"\n },\n {\n \"code\": \"13113\",\n \"name\": \"Z51\"\n },\n {\n \"code\": \"121091\",\n \"name\": \"Z43\"\n },\n {\n \"code\": \"z1\",\n \"name\": \"Z3\"\n },\n {\n \"code\": \"BHARAT\",\n \"name\": \"Bharat\"\n },\n {\n \"code\": \"qq\",\n \"name\": \"Q-TEST\"\n },\n {\n \"code\": \"132141\",\n \"name\": \"Z52\"\n },\n {\n \"code\": \"3523532\",\n \"name\": \"Z24\"\n },\n {\n \"code\": \"NAKH\",\n \"name\": \"Al Nakheel Mall - Riyadh (KARAZ LINEN)\"\n },\n {\n \"code\": \"2321\",\n \"name\": \"Trustangle\"\n },\n {\n \"code\": \"WH-Best-one\",\n \"name\": \"Hub 2\"\n },\n {\n \"code\": \"12343\",\n \"name\": \"Ritik Hub\"\n },\n {\n \"code\": \"1134\",\n \"name\": \"Z44\"\n },\n {\n \"code\": \"1231\",\n \"name\": \"UPDATED\"\n },\n {\n \"code\": \"256\",\n \"name\": \"Z4\"\n },\n {\n \"code\": \"KRZWH\",\n \"name\": \"Karaz Warehouse\"\n },\n {\n \"code\": \"masdar1\",\n \"name\": \"Masdar Al Qadsiyah\"\n },\n {\n \"code\": \"testhub111\",\n \"name\": \"testhub1\"\n },\n {\n \"code\": \"seamlesswh\",\n \"name\": \"Seamless\"\n },\n {\n \"code\": \"zw\",\n \"name\": \"z hub warehouse\"\n },\n {\n \"code\": \"zr\",\n \"name\": \"Z1\"\n },\n {\n \"code\": \"12412\",\n \"name\": \"Z20\"\n },\n {\n \"code\": \"7771\",\n \"name\": \"Z21\"\n },\n {\n \"code\": \"123654\",\n \"name\": \"Z29\"\n },\n {\n \"code\": \"seamlesscluster\",\n \"name\": \"Z37\"\n },\n {\n \"code\": \"1234345\",\n \"name\": \"Z53\"\n },\n {\n \"code\": \"hubgaurav\",\n \"name\": \"Z55\"\n },\n {\n \"code\": \"12542545\",\n \"name\": \"Z64\"\n },\n {\n \"code\": \"TTT\",\n \"name\": \"TEST 1234\"\n },\n {\n \"code\": \"123456789\",\n \"name\": \"ray test\"\n },\n {\n \"code\": \"124\",\n \"name\": \"Test Hub - Client\"\n },\n {\n \"code\": \"1242352\",\n \"name\": \"Beta Demo Hub2\"\n },\n {\n \"code\": \"AhmadTurkTest1\",\n \"name\": \"Ahmad Turk Test\"\n },\n {\n \"code\": \"1232\",\n \"name\": \"Ray 1\"\n },\n {\n \"code\": \"123\",\n \"name\": \"ray T\"\n },\n {\n \"code\": \"14\",\n \"name\": \"Sector 14\"\n },\n {\n \"code\": \"Leb1\",\n \"name\": \"Z13\"\n },\n {\n \"code\": \"Kas1\",\n \"name\": \"Z17\"\n },\n {\n \"code\": \"123332\",\n \"name\": \"Z2\"\n },\n {\n \"code\": \"12344\",\n \"name\": \"Z7\"\n },\n {\n \"code\": \"ZH\",\n \"name\": \"Z15\"\n },\n {\n \"code\": \"0711\",\n \"name\": \"Z18\"\n },\n {\n \"code\": \"AhmadTurkTest2\",\n \"name\": \"Z19\"\n },\n {\n \"code\": \"hublocation123\",\n \"name\": \"Z32\"\n },\n {\n \"code\": \"123123123231\",\n \"name\": \"Z35\"\n },\n {\n \"code\": \"12100012\",\n \"name\": \"Z42\"\n },\n {\n \"code\": \"23456\",\n \"name\": \"Z57\"\n },\n {\n \"code\": \"hgeyg\",\n \"name\": \"Z59\"\n },\n {\n \"code\": \"seamlesszone\",\n \"name\": \"Z61\"\n },\n {\n \"code\": \"80\",\n \"name\": \"Z63\"\n },\n {\n \"code\": \"25681\",\n \"name\": \"Z65\"\n },\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n },\n {\n \"code\": \"1234A\",\n \"name\": \"Hub 3\"\n },\n {\n \"code\": \"12341\",\n \"name\": \"Hub-5\"\n },\n {\n \"code\": \"2345\",\n \"name\": \"12\"\n },\n {\n \"code\": \"678123\",\n \"name\": \"1-RUHSL\"\n },\n {\n \"code\": \"adsgfmch\",\n \"name\": \"Z27\"\n },\n {\n \"code\": \"134141\",\n \"name\": \"Z8\"\n },\n {\n \"code\": \"HUB090989\",\n \"name\": \"Z23\"\n },\n {\n \"code\": \"32990\",\n \"name\": \"Z28\"\n },\n {\n \"code\": \"133212132213132\",\n \"name\": \"Z36\"\n },\n {\n \"code\": \"201\",\n \"name\": \"Z38\"\n },\n {\n \"code\": \"123415\",\n \"name\": \"Z45\"\n },\n {\n \"code\": \"12342\",\n \"name\": \"Z46\"\n },\n {\n \"code\": \"12425\",\n \"name\": \"Z48\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Z49\"\n },\n {\n \"code\": \"2\",\n \"name\": \"Z56\"\n },\n {\n \"code\": \"1092\",\n \"name\": \"No Purchase Order Hub\"\n },\n {\n \"code\": \"0123\",\n \"name\": \"Test no PO\"\n },\n {\n \"code\": \"jhgfd\",\n \"name\": \"Z47\"\n },\n {\n \"code\": \"12351\",\n \"name\": \"Omni Hub\"\n },\n {\n \"code\": \"20001\",\n \"name\": \"test1900\"\n },\n {\n \"code\": \"111222333\",\n \"name\": \"dabllah1\"\n },\n {\n \"code\": \"14531\",\n \"name\": \"Testing hub\"\n },\n {\n \"code\": \"b2c000\",\n \"name\": \"Nana Hub\"\n },\n {\n \"code\": \"H11122\",\n \"name\": \"Test Hub\"\n },\n {\n \"code\": \"20101\",\n \"name\": \"Muntazir Hub\"\n },\n {\n \"code\": \"893\",\n \"name\": \"Z5\"\n },\n {\n \"code\": \"15124\",\n \"name\": \"Z6\"\n },\n {\n \"code\": \"123456q\",\n \"name\": \"Z10\"\n },\n {\n \"code\": \"111\",\n \"name\": \"Z11\"\n },\n {\n \"code\": \"1asd\",\n \"name\": \"Z16\"\n },\n {\n \"code\": \"RUH\",\n \"name\": \"Z22\"\n },\n {\n \"code\": \"13134\",\n \"name\": \"Z25\"\n },\n {\n \"code\": \"code000\",\n \"name\": \"Z30\"\n },\n {\n \"code\": \"1234567897iuytredd\",\n \"name\": \"Z33\"\n },\n {\n \"code\": \"code777\",\n \"name\": \"Z39\"\n },\n {\n \"code\": \"2BC1B281\",\n \"name\": \"Z41\"\n },\n {\n \"code\": \"d1\",\n \"name\": \"Z50\"\n },\n {\n \"code\": \"34151\",\n \"name\": \"Z60\"\n },\n {\n \"code\": \"12345\",\n \"name\": \"Z62\"\n },\n {\n \"code\": \"TR3\",\n \"name\": \"Training Hub B2B\"\n },\n {\n \"code\": \"111222333444\",\n \"name\": \"dabllah12\"\n },\n {\n \"code\": \"SHUBHRA\",\n \"name\": \"Shubhra Testing\"\n },\n {\n \"code\": \"OFF\",\n \"name\": \"Training B2C - Off\"\n },\n {\n \"code\": \"321\",\n \"name\": \"Kanya Kumari Hub\"\n },\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n },\n {\n \"code\": \"65465\",\n \"name\": \"Testing Hub 1\"\n },\n {\n \"code\": \"7777777\",\n \"name\": \"Chirag_Hub\"\n },\n {\n \"code\": \"MN1\",\n \"name\": \"M-Noor\"\n },\n {\n \"code\": \"00001\",\n \"name\": \"Nbox Logistics Hub 1\"\n },\n {\n \"code\": \"RH\",\n \"name\": \"Demo Riyadh Hub\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Riyadh Warehouse\"\n },\n {\n \"code\": \"1238\",\n \"name\": \"test-1238\"\n },\n {\n \"code\": \"po099\",\n \"name\": \"Test OmniHub\"\n },\n {\n \"code\": \"bbbb\",\n \"name\": \"Locations print\"\n },\n {\n \"code\": \"amaterasu\",\n \"name\": \"Amaterasu\"\n },\n {\n \"code\": \"246523\",\n \"name\": \"test-ts\"\n },\n {\n \"code\": \"QQQ\",\n \"name\": \"AL-CO-Q\"\n },\n {\n \"code\": \"qs\",\n \"name\": \"Qasr AL Awani\"\n },\n {\n \"code\": \"027\",\n \"name\": \"Laverne Training\"\n },\n {\n \"code\": \"2345666\",\n \"name\": \"Bharat Testing\"\n },\n {\n \"code\": \"123654234\",\n \"name\": \"ADab\"\n },\n {\n \"code\": \"ASH01\",\n \"name\": \"Ashar Warehouse\"\n },\n {\n \"code\": \"ruh123\",\n \"name\": \"RUH123\"\n },\n {\n \"code\": \"flexp\",\n \"name\": \"Flexp\"\n },\n {\n \"code\": \"SRYD\",\n \"name\": \"Startlinks Riyadh\"\n },\n {\n \"code\": \"RUH1\",\n \"name\": \"ruh\"\n },\n {\n \"code\": \"prolotest\",\n \"name\": \"Prolo training\"\n },\n {\n \"code\": \"1309S\",\n \"name\": \"KIMIS\"\n },\n {\n \"code\": \"PO0980\",\n \"name\": \"KIMIS12\"\n },\n {\n \"code\": \"111222\",\n \"name\": \"Dabllah\"\n },\n {\n \"code\": \"1234567\",\n \"name\": \"dab\"\n },\n {\n \"code\": \"19dffg\",\n \"name\": \"abdul\"\n },\n {\n \"code\": \"1233321\",\n \"name\": \"ddd\"\n },\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n },\n {\n \"code\": \"002544\",\n \"name\": \"ETX1\"\n },\n {\n \"code\": \"IbrahimWH001\",\n \"name\": \"Ibrahim-WH\"\n },\n {\n \"code\": \"12344321\",\n \"name\": \"Al-besher\"\n },\n {\n \"code\": \"test001\",\n \"name\": \"Testing-Hub\"\n },\n {\n \"code\": \"000AH\",\n \"name\": \"Adarsh\"\n },\n {\n \"code\": \"999\",\n \"name\": \"6\"\n },\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n },\n {\n \"code\": \"shoga2\",\n \"name\": \"Shoga\"\n },\n {\n \"code\": \"CHIKU\",\n \"name\": \"5\"\n },\n {\n \"code\": \"2131\",\n \"name\": \"operation - Reefi online\"\n },\n {\n \"code\": \"501\",\n \"name\": \"ABC\"\n },\n {\n \"code\": \"201010101\",\n \"name\": \"Muntazir Hub 4\"\n },\n {\n \"code\": \"99999\",\n \"name\": \"MonksTestingHub\"\n },\n {\n \"code\": \"skj9\",\n \"name\": \"ss\"\n },\n {\n \"code\": \"456\",\n \"name\": \"newworld\"\n },\n {\n \"code\": \"56787\",\n \"name\": \"Test Ok 23456\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"sss\",\n \"period_start_date\": \"Aug 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Aug 31, 2024 12:00:00 AM\",\n \"due_date\": \"Sep 09, 2024 04:30:47 PM\",\n \"created_at\": \"Sep 02, 2024 04:30:47 PM\"\n },\n {\n \"name\": \"BILL-DE-SE-15-385\",\n \"seller\": {\n \"name\": \"Abdullah\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"12\",\n \"name\": \"Hub -2\"\n }\n ],\n \"status\": \"overdue\",\n \"pdf\": \"https://omniful-staging-uploads.s3.amazonaws.com/billing/bill/pdf/b10e0436-a949-44f6-85d7-c3a84b4a0310_26_66d5e12fd5cf77abe4652db1.pdf\",\n \"contract_name\": \"Fulfillment serves11111\",\n \"period_start_date\": \"Aug 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Aug 31, 2024 12:00:00 AM\",\n \"due_date\": \"Sep 09, 2024 04:00:47 PM\",\n \"created_at\": \"Sep 02, 2024 04:00:47 PM\"\n },\n {\n \"name\": \"BILL-ON/OFF-1\",\n \"seller\": {\n \"name\": \"Training B2C\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Premium Package222\",\n \"period_start_date\": \"Aug 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Aug 31, 2024 12:00:00 AM\",\n \"due_date\": \"Sep 12, 2024 03:30:47 PM\",\n \"created_at\": \"Sep 02, 2024 03:30:47 PM\"\n },\n {\n \"name\": \"BILL-FR-836-1\",\n \"seller\": {\n \"name\": \"3PL Fulfillment 7\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"2024\",\n \"name\": \"Training B2C - On\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"Storage Station_1\",\n \"period_start_date\": \"Aug 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Aug 31, 2024 12:00:00 AM\",\n \"due_date\": \"Sep 12, 2024 03:00:47 PM\",\n \"created_at\": \"Sep 02, 2024 03:00:47 PM\"\n },\n {\n \"name\": \"BILL-AT-955-1\",\n \"seller\": {\n \"name\": \"3PL fulfillment 3\",\n \"address\": \"\",\n \"email\": \"\",\n \"contact\": \"\"\n },\n \"hubs\": [\n {\n \"code\": \"132\",\n \"name\": \"Demo Account\"\n }\n ],\n \"status\": \"draft\",\n \"pdf\": \"\",\n \"contract_name\": \"TEST ACCOUNTS\",\n \"period_start_date\": \"Aug 01, 2024 12:00:00 AM\",\n \"period_end_date\": \"Aug 31, 2024 12:00:00 AM\",\n \"due_date\": \"Sep 09, 2024 02:30:47 PM\",\n \"created_at\": \"Sep 02, 2024 02:30:47 PM\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 21,\n \"per_page\": 30,\n \"total\": 613\n }\n}"}],"_postman_id":"9e62823b-3783-4dc4-8d96-f0eba9caf9f0"},{"name":"Get Bill","id":"c73fdc27-7907-4d12-b6ce-7ad049ac491a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/bills/:bill_name?page=2&per_page=30&","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","bills",":bill_name"],"host":["{{base_url}}"],"query":[{"key":"page","value":"2"},{"key":"per_page","value":"30"},{"key":"","value":null}],"variable":[{"type":"any","value":"BILL-MN-1-4","key":"bill_name"}]}},"response":[{"id":"bdd4ce4f-9c13-48d9-b6d7-9bf2c131d2f4","name":"Get Bill","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/bills/:bill_name?page=2&per_page=30&","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","bills",":bill_name"],"query":[{"key":"page","value":"2"},{"key":"per_page","value":"30"},{"key":"","value":null}],"variable":[{"key":"bill_name","value":"BILL-MN-1-4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Oct 2024 09:00:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"cc9cc722-c6eb-40d8-97bf-b8022113f961"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8cecb322aa3b20b2-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"name\": \"BILL-MN-1-4\",\n \"seller\": {\n \"name\": \"MNoor [Seller]\",\n \"address\": \"44kk 44kk Aba Alworood Riyadh Region Saudi Arabia\",\n \"email\": \"Moh.tawaha72@gmail.com\",\n \"contact\": \"123456789\"\n },\n \"hubs\": [\n {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n }\n ],\n \"status\": \"draft\",\n \"currency\": \"SAR\",\n \"grand_total\": 0,\n \"grand_total_after_discount\": 0,\n \"discount\": {\n \"percentage\": 0,\n \"value\": 0,\n \"display_percentage\": \"0\",\n \"display_value\": \"0\"\n },\n \"contract_name\": \"mnoor\",\n \"fees\": [\n {\n \"name\": \"Storage Fees (Per Day)\",\n \"rules\": [\n {\n \"key\": \"Space Utilization\",\n \"display_key\": \"Space Utilization\",\n \"label\": \"\",\n \"unit\": \"Per CBM\",\n \"display_unit\": \"CBM\",\n \"costs\": [\n {\n \"from\": 0,\n \"to\": 0,\n \"value\": 100,\n \"operator\": \"more_than\",\n \"total\": 0,\n \"usage\": 0,\n \"display_total\": \"0\",\n \"display_value\": \"100\",\n \"display_usage\": \"0\",\n \"display_from\": \"0\",\n \"display_to\": \"0\"\n }\n ],\n \"usage\": 0,\n \"billable_usage\": 0,\n \"is_range\": false,\n \"total\": 0,\n \"operator\": \"multiply\",\n \"display_usage\": \"0\",\n \"display_total\": \"0\",\n \"display_billable_usage\": \"0\",\n \"condition\": {\n \"name\": \"\",\n \"description\": \"\",\n \"conditions\": {\n \"name\": {\n \"key_value\": null,\n \"display_value\": null,\n \"data_type\": null\n },\n \"operator\": {\n \"key_value\": null,\n \"display_value\": null,\n \"data_type\": null\n },\n \"sub_conditions\": [],\n \"value\": {\n \"key_value\": null,\n \"display_value\": null,\n \"data_type\": null\n },\n \"logical_operator\": {\n \"key_value\": null,\n \"display_value\": null,\n \"data_type\": null\n }\n },\n \"action_group\": {\n \"cost\": 0,\n \"currency\": \"\",\n \"additional_weight_info\": {\n \"cost\": 0,\n \"interval\": 0,\n \"upper_limit\": 0\n }\n },\n \"priority\": 0\n }\n }\n ],\n \"total\": 0,\n \"display_total\": \"0\"\n }\n ],\n \"hub_bills\": [],\n \"finalised_on\": \"January 01, 0001\",\n \"finalised_by\": \"\",\n \"period_start_date\": \"September 04, 2024\",\n \"period_end_date\": \"October 03, 2024\",\n \"pdf\": \"https://omniful-staging-uploads.s3.amazonaws.com/billing/bill/pdf/2ccf3118-8fa6-4fbb-8b1c-0a7d36f37a0f_341_670399952f1834ddf510bdfa.pdf\",\n \"remark\": \"\",\n \"due_date\": \"October 12, 2024\",\n \"created_at\": \"October 07, 2024 8:19 AM\",\n \"display_grand_total\": \"0\",\n \"display_grand_total_after_discount\": \"0\"\n },\n \"meta\": {\n \"current_page\": 2,\n \"last_page\": 1,\n \"per_page\": 30,\n \"total\": 1\n }\n}"}],"_postman_id":"c73fdc27-7907-4d12-b6ce-7ad049ac491a"},{"name":"Get Hub Bills","id":"d7dea363-4a9d-4487-9513-e2b4ec9f96b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:bill_name/bills","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","hubs",":bill_name","bills"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"BILL-MN-1-4","key":"bill_name"}]}},"response":[{"id":"6fe34df2-9f7a-4c5f-bac1-efc22bbb8d0e","name":"Get Hub Bills","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:bill_name/bills","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","hubs",":bill_name","bills"],"variable":[{"key":"bill_name","value":"BILL-MN-1-4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Oct 2024 09:01:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"56320572-84d8-493c-82e1-dc9dede9e4ba"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8cecb4fd4a5a9c8e-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"hub\": {\n \"code\": \"ON\",\n \"name\": \"MNOOR-ON\"\n },\n \"fees\": [\n {\n \"name\": \"Storage Fees (Per Day)\",\n \"rules\": [\n {\n \"key\": \"Space Utilization\",\n \"display_key\": \"Space Utilization\",\n \"label\": \"\",\n \"unit\": \"Per CBM\",\n \"display_unit\": \"CBM\",\n \"costs\": [\n {\n \"from\": 0,\n \"to\": 0,\n \"value\": 100,\n \"operator\": \"more_than\",\n \"total\": 0,\n \"usage\": 0,\n \"display_total\": \"0\",\n \"display_value\": \"100\",\n \"display_usage\": \"0\",\n \"display_from\": \"0\",\n \"display_to\": \"0\"\n }\n ],\n \"usage\": 0,\n \"billable_usage\": 0,\n \"is_range\": false,\n \"total\": 0,\n \"operator\": \"multiply\",\n \"display_usage\": \"0\",\n \"display_total\": \"0\",\n \"display_billable_usage\": \"0\",\n \"condition\": {\n \"name\": \"\",\n \"description\": \"\",\n \"conditions\": {\n \"name\": {\n \"key_value\": null,\n \"display_value\": null,\n \"data_type\": null\n },\n \"operator\": {\n \"key_value\": null,\n \"display_value\": null,\n \"data_type\": null\n },\n \"sub_conditions\": [],\n \"value\": {\n \"key_value\": null,\n \"display_value\": null,\n \"data_type\": null\n },\n \"logical_operator\": {\n \"key_value\": null,\n \"display_value\": null,\n \"data_type\": null\n }\n },\n \"action_group\": {\n \"cost\": 0,\n \"currency\": \"\",\n \"additional_weight_info\": {\n \"cost\": 0,\n \"interval\": 0,\n \"upper_limit\": 0\n }\n },\n \"priority\": 0\n }\n }\n ],\n \"total\": 0,\n \"display_total\": \"0\"\n }\n ],\n \"total\": 0,\n \"display_total\": \"0\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"}],"_postman_id":"d7dea363-4a9d-4487-9513-e2b4ec9f96b4"},{"name":"Generate Bill","id":"8fa0c213-f649-4505-9d3c-f9c5ab09c2a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contract_name\": \"mnoor\",\n \"start_date\": \"04-09-2024\",\n \"end_date\": \"03-10-2024\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/bills/generate","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","bills","generate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e7e7ecc7-9c05-48be-80eb-6b543399f1f0","name":"Generate Bill","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contract_name\": \"mnoor\",\n \"start_date\": \"04-09-2024\",\n \"end_date\": \"03-10-2024\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/bills/generate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Oct 2024 09:02:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"84cbfd37-8340-44ae-ab7d-473d46c0b557"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8cecb645fe0607ff-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success : The bill generated successfully.\"\n },\n \"meta\": null\n}"}],"_postman_id":"8fa0c213-f649-4505-9d3c-f9c5ab09c2a0"},{"name":"Update Bill Status","id":"e3314234-678f-4636-98e3-11da2bcc66f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"rejected\",\n \"remark\": \"Payment received on time\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/bills/:bill_name/status","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","bills",":bill_name","status"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"BILL-12-8","key":"bill_name"}]}},"response":[{"id":"94600221-5324-4b51-b5e1-0e949c302c70","name":"Update Bill Ststus","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"rejected\",\n \"remark\": \"Payment received on time\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/bills/:bill_name/status","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","bills",":bill_name","status"],"variable":[{"key":"bill_name","value":"BILL-12-8"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Oct 2024 09:31:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"291c0205-0939-4249-8d06-ca98bd38cea3"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8cece16c182b2d15-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success : The bill status updated successfully.\"\n },\n \"meta\": null\n}"}],"_postman_id":"e3314234-678f-4636-98e3-11da2bcc66f0"},{"name":"Create Finalize Bill","id":"2c84e020-e938-4698-8595-f63389fe326d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"total\": 100.00,\n \"remark\": \"Payment for September\",\n \"discount\": {\n \"percentage\": 10,\n \"value\": 10.00\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/bills/:bill_name/finalize","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","bills",":bill_name","finalize"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"BILL-AT-955-3","key":"bill_name"}]}},"response":[{"id":"9c980d3e-f98a-43cd-9c2d-02fd7cf7eea5","name":"Create Finalize Bill","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"total\": 100.00,\n \"remark\": \"Payment for September\",\n \"discount\": {\n \"percentage\": 10,\n \"value\": 10.00\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/bills/:bill_name/finalize","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","bills",":bill_name","finalize"],"variable":[{"key":"bill_name","value":"BILL-AT-955-3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Oct 2024 09:04:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"f859fc28-e206-4d2b-a14a-f82518b06d2e"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8cecb96aff365794-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success : The bill finalized successfully.\"\n },\n \"meta\": null\n}"}],"_postman_id":"2c84e020-e938-4698-8595-f63389fe326d"}],"id":"dc2c55a7-870e-4a01-bfd3-d6f85d03fc3c","_postman_id":"dc2c55a7-870e-4a01-bfd3-d6f85d03fc3c","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Report","item":[{"name":"Fetch Supported Reports","id":"370b3232-6fa7-4d3b-b316-b58344a684a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/reports","description":"

This API returns a list of categories, each containing a list of reports. You can optionally filter to show only archived reports or only active reports.
Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description	Example
`is_archived`	boolean	No	Filter reports by archive status. If `true`, returns only archived reports. If `false` or not provided, returns only active reports.	`true` or `false`

Each report has a display name, key name, and a list of filters. Each filter has information about whether it is required, its key name, data type, sample value, and options (if any).

For example, under the \"Invoicing Reports\" category, there is a \"Seller Activity Report\" which requires a \"hub\" and a \"date_range\" filter. Similarly, under the \"Fulfilment Reports\" category, there is an \"Orders Report\" which requires a \"hub\", \"date_range\", and \"order_status\" filter.

Archived Reports Example:
When is_archived=true, you'll see reports like \"Orders Report\" under \"Fulfilment Reports\" category. This archived report includes a \"granularity\" filter in the filters data that explicitly indicates the supported time granularity:

If the granularity filter shows \"month\" as an option, it's a monthly report only

The granularity filter in archived reports determines which time format you should use when downloading the report:

Monthly reports: Use mm-yyyy format (e.g., \"12-2023\")

Upon sending a GET request to the specified endpoint, you will receive a response containing the data of the supported reports. This data can be used to understand the types of reports available and the required filters for each report.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","reports"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1f90d0d2-7fcd-4891-b207-638991c4dd75","name":"Fetch Supported Reports","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/reports"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Jul 2025 11:13:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"a06fe2f7-c8b9-4584-bc9e-2987140dda1e"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"95f096e1bf783961-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"categories\": [\n {\n \"key_name\": \"fulfilment\",\n \"display_name\": \"Fulfilment Reports\",\n \"reports\": [\n {\n \"display_name\": \"On-Hold Orders Report\",\n \"key_name\": \"on-hold_orders\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"pending_order_reason\",\n \"datatype\": \"string\",\n \"sample_value\": \"inventory_not_present\",\n \"options\": [\n {\n \"display_name\": \"Insufficient Inventory\",\n \"key_name\": \"inventory_not_present\"\n },\n {\n \"display_name\": \"Invalid SKU\",\n \"key_name\": \"sku_not_valid\"\n },\n {\n \"display_name\": \"Require Manual Approval\",\n \"key_name\": \"require_manual_approval\"\n },\n {\n \"display_name\": \"Manually Put On Hold\",\n \"key_name\": \"forceful_on_hold\"\n },\n {\n \"display_name\": \"Routing Conditions Not Met\",\n \"key_name\": \"not_able_to_route\"\n }\n ]\n }\n ]\n },\n {\n \"display_name\": \"OrdersReport\",\n \"key_name\": \"orders\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"order_status\",\n \"datatype\": \"string\",\n \"sample_value\": \"new_order\",\n \"options\": [\n {\n \"display_name\": \"CreatedAt\",\n \"key_name\": \"created\"\n },\n {\n \"display_name\": \"HubAssignedAt\",\n \"key_name\": \"new_order\"\n },\n {\n \"display_name\": \"PickedAt\",\n \"key_name\": \"picked\"\n },\n {\n \"display_name\": \"ConsolidatedAt\",\n \"key_name\": \"consolidated\"\n },\n {\n \"display_name\": \"PackedAt\",\n \"key_name\": \"packed\"\n },\n {\n \"display_name\": \"ShipmentCreatedAt\",\n \"key_name\": \"ready_to_ship\"\n },\n {\n \"display_name\": \"ReadyForhandoverAt\",\n \"key_name\": \"ready_for_handover\"\n },\n {\n \"display_name\": \"ShippedAt\",\n \"key_name\": \"shipped\"\n },\n {\n \"display_name\": \"DeliveredAt\",\n \"key_name\": \"delivered\"\n },\n {\n \"display_name\": \"CancelledAt\",\n \"key_name\": \"cancelled\"\n },\n {\n \"display_name\": \"ReturnInProgressAt\",\n \"key_name\": \"return_in_progress\"\n },\n {\n \"display_name\": \"ReturnToOriginAt\",\n \"key_name\": \"return_to_origin\"\n },\n {\n \"display_name\": \"PartialReturnAt\",\n \"key_name\": \"partial_return\"\n },\n {\n \"display_name\": \"ReturnedAt\",\n \"key_name\": \"returned\"\n }\n ]\n }\n ]\n },\n {\n \"display_name\": \"ReturnOrderItemLevelReport\",\n \"key_name\": \"return_order_item_level\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"return_order_status\",\n \"datatype\": \"string\",\n \"sample_value\": \"initiated\",\n \"options\": [\n {\n \"display_name\": \"CreatedAt\",\n \"key_name\": \"created\"\n },\n {\n \"display_name\": \"InitiatedAt\",\n \"key_name\": \"initiated\"\n },\n {\n \"display_name\": \"ReturnShipmentCreatedAt\",\n \"key_name\": \"return_shipment_created\"\n },\n {\n \"display_name\": \"OrderPickedAt\",\n \"key_name\": \"order_picked_up\"\n },\n {\n \"display_name\": \"ReturnToOriginAt\",\n \"key_name\": \"return_to_origin\"\n },\n {\n \"display_name\": \"QCInProgressAt\",\n \"key_name\": \"qc_in_progress\"\n },\n {\n \"display_name\": \"QCProcessedAt\",\n \"key_name\": \"qc_processed\"\n }\n ]\n }\n ]\n },\n {\n \"display_name\": \"ReturnOrdersReport\",\n \"key_name\": \"return_orders\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"return_order_status\",\n \"datatype\": \"string\",\n \"sample_value\": \"initiated\",\n \"options\": [\n {\n \"display_name\": \"CreatedAt\",\n \"key_name\": \"created\"\n },\n {\n \"display_name\": \"InitiatedAt\",\n \"key_name\": \"initiated\"\n },\n {\n \"display_name\": \"ReturnShipmentCreatedAt\",\n \"key_name\": \"return_shipment_created\"\n },\n {\n \"display_name\": \"OrderPickedAt\",\n \"key_name\": \"order_picked_up\"\n },\n {\n \"display_name\": \"ReturnToOriginAt\",\n \"key_name\": \"return_to_origin\"\n },\n {\n \"display_name\": \"QCInProgressAt\",\n \"key_name\": \"qc_in_progress\"\n },\n {\n \"display_name\": \"QCProcessedAt\",\n \"key_name\": \"qc_processed\"\n }\n ]\n }\n ]\n },\n {\n \"display_name\": \"SalesOrderItemReport\",\n \"key_name\": \"sales_order_item\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"order_status\",\n \"datatype\": \"string\",\n \"sample_value\": \"new_order\",\n \"options\": [\n {\n \"display_name\": \"CreatedAt\",\n \"key_name\": \"created\"\n },\n {\n \"display_name\": \"HubAssignedAt\",\n \"key_name\": \"new_order\"\n },\n {\n \"display_name\": \"PickedAt\",\n \"key_name\": \"picked\"\n },\n {\n \"display_name\": \"ConsolidatedAt\",\n \"key_name\": \"consolidated\"\n },\n {\n \"display_name\": \"PackedAt\",\n \"key_name\": \"packed\"\n },\n {\n \"display_name\": \"ShipmentCreatedAt\",\n \"key_name\": \"ready_to_ship\"\n },\n {\n \"display_name\": \"ReadyForhandoverAt\",\n \"key_name\": \"ready_for_handover\"\n },\n {\n \"display_name\": \"ShippedAt\",\n \"key_name\": \"shipped\"\n },\n {\n \"display_name\": \"DeliveredAt\",\n \"key_name\": \"delivered\"\n },\n {\n \"display_name\": \"CancelledAt\",\n \"key_name\": \"cancelled\"\n },\n {\n \"display_name\": \"ReturnInProgressAt\",\n \"key_name\": \"return_in_progress\"\n },\n {\n \"display_name\": \"ReturnToOriginAt\",\n \"key_name\": \"return_to_origin\"\n },\n {\n \"display_name\": \"PartialReturnAt\",\n \"key_name\": \"partial_return\"\n },\n {\n \"display_name\": \"ReturnedAt\",\n \"key_name\": \"returned\"\n }\n ]\n }\n ]\n },\n {\n \"display_name\": \"SalesReturnOrderItemReport\",\n \"key_name\": \"sales_return_order_item_level\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"return_order_status\",\n \"datatype\": \"string\",\n \"sample_value\": \"initiated\",\n \"options\": [\n {\n \"display_name\": \"CreatedAt\",\n \"key_name\": \"created\"\n },\n {\n \"display_name\": \"InitiatedAt\",\n \"key_name\": \"initiated\"\n },\n {\n \"display_name\": \"ReturnShipmentCreatedAt\",\n \"key_name\": \"return_shipment_created\"\n },\n {\n \"display_name\": \"OrderPickedAt\",\n \"key_name\": \"order_picked_up\"\n },\n {\n \"display_name\": \"ReturnToOriginAt\",\n \"key_name\": \"return_to_origin\"\n },\n {\n \"display_name\": \"QCInProgressAt\",\n \"key_name\": \"qc_in_progress\"\n },\n {\n \"display_name\": \"QCProcessedAt\",\n \"key_name\": \"qc_processed\"\n }\n ]\n }\n ]\n },\n {\n \"display_name\": \"StockTransferOrdersReport\",\n \"key_name\": \"stock_transfer_orders\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"destination_hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"sto_request_status\",\n \"datatype\": \"string\",\n \"sample_value\": \"accepted\",\n \"options\": [\n {\n \"display_name\": \"Pending\",\n \"key_name\": \"pending\"\n },\n {\n \"display_name\": \"Cancelled\",\n \"key_name\": \"cancelled\"\n },\n {\n \"display_name\": \"Accepted\",\n \"key_name\": \"accepted\"\n }\n ]\n }\n ]\n },\n {\n \"display_name\": \"WarehouseOrderItemReport\",\n \"key_name\": \"warehouse_order_item_level\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n }\n ]\n },\n {\n \"key_name\": \"inventory\",\n \"display_name\": \"Inventory Reports\",\n \"reports\": [\n {\n \"display_name\": \"Batch Report\",\n \"key_name\": \"batch\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"Cycle Count Report\",\n \"key_name\": \"cycle_count\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"HubInventoryReport\",\n \"key_name\": \"hub_inventory\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"InventoryLogReport\",\n \"key_name\": \"inventory_log\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"LocationInventoryReport\",\n \"key_name\": \"location_inventory\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"Serialisation Report\",\n \"key_name\": \"serialisation\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n }\n ]\n }\n ]\n },\n {\n \"key_name\": \"invoicing\",\n \"display_name\": \"Invoicing Reports\",\n \"reports\": [\n {\n \"display_name\": \"Seller Activity Report\",\n \"key_name\": \"seller_activity\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n }\n ]\n },\n {\n \"key_name\": \"inwarding\",\n \"display_name\": \"Inwarding Reports\",\n \"reports\": [\n {\n \"display_name\": \"Gate Entry Report\",\n \"key_name\": \"gate_entry\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"GRN Report\",\n \"key_name\": \"grn\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"Purchase Order Item Level Report\",\n \"key_name\": \"purchase_order_item_level\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"PurchaseOrderLevelReport\",\n \"key_name\": \"purchase_order_level\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"PutAway Report\",\n \"key_name\": \"put_away\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"Return Gate Entry Report\",\n \"key_name\": \"return_gate_entry\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"StockTransferOrderReport(Inwarding)\",\n \"key_name\": \"stock_transfer_order\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date_range\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"2006-12-10\",\n \"2006-12-15\"\n ],\n \"options\": null\n }\n ]\n }\n ]\n },\n {\n \"key_name\": \"valuation\",\n \"display_name\": \"Valuation Reports\",\n \"reports\": [\n {\n \"display_name\": \"InventoryWeightedAverageCostReport\",\n \"key_name\": \"wac\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": false,\n \"key_name\": \"hubs\",\n \"datatype\": \"string_array\",\n \"sample_value\": [\n \"Sample-Hub-1\"\n ],\n \"options\": null\n }\n ]\n }\n ]\n },\n {\n \"key_name\": \"workforce_productivity\",\n \"display_name\": \"Workforce Productivity Reports\",\n \"reports\": [\n {\n \"display_name\": \"Productivity Report\",\n \"key_name\": \"productivity\",\n \"filter\": [\n {\n \"is_required\": false,\n \"key_name\": \"hub\",\n \"datatype\": \"string\",\n \"sample_value\": \"Sample-Hub-1\",\n \"options\": null\n },\n {\n \"is_required\": true,\n \"key_name\": \"date\",\n \"datatype\": \"string\",\n \"sample_value\": \"2006-12-15\",\n \"options\": null\n }\n ]\n }\n ]\n }\n ]\n },\n \"meta\": null\n}"},{"id":"5133834a-62e0-4dd4-b47d-256b696b7d5b","name":"Fetch Supported Archived Reports","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/reports?is_archived=true","host":["{{base_url}}"],"path":["sales-channel","public","v1","reports"],"query":[{"key":"is_archived","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Jul 2025 11:15:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"86ccac64-f3a5-43f2-bee4-f4765788bf27"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"95f09aeeab9dc98b-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"categories\": [\n {\n \"key_name\": \"fulfilment\",\n \"display_name\": \"Fulfilment Reports\",\n \"reports\": [\n {\n \"display_name\": \"On-Hold Orders Report\",\n \"key_name\": \"on-hold_orders\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"OrdersReport\",\n \"key_name\": \"orders\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"ReturnOrderItemLevelReport\",\n \"key_name\": \"return_order_item_level\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"ReturnOrdersReport\",\n \"key_name\": \"return_orders\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"SalesOrderItemReport\",\n \"key_name\": \"sales_order_item\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"SalesReturnOrderItemReport\",\n \"key_name\": \"sales_return_order_item_level\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"StockTransferOrdersReport\",\n \"key_name\": \"stock_transfer_orders\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"WarehouseOrderItemReport\",\n \"key_name\": \"warehouse_order_item_level\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n }\n ]\n },\n {\n \"key_name\": \"inventory\",\n \"display_name\": \"Inventory Reports\",\n \"reports\": [\n {\n \"display_name\": \"Batch Report\",\n \"key_name\": \"batch\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"Cycle Count Report\",\n \"key_name\": \"cycle_count\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"HubInventoryReport\",\n \"key_name\": \"hub_inventory\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"InventoryLogReport\",\n \"key_name\": \"inventory_log\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"LocationInventoryReport\",\n \"key_name\": \"location_inventory\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"Serialisation Report\",\n \"key_name\": \"serialisation\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n }\n ]\n },\n {\n \"key_name\": \"invoicing\",\n \"display_name\": \"Invoicing Reports\",\n \"reports\": [\n {\n \"display_name\": \"Seller Activity Report\",\n \"key_name\": \"seller_activity\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n }\n ]\n },\n {\n \"key_name\": \"inwarding\",\n \"display_name\": \"Inwarding Reports\",\n \"reports\": [\n {\n \"display_name\": \"Gate Entry Report\",\n \"key_name\": \"gate_entry\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"GRN Report\",\n \"key_name\": \"grn\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"Purchase Order Item Level Report\",\n \"key_name\": \"purchase_order_item_level\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"PurchaseOrderLevelReport\",\n \"key_name\": \"purchase_order_level\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"PutAway Report\",\n \"key_name\": \"put_away\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"Return Gate Entry Report\",\n \"key_name\": \"return_gate_entry\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n },\n {\n \"display_name\": \"StockTransferOrderReport(Inwarding)\",\n \"key_name\": \"stock_transfer_order\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n }\n ]\n },\n {\n \"key_name\": \"valuation\",\n \"display_name\": \"Valuation Reports\",\n \"reports\": [\n {\n \"display_name\": \"InventoryWeightedAverageCostReport\",\n \"key_name\": \"wac\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n }\n ]\n },\n {\n \"key_name\": \"workforce_productivity\",\n \"display_name\": \"Workforce Productivity Reports\",\n \"reports\": [\n {\n \"display_name\": \"Productivity Report\",\n \"key_name\": \"productivity\",\n \"filter\": [\n {\n \"is_required\": true,\n \"key_name\": \"granularity\",\n \"datatype\": \"string\",\n \"sample_value\": \"month\",\n \"options\": [\n {\n \"display_name\": \"Monthly\",\n \"key_name\": \"month\"\n }\n ]\n },\n {\n \"is_required\": false,\n \"key_name\": \"month\",\n \"datatype\": \"string\",\n \"sample_value\": \"01-2025\",\n \"options\": null\n }\n ]\n }\n ]\n }\n ]\n },\n \"meta\": null\n}"}],"_postman_id":"370b3232-6fa7-4d3b-b316-b58344a684a6"},{"name":"Download Report","id":"32217b0f-367c-4b65-9cb0-46f71cf92833","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{AccessToken}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"timezone\": \"Asia/Riyadh\",\n \"filters\": [\n {\n \"key_name\": \"hub\",\n \"value\": \"Hub27\"\n },\n {\n \"key_name\": \"date_range\",\n \"value\": [\n \"2023-11-29\",\n \"2023-12-04\"\n ]\n },\n {\n \"key_name\": \"order_status\",\n \"value\": \"picked\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/reports/:category/:report/download","description":"

To use this API, you need to send a POST request to the specified endpoint with the category key name and report key name from the Fetch Supported Reports API. The request body should contain the timezone and the filters for the report. Each filter should have a key name and a value. The key names should be according to the key name given in Fetch Supported Reports API. The values for these keys should be replaced with your actual values in the same format as given in sample_values of Fetch Supported Reports API.

Upon sending this request to the Omniful API, the system will generate the report based on the provided filters and send the response to the webhook URL given in Fetch Supported Reports API.

Important points to consider:

Required Filters Should always be present with valid values.
\n
In case options is present for particular filter in Fetch Supported Reports API . The filter value passed should be one of the key_name in options
\n
The date format should always be yyy-mm-dd and the date range filter will be in format [start_date, end_date]
\n
Timezone should always be passed in the request.
\n
Difference between start and end date can be maximum of 7 days and first value of date_range corresponds to start_date while second value corresponds to end_date****.
\n
The category in param corresponds to the key_name of category while report in param corresponds to the key_name of report in Fetch Supported Reports API
\n

⚡ Rate Limiting

To ensure fair usage and performance stability, Omniful APIs have a default rate limit of:

✅ 30 requests per minute

📌 Exceeding the limit may result in temporary API restrictions

\n","urlObject":{"path":["sales-channel","public","v1","reports",":category",":report","download"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"fulfilment","key":"category"},{"type":"any","value":"orders","key":"report"}]}},"response":[{"id":"36389896-9eef-4b37-8f0e-5fa2f524df60","name":"Download Report","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"timezone\": \"Asia/Riyadh\",\n \"filters\": [\n {\n \"key_name\": \"hub\",\n \"value\": \"Hub27\"\n },\n {\n \"key_name\": \"date_range\",\n \"value\": [\n \"2023-11-29\",\n \"2023-12-04\"\n ]\n },\n {\n \"key_name\": \"order_status\",\n \"value\": \"picked\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{StagingEnv}}/sales-channel/public/v1/reports/:category/:report/download","host":["{{StagingEnv}}"],"path":["sales-channel","public","v1","reports",":category",":report","download"],"variable":[{"key":"category","value":"fulfilment"},{"key":"report","value":"orders"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Dec 2023 08:44:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"2664d900-0538-4c0d-bca0-7abf8d2ddd9d"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"830b02168a63f2ce-BOM"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"Message\": \"Report Generation In Progress!!\",\n \"id\": \"672859ecb4616975f0010b5f\"\n },\n \"meta\": null\n}"}],"_postman_id":"32217b0f-367c-4b65-9cb0-46f71cf92833"},{"name":"Download Archived Report","id":"2942d386-6050-4dd3-947a-434d6fe70e6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"granularity\": \"month\",\n \"month\": \"12-2024\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/reports/archived/:category/:report/download","description":"

Download Archived Reports

Overview

This API allows you to download archived reports with specific granularity (monthly). Archived reports contain historical data that has been moved to archive status and can be accessed for compliance or historical analysis purposes.

Endpoint

POST {{base_url}}/sales-channel/public/v1/reports/archived/:category/:report/download

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description	Example
`category`	string	Yes	The category key name of the report	`fulfilment`
`report`	string	Yes	The report key name within the category	`orders`

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description	Example
`granularity`	string	Yes	The granularity level for the archived report. Must be \"month\".	`\"month\"`
`month`	string	Conditional	Required when granularity is \"month\". Month in mm-yyyy format	`\"01-2024\"`

Authorization

Bearer Token

This request uses Bearer Token from folder Tenant APIs

This is the request payload which has been fired in webhook in case of Success

This is the request payload which has been fired in webhook in case of Failure

Event Names: [ order.create.event, order.new.event, order.update.event, order.shipment.event, order.hub_assign.event, order.invoice-update.event, order.sync.event]

Event Names: [ sku.create.event, sku.update.event]

Event Names: [ inventory.update.event]

dispose — generated when a user disposes inventory.
\n
conversion — generated when a user marks inventory as failed.
\n

Event Names: [ grn.qc.event ]

Event Names: [ return_order.create.event, return_order.qc.event, return_order.shipment.event, return_order.invoice_update.event]

\n
Note: STO event webhooks are only triggered when the STO is generated by a sales channel.
\n

Event Names: [shipment-order.create.event, shipment-order.update.event]

Event Names: [purchase_order.create.event, purchase_order.update.event]

In the purchase order webhook payload, a maximum of 200 items will be included.

If the purchase order contains more than 200 items, the remaining items must be retrieved using the APIs.

📌 Webhook Payload Reference

Overview

This section provides sample webhook payloads for all available webhooks. You can refer to these payloads to understand the structure and expected data for each event.

🔹 How to Use

Review the sample webhook payloads to understand the data format.
\n
Use them as a reference when setting up webhook listeners in your system.
\n
Ensure your application can handle incoming webhook requests and parse the payload accordingly.
\n

For detailed webhook event descriptions and payload samples, refer to the Webhook Documentation. 🚀

⚠️ Please Note:
Each webhook request has a 30-second timeout. This means your endpoint must send a valid HTTP response within 30 seconds of receiving the request. If no response is received within this window, our system will retry the request up to 3 times before marking it as failed.

🔐 Custom Headers

Custom HTTP headers can be added to webhook events to support advanced use cases such as authentication, request routing, or internal tracking.

✨ Key Capabilities

Add up to 2 custom headers per webhook event
\n
Each header consists of a key–value pair
\n
These headers are sent with every webhook request for the configured event
\n

📏 Constraints

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Limit
Maximum custom headers	2
Header key max length	50 characters
Header value max length	4500 characters

🚫 Restricted Header Keys

For security and system integrity reasons, custom header keys must NOT use any of the following reserved headers:

x-omniful-request-id\nx-omniful-channel-name\nwebhook-secret-key\nwebhook-event\ntracestate\ntraceparent\nnewrelic\n\n

📘 Status Code Reference (status_code)

✅ Order Status Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Label	Status Code
On Hold	`on_hold`
Hub Assigned	`hub_assigned`
New Order	`new_order`
Picked	`picked`
Packed	`packed`
Ready To Ship	`ready_to_ship`
Shipped	`shipped`
Delivered	`delivered`
Cancelled	`cancelled`

🔁 Return Status Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Label	Status Code
New Return Request	`new_return_request`
Return Request Approved	`return_request_approved`
Return Request Rejected	`return_request_rejected`
Return Order Initiated	`return_initiated`
Return Shipment Created	`return_shipment_created`
Return Order Arrived At Hub	`return_order_arrived_at_hub`
Return Order QC Processed	`return_order_qc_processed`
Return Order Picked Up	`return_order_picked_up`
Return Order Cancelled	`return_order_cancelled`
Return Order Completed	`return_order_completed`
Return To Origin	`return_to_origin`

","_postman_id":"98a2577d-4460-42c2-b4e6-5386cd21107b","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Return Orders","item":[{"name":"Return Shipment","item":[{"name":"Create Sales Channel Shipment","id":"918946cd-0cf7-4423-832a-d141bddc0b97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"tracking_url\": \"https://tracking.fedex.com/123456789\",\n \"awb_number\": \"AWB123452832\",\n \"awb_label\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/shipping/tamex/pixicommerce435/14755/55f86b562b59de7e04cc5687_awb_label.pdf\",\n \"package_details\": {\n \"number_of_boxes\": 1,\n \"weight\": 1,\n \"dimensions\": {\n \"length\": 30,\n \"breadth\": 20,\n \"height\": 15\n },\n \"remarks\": \"Handle with care\"\n },\n \"courier_partner\": {\n \"tag\": \"dhl_express\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_id/return_orders/:return_order_id/shipment","description":"

Add Shipment for Return Order

This endpoint allows the user to add a shipment for a specific return order belonging to a seller.

Request Body

tracking_url (string) - The URL for tracking the shipment.
\n
awb_number (string) - The Air Waybill (AWB) number for the shipment.
\n
awb_label (string) - The URL to the AWB label for the shipment.
\n
package_details (object) - Details of the package including number of boxes, weight, dimensions, and remarks.
\n
- number_of_boxes (integer) - The number of boxes in the shipment.
  \n
- weight (integer) - The total weight of the shipment.
  \n
- dimensions (object) - The dimensions of the package including length, breadth, and height.
  \n
  - length (integer) - The length of the package.
    \n
  - breadth (integer) - The breadth of the package.
    \n
  - height (integer) - The height of the package.
    \n
  \n
- remarks (string) - Any specific remarks for handling the package.
  \n
\n
courier_partner (object) - Details of the courier partner including ID, name, tag, and logo URL.
\n
- tag (string) - The tag associated with the courier partner.
\n

\n","urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_id","return_orders",":return_order_id","shipment"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"VN-717","key":"seller_id"},{"type":"any","value":"RO-01062025-DMNDZ","key":"return_order_id"}]}},"response":[{"id":"6e0aefc9-9b68-4919-846e-f2f045a67d86","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"tracking_url\": \"https://tracking.fedex.com/123456789\",\n \"awb_number\": \"AWB123452832\",\n \"awb_label\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/shipping/tamex/pixicommerce435/14755/55f86b562b59de7e04cc5687_awb_label.pdf\",\n \"package_details\": {\n \"number_of_boxes\": 1,\n \"weight\": 1,\n \"dimensions\": {\n \"length\": 30,\n \"breadth\": 20,\n \"height\": 15\n },\n \"remarks\": \"Handle with care\"\n },\n \"courier_partner\": {\n \"tag\": \"dhl_express\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_id/return_orders/:return_order_id/shipment","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_id","return_orders",":return_order_id","shipment"],"variable":[{"key":"seller_id","value":"VN-717"},{"key":"return_order_id","value":"RO-01062025-DMNDZ"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 01 Jun 2025 13:56:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"cab26cec-f8d9-4668-895d-1feaeea1829c"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Strict-Transport-Security","value":"max-age=300"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"948f377facb081cf-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Return shipment created successfully\",\n \"meta\": null\n}"}],"_postman_id":"918946cd-0cf7-4423-832a-d141bddc0b97"},{"name":"Update Sales Channel Shipment status","id":"8039e5f5-56eb-46c1-b4de-90385e9348a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"shipment_status\": \"picked_up\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_id/return_orders/:return_order_id/shipment/status","description":"

Allowed Shipment Status: [ picked_up, return_to_origin, cancelled]

\n","urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_id","return_orders",":return_order_id","shipment","status"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"VN-717","key":"seller_id"},{"type":"any","value":"RO-01062025-DMNDZ","key":"return_order_id"}]}},"response":[{"id":"347f4ea0-597e-4705-a7d3-7e0b322a463b","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"shipment_status\": \"picked_up\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_id/return_orders/:return_order_id/shipment/status","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_id","return_orders",":return_order_id","shipment","status"],"variable":[{"key":"seller_id","value":"VN-717"},{"key":"return_order_id","value":"RO-01062025-DMNDZ"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 01 Jun 2025 13:57:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"4023b876-47f9-43ed-a05e-39134d1156d4"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Strict-Transport-Security","value":"max-age=300"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"948f37e30be0d1bc-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Return shipment status updated successfully\",\n \"meta\": null\n}"}],"_postman_id":"8039e5f5-56eb-46c1-b4de-90385e9348a8"}],"id":"53d6b841-2b44-4d17-9a99-67b9a8f589d6","_postman_id":"53d6b841-2b44-4d17-9a99-67b9a8f589d6","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Create Customer Return Order","id":"8f787366-06aa-4909-8af8-1323c33d461e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"return_order_id\" :\"priyardarshi\", // mandatory\n \"return_items\" : [\n {\n \"item_id\": \"695b52bb028d19e04e411275\", // mandatory\n \"return_item_id\": \"wdewd\",\n \"sku_code\": \"SKU 31\", // mandatory\n \"return_quantity\": 1,\n \"return_reasons\": [ // mandatory\n {\n \"reason\": \"Small size\", \n \"quantity\": 1\n }\n ], // optional\n \"unit_price\": 11.4,\n \"discount\": 1.2,\n \"total\":10.2\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"\", // one of cod_fee, return_fee, return_shipment_fee\n \"cost\": 5.00,\n \"tax_inclusive\": true,\n \"tax_percentage\": 10.00,\n \"is_applied\": true\n }\n ] // optional\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:order_id/return_orders","description":"

This API endpoint allows you to create a return order for any forward order that has been marked as Delivered.

Precondition

The order must have the status Delivered to be eligible for a return.

Field Descriptions

Field	Type	Mandatory/Optional	Description
`return_order_id`	string	Mandatory	Unique identifier for the return order.
`return_items`	array of objects	Mandatory	List of items being returned, including `item_id`, `sku_code`, and `return_quantity`.
`item_id`	string	Mandatory	Original order item ID.
`sku_code`	string	Mandatory	SKU code of the item being returned.
`return_quantity`	integer	Mandatory	Quantity of the item being returned.
`return_item_id`	string	Optional	Unique ID for the returned item.
`return_reasons`	array of objects	Optional	List of reasons for return, with each entry specifying `reason` and `quantity`.
`unit_price`	float	Optional	Price per unit of the item.
`discount`	float	Optional	Discount applied to the item.
`total`	float	Optional	Total price for the returned quantity.
`additional_charges`	array of objects	Optional	List of additional charges applied to the return, including the `type`, `cost`, `tax_inclusive`, etc.
`type`	string	Optional	Type of charge, one of `cod_fee`, `return_fee`, `return_shipment_fee`.
`cost`	float	Optional	The cost of the additional charge.
`tax_inclusive`	boolean	Optional	Whether the charge includes tax.
`tax_percentage`	float	Optional	Tax percentage applied to the additional charge.
`is_applied`	boolean	Optional	Whether the additional charge is applied to the return.

Response

The response will include the details of the created return order, including the return order ID, return items, and any additional charges applied.

Notes

return_order_id and the fields inside return_items marked as mandatory must always be provided.
\n
Optional fields can be included based on business requirements (e.g., specifying return reasons or applying additional charges).
\n

This API endpoint allows you to create a return order for any forward order that has been marked as Return To Origin.

Precondition

The order must have the status Return To Origin to be eligible for a return.

Field Descriptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Mandatory/Optional	Description
`return_order_id`	string	Mandatory	Unique identifier for the return order.

Notes

return_order_id must always be provided.

Page number of response

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of responses per page

\n","type":"text/plain"},"key":"per_page","value":"3"},{"disabled":true,"description":{"content":"

single value

\n","type":"text/plain"},"key":"return_order_id","value":"r-pos-SHUBHRAIPHONE15-1"},{"disabled":true,"description":{"content":"

multiple values

\n","type":"text/plain"},"key":"return_order_ids","value":"RO-13022025-XPNDS54"},{"disabled":true,"description":{"content":"

Forward order alias

\n","type":"text/plain"},"key":"order_alias","value":"10262"},{"disabled":true,"description":{"content":"

Omniful Return order id

\n","type":"text/plain"},"key":"id","value":"67bc05df6412a6fcb2da2dba"},{"disabled":true,"description":{"content":"

Sales Channel Forward Order Id

\n","type":"text/plain"},"key":"order_id","value":"B2C_8796907607607"},{"disabled":true,"description":{"content":"

Customer's Mobile Number

\n","type":"text/plain"},"key":"customer_mobile","value":"+966-123489723"}],"variable":[{"description":{"content":"

Unique identifier of seller

\n","type":"text/plain"},"type":"any","value":"Test-123","key":"seller_code"}]}},"response":[{"id":"f99d31da-56b4-4308-bb2a-ff4a881496d6","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/return_orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","return_orders"],"query":[{"key":"return_order_id","value":"r-pos-SHUBHRAIPHONE15-1","description":"single value","disabled":true},{"key":"return_order_ids","value":"RO-13022025-XPNDS54","description":"multiple values","disabled":true}],"variable":[{"key":"seller_code","value":"Test-1234"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Feb 2025 05:38:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"63fa4770-e74d-4deb-865d-ead0f499b0ad"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Strict-Transport-Security","value":"max-age=300"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"916d1c6d9f7359cc-DEL"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"697812226b6800a476f14843\",\n \"return_order_id\": \"RO-27012026-XWPXR\",\n \"order_id\": \"697810ff6b6800a476f1483d\",\n \"seller_name\": \"Sanat\",\n \"type\": \"Customer Return\",\n \"source\": \"Manual\",\n \"customer\": {\n \"first_name\": \"Sanat\",\n \"last_name\": \"Smith\",\n \"mobile\": \"+966-541234561\",\n \"mobile_code\": \"+966\",\n \"email\": \"sjsanat@gmail.com\"\n },\n \"order_reference_id\": \"B2C_1769476351032397077_533\",\n \"hub_code\": \"132\",\n \"total_return_quantity\": 1,\n \"total_sku_count\": 1,\n \"delivered_quantity\": 1,\n \"total\": 120,\n \"pickup_address\": {\n \"address1\": \"456 Oak Avenue\",\n \"address2\": \"Apartment 1\",\n \"city\": \"\",\n \"country\": \"Saudi Arabia\",\n \"first_name\": \"Sanat\",\n \"last_name\": \"Smith\",\n \"phone\": \"+966-541234561\",\n \"email\": \"\",\n \"state\": \"\",\n \"area\": \"\",\n \"zip\": \"SA56789\",\n \"state_code\": \"\",\n \"country_code\": \"SA\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"national_address_code\": \"SA123\"\n },\n \"status\": \"Initiated\",\n \"refund_status\": \"Pending\",\n \"qc_fail_reasons\": [\n {\n \"key\": \"item_damaged\",\n \"display_name\": \"Item Damaged\"\n },\n {\n \"key\": \"color_faded\",\n \"display_name\": \"Color Faded\"\n },\n {\n \"key\": \"item_not_received\",\n \"display_name\": \"Item Not Received\"\n }\n ],\n \"oms_qc_status\": \"Pending\",\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"order_created_at\": \"2026-01-27T01:12:31.311Z\",\n \"order_delivered_at\": \"2026-01-27T01:16:57.141Z\",\n \"payment_method\": \"prepaid\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 104.35,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 15.65,\n \"discount\": 0,\n \"total\": 120,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"return_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"},{"id":"558cfbe2-4728-47ce-be25-554f2e9e17a3","name":"Success (With Return Order Id Filter)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/return_orders/?page=1&per_page=3&return_order_id=RO-09122025-VQDRJ","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","return_orders",""],"query":[{"key":"page","value":"1","description":"Page number of response"},{"key":"per_page","value":"3","description":"Number of responses per page"},{"key":"return_order_id","value":"RO-09122025-VQDRJ","description":"single value "},{"key":"return_order_ids","value":"RO-13022025-XPNDS54","description":"multiple values","disabled":true},{"key":"order_alias","value":"10262","description":"Forward order alias","type":"text","disabled":true},{"key":"id","value":"67bc05df6412a6fcb2da2dba","description":"Omniful Return order id","type":"text","disabled":true},{"key":"order_id","value":"B2C_8796907607607","description":"Sales Channel Forward Order Id","type":"text","disabled":true},{"key":"customer_mobile","value":"+966-123489723","description":"Customer's Mobile Number","type":"text","disabled":true}],"variable":[{"key":"seller_code","value":"Test-123","description":"Unique identifier of seller"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"6937c549a18cfeca13738540\",\n \"return_order_id\": \"RO-09122025-VQDRJ\",\n \"order_id\": \"691c0cdf8b15d97a2bbb5077\",\n \"seller_name\": \"Sanat\",\n \"type\": \"Customer Return\",\n \"source\": \"Manual\",\n \"customer\": {\n \"first_name\": \"sanat sj\",\n \"mobile\": \"+91-7667624221\",\n \"email\": \"sjsanat@gmail.com\"\n },\n \"order_reference_id\": \"B2B_1763445983462079949_525\",\n \"hub_code\": \"132\",\n \"total_return_quantity\": 5,\n \"total_sku_count\": 1,\n \"delivered_quantity\": 5,\n \"total\": 600.01,\n \"pickup_address\": {\n \"address1\": \"Gurgaon\",\n \"address2\": \"\",\n \"city\": \"Gurgaon\",\n \"country\": \"India\",\n \"first_name\": \"sanat sj\",\n \"last_name\": \"\",\n \"phone\": \"+91-7667624221\",\n \"email\": \"\",\n \"state\": \"\",\n \"area\": \"\",\n \"zip\": \"\",\n \"state_code\": \"HR\",\n \"country_code\": \"IN\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"national_address_code\": \"\"\n },\n \"status\": \"Return Shipment Created\",\n \"refund_status\": \"Pending\",\n \"qc_fail_reasons\": [\n {\n \"key\": \"item_not_received\",\n \"display_name\": \"Item Not Received\"\n },\n {\n \"key\": \"item_damaged\",\n \"display_name\": \"Item Damaged\"\n },\n {\n \"key\": \"color_faded\",\n \"display_name\": \"Color Faded\"\n }\n ],\n \"oms_qc_status\": \"Pending\",\n \"shipment_created\": true,\n \"is_shipment_created\": true,\n \"print_awb_allowed\": true,\n \"shipment\": {\n \"shipment_order_id\": \"698ed00f5946202a532f8a3e\",\n \"awb_number\": \"9876543789087654\",\n \"shipping_partner_status\": \"ready_for_pickup\",\n \"delivery_status\": \"\",\n \"awb_label\": \"https://cdn.salla.sa/bwlle/shipping-policy/138356829-dTLTNMzjV7Jug2x187cBz0j6EDBa5fDXq5ORRrEu.pdf\",\n \"shipping_partner_tag\": \"manual\",\n \"shipping_partner_name\": \"Manual\",\n \"tracking_url\": \"https://ajex.phptest.aj-ex.com/tracking?tracking_number=AJA900000097837\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"order_created_at\": \"2025-11-18T06:06:23.488Z\",\n \"order_delivered_at\": \"2025-12-03T06:46:58.985Z\",\n \"payment_method\": \"prepaid\",\n \"invoice\": {\n \"currency\": \"SAR\",\n \"subtotal\": 521.75,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 78.26,\n \"discount\": 0,\n \"total\": 600.01,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"return_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false,\n \"discount_amount\": 0\n }\n ],\n \"attachments\": null,\n \"exchange_rate\": {\n \"order_currency\": \"\",\n \"store_currency\": \"\",\n \"rate\": 0\n }\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 1\n }\n}"}],"_postman_id":"352f46d9-7bce-4e9f-8844-79b5f2128c51"}],"id":"82648227-13b4-4354-b043-cc4ef80dd55a","_postman_id":"82648227-13b4-4354-b043-cc4ef80dd55a","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Inventory","item":[{"name":"Push Inventory","id":"9f7ceacf-6e74-4361-9457-541c221fbcb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"sku_detail\": [\n {\n \"sku_code\": \"sku-srv\",\n \"quantity\": 10\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/sellers/:seller_code/inventory","description":"

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 and should contain the following structure:

{\n  \"sku_detail\": [\n    {\n      \"sku_code\": \"string\",   // The unique code for the SKU (Stock Keeping Unit)\n      \"quantity\": integer      // The quantity of the SKU to be updated in the inventory\n    }\n  ]\n}\n\n

sku_detail: An array of objects, each representing a SKU and its associated quantity.
- sku_code: A string that identifies the SKU.
- quantity: An integer that specifies the amount of the SKU being added or updated.
\n
Max 200 skus are allowed in the payload of each request.

Response

The response will typically include a confirmation of the update, along with the failed skus with reasons.

\n","type":"text/plain"},"key":"updated_from","value":"2025-03-02 15:04:05"},{"description":{"content":"

\n","type":"text/plain"},"key":"updated_to","value":"2025-03-04 15:04:05"},{"description":{"content":"

Specify the timezone in which you want the inventory update timestamps to be returned. If no timezone is provided, the system defaults to UTC. Example: Asia/Riyadh.

\n","type":"text/plain"},"key":"timezone","value":"UTC"}],"variable":[{"type":"any","value":"ONLS","key":"hub_code"}]}},"response":[{"id":"94117169-4eea-4bb6-9834-a3c4afc7a67a","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/inventory","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","hubs",":hub_code","inventory"],"query":[{"key":"seller_code","value":"SG-333","disabled":true},{"key":"sku_code","value":"parle-g","disabled":true},{"key":"sku_codes","value":"","disabled":true}],"variable":[{"key":"hub_code","value":"ONLS"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Feb 2025 05:56:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"1e046036-a10e-42f3-8eff-84792f85db5d"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"917573da8ea6c578-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"parle-g\",\n \"available_quantity\": 231111113,\n \"sku_name\": \"Parle G\",\n \"quantity_on_hand\": 231111113,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"iphone-new-test-2\",\n \"available_quantity\": 0,\n \"sku_name\": \"Iphone 15 Edited\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"sku-1002\",\n \"available_quantity\": 0,\n \"sku_name\": \"sku-1002\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"sku-1001\",\n \"available_quantity\": 999,\n \"sku_name\": \"sku-1001\",\n \"quantity_on_hand\": 1000,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"Z.611660.172017648074509\",\n \"available_quantity\": 150,\n \"sku_name\": \"empower_test\",\n \"quantity_on_hand\": 152,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"Z.561389.17200858404338217\",\n \"available_quantity\": 298,\n \"sku_name\": \"fast_hub_test\",\n \"quantity_on_hand\": 300,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"sku-1234\",\n \"available_quantity\": 1000,\n \"sku_name\": \"sku-1234\",\n \"quantity_on_hand\": 1000,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"SKU-1001\",\n \"available_quantity\": 0,\n \"sku_name\": \"Name555566\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"1108322\",\n \"available_quantity\": 56473,\n \"sku_name\": \"Jean Paul Gaultier Gaultier Divine Eau de Parfum 100ml\",\n \"quantity_on_hand\": 56475,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"1108448\",\n \"available_quantity\": 1107,\n \"sku_name\": \"Gucci Bloom Eau de Parfum 100ml\",\n \"quantity_on_hand\": 1111,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"newproduct\",\n \"available_quantity\": 297,\n \"sku_name\": \"Smart LED TV7\",\n \"quantity_on_hand\": 298,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"testsku001\",\n \"available_quantity\": 96,\n \"sku_name\": \"testsku001\",\n \"quantity_on_hand\": 99,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"TEST001\",\n \"available_quantity\": 8,\n \"sku_name\": \"Timex Multifunction Timeplece\",\n \"quantity_on_hand\": 10,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"COD\",\n \"available_quantity\": -227,\n \"sku_name\": \"Cash On Delivery\",\n \"quantity_on_hand\": -227,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004419\",\n \"available_quantity\": 1000,\n \"sku_name\": \"Lego 2 Blue Gel Pen with Minifigure\",\n \"quantity_on_hand\": 1000,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8004137\",\n \"available_quantity\": 0,\n \"sku_name\": \"Pabobo Kid'Sleep Moon\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"8001417\",\n \"available_quantity\": 0,\n \"sku_name\": \"DISNEY FROZEN LCD WATCH\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"7201405\",\n \"available_quantity\": 0,\n \"sku_name\": \"Ray-Ban RB2132 New Wayfarer Classic Square Sunglasses Blue/Grey\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"7201348\",\n \"available_quantity\": 0,\n \"sku_name\": \"Michael Kors Mk2089U Sunglasses Tortoise\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"ONLS\",\n \"sku_code\": \"7201347\",\n \"available_quantity\": 0,\n \"sku_name\": \"Michael Kors Mk2024 Sunglasses Black\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 193,\n \"per_page\": 20,\n \"total\": 3856\n }\n}"},{"id":"cc99cb7b-1cb4-4add-bd0e-167f97eb9a88","name":"Invalid Hub Code","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/inventory","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","hubs",":hub_code","inventory"],"query":[{"key":"seller_code","value":"SG-333","disabled":true},{"key":"sku_code","value":"","disabled":true},{"key":"sku_codes","value":"","disabled":true}],"variable":[{"key":"hub_code","value":"ONLS-HUB"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:24:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"946e6609-2f68-4715-90eb-248e6983b1bd"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913b970c9cf4c9bd-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 403,\n \"error\": {\n \"message\": \"You are not authorised to perform this action\"\n }\n}"},{"id":"87d1ea06-50a5-492c-a22c-6c5ad31b6d76","name":"Hub Mapping Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/inventory","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","hubs",":hub_code","inventory"],"query":[{"key":"seller_code","value":"SG-333","disabled":true},{"key":"sku_code","value":"","disabled":true},{"key":"sku_codes","value":"","disabled":true}],"variable":[{"key":"hub_code","value":"20101"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Feb 2025 05:25:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"5aada6da-bd01-4771-b035-7f7292bb8544"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"913b990e883e0629-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"Invalid hub code.\"\n }\n}"}],"_postman_id":"80663936-ff98-4454-9ae5-b7e61e57661a"},{"name":"Get Inventory for SKU Across All Hubs","id":"c4cfd7dd-32d2-4381-89c3-9b1cf643b0aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/skus/:sku_code/inventory","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","skus",":sku_code","inventory"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

Page Number

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Results per page

\n","type":"text/plain"},"key":"per_page","value":"2"},{"disabled":true,"description":{"content":"

(Optional) used to filter hubs using Hub Code

\n","type":"text/plain"},"key":"hub_codes","value":"hub_code_1"}],"variable":[{"description":{"content":"

Seller unique identifier

\n","type":"text/plain"},"type":"any","value":"974","key":"seller_code"},{"description":{"content":"

SKU Unique Identifier

\n","type":"text/plain"},"type":"any","value":"6302592","key":"sku_code"}]}},"response":[{"id":"900aa020-1fb5-41fc-95ae-d4e617f938ce","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTgzNjQ4MjgsImp0aSI6ImI2NDUyYTBlLWZkYWYtNDBlYi05NjRkLTI1OGFmN2E1YjIwNiIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRDb2RlIjoiMzcxODEyNDk2OCIsIlRlbmFudElEIjoiIiwiVXNlcklEIjoiNTYyOCIsIlVzZXJOYW1lIjoiSGluaXNoIEJhbnNhbCIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjEyMH19LCJ0b2tlbl90eXBlIjoiQmVhcmVyIn0.SUhsS9bmE9bfPb4mX9sOl6W9tyrK_fiSHO6vmmVWwoLzzRsn3Z9jqhgEi1V-1Z9xXsyIPzUtuPJ3oDQTvLNDwzx4eS5Sf0ZhpcI4dE-iA1EkzIzssr2dHMiHZxGjIoBlq8Wwqu4Bhe0NnEOgUHddReTKq40OBBp-44CvgHVZvjm-VPwqN9lvPOljag5fsMQzgeN3aH66v3X0ajdBtAoTXyqZDgd2kRCfHneoGPMrKSOvjByGgsx9GU3qmKu126ZnAufrjvVWk9W26SMmJrg73to8kRfWhJ0jS5F7Kr45mKZFn_6tEDLDxpCq07TaAm-DD-M0GhZdPTW7H9wWx20tt9-55r_KbhWIqPtjH7vRQ4Rdyimx8BYYz7HVlQOuji6VvpQ1ge23KrKzyhBptqO-_6Arpbfj42ewOViFOEL2w6h6t9DRrqNoxG13Jm3ZQYQJf2_Vpt8l2iuEPxSaqI_5_upsLXUt8RhS99vaZ_XXOgMayh7NvVVpbmmUTdfpQ-epZEfInp_2emJu3NFKEjugpANzcdp8fvAKqjTDimhIL59R4HwP2dmTyGWmSx3_VQqJiRQtvA-2yH91pbIwE2hUVQJv5-o2bO4GHaiBNUkjxSQE3e6qnN2H7kxa4j9-ik4YvMPaUtX1XAwXxtkUOR_jKuk4qEd9gZB8gKaV7v9ZWfE"}],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/974/skus/6302592/inventory?page=1&per_page=2&hub_codes=1111111&hub_codes=locoff","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","tenants","sellers","974","skus","6302592","inventory"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"2"},{"key":"hub_codes","value":"1111111"},{"key":"hub_codes","value":"locoff"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 08 Sep 2025 10:02:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"b645331f-1b59-4899-9413-f2facd864faa"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"97bd9c7c4c247fbd-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"hub_code\": \"locoff\",\n \"sku_code\": \"6302592\",\n \"available_quantity\": 9999996,\n \"sku_name\": \"uiaasdj\",\n \"quantity_on_hand\": 9999996,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 9999993,\n \"quantity_location_fail_inventory_sum\": 0,\n \"updated_at\": \"\",\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n },\n {\n \"hub_code\": \"1111111\",\n \"sku_code\": \"6302592\",\n \"available_quantity\": 0,\n \"sku_name\": \"uiaasdj\",\n \"quantity_on_hand\": 0,\n \"quantity_reserved\": 0,\n \"uom\": \"ea\",\n \"quantity_location_pass_inventory_sum\": 0,\n \"quantity_location_fail_inventory_sum\": 0,\n \"updated_at\": \"\",\n \"seller\": {\n \"code\": \"12\",\n \"name\": \"21\"\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 2,\n \"last_page\": 1,\n \"total\": 2\n }\n}"}],"_postman_id":"c4cfd7dd-32d2-4381-89c3-9b1cf643b0aa"},{"name":"Push Safety Stock","id":"095e6741-518b-48de-a518-50750ea619e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"sku_detail\": [\n {\n \"sku_code\": \"65525900136597\",\n \"quantity\": 1001\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/sellers/:seller_code/safety_stock","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","hubs",":hub_code","sellers",":seller_code","safety_stock"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"hub_123","key":"hub_code"},{"type":"any","value":"seller_1234","key":"seller_code"}]}},"response":[{"id":"ee65952b-8cd6-4341-a53f-6f78d6b6c00a","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NzcwMjk0MTcsImp0aSI6IjYyODJhNDkzLTY1NTYtNDNkYy1hZmM2LTk0Njk4OTlhMDYwOCIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRDb2RlIjoiMzcxODEyNDk2OCIsIlRlbmFudElEIjoiIiwiVXNlcklEIjoiNDUwOCIsIlVzZXJOYW1lIjoiRGhydXYgQmhhdHQiLCJSYXRlTGltaXREZXRhaWxzIjp7IkVuYWJsZWQiOnRydWUsIlJlcXVlc3RzUGVyTWludXRlIjoxMjB9fSwidG9rZW5fdHlwZSI6IkJlYXJlciJ9.b8mVlSH0b_97JcqSysSL8-S4GiimRozc3wLcv6LqDTsUaGfwo0zYNP27-bEOsJViLWDJgm73BR7SwG-Vq6NU4tMp71g0RtnQZwCRpqVtROdVnJt0UvN3GDTS1IhZSmM4Y5iTJF3FHD4vy2k0IRCUavvxYBAX3L6-8FfqdzBN7YbZsl0OUgEjum-3pgtAy7WCQgGGqqLjCzN8zUh0I2XHiU0k11VZFJb4-Gf0EXTFtzwc4NbBEMpM1prZ3u7Q7PVzLBEykCFverBS5WKFyyNxYHbHe6b3gKmR6x1U_VE1zKE0c0D12iTCx5h6BbRO__VbUZS2eZvGE-uLas3Oi6MV3txz21pyoo_jERlQCr4_yqx6Y0x9iQVrkA3Thr9eBpRLWtUiYqgoZfGYuuDjNM0DxRUOT0_ld40_J6WccfKiCzs_YrjikAauEhiOb9qdTttKLMK8NoR3OeB68x5QPYXz0VdwIDzF3Yn1YlmOYdVKF5R4Q5fbinwwJqIlaJgUDgpTLU3T9511kyOt1hdmr4h_PPyB92ohEfStO5DbHMcCTpaRrWQ-oTl_XOdgZ7GFSO7FYzQ2ZrdrE7_Pppq_XRJFIiOyJ2cCHXLvqzztMNaI0waTAwyGxFOdknounl6Q-rMfG8X9xLzqed_c5A6mW9a33erktFeUm5MiVtYwER-UD6s"}],"body":{"mode":"raw","raw":"{\n \"sku_detail\": [\n {\n \"sku_code\": \"65525900136597\",\n \"quantity\": 1001\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/hubs/locoff/sellers/PJ01/safety_stock"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Thu, 02 Apr 2026 08:21:49 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"x-omniful-request-id","value":"15fea88b-7cd6-4cda-9f3d-6d14e5f4c960"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"content-encoding","value":"br"},{"key":"server","value":"cloudflare"},{"key":"cf-ray","value":"9e5e6c188f857fd4-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"failed_skus\": null\n },\n \"meta\": null\n}"}],"_postman_id":"095e6741-518b-48de-a518-50750ea619e0"}],"id":"9da9e6c0-07e8-4a04-83a0-3cb61ef204fc","_postman_id":"9da9e6c0-07e8-4a04-83a0-3cb61ef204fc","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Shipping Accounts","item":[{"name":"Get All Shipping Accounts","id":"654fde86-4414-42ef-9bbb-769dbf343e38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/shipping_accounts","description":"

This API is used to fetch all shipping accounts for the Tenant.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["sales-channel","public","v1","tenants","shipping_accounts"],"host":["prodapi","omniful","com"],"query":[],"variable":[]}},"response":[{"id":"70e0f537-29e0-4e19-8a99-2a38df9fc2e2","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/shipping_accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Aug 2025 08:01:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"307fd2d6-afb7-49fe-b6d0-a5401ebe245d"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"976a84a5b82c5982-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"f3004c62-12cf-481b-b058-cc9a906c74b9\",\n \"name\": \"STARTLINKS\",\n \"shipping_partner_info\": {\n \"name\": \"Starlinks\",\n \"tag\": \"starlinks\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/starlinks-logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Starlinks\",\n \"tag\": \"starlinks\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/starlinks-logo.png\"\n }\n },\n {\n \"id\": \"995ab613-7f82-46d5-8391-55e81e108a77\",\n \"name\": \"test-2\",\n \"shipping_partner_info\": {\n \"name\": \"Naqel\",\n \"tag\": \"naqel\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/naqel_logo_.jpeg\"\n },\n \"courier_partner_info\": {\n \"name\": \"Naqel\",\n \"tag\": \"naqel\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/naqel_logo_.jpeg\"\n }\n },\n {\n \"id\": \"c79430ae-2f7b-4452-8f05-b9d2ba20ffec\",\n \"name\": \"testing\",\n \"shipping_partner_info\": {\n \"name\": \"360 Express Pro\",\n \"tag\": \"express_pro_360\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/360_express.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"360 Express Pro\",\n \"tag\": \"express_pro_360\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/360_express.png\"\n }\n },\n {\n \"id\": \"7a029898-145b-49d3-9a47-c0f7cdb5475d\",\n \"name\": \"Migration Partner\",\n \"shipping_partner_info\": {\n \"name\": \"Migration Partner\",\n \"tag\": \"migration_partner\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logo/omniful-tms.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n {\n \"id\": \"3ab5e925-9b59-4338-b2f0-d8cd1ea5fbf8\",\n \"name\": \"Wepik\",\n \"shipping_partner_info\": {\n \"name\": \"Wepik\",\n \"tag\": \"wepik\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/wepik_logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Wepik\",\n \"tag\": \"wepik\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/wepik_logo.png\"\n }\n },\n {\n \"id\": \"56cb086a-ea9b-494e-9f10-5cba36547e3a\",\n \"name\": \"test bosta123\",\n \"shipping_partner_info\": {\n \"name\": \"Bosta\",\n \"tag\": \"bosta\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/bosta.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Bosta\",\n \"tag\": \"bosta\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/courier-partner/Bosta.svg\"\n }\n },\n {\n \"id\": \"4f1d2876-ed16-4638-974a-cad340092518\",\n \"name\": \"Test\",\n \"shipping_partner_info\": {\n \"name\": \"Deliverist\",\n \"tag\": \"deliverist\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/Outlook-wje1ztzu+(1).png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Deliverist\",\n \"tag\": \"deliverist\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/Outlook-wje1ztzu+(1).png\"\n }\n },\n {\n \"id\": \"e4dbf8ae-29d2-434b-acf9-e533d41974d1\",\n \"name\": \"test12\",\n \"shipping_partner_info\": {\n \"name\": \"Naqel\",\n \"tag\": \"naqel\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/naqel_logo_.jpeg\"\n },\n \"courier_partner_info\": {\n \"name\": \"Naqel\",\n \"tag\": \"naqel\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/naqel_logo_.jpeg\"\n }\n },\n {\n \"id\": \"cc382c35-97f7-4df7-a05a-19ba23acebea\",\n \"name\": \"UWC TMSDEMO Dashboard\",\n \"shipping_partner_info\": {\n \"name\": \"tmsdemo\",\n \"tag\": \"tmsdemo\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logo/omniful-tms.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n {\n \"id\": \"c125f2b9-4353-4ca1-8ad7-1fd911c3829c\",\n \"name\": \"testing\",\n \"shipping_partner_info\": {\n \"name\": \"NBOX\",\n \"tag\": \"nbox\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/nbox_logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"NBOX\",\n \"tag\": \"nbox\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/nbox_logo.png\"\n }\n },\n {\n \"id\": \"8e81f664-ac98-4b32-a641-0605f759e08f\",\n \"name\": \"test\",\n \"shipping_partner_info\": {\n \"name\": \"Naqel\",\n \"tag\": \"naqel\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/naqel_logo_.jpeg\"\n },\n \"courier_partner_info\": {\n \"name\": \"Naqel\",\n \"tag\": \"naqel\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/naqel_logo_.jpeg\"\n }\n },\n {\n \"id\": \"18c26e98-6018-4302-b0d6-6f3946449e22\",\n \"name\": \"test account\",\n \"shipping_partner_info\": {\n \"name\": \"Careem\",\n \"tag\": \"careem_courier\",\n \"logo\": \"https://omniful-production-uploads.s3.amazonaws.com/tenants/logos/73ca30d8-e549-4af5-97d8-16f40ff0992b.1717510957\"\n },\n \"courier_partner_info\": {\n \"name\": \"Careem\",\n \"tag\": \"careem_courier\",\n \"logo\": \"https://omniful-production-uploads.s3.amazonaws.com/tenants/logos/73ca30d8-e549-4af5-97d8-16f40ff0992b.1717510957\\n\"\n }\n },\n {\n \"id\": \"3b43836b-011a-4e5d-973c-2fafcdc04c9b\",\n \"name\": \"Test\",\n \"shipping_partner_info\": {\n \"name\": \"HG Express\",\n \"tag\": \"hg_express\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/hg_express.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"HG Express\",\n \"tag\": \"hg_express\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/hg_express.png\"\n }\n },\n {\n \"id\": \"15bee006-12a4-4a21-b2ff-0003c543d8b1\",\n \"name\": \"Aman Seller\",\n \"shipping_partner_info\": {\n \"name\": \"Migration Partner\",\n \"tag\": \"migration_partner\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logo/omniful-tms.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n {\n \"id\": \"dc00b58e-ce83-4b19-b998-c52a30641a8d\",\n \"name\": \"Sent Logistics\",\n \"shipping_partner_info\": {\n \"name\": \"Tms Demo\",\n \"tag\": \"tms-demo\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logo/omniful-tms.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Tms Demo\",\n \"tag\": \"tms-demo\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logo/omniful-tms.png\"\n }\n },\n {\n \"id\": \"ff441cef-3102-4c16-97c9-c9300afc4117\",\n \"name\": \"Aramex_account\",\n \"shipping_partner_info\": {\n \"name\": \"Aramex\",\n \"tag\": \"aramex\",\n \"logo\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/shipping/aramex.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Aramex\",\n \"tag\": \"aramex\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/courier-partner/Aramex.png\"\n }\n },\n {\n \"id\": \"aa748904-d514-4d91-9f7b-3a2b3bf1aa11\",\n \"name\": \"Anshul Testing\",\n \"shipping_partner_info\": {\n \"name\": \"Omniful Delivery App\",\n \"tag\": \"driver_app\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/shipping/omniful.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n {\n \"id\": \"57f3cab4-210e-47bd-a604-43d18402c7bb\",\n \"name\": \"sahab test\",\n \"shipping_partner_info\": {\n \"name\": \"Sahab\",\n \"tag\": \"sahab\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/sahab_logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Sahab\",\n \"tag\": \"sahab\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/sahab_logo.png\"\n }\n },\n {\n \"id\": \"aabc2542-32b1-4552-9421-e488e8edf44f\",\n \"name\": \"DY\",\n \"shipping_partner_info\": {\n \"name\": \"JNT\",\n \"tag\": \"jandt\",\n \"logo\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/shipping/J%26T.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"JNT\",\n \"tag\": \"jandt\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/shipping/J%26T.png\"\n }\n },\n {\n \"id\": \"9b4bff54-8c9b-406c-b6cd-8c5a61506fd4\",\n \"name\": \"Testing\",\n \"shipping_partner_info\": {\n \"name\": \"Prolo\",\n \"tag\": \"prolo\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/prolo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Prolo\",\n \"tag\": \"prolo\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/prolo.png\"\n }\n },\n {\n \"id\": \"1b41065c-f61f-4caf-90d7-0b6dcaf6a3a0\",\n \"name\": \"nawel\",\n \"shipping_partner_info\": {\n \"name\": \"Nawel\",\n \"tag\": \"nawel\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/nawel.jpeg\"\n },\n \"courier_partner_info\": {\n \"name\": \"Nawel\",\n \"tag\": \"nawel\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/nawel.jpeg\"\n }\n },\n {\n \"id\": \"a34eb503-1eea-4a14-90a2-3933154b8a5c\",\n \"name\": \"Arzaq Testing\",\n \"shipping_partner_info\": {\n \"name\": \"Arzaq Plus\",\n \"tag\": \"f2l\",\n \"logo\": \"https://omniful-production-uploads.s3.amazonaws.com/tenants/logos/1b8b13db-907c-47ee-91ee-d0a2d6497f63.1717744124\"\n },\n \"courier_partner_info\": {\n \"name\": \"Arzaq Plus\",\n \"tag\": \"f2l\",\n \"logo\": \"https://omniful-production-uploads.s3.amazonaws.com/tenants/logos/1b8b13db-907c-47ee-91ee-d0a2d6497f63.1717744124\"\n }\n },\n {\n \"id\": \"e14dcfed-76a1-4674-85d0-1f8cc6944ebb\",\n \"name\": \"Omniful - Thabit (live)\",\n \"shipping_partner_info\": {\n \"name\": \"Thabit Logistics\",\n \"tag\": \"thabit\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/thabit.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Thabit\",\n \"tag\": \"thabit\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/courier-partner/CFjfKOBbrP.png\"\n }\n },\n {\n \"id\": \"4e7d6048-0011-46af-83fb-5e14905c4d14\",\n \"name\": \"Test\",\n \"shipping_partner_info\": {\n \"name\": \"Saudi Hajer Logistics\",\n \"tag\": \"alhajer\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/saudi_hajer.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Saudi Hajer Logistics\",\n \"tag\": \"alhajer\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/saudi_hajer.png\"\n }\n },\n {\n \"id\": \"5af6bba7-6cdc-4d0b-9898-abbadfe94ac8\",\n \"name\": \"Test\",\n \"shipping_partner_info\": {\n \"name\": \"JNT\",\n \"tag\": \"jandt\",\n \"logo\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/shipping/J%26T.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"JNT\",\n \"tag\": \"jandt\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/shipping/J%26T.png\"\n }\n },\n {\n \"id\": \"3adac00f-b7cb-4c61-a7ab-03b7fdfcd923\",\n \"name\": \"AlFaleh House Sports Company\",\n \"shipping_partner_info\": {\n \"name\": \"Aramex\",\n \"tag\": \"aramex\",\n \"logo\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/shipping/aramex.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Aramex\",\n \"tag\": \"aramex\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/courier-partner/Aramex.png\"\n }\n },\n {\n \"id\": \"36f3c47f-bd8b-4835-aeed-d5c9f77889eb\",\n \"name\": \"Test\",\n \"shipping_partner_info\": {\n \"name\": \"Naqel\",\n \"tag\": \"naqel\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/naqel_logo_.jpeg\"\n },\n \"courier_partner_info\": {\n \"name\": \"Naqel\",\n \"tag\": \"naqel\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/naqel_logo_.jpeg\"\n }\n },\n {\n \"id\": \"5e167252-b244-4134-97bf-220284f5c8a1\",\n \"name\": \"pieship\",\n \"shipping_partner_info\": {\n \"name\": \"Pieship\",\n \"tag\": \"pieship\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/pieship_logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Pieship\",\n \"tag\": \"pieship\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/pieship_logo.png\"\n }\n },\n {\n \"id\": \"027f4ab8-a476-4d90-892d-16a9eb041acf\",\n \"name\": \"AYmakan - test\",\n \"shipping_partner_info\": {\n \"name\": \"Aymakan\",\n \"tag\": \"aymakan\",\n \"logo\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/shipping/aymakan.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Aymakan\",\n \"tag\": \"aymakan\",\n \"logo\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/shipping/aymakan.png\"\n }\n },\n {\n \"id\": \"24fa2637-12e8-46c3-89dc-92c6a10e3632\",\n \"name\": \"star\",\n \"shipping_partner_info\": {\n \"name\": \"Starlinks\",\n \"tag\": \"starlinks\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/starlinks-logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Starlinks\",\n \"tag\": \"starlinks\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/starlinks-logo.png\"\n }\n },\n {\n \"id\": \"c69abc8a-bb2c-4936-98ff-1892d4d7befd\",\n \"name\": \"Test Demo - PTL\",\n \"shipping_partner_info\": {\n \"name\": \"PTL\",\n \"tag\": \"ptl\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/ptl.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"PTL\",\n \"tag\": \"ptl\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/ptl.png\"\n }\n },\n {\n \"id\": \"b478b8ed-18d3-4b1f-9562-7d887a190c8b\",\n \"name\": \"shipday-test1\",\n \"shipping_partner_info\": {\n \"name\": \"Shipday\",\n \"tag\": \"shipday\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/shipday_.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Shipday\",\n \"tag\": \"shipday\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/shipday_.png\"\n }\n },\n {\n \"id\": \"7e77ea7a-dfd8-428c-9487-d065e2645890\",\n \"name\": \"roboost-Test\",\n \"shipping_partner_info\": {\n \"name\": \"Roboost\",\n \"tag\": \"roboost\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/Roboost_Logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Roboost\",\n \"tag\": \"roboost\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/Roboost_Logo.png\"\n }\n },\n {\n \"id\": \"316d5b6e-4122-4d3d-9ad8-948af77c1f83\",\n \"name\": \"Sent express\",\n \"shipping_partner_info\": {\n \"name\": \"Sent Express\",\n \"tag\": \"sent_express\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/sent.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Sent Express\",\n \"tag\": \"sent_express\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/sent.png\"\n }\n },\n {\n \"id\": \"67bfac82-4e3f-477b-b986-0325b79477bd\",\n \"name\": \"test\",\n \"shipping_partner_info\": {\n \"name\": \"Nashmi (Shipox)\",\n \"tag\": \"nashmi_shipox\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/nashmi.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Nashmi (Shipox)\",\n \"tag\": \"nashmi_shipox\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/nashmi.png\"\n }\n },\n {\n \"id\": \"f17b4d27-b053-4387-b4b7-aa8e7dd32b1b\",\n \"name\": \"test\",\n \"shipping_partner_info\": {\n \"name\": \"Two Holding\",\n \"tag\": \"two_holding\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logotwoholding.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Two Holding\",\n \"tag\": \"two_holding\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logotwoholding.png\"\n }\n },\n {\n \"id\": \"0c5f2184-0627-47de-ad75-a3cb57da50f5\",\n \"name\": \"TA\",\n \"shipping_partner_info\": {\n \"name\": \"On Fleet\",\n \"tag\": \"on_fleet\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/on_fleet_logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"On Fleet\",\n \"tag\": \"on_fleet\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/on_fleet_logo.png\"\n }\n },\n {\n \"id\": \"e84c4df8-04d4-4bb3-96ea-3ab7963d6a65\",\n \"name\": \"test\",\n \"shipping_partner_info\": {\n \"name\": \"Pieship\",\n \"tag\": \"pieship\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/pieship_logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Pieship\",\n \"tag\": \"pieship\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/pieship_logo.png\"\n }\n },\n {\n \"id\": \"f58261a4-84a6-4610-8c7d-2d539cc04451\",\n \"name\": \"test\",\n \"shipping_partner_info\": {\n \"name\": \"Fasthub\",\n \"tag\": \"fasthub\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/fasthub.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Fasthub\",\n \"tag\": \"fasthub\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/fasthub.png\"\n }\n },\n {\n \"id\": \"74fa937f-78ab-4bf2-a4de-4cb6e3ee7278\",\n \"name\": \"beone\",\n \"shipping_partner_info\": {\n \"name\": \"Beone Express\",\n \"tag\": \"beone_express\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/beone_express.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Beone Express\",\n \"tag\": \"beone_express\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/beone_express.png\"\n }\n },\n {\n \"id\": \"11de3c1c-f922-41ef-bc29-4748f0777f8f\",\n \"name\": \"J&T - Test 2\",\n \"shipping_partner_info\": {\n \"name\": \"JNT\",\n \"tag\": \"jandt\",\n \"logo\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/shipping/J%26T.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"JNT\",\n \"tag\": \"jandt\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/shipping/J%26T.png\"\n }\n },\n {\n \"id\": \"1aebefbc-b4f1-4518-b182-23f8c24450ba\",\n \"name\": \"Test\",\n \"shipping_partner_info\": {\n \"name\": \"Omni Llama\",\n \"tag\": \"omni_llama\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/b2bomnic_logo.jpeg\"\n },\n \"courier_partner_info\": {\n \"name\": \"Omni Llama\",\n \"tag\": \"omni_llama\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/b2bomnic_logo.jpeg\"\n }\n },\n {\n \"id\": \"ab3769d4-3692-432a-8668-243c606ef6d8\",\n \"name\": \"Test\",\n \"shipping_partner_info\": {\n \"name\": \"Thabit Logistics\",\n \"tag\": \"thabit\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/thabit.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Thabit\",\n \"tag\": \"thabit\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/courier-partner/CFjfKOBbrP.png\"\n }\n },\n {\n \"id\": \"8afc4447-e0f9-427e-adca-71c619248154\",\n \"name\": \"43267\",\n \"shipping_partner_info\": {\n \"name\": \"COLDT\",\n \"tag\": \"coldt\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/coldt.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"COLDT\",\n \"tag\": \"coldt\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/coldt.png\"\n }\n },\n {\n \"id\": \"beff5a2e-0aa4-414a-abdc-0d5158971800\",\n \"name\": \"FleetRunnr -Testing\",\n \"shipping_partner_info\": {\n \"name\": \"Fleet Runnr\",\n \"tag\": \"fleet_runnr\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/image.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Fleet Runnr\",\n \"tag\": \"fleet_runnr\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/image.png\"\n }\n },\n {\n \"id\": \"13e86290-b271-439f-83bf-547e4c9a8905\",\n \"name\": \"test\",\n \"shipping_partner_info\": {\n \"name\": \"Placersa\",\n \"tag\": \"placersa\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/placer.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Placersa\",\n \"tag\": \"placersa\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/placer.png\"\n }\n },\n {\n \"id\": \"3a0d7ab6-9fde-4ff7-9caa-60229001efe4\",\n \"name\": \"tam2go - test\",\n \"shipping_partner_info\": {\n \"name\": \"Tam2go\",\n \"tag\": \"tam2go\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/tam2go.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Tam2go\",\n \"tag\": \"tam2go\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/tam2go.png\"\n }\n },\n {\n \"id\": \"18944f50-e1ab-4224-a187-7f568b7db765\",\n \"name\": \"Omniful( Live Account)\",\n \"shipping_partner_info\": {\n \"name\": \"COLDT\",\n \"tag\": \"coldt\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/coldt.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"COLDT\",\n \"tag\": \"coldt\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/coldt.png\"\n }\n },\n {\n \"id\": \"b9167a5e-1ddb-42d7-be9f-c9a88ba06675\",\n \"name\": \"test\",\n \"shipping_partner_info\": {\n \"name\": \"UPS Arabic\",\n \"tag\": \"ups_arabic\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/ups.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"UPS Arabic\",\n \"tag\": \"ups_arabic\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/ups.png\\n\"\n }\n },\n {\n \"id\": \"9cc06da9-9c83-48c5-ad46-0cfd965cd39d\",\n \"name\": \"Axis Logistics (Test)\",\n \"shipping_partner_info\": {\n \"name\": \"Nashmi\",\n \"tag\": \"nashmi\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/nashmi.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Nashmi\",\n \"tag\": \"nashmi\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/nashmi.png\"\n }\n },\n {\n \"id\": \"3b2423d9-5d5e-4948-9021-87ef9e545ef9\",\n \"name\": \"Tushar - test\",\n \"shipping_partner_info\": {\n \"name\": \"Shipday\",\n \"tag\": \"shipday\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/shipday_.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Shipday\",\n \"tag\": \"shipday\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/shipday_.png\"\n }\n },\n {\n \"id\": \"e8daa0ca-9ed3-42c5-92d0-ca85668aca06\",\n \"name\": \"Fastco\",\n \"shipping_partner_info\": {\n \"name\": \"Fastcoo\",\n \"tag\": \"fastcoo\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/fastcoo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Fastcoo\",\n \"tag\": \"fastcoo\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/fastcoo.png\"\n }\n },\n {\n \"id\": \"d60cc76a-1c0c-4afa-bfda-db8aa0eb9eea\",\n \"name\": \"kwickBox - Test\",\n \"shipping_partner_info\": {\n \"name\": \"Kwick Box\",\n \"tag\": \"kwick_box\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/kwick_box.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Kwick Box\",\n \"tag\": \"kwick_box\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/kwick_box.png\"\n }\n },\n {\n \"id\": \"b7bf7568-02e7-44fe-a502-85687771d3ee\",\n \"name\": \"GFS\",\n \"shipping_partner_info\": {\n \"name\": \"GFS\",\n \"tag\": \"gfs\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/gfs.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"GFS\",\n \"tag\": \"gfs\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/gfs.png\"\n }\n },\n {\n \"id\": \"80d5df4e-6d71-4767-92af-2cf8ce8586b5\",\n \"name\": \"Testing\",\n \"shipping_partner_info\": {\n \"name\": \"Massuul\",\n \"tag\": \"massuul\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/responsible.jpeg\"\n },\n \"courier_partner_info\": {\n \"name\": \"Massuul\",\n \"tag\": \"massuul\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/responsible.jpeg\"\n }\n },\n {\n \"id\": \"7fe28e60-3f7e-4e0d-80c7-e8b83cf69cf8\",\n \"name\": \"test\",\n \"shipping_partner_info\": {\n \"name\": \"Flow Progressive Logistics\",\n \"tag\": \"flow_progressive_logistics\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/flow_logistics_logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Flow Progressive Logistics\",\n \"tag\": \"flow_progressive_logistics\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/flow_logistics_logo.png\"\n }\n },\n {\n \"id\": \"e014ca0a-cc9d-4ea2-bf06-e6bd132f65fb\",\n \"name\": \"Nana Roboost\",\n \"shipping_partner_info\": {\n \"name\": \"Roboost\",\n \"tag\": \"roboost\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/Roboost_Logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Roboost\",\n \"tag\": \"roboost\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/Roboost_Logo.png\"\n }\n },\n {\n \"id\": \"0ac9810b-1fcb-44d3-9d41-d9ebe03228cc\",\n \"name\": \"Omniful TMS\",\n \"shipping_partner_info\": {\n \"name\": \"Try TMS\",\n \"tag\": \"try-tms\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logo/omniful-tms.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Try Tms\",\n \"tag\": \"try-tms\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logo/omniful-tms.png\"\n }\n },\n {\n \"id\": \"666c3cda-43f5-4107-b9a3-33b7b8d338d1\",\n \"name\": \"test\",\n \"shipping_partner_info\": {\n \"name\": \"Kasb\",\n \"tag\": \"kasb\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/kasb_logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Kasb\",\n \"tag\": \"kasb\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/kasb_logo.png\"\n }\n },\n {\n \"id\": \"054ae3b0-05e4-46db-b241-2decd39aa5d9\",\n \"name\": \"Testing - HTC\",\n \"shipping_partner_info\": {\n \"name\": \"HTC\",\n \"tag\": \"htc\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/htc.jpeg\"\n },\n \"courier_partner_info\": {\n \"name\": \"HTC\",\n \"tag\": \"htc\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/htc.jpeg\"\n }\n },\n {\n \"id\": \"1ba6cba9-bc48-4d67-acd1-b3298504fb76\",\n \"name\": \"Talabati\",\n \"shipping_partner_info\": {\n \"name\": \"Last Mile\",\n \"tag\": \"lastmile\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logo/omniful-tms.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Lastmile\",\n \"tag\": \"lastmile\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/logo/omniful-tms.png\"\n }\n },\n {\n \"id\": \"92f638f4-c21a-4971-ba01-70feeeee275d\",\n \"name\": \"testasdfa\",\n \"shipping_partner_info\": {\n \"name\": \"Sent Express V2\",\n \"tag\": \"sent_express_v2\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/sent.png\\n\"\n },\n \"courier_partner_info\": {\n \"name\": \"Sent Express V2\",\n \"tag\": \"sent_express_v2\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/sent.png\\n\"\n }\n },\n {\n \"id\": \"10b1598a-65c3-48f5-b9a7-4aac35c62fa0\",\n \"name\": \"test\",\n \"shipping_partner_info\": {\n \"name\": \"Salasa\",\n \"tag\": \"salasa\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/salasa_logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Salasa\",\n \"tag\": \"salasa\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/salasa_logo.png\"\n }\n },\n {\n \"id\": \"6d34f040-f425-46f6-b4d4-c0f61575506e\",\n \"name\": \"Test-Jandt\",\n \"shipping_partner_info\": {\n \"name\": \"JNT\",\n \"tag\": \"jandt\",\n \"logo\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/shipping/J%26T.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"JNT\",\n \"tag\": \"jandt\",\n \"logo\": \"https://omniful-staging-uploads.s3.eu-central-1.amazonaws.com/shipping/J%26T.png\"\n }\n },\n {\n \"id\": \"accd82e5-6ad1-41f8-b111-0b1dc8815fc4\",\n \"name\": \"testing salasa\",\n \"shipping_partner_info\": {\n \"name\": \"Salasa\",\n \"tag\": \"salasa\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/salasa_logo.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Salasa\",\n \"tag\": \"salasa\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/salasa_logo.png\"\n }\n },\n {\n \"id\": \"93166faf-64a9-49d5-8d38-9dd9284eef42\",\n \"name\": \"AYmakan - test\",\n \"shipping_partner_info\": {\n \"name\": \"Careem Express\",\n \"tag\": \"careem_now\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/careem.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Careem Express\",\n \"tag\": \"careem_now\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/careem.png\"\n }\n },\n {\n \"id\": \"7345bc97-c101-4b29-859a-3afb0c78acc8\",\n \"name\": \"Aniket test\",\n \"shipping_partner_info\": {\n \"name\": \"Shipday\",\n \"tag\": \"shipday\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/shipday_.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Shipday\",\n \"tag\": \"shipday\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/shipday_.png\"\n }\n },\n {\n \"id\": \"7125f3e4-7146-4f33-805c-896e81a8e2cf\",\n \"name\": \"alshrouq\",\n \"shipping_partner_info\": {\n \"name\": \"Alshrouq Express\",\n \"tag\": \"alshrouq_express\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/image+(1).png\"\n },\n \"courier_partner_info\": {\n \"name\": \"Alshrouq Express\",\n \"tag\": \"alshrouq_express\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/image+(1).png\"\n }\n },\n {\n \"id\": \"dd58d270-da34-4cab-8973-e60640908d42\",\n \"name\": \"Test\",\n \"shipping_partner_info\": {\n \"name\": \"M5azn\",\n \"tag\": \"m5azn\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/m5aznwms.png\"\n },\n \"courier_partner_info\": {\n \"name\": \"m5azn\",\n \"tag\": \"m5azn\",\n \"logo\": \"https://s3.eu-central-1.amazonaws.com/s3images.omniful.com/shipping-service/shipping-partner/m5aznwms.png\"\n }\n }\n ],\n \"meta\": null\n}"}],"_postman_id":"654fde86-4414-42ef-9bbb-769dbf343e38"}],"id":"b7e681cc-7117-4abd-8707-d6f8d6ccb460","_postman_id":"b7e681cc-7117-4abd-8707-d6f8d6ccb460","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Background Jobs","item":[{"name":"Get Job by ID","id":"ee45e3cd-642d-4b5a-8d69-4e3f8700ed1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/jobs/:job_id","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["sales-channel","public","v1","tenants","jobs",":job_id"],"host":["prodapi","omniful","com"],"query":[],"variable":[{"type":"any","value":"78879aa5-8752-4688-b6a0-169387d349f7","key":"job_id"}]}},"response":[{"id":"f4402060-f970-491f-82a1-8aaf3743e4c7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTgzNjQ4MjgsImp0aSI6ImI2NDUyYTBlLWZkYWYtNDBlYi05NjRkLTI1OGFmN2E1YjIwNiIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRDb2RlIjoiMzcxODEyNDk2OCIsIlRlbmFudElEIjoiIiwiVXNlcklEIjoiNTYyOCIsIlVzZXJOYW1lIjoiSGluaXNoIEJhbnNhbCIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjEyMH19LCJ0b2tlbl90eXBlIjoiQmVhcmVyIn0.SUhsS9bmE9bfPb4mX9sOl6W9tyrK_fiSHO6vmmVWwoLzzRsn3Z9jqhgEi1V-1Z9xXsyIPzUtuPJ3oDQTvLNDwzx4eS5Sf0ZhpcI4dE-iA1EkzIzssr2dHMiHZxGjIoBlq8Wwqu4Bhe0NnEOgUHddReTKq40OBBp-44CvgHVZvjm-VPwqN9lvPOljag5fsMQzgeN3aH66v3X0ajdBtAoTXyqZDgd2kRCfHneoGPMrKSOvjByGgsx9GU3qmKu126ZnAufrjvVWk9W26SMmJrg73to8kRfWhJ0jS5F7Kr45mKZFn_6tEDLDxpCq07TaAm-DD-M0GhZdPTW7H9wWx20tt9-55r_KbhWIqPtjH7vRQ4Rdyimx8BYYz7HVlQOuji6VvpQ1ge23KrKzyhBptqO-_6Arpbfj42ewOViFOEL2w6h6t9DRrqNoxG13Jm3ZQYQJf2_Vpt8l2iuEPxSaqI_5_upsLXUt8RhS99vaZ_XXOgMayh7NvVVpbmmUTdfpQ-epZEfInp_2emJu3NFKEjugpANzcdp8fvAKqjTDimhIL59R4HwP2dmTyGWmSx3_VQqJiRQtvA-2yH91pbIwE2hUVQJv5-o2bO4GHaiBNUkjxSQE3e6qnN2H7kxa4j9-ik4YvMPaUtX1XAwXxtkUOR_jKuk4qEd9gZB8gKaV7v9ZWfE"}],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/jobs/:job_id","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","tenants","jobs",":job_id"],"variable":[{"key":"job_id","value":"78879aa5-8752-4688-b6a0-169387d349f7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Sep 2025 12:33:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"79891171-4cac-4535-a558-2ec710579e22"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"97a5c1be4d2b8016-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"job_id\": \"78879aa5-8752-4688-b6a0-169387d349f7\",\n \"job_status\": \"completed\",\n \"job_type\": \"order.bulk-create\",\n \"job_items\": [\n {\n \"id\": \"order-12782352367678\",\n \"item_type\": \"order\",\n \"status\": \"completed\",\n \"success\": true\n },\n {\n \"id\": \"order-127823523676\",\n \"item_type\": \"order\",\n \"status\": \"failed\",\n \"success\": false,\n \"error_message\": \"Order Already Exist\"\n }\n ],\n \"job_total_count\": 2,\n \"job_completed_count\": 2,\n \"job_failed_count\": 1,\n \"started_at\": \"2025-09-05T12:06:13.587732364Z\",\n \"last_updated_at\": \"2025-09-05T12:06:13.725511026Z\",\n \"completed_at\": \"2025-09-05T12:06:13.725511156Z\"\n },\n \"meta\": null\n}"}],"_postman_id":"ee45e3cd-642d-4b5a-8d69-4e3f8700ed1a"}],"id":"b4c949f0-8d05-46ab-b038-3ec9dff6f6b4","_postman_id":"b4c949f0-8d05-46ab-b038-3ec9dff6f6b4","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Seller Integrations","item":[{"name":"Seller Integrations","id":"766708d7-6ae8-4533-a240-b836c3ba37b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/EX-637/channels/integrations?page=1&per_page=10","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers","EX-637","channels","integrations"],"host":["{{base_url}}"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"}],"variable":[]}},"response":[{"id":"4dfd9257-7bde-41ff-bed7-07a5141586b2","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/EX-637/channels/integrations?page=1&per_page=10","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers","EX-637","channels","integrations"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Sep 2025 12:57:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"x-omniful-request-id","value":"3b75bf45-ab53-429b-8bc2-2a289c1e8784"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"97a5e4e4b8775984-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"integration_token\": \"a1f2d898-60f5-4d82-9e52-b1902c269e4f\",\n \"name\": \"api\",\n \"sales_channel_name\": \"Custom\",\n \"sales_channel_tag\": \"custom\",\n \"is_active\": true\n },\n {\n \"integration_token\": \"9928b59b-2e3b-47a9-813c-f89372ab551a\",\n \"name\": \"test-tg11\",\n \"sales_channel_name\": \"Shopify\",\n \"sales_channel_tag\": \"shopify\",\n \"is_active\": true\n },\n {\n \"integration_token\": \"151e21f1-2e36-4c1e-8287-71a1f23bea5f\",\n \"name\": \"happy\",\n \"sales_channel_name\": \"Custom\",\n \"sales_channel_tag\": \"custom\",\n \"is_active\": true\n },\n {\n \"integration_token\": \"b5d45113-3df4-40d3-befe-e21c97c6667c\",\n \"name\": \"srv-testing\",\n \"sales_channel_name\": \"Shopify\",\n \"sales_channel_tag\": \"shopify\",\n \"is_active\": true\n },\n {\n \"integration_token\": \"12ae0059-a077-4130-8163-85e0ed229292\",\n \"name\": \"Zid App Market store\",\n \"sales_channel_name\": \"Zid\",\n \"sales_channel_tag\": \"zid\",\n \"is_active\": false\n },\n {\n \"integration_token\": \"5b0b15ef-d37c-4401-bd5e-faaa8f7a490a\",\n \"name\": \"HYPERNEST\",\n \"sales_channel_name\": \"Shopify\",\n \"sales_channel_tag\": \"shopify\",\n \"is_active\": false\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 20,\n \"last_page\": 1,\n \"total\": 6\n }\n}"}],"_postman_id":"766708d7-6ae8-4533-a240-b836c3ba37b9"}],"id":"9ef9f6aa-f9e4-43e7-8079-d258d20c14e6","_postman_id":"9ef9f6aa-f9e4-43e7-8079-d258d20c14e6","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Pickup Locations","item":[{"name":"Upsert Pickup Locations","id":"55a6ec6b-b5d3-4e61-af2b-2bf5a1adcc9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Main Warehouse\",\n \"email\": \"warehouse@example.com\",\n \"phone_number\": {\n \"number\": \"1234567890\",\n \"country_calling_code\": \"+91\",\n \"country_code\": \"IN\"\n },\n \"external_hub_identifier\": \"HUB123456\",\n \"address\": {\n \"address_1\": \"123 Street Name\",\n \"address_2\": \"Suite 400\",\n \"postal_code\": \"560001\",\n \"city_name\": \"Riyadh\",\n \"country_name\": \"Saudi Arabia\",\n \"state_name\": \"Riyadh\",\n \"country_code\": \"SA\",\n \"state_code\": \"01\",\n \"latitude\": 24.8506269,\n \"longitude\": 46.8180723,\n \"national_address_code\": \"\"\n },\n \"virtual_hub_type\": \"virtual\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/pickup_locations","description":"

Create Pickup Location API

Description

Creates a new pickup (hub) location for a seller. A pickup location can be physical or virtual and is used for fulfilling orders and assigning shipments.

📋 Field Descriptions

Top-Level Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	✅	Name of the pickup location (e.g., “Main Warehouse”).
`email`	string	✅	Contact email for the pickup location.
`phone_number`	object	✅	Contact phone details (number, code, country).
`external_hub_identifier`	string	✅	External system reference/ID for hub mapping.
`address`	object	✅	Address details of the pickup location.
`virtual_hub_type`	string	❌	If hub is virtual, specify type (e.g., `virtual`).

Phone Number Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`number`	string	✅	Phone number of the pickup location.
`country_calling_code`	string	❌	International calling code (e.g., `+91`).
`country_code`	string	✅	ISO 2-letter country code (e.g., `IN`).

Address Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`address_1`	string	✅	Primary address line (e.g., street, plot).
`address_2`	string	❌	Secondary address line (e.g., suite, floor).
`postal_code`	string	✅	Postal/ZIP code.
`city_name`	string	❌	City where hub is located.
`state_name`	string	❌	State/Province name.
`country_name`	string	✅	Country name.
`country_code`	string	✅	ISO 2-letter country code.
`state_code`	string	❌	State code (if applicable).
`latitude`	number	❌	Latitude coordinates for hub geolocation.
`longitude`	number	❌	Longitude coordinates for hub geolocation.
`national_address_code`	string	❌	National address code for hub.

Description

Retrieves all pickup locations configured for a specific seller under a tenant. Useful for fetching active hubs/warehouses and their details.

Warehouse Name

\n","type":"text/plain"},"key":"name","value":"John Doe"},{"disabled":true,"description":{"content":"

Warehouse Email

\n","type":"text/plain"},"key":"email","value":"johndoe@gmail.com"},{"disabled":true,"description":{"content":"

Unique Identifier for the pickup location

\n","type":"text/plain"},"key":"pickup_location_code","value":"HUB123456"}],"variable":[{"description":{"content":"

Unique Identifier of Seller

\n","type":"text/plain"},"type":"any","value":"TC-076","key":"seller_code"}]}},"response":[{"id":"f4dcb4c6-68a1-4f1b-9a11-1161b35d5ec0","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/pickup_locations","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","pickup_locations"],"query":[{"key":"name","value":"John Doe","description":"Warehouse Name","type":"text","disabled":true},{"key":"email","value":"johndoe@gmail.com","description":"Warehouse Email","type":"text","disabled":true},{"key":"pickup_location_code","value":"HUB123456","description":"Unique Identifier for the pickup location","type":"text","disabled":true}],"variable":[{"key":"seller_code","value":"TC-076","description":"Unique Identifier of Seller"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Sat, 20 Sep 2025 07:23:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"9c91d236-a8a1-4e68-ac2f-018d4477cd65"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"981f93b50c7589a2-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"name\": \"Main Warehouse\",\n \"email\": \"warehouse@example.com\",\n \"phone_number\": \"+91-1234567890\",\n \"address\": {\n \"address_1\": \"123 Street Name\",\n \"address_2\": \"Suite 400\",\n \"postal_code\": \"560001\",\n \"city_name\": \"Riyadh\",\n \"country_name\": \"Saudi Arabia\",\n \"state_name\": \"Riyadh Region\",\n \"country_code\": \"SA\",\n \"state_code\": \"01\",\n \"latitude\": 24.8506269,\n \"longitude\": 46.8180723,\n \"national_address_code\": \"\"\n },\n \"type\": \"virtual\",\n \"pickup_location_code\": \"HUB123456\",\n \"created_at\": \"2025-09-20T07:21:21.965Z\",\n \"updated_at\": \"2025-09-20T07:21:21.965Z\"\n },\n {\n \"name\": \"Sender\",\n \"email\": \"sender@example.com\",\n \"phone_number\": \"+91-9876543210\",\n \"address\": {\n \"address_1\": \"123 Warehouse St.\",\n \"address_2\": \"Block A\",\n \"postal_code\": \"400001\",\n \"city_name\": \"Mumbai\",\n \"country_name\": \"India\",\n \"state_name\": \"Maharashtra\",\n \"country_code\": \"IN\",\n \"state_code\": \"MH\",\n \"latitude\": 19.076,\n \"longitude\": 72.8777,\n \"national_address_code\": \"\"\n },\n \"type\": \"virtual\",\n \"pickup_location_code\": \"H200925-37161-NTBLY\",\n \"created_at\": \"2025-09-20T06:58:58.024Z\",\n \"updated_at\": \"2025-09-20T06:58:58.024Z\"\n }\n ],\n \"meta\": null\n}"}],"_postman_id":"b2d3ccab-6c92-4091-8f50-40a6b62e99c2"},{"name":"Get Pickup Location By Code","id":"2efb318f-5bcd-4459-86ef-c23b29d9bc8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/pickup_locations/:pickup_location_code","description":"

Description

Fetches details of a specific pickup location (hub) for a given seller, using the hub’s external_hub_identifier.

🔗 Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`seller_code`	string	✅	Unique seller code (e.g., `0099`).
`external_hub_identifier`	string	✅	External identifier of the hub/pickup location (e.g., `HUB123456`).

Unique Identifier of the seller

\n","type":"text/plain"},"type":"any","value":"0099","key":"seller_code"},{"description":{"content":"

Unique Identifier of the picking location

\n","type":"text/plain"},"type":"any","value":"HUB123456","key":"pickup_location_code"}]}},"response":[{"id":"89cd7c9d-01ae-4213-96a0-13d2bf329e58","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/0019/pickup_locations/HUB123456"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 25 Sep 2025 13:23:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"8133bb6d-d849-4918-b0cf-1fa019d24bee"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"984ad5ffcd659db7-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"name\": \"Main Warehouse\",\n \"email\": \"warehouse@example.com\",\n \"phone_number\": \"+91-1234567890\",\n \"address\": {\n \"address_1\": \"123 Street Name\",\n \"address_2\": \"Suite 400\",\n \"postal_code\": \"560001\",\n \"city_name\": \"Riyadh\",\n \"country_name\": \"Saudi Arabia\",\n \"state_name\": \"Riyadh Region\",\n \"country_code\": \"SA\",\n \"state_code\": \"01\",\n \"latitude\": 24.8506269,\n \"longitude\": 46.8180723,\n \"national_address_code\": \"\"\n },\n \"type\": \"virtual\",\n \"pickup_location_code\": \"HUB123456\",\n \"created_at\": \"2025-09-25T13:10:08.465Z\",\n \"updated_at\": \"2025-09-25T13:10:08.465Z\"\n },\n \"meta\": null\n}"}],"_postman_id":"2efb318f-5bcd-4459-86ef-c23b29d9bc8c"}],"id":"6b5901eb-9e51-4577-872a-bb33909c7a54","_postman_id":"6b5901eb-9e51-4577-872a-bb33909c7a54","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Shipment Orders","item":[{"name":"Return Shipment Orders","item":[{"name":"Create Return Order","id":"65fae50b-a15e-4318-9462-cb14327315d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"return_order_id\": \"RO-106213\",\n \"return_items\": [\n {\n \"item_id\": \"JOUFURH05082036\",\n \"return_item_id\": \"Rqueen_bed\",\n \"sku_code\": \"JOUFURH05082036\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged item\",\n \"quantity\": 1,\n \"comment\": \"Product arrived with broken packaging\"\n }\n ],\n \"unit_price\": 50.0,\n \"discount\": 0,\n \"total\": 100.0\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"cod_fee\",\n \"cost\": 50.0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 5.0,\n \"is_applied\": true\n },\n {\n \"type\": \"platform_fee\",\n \"cost\": 30.0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0.0,\n \"is_applied\": false\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/:order_id/return_orders","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders",":order_id","return_orders"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"

Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform.

\n","type":"text/plain"},"type":"any","value":"3705","key":"seller_code"},{"description":{"content":"

Unique identifier of shipment order

\n","type":"text/plain"},"type":"any","value":"68f8aa5753ed4fff60b905da","key":"order_id"}]}},"response":[{"id":"d28c6e1f-3fd2-49e0-b3fd-cde36ec31acd","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"return_order_id\": \"RO-106213\",\n \"return_items\": [\n {\n \"item_id\": \"JOUFURH05082036\", //Sales Channel Item Id\n \"return_item_id\": \"Rqueen_bed\",\n \"sku_code\": \"JOUFURH05082036\",\n \"return_quantity\": 1,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged item\",\n \"quantity\": 1,\n \"comment\": \"Product arrived with broken packaging\"\n }\n ],\n \"unit_price\": 50.0,\n \"discount\": 0,\n \"total\": 100.0\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"platform_fee\",\n \"cost\": 30.0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0.0,\n \"is_applied\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/:order_id/return_orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders",":order_id","return_orders"],"variable":[{"key":"seller_code","value":"3705","description":"Unique identifier assigned to a seller in the Omniful system. This code helps differentiate between multiple sellers operating on the platform."},{"key":"order_id","value":"68f8aa5753ed4fff60b905da","description":"Unique identifier of shipment order"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 03 Nov 2025 13:10:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"d315a095-d0ca-432b-b68e-056cdd17e161"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"998c1ceb1d507f71-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Customer return order created successfully.\",\n \"meta\": null\n}"}],"_postman_id":"65fae50b-a15e-4318-9462-cb14327315d9"},{"name":"Get Return Orders","id":"e08e35f1-a38b-4bd7-9a39-f01b48c86d3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/return_orders","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders","return_orders"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

Page number of response

\n","type":"text/plain"},"key":"page","value":null},{"disabled":true,"description":{"content":"

Number of shipment orders per page

\n","type":"text/plain"},"key":"per_page","value":null},{"disabled":true,"description":{"content":"

Unique identifier of shipment order

\n","type":"text/plain"},"key":"return_order_id","value":null},{"disabled":true,"description":{"content":"

Unique identifiers of shipment orders

\n","type":"text/plain"},"key":"return_order_ids","value":null}],"variable":[{"type":"any","value":"3705","key":"seller_code"}]}},"response":[{"id":"83f63c21-80fe-49dd-b6fb-242a4454a6ec","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/return_orders","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders","return_orders"],"variable":[{"key":"seller_code","value":"3705"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 03 Nov 2025 13:15:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"612cfb69-1f16-4bf3-99e7-78ae870bd261"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"998c246fab43596a-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"6908a9ce71187141897e4a8f\",\n \"return_order_id\": \"RO-106213\",\n \"order_id\": \"68f8aa5753ed4fff60b905da\",\n \"seller_name\": \"Joint furniture\",\n \"type\": \"Customer Return\",\n \"source\": \"Sales Channel\",\n \"customer\": {\n \"first_name\": \"فاطمه\",\n \"last_name\": \"الزهراء عبدالروؤف توفيق\",\n \"mobile\": \"+20-1005160640\",\n \"mobile_code\": \"+20\",\n \"email\": \"customer@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"order_reference_id\": \"324234\",\n \"order_items\": [\n {\n \"seller_sku_code\": \"JOUFURH05082036\",\n \"item_barcodes\": [],\n \"return_reason\": \"\",\n \"return_reasons\": [],\n \"unit_price\": 11531,\n \"selling_price\": 11531,\n \"total\": 11531,\n \"refunded_quantity\": 0,\n \"returned_quantity\": 0,\n \"delivered_quantity\": 1,\n \"return_quantity\": 1,\n \"return_weight\": {},\n \"display_return_weight\": \"\",\n \"is_weighted\": false,\n \"discount\": 0,\n \"tax\": 0,\n \"tax_percent\": 0\n }\n ],\n \"total_sku_count\": 1,\n \"delivered_quantity\": 1,\n \"total\": 11531,\n \"pickup_address\": {\n \"address1\": \"كمبوند الياسمين فيلا 1132 الشيخ زايد الجيزة\",\n \"address2\": \"Giza\",\n \"city\": \"الشيخ زايد\",\n \"country\": \"Egypt\",\n \"first_name\": \"فاطمه\",\n \"last_name\": \"الزهراء عبدالروؤف توفيق\",\n \"phone\": \"1005160640\",\n \"email\": \"\",\n \"state\": \"Giza\",\n \"area\": \"\",\n \"zip\": \"110001\",\n \"state_code\": \"\",\n \"country_code\": \"EG\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"national_address_code\" : \"nac_1234\"\n },\n \"status\": \"Initiated\",\n \"refund_status\": \"Pending\",\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"order_created_at\": \"2025-09-11T15:55:43Z\",\n \"order_delivered_at\": \"2025-11-03T13:07:13.915Z\",\n \"payment_method\": \"postpaid\",\n \"invoice\": {\n \"currency\": \"EGP\",\n \"subtotal\": 11531,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"total\": 11451,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"cod_fee\",\n \"cost\": 50,\n \"cost_without_tax\": 47.62,\n \"tax_amount\": 2.38,\n \"tax_inclusive\": true,\n \"tax_percentage\": 5,\n \"is_applied\": true\n },\n {\n \"type\": \"platform_fee\",\n \"cost\": 30,\n \"cost_without_tax\": 30,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": null\n },\n \"hub_detail\": {\n \"code\": \"\"\n },\n \"total_return_quantity\": 1\n },\n {\n \"id\": \"68ff8ac51a26ca4abb4c336c\",\n \"return_order_id\": \"RO-27102025-NGLOB\",\n \"order_id\": \"68dfe387f0dc94debbccbc99\",\n \"seller_name\": \"Joint furniture\",\n \"type\": \"Customer Return\",\n \"source\": \"Manual\",\n \"customer\": {\n \"first_name\": \"ندى\",\n \"last_name\": \"محمد\",\n \"mobile\": \"+20-1011755247\",\n \"mobile_code\": \"+20\",\n \"email\": \"customer@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"order_reference_id\": \"239634\",\n \"order_items\": [\n {\n \"seller_sku_code\": \"JOUFURH528052408\",\n \"item_barcodes\": [],\n \"return_reason\": \"\",\n \"return_reasons\": [],\n \"unit_price\": 25879,\n \"selling_price\": 25879,\n \"total\": 21997.15,\n \"refunded_quantity\": 0,\n \"returned_quantity\": 0,\n \"delivered_quantity\": 1,\n \"return_quantity\": 1,\n \"return_weight\": {},\n \"display_return_weight\": \"\",\n \"is_weighted\": false,\n \"discount\": 3881.85,\n \"tax\": 0,\n \"tax_percent\": 0\n }\n ],\n \"total_sku_count\": 1,\n \"delivered_quantity\": 1,\n \"total\": 21997.15,\n \"pickup_address\": {\n \"address1\": \"جردنيا سيتي مدينة نصر عمارة 657 شقة 24\",\n \"address2\": \"Cairo\",\n \"city\": \"مدينة نصر\",\n \"country\": \"Egypt\",\n \"first_name\": \"ندى\",\n \"last_name\": \"محمد\",\n \"phone\": \"1011755247\",\n \"email\": \"\",\n \"state\": \"Cairo\",\n \"area\": \"\",\n \"zip\": \"110001\",\n \"state_code\": \"\",\n \"country_code\": \"EG\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"national_address_code\" : \"nac_1234\"\n },\n \"status\": \"Initiated\",\n \"refund_status\": \"Pending\",\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"order_created_at\": \"2025-09-11T15:54:43Z\",\n \"order_delivered_at\": \"2025-10-26T12:57:27.052Z\",\n \"payment_method\": \"postpaid\",\n \"invoice\": {\n \"currency\": \"EGP\",\n \"subtotal\": 25879,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 3881.85,\n \"total\": 21997.15,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"return_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": null\n },\n \"hub_detail\": {\n \"code\": \"H180925-26137526-IETRI\"\n },\n \"total_return_quantity\": 1\n },\n {\n \"id\": \"68e7a34f01cfe384fd787be2\",\n \"return_order_id\": \"RO-09102025-JVMRO\",\n \"order_id\": \"68daec91ecebd48d5dfdbfe1\",\n \"seller_name\": \"Joint furniture\",\n \"type\": \"Customer Return\",\n \"source\": \"Manual\",\n \"customer\": {\n \"first_name\": \"Mahmoud\",\n \"last_name\": \"atef\",\n \"mobile\": \"+20-1014561191\",\n \"mobile_code\": \"+20\",\n \"email\": \"customer@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"order_reference_id\": \"2438674\",\n \"order_items\": [\n {\n \"seller_sku_code\": \"JOUFURH94224\",\n \"item_barcodes\": [],\n \"return_reason\": \"\",\n \"return_reasons\": [\n {\n \"reason\": \"Damaged\",\n \"quantity\": 1\n }\n ],\n \"unit_price\": 21390,\n \"selling_price\": 21390,\n \"total\": 21390,\n \"refunded_quantity\": 0,\n \"returned_quantity\": 0,\n \"delivered_quantity\": 1,\n \"return_quantity\": 1,\n \"return_weight\": {},\n \"display_return_weight\": \"\",\n \"is_weighted\": false,\n \"discount\": 0,\n \"tax\": 0,\n \"tax_percent\": 0\n }\n ],\n \"total_sku_count\": 1,\n \"delivered_quantity\": 1,\n \"total\": 21390,\n \"pickup_address\": {\n \"address1\": \"المستقبل الشيخ زايد بجوار مول الكورت يارد\",\n \"address2\": \"Giza\",\n \"city\": \"الشيخ زايد\",\n \"country\": \"Egypt\",\n \"first_name\": \"Mahmoud\",\n \"last_name\": \"atef\",\n \"phone\": \"1014561191\",\n \"email\": \"\",\n \"state\": \"Giza\",\n \"area\": \"\",\n \"zip\": \"110001\",\n \"state_code\": \"\",\n \"country_code\": \"EG\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"national_address_code\" : \"nac_1234\"\n },\n \"status\": \"Initiated\",\n \"refund_status\": \"Pending\",\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"order_created_at\": \"2025-09-11T16:04:46Z\",\n \"order_delivered_at\": \"2025-10-01T07:56:45.558Z\",\n \"payment_method\": \"prepaid\",\n \"invoice\": {\n \"currency\": \"EGP\",\n \"subtotal\": 21390,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"total\": 21390,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"return_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": null\n },\n \"hub_detail\": {\n \"code\": \"H180925-26137526-IETRI\"\n },\n \"total_return_quantity\": 1\n },\n {\n \"id\": \"68e7a2dccdb6d0d355c7b8ff\",\n \"return_order_id\": \"RO-09102025-BYTCW\",\n \"order_id\": \"68dd19c5f14a4437e7090de1\",\n \"seller_name\": \"Joint furniture\",\n \"type\": \"Customer Return\",\n \"source\": \"Manual\",\n \"customer\": {\n \"first_name\": \"Mohamed\",\n \"last_name\": \"Rayyan\",\n \"mobile\": \"+20-1111999675\",\n \"mobile_code\": \"+20\",\n \"email\": \"customer@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"order_reference_id\": \"2396522\",\n \"order_items\": [\n {\n \"seller_sku_code\": \"JOUFURH528052408\",\n \"item_barcodes\": [],\n \"return_reason\": \"\",\n \"return_reasons\": [],\n \"unit_price\": 25879,\n \"selling_price\": 25879,\n \"total\": 21997.15,\n \"refunded_quantity\": 0,\n \"returned_quantity\": 0,\n \"delivered_quantity\": 1,\n \"return_quantity\": 1,\n \"return_weight\": {},\n \"display_return_weight\": \"\",\n \"is_weighted\": false,\n \"discount\": 3881.85,\n \"tax\": 0,\n \"tax_percent\": 0\n }\n ],\n \"total_sku_count\": 1,\n \"delivered_quantity\": 1,\n \"total\": 21997.15,\n \"pickup_address\": {\n \"address1\": \"212 شارع فيصل - محطة التعاون - نفس عمارة بي تك - الدور السادس - شقة 13\",\n \"address2\": \"Giza\",\n \"city\": \"10th of ramadan\",\n \"country\": \"Egypt\",\n \"first_name\": \"Mohamed\",\n \"last_name\": \"Rayyan\",\n \"phone\": \"+20-1111999675\",\n \"email\": \"\",\n \"state\": \"\",\n \"area\": \"\",\n \"zip\": \"110001\",\n \"state_code\": \"\",\n \"country_code\": \"EG\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"national_address_code\" : \"nac_1234\"\n },\n \"status\": \"Initiated\",\n \"refund_status\": \"Pending\",\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"order_created_at\": \"2025-09-11T15:54:40Z\",\n \"order_delivered_at\": \"2025-10-01T12:33:38.435Z\",\n \"payment_method\": \"postpaid\",\n \"invoice\": {\n \"currency\": \"EGP\",\n \"subtotal\": 25879,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 3881.85,\n \"total\": 21997.15,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"return_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": null\n },\n \"hub_detail\": {\n \"code\": \"H180925-26137526-IETRI\"\n },\n \"total_return_quantity\": 1\n }\n ],\n \"meta\": null\n}"}],"_postman_id":"e08e35f1-a38b-4bd7-9a39-f01b48c86d3e"},{"name":"Get Return Order by Id","id":"66929aef-c257-4716-9efd-a995ce5f62e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/return_orders/:return_order_id","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders","return_orders",":return_order_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"3705","key":"seller_code"},{"type":"any","value":"RO-106213","key":"return_order_id"}]}},"response":[{"id":"02fde45f-49dd-4efb-81d9-e36174d75c87","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NjM4MTg4MjIsImp0aSI6IjE0Mzk3NDgxLTZmYzctNGE2OC05ZGZiLTEzYjI2YTM4OWFkMCIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRDb2RlIjoiMzY4MDY3ODU1IiwiVGVuYW50SUQiOiIiLCJVc2VySUQiOiI5MjE2IiwiVXNlck5hbWUiOiJoaW5pc2giLCJSYXRlTGltaXREZXRhaWxzIjp7IkVuYWJsZWQiOnRydWUsIlJlcXVlc3RzUGVyTWludXRlIjoxMjB9fSwidG9rZW5fdHlwZSI6IkJlYXJlciJ9.kbTO3a5mD9ORw0-bRQgqQ7yURah9CRuB-lMrmlqX-cdhlug6kNmJ4Xi9P6fNOpK-ZY2rypwyfX81SR-CkU613UEp_WvgnoCUw3VTLmXwUKWlgNaEROU2rbQrZoAXuW173VB4CvAnYOU8NQpCpG-v6SM5B_6JuTVhfH-aUu3bKGITWO_0UYfNHGPGrkykFMAGna80PUXhkcese_fyofxgD32Pv-jfAqkqYnLZV4pqLHgdVDjTLBx7jzC40GbWp3m8hFNQVZIldr5q0LV1BFdL42hmuWubCkAq3U7NnEjsNlL_SSrINpmSRBotMVtTTqOCteEV7h5wYB5lNTSk7LPtZW5vx2bViqY8ny1-4LcxcZ8vKEdlDIwuY7TP_KQZgmAKDW38JOpZzFLx-WBFsYlRKXgLXFRaTPqZs8JypwXxfq5nxMPYy5PcJxupkHe0WY0LaMFwGEyH4yZ2HrHzgU3c6h1HsdU2EVIb-DjpimuHClXk6-j4M9WhayY7iZyV6Emd4ZRV5_fhoT-Z5xlB7jlIUyFwDgstlVPIJGiD23pZ_q4_WC7mHgvqAqThhmI-1XuHkFpsSbPLpy7xkbYao6DnWy5qbVO8GHgFvXJ9x_WWXOit03c0o2I9vFkzwMbUhfSzJ6VhRlMXa5gR2t1uoLeZcvonZPaVj0swPAFXA86Cnrg"}],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/return_orders/:return_order_id","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders","return_orders",":return_order_id"],"variable":[{"key":"seller_code","value":"3705"},{"key":"return_order_id","value":"RO-106213"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 03 Nov 2025 13:21:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"7f84827e-5950-4cb5-bf46-9dc9981ca5b9"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"998c2cdf89ecf043-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"6908a9ce71187141897e4a8f\",\n \"return_order_id\": \"RO-106213\",\n \"order_id\": \"68f8aa5753ed4fff60b905da\",\n \"seller_name\": \"Joint furniture\",\n \"type\": \"Customer Return\",\n \"source\": \"Sales Channel\",\n \"customer\": {\n \"first_name\": \"فاطمه\",\n \"last_name\": \"الزهراء عبدالروؤف توفيق\",\n \"mobile\": \"+20-1005160640\",\n \"mobile_code\": \"+20\",\n \"email\": \"customer@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"order_reference_id\": \"324234\",\n \"order_items\": [\n {\n \"seller_sku_code\": \"JOUFURH05082036\",\n \"item_barcodes\": [],\n \"return_reason\": \"\",\n \"return_reasons\": [],\n \"unit_price\": 11531,\n \"selling_price\": 11531,\n \"total\": 11531,\n \"refunded_quantity\": 0,\n \"returned_quantity\": 0,\n \"delivered_quantity\": 1,\n \"return_quantity\": 1,\n \"return_weight\": {},\n \"display_return_weight\": \"\",\n \"is_weighted\": false,\n \"discount\": 0,\n \"tax\": 0,\n \"tax_percent\": 0\n }\n ],\n \"total_sku_count\": 1,\n \"delivered_quantity\": 1,\n \"total\": 11531,\n \"pickup_address\": {\n \"address1\": \"كمبوند الياسمين فيلا 1132 الشيخ زايد الجيزة\",\n \"address2\": \"Giza\",\n \"city\": \"الشيخ زايد\",\n \"country\": \"Egypt\",\n \"first_name\": \"فاطمه\",\n \"last_name\": \"الزهراء عبدالروؤف توفيق\",\n \"phone\": \"1005160640\",\n \"email\": \"\",\n \"state\": \"Giza\",\n \"area\": \"\",\n \"zip\": \"110001\",\n \"state_code\": \"\",\n \"country_code\": \"EG\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"national_address_code\" : \"nac_1234\"\n },\n \"status\": \"Initiated\",\n \"refund_status\": \"Pending\",\n \"shipment\": {\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"order_created_at\": \"2025-09-11T15:55:43Z\",\n \"order_delivered_at\": \"2025-11-03T13:07:13.915Z\",\n \"payment_method\": \"postpaid\",\n \"invoice\": {\n \"currency\": \"EGP\",\n \"subtotal\": 11531,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"total\": 11451,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"cod_fee\",\n \"cost\": 50,\n \"cost_without_tax\": 47.62,\n \"tax_amount\": 2.38,\n \"tax_inclusive\": true,\n \"tax_percentage\": 5,\n \"is_applied\": true\n },\n {\n \"type\": \"platform_fee\",\n \"cost\": 30,\n \"cost_without_tax\": 30,\n \"tax_amount\": 0,\n \"tax_inclusive\": false,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": null\n },\n \"hub_detail\": {\n \"code\": \"\"\n },\n \"total_return_quantity\": 1\n },\n \"meta\": null\n}"}],"_postman_id":"66929aef-c257-4716-9efd-a995ce5f62e0"}],"id":"16d4534c-d434-42b6-83f2-e2a71e6ffc63","_postman_id":"16d4534c-d434-42b6-83f2-e2a71e6ffc63","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Shipment Order Return Request","item":[{"name":"Create Return Request","id":"aa5f45cd-57d5-458a-950c-c66da7c0d992","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"return_request_number\": \"RRN-108\",\n \"return_reason\": \"Customer dissatisfaction with product quality\",\n \"return_items\": [\n {\n \"seller_sku_code\": \"JOUFURH528052406\",\n \"quantity\": 1,\n \"return_reason\": \"Item defective\",\n \"refund_amount\": 950.0,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged packaging\",\n \"quantity\": 1,\n \"comment\": \"Outer box torn on arrival\"\n }\n ]\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"platform_fee\",\n \"cost_with_tax\": 30.0,\n \"tax_percentage\": 0.0\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/:order_id/return_requests","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders",":order_id","return_requests"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"3705","key":"seller_code"},{"type":"any","value":"68f8aa561f63128c15fc83ed","key":"order_id"}]}},"response":[{"id":"9abc6db2-1a9d-44a6-a1cc-e77129fa0172","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NjM4MTg4MjIsImp0aSI6IjE0Mzk3NDgxLTZmYzctNGE2OC05ZGZiLTEzYjI2YTM4OWFkMCIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRDb2RlIjoiMzY4MDY3ODU1IiwiVGVuYW50SUQiOiIiLCJVc2VySUQiOiI5MjE2IiwiVXNlck5hbWUiOiJoaW5pc2giLCJSYXRlTGltaXREZXRhaWxzIjp7IkVuYWJsZWQiOnRydWUsIlJlcXVlc3RzUGVyTWludXRlIjoxMjB9fSwidG9rZW5fdHlwZSI6IkJlYXJlciJ9.kbTO3a5mD9ORw0-bRQgqQ7yURah9CRuB-lMrmlqX-cdhlug6kNmJ4Xi9P6fNOpK-ZY2rypwyfX81SR-CkU613UEp_WvgnoCUw3VTLmXwUKWlgNaEROU2rbQrZoAXuW173VB4CvAnYOU8NQpCpG-v6SM5B_6JuTVhfH-aUu3bKGITWO_0UYfNHGPGrkykFMAGna80PUXhkcese_fyofxgD32Pv-jfAqkqYnLZV4pqLHgdVDjTLBx7jzC40GbWp3m8hFNQVZIldr5q0LV1BFdL42hmuWubCkAq3U7NnEjsNlL_SSrINpmSRBotMVtTTqOCteEV7h5wYB5lNTSk7LPtZW5vx2bViqY8ny1-4LcxcZ8vKEdlDIwuY7TP_KQZgmAKDW38JOpZzFLx-WBFsYlRKXgLXFRaTPqZs8JypwXxfq5nxMPYy5PcJxupkHe0WY0LaMFwGEyH4yZ2HrHzgU3c6h1HsdU2EVIb-DjpimuHClXk6-j4M9WhayY7iZyV6Emd4ZRV5_fhoT-Z5xlB7jlIUyFwDgstlVPIJGiD23pZ_q4_WC7mHgvqAqThhmI-1XuHkFpsSbPLpy7xkbYao6DnWy5qbVO8GHgFvXJ9x_WWXOit03c0o2I9vFkzwMbUhfSzJ6VhRlMXa5gR2t1uoLeZcvonZPaVj0swPAFXA86Cnrg"}],"body":{"mode":"raw","raw":"{\n \"return_request_number\": \"RRN-108\",\n \"return_reason\": \"Customer dissatisfaction with product quality\",\n \"return_items\": [\n {\n \"seller_sku_code\": \"JOUFURH528052406\",\n \"quantity\": 1,\n \"return_reason\": \"Item defective\",\n \"refund_amount\": 950.0,\n \"return_reasons\": [\n {\n \"reason\": \"Damaged packaging\",\n \"quantity\": 1,\n \"comment\": \"Outer box torn on arrival\"\n }\n ]\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"cod_fee\",\n \"cost_with_tax\": 50.0,\n \"tax_percentage\": 5.0\n },\n {\n \"type\": \"platform_fee\",\n \"cost_with_tax\": 30.0,\n \"tax_percentage\": 0.0\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/:order_id/return_requests","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders",":order_id","return_requests"],"variable":[{"key":"seller_code","value":"3705"},{"key":"order_id","value":"68f8aa561f63128c15fc83ed"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 03 Nov 2025 13:25:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"c201d49c-b2c2-4153-a0e9-30547e07cf5c"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"998c32880a06897e-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"6908ad44c6dd292046904ac5\",\n \"return_request_number\": \"RRN-108\",\n \"customer\": {\n \"first_name\": \"body\",\n \"last_name\": \"ayman\",\n \"mobile\": \"+20-1119680001\",\n \"mobile_code\": \"+20\",\n \"email\": \"customer@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Joint furniture\",\n \"order_id\": \"2334324324\",\n \"return_items\": [\n {\n \"id\": \"6908ad43c6dd292046904ac4\",\n \"sales_channel_item_id\": \"2334324324\",\n \"sku_code\": \"JOUFURH528052406\",\n \"return_quantity\": 1,\n \"return_reason\": \"Item defective\",\n \"delivered_quantity\": 1\n }\n ],\n \"total_return_items_count\": 1,\n \"total_delivered_items_count\": 1,\n \"total_sku_count\": 1,\n \"total\": 30074,\n \"invoice\": {\n \"currency\": \"EGP\",\n \"subtotal\": 30074,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"total\": 29994,\n \"total_paid\": 30074,\n \"total_due\": 30074,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"cod_fee\",\n \"cost\": 50,\n \"cost_without_tax\": 47.62,\n \"tax_amount\": 2.38,\n \"tax_inclusive\": true,\n \"tax_percentage\": 5,\n \"is_applied\": true\n },\n {\n \"type\": \"platform_fee\",\n \"cost\": 30,\n \"cost_without_tax\": 30,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": true\n }\n ],\n \"attachments\": null\n },\n \"payment_method\": \"Postpaid\",\n \"status\": \"New\",\n \"shipment\": {\n \"order_delivered_at\": \"2025-11-03T13:23:42.48Z\",\n \"order_shipped_at\": \"2025-11-03T13:00:05.716Z\",\n \"shipment_order_id\": \"68f8aa8165f0e66a225c41f9\",\n \"awb_number\": \"AWB-A314A73A\",\n \"delivery_status\": \"\",\n \"awb_label\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/pdf-merger/b9c8d13a-9cee-4484-be49-08427396a5c1/awb-merged-68f8aa814821155539d61ab5.pdf\",\n \"shipping_partner_tag\": \"lifters\",\n \"shipping_partner_name\": \"Lifters\",\n \"number_of_boxes\": 4,\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n }\n },\n \"meta\": null\n}"}],"_postman_id":"aa5f45cd-57d5-458a-950c-c66da7c0d992"},{"name":"Get Return Request","id":"75965c7e-e51b-4932-be1b-cd18ce5a1d13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/return_requests","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders","return_requests"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"3705","key":"seller_code"}]}},"response":[{"id":"4345c9dd-34b4-4146-9f53-5ae63ce7b203","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/return_requests","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders","return_requests"],"query":[{"key":"page","value":null,"description":"Page number of response","type":"text","disabled":true},{"key":"per_page","value":null,"description":"Number of shipment orders per page","type":"text","disabled":true},{"key":"order_id","value":null,"description":"Unique identifier of shipment order","type":"text","disabled":true},{"key":"status","value":null,"description":"Status of the return request","type":"text","disabled":true}],"variable":[{"key":"seller_code","value":"3705"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 03 Nov 2025 13:27:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"e2d643d5-ebe7-4f07-9ace-8b1e5d754b87"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"998c3592e93d59e1-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"6908ad44c6dd292046904ac5\",\n \"return_request_number\": \"RRN-108\",\n \"customer\": {\n \"first_name\": \"body\",\n \"last_name\": \"ayman\",\n \"mobile\": \"+20-1119680001\",\n \"mobile_code\": \"+20\",\n \"email\": \"customer@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Joint furniture\",\n \"order_id\": \"2334324324\",\n \"return_items\": [\n {\n \"id\": \"6908ad43c6dd292046904ac4\",\n \"sales_channel_item_id\": \"2334324324\",\n \"sku_code\": \"JOUFURH528052406\",\n \"return_quantity\": 1,\n \"return_reason\": \"Item defective\",\n \"delivered_quantity\": 1\n }\n ],\n \"total_return_items_count\": 1,\n \"total_delivered_items_count\": 1,\n \"total_sku_count\": 1,\n \"total\": 30074,\n \"invoice\": {\n \"currency\": \"EGP\",\n \"subtotal\": 30074,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"total\": 29994,\n \"total_paid\": 30074,\n \"total_due\": 30074,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"cod_fee\",\n \"cost\": 50,\n \"cost_without_tax\": 47.62,\n \"tax_amount\": 2.38,\n \"tax_inclusive\": true,\n \"tax_percentage\": 5,\n \"is_applied\": true\n },\n {\n \"type\": \"platform_fee\",\n \"cost\": 30,\n \"cost_without_tax\": 30,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": true\n }\n ],\n \"attachments\": null\n },\n \"payment_method\": \"Postpaid\",\n \"status\": \"New\",\n \"shipment\": {\n \"order_delivered_at\": \"2025-11-03T13:23:42.48Z\",\n \"order_shipped_at\": \"2025-11-03T13:00:05.716Z\",\n \"shipment_order_id\": \"68f8aa8165f0e66a225c41f9\",\n \"awb_number\": \"AWB-A314A73A\",\n \"delivery_status\": \"\",\n \"awb_label\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/pdf-merger/b9c8d13a-9cee-4484-be49-08427396a5c1/awb-merged-68f8aa814821155539d61ab5.pdf\",\n \"shipping_partner_tag\": \"lifters\",\n \"shipping_partner_name\": \"Lifters\",\n \"number_of_boxes\": 4,\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n }\n },\n {\n \"id\": \"68ff8abc96f0f8ee4722bc09\",\n \"customer\": {\n \"first_name\": \"ندى\",\n \"last_name\": \"محمد\",\n \"mobile\": \"+20-1011755247\",\n \"mobile_code\": \"+20\",\n \"email\": \"customer@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Joint furniture\",\n \"order_id\": \"239634\",\n \"return_items\": [\n {\n \"id\": \"68ff8abc96f0f8ee4722bc08\",\n \"sales_channel_item_id\": \"239634\",\n \"sku_code\": \"JOUFURH528052408\",\n \"return_quantity\": 1,\n \"delivered_quantity\": 1\n }\n ],\n \"total_return_items_count\": 1,\n \"total_delivered_items_count\": 1,\n \"total_sku_count\": 1,\n \"total\": 21997.15,\n \"invoice\": {\n \"currency\": \"EGP\",\n \"subtotal\": 21997.15,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 3881.85,\n \"total\": 21997.15,\n \"total_paid\": 25879,\n \"total_due\": 21997.15,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"return_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": null\n },\n \"payment_method\": \"Postpaid\",\n \"status\": \"Approved\",\n \"shipment_type\": \"Omniful Generated\",\n \"shipment\": {\n \"order_delivered_at\": \"2025-10-26T12:57:27.052Z\",\n \"order_shipped_at\": \"2025-10-13T11:47:43.16Z\",\n \"shipment_order_id\": \"68dfe3870ffa40d682966d3e\",\n \"awb_number\": \"AWB-766575D5\",\n \"delivery_status\": \"\",\n \"awb_label\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/pdf-merger/684e6ecf-9940-4fb0-99e4-244f23e51137/awb-merged-68dfe387b7c62254a4da2949.pdf\",\n \"shipping_partner_tag\": \"lifters\",\n \"shipping_partner_name\": \"Lifters\",\n \"number_of_boxes\": 4,\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n }\n },\n {\n \"id\": \"68e7a34801cfe384fd787bdd\",\n \"customer\": {\n \"first_name\": \"Mahmoud\",\n \"last_name\": \"atef\",\n \"mobile\": \"+20-1014561191\",\n \"mobile_code\": \"+20\",\n \"email\": \"customer@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Joint furniture\",\n \"order_id\": \"2438674\",\n \"return_items\": [\n {\n \"id\": \"68e7a34801cfe384fd787bdc\",\n \"sales_channel_item_id\": \"2438674\",\n \"sku_code\": \"JOUFURH94224\",\n \"return_quantity\": 1,\n \"delivered_quantity\": 1\n }\n ],\n \"total_return_items_count\": 1,\n \"total_delivered_items_count\": 1,\n \"total_sku_count\": 1,\n \"total\": 21390,\n \"invoice\": {\n \"currency\": \"EGP\",\n \"subtotal\": 21390,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"total\": 21390,\n \"total_paid\": 21390,\n \"total_due\": 0,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"return_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": null\n },\n \"payment_method\": \"Prepaid\",\n \"status\": \"Approved\",\n \"shipment_type\": \"Omniful Generated\",\n \"shipment\": {\n \"order_delivered_at\": \"2025-10-01T07:56:45.558Z\",\n \"order_shipped_at\": \"2025-10-01T07:43:58.963Z\",\n \"shipment_order_id\": \"68daec915b87cca2ab40c0c2\",\n \"awb_number\": \"AWB-38BA9048\",\n \"delivery_status\": \"\",\n \"awb_label\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/pdf-merger/2afca6b6-db4d-412a-b0c4-eaeb76e72c19/awb-merged-68daec91ff8f98f23611c6f4.pdf\",\n \"shipping_partner_tag\": \"lifters\",\n \"shipping_partner_name\": \"Lifters\",\n \"number_of_boxes\": 4,\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n }\n },\n {\n \"id\": \"68e60739ca4a1f07d604daed\",\n \"customer\": {\n \"first_name\": \"Mohamed\",\n \"last_name\": \"Rayyan\",\n \"mobile\": \"+20-1111999675\",\n \"mobile_code\": \"+20\",\n \"email\": \"customer@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"seller_name\": \"Joint furniture\",\n \"order_id\": \"2396522\",\n \"return_items\": [\n {\n \"id\": \"68e60739ca4a1f07d604daec\",\n \"sales_channel_item_id\": \"2396522\",\n \"sku_code\": \"JOUFURH528052408\",\n \"return_quantity\": 1,\n \"delivered_quantity\": 1\n }\n ],\n \"total_return_items_count\": 1,\n \"total_delivered_items_count\": 1,\n \"total_sku_count\": 1,\n \"total\": 21997.15,\n \"invoice\": {\n \"currency\": \"EGP\",\n \"subtotal\": 21997.15,\n \"shipping_price\": 0,\n \"shipping_refund\": 0,\n \"tax\": 0,\n \"discount\": 3881.85,\n \"total\": 21997.15,\n \"total_paid\": 25879,\n \"total_due\": 21997.15,\n \"shipping_tax\": 0,\n \"sub_total_tax_inclusive\": false,\n \"sub_total_discount_inclusive\": false,\n \"shipping_tax_inclusive\": false,\n \"shipping_discount_inclusive\": false,\n \"additional_charges\": [\n {\n \"type\": \"return_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n },\n {\n \"type\": \"return_shipment_fee\",\n \"cost\": 0,\n \"cost_without_tax\": 0,\n \"tax_amount\": 0,\n \"tax_inclusive\": true,\n \"tax_percentage\": 0,\n \"is_applied\": false\n }\n ],\n \"attachments\": null\n },\n \"payment_method\": \"Postpaid\",\n \"status\": \"Approved\",\n \"shipment_type\": \"Omniful Generated\",\n \"shipment\": {\n \"order_delivered_at\": \"2025-10-01T12:33:38.435Z\",\n \"order_shipped_at\": \"2025-10-01T12:19:53.095Z\",\n \"shipment_order_id\": \"68dd19c506d1a329e58f6924\",\n \"awb_number\": \"AWB-06746061\",\n \"delivery_status\": \"\",\n \"awb_label\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/pdf-merger/d4213431-6bf9-453a-80ea-358dcb84d827/awb-merged-68dd19c59672e8d20832a175.pdf\",\n \"shipping_partner_tag\": \"lifters\",\n \"shipping_partner_name\": \"Lifters\",\n \"number_of_boxes\": 4,\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 4\n }\n}"}],"_postman_id":"75965c7e-e51b-4932-be1b-cd18ce5a1d13"},{"name":"Approve Return Request","id":"828f1c0b-ac94-4b24-a031-7ca308eeacf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"return_request_id\": \"6908ad44c6dd292046904ac5\",\n \"approval_mode\": \"partial\",\n \"return_reason\": \"Items partially defective\",\n \"total_refundable_amount\": 950.0,\n \"order_items\": [\n {\n \"sku_code\": \"JOUFURH528052406\",\n \"item_id\": \"6908ad43c6dd292046904ac4\", // same as the id recieved in response of get return requests or create return request\n \"return_quantity\": 1,\n \"return_reason\": \"Damaged product\",\n \"return_reasons\": [\n {\n \"reason\": \"Screen cracked\",\n \"quantity\": 1,\n \"comment\": \"Visible crack on screen upon delivery\"\n }\n ]\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"platform_fee\",\n \"cost_with_tax\": 30.0,\n \"tax_percentage\": 0.0\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/return_requests/:return_request_id/approve","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders","return_requests",":return_request_id","approve"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"3705","key":"seller_code"},{"type":"any","value":"6908ad44c6dd292046904ac5","key":"return_request_id"}]}},"response":[{"id":"318f0c3b-f0c9-4b9f-aa09-75ab49586299","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"return_request_id\": \"6908ad44c6dd292046904ac5\",\n \"approval_mode\": \"partial\",\n \"return_reason\": \"Items partially defective\",\n \"total_refundable_amount\": 950.0,\n \"order_items\": [\n {\n \"sku_code\": \"JOUFURH528052406\",\n \"item_id\": \"6908ad43c6dd292046904ac4\",\n \"return_quantity\": 1,\n \"return_reason\": \"Damaged product\",\n \"return_reasons\": [\n {\n \"reason\": \"Screen cracked\",\n \"quantity\": 1,\n \"comment\": \"Visible crack on screen upon delivery\"\n }\n ]\n }\n ],\n \"additional_charges\": [\n {\n \"type\": \"platform_fee\",\n \"cost_with_tax\": 30.0,\n \"tax_percentage\": 0.0\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/return_requests/:return_request_id/approve","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders","return_requests",":return_request_id","approve"],"variable":[{"key":"seller_code","value":"3705"},{"key":"return_request_id","value":"6908ad44c6dd292046904ac5"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 03 Nov 2025 13:34:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"b7a44a23-6cd4-42f9-b8cf-b830dc69f957"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"998c3fecdb797f8f-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Return request approved successfully\",\n \"meta\": null\n}"}],"_postman_id":"828f1c0b-ac94-4b24-a031-7ca308eeacf2"},{"name":"Reject Return Request","id":"0a1c27b3-30a3-4be3-aa04-0e08c9b63fb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/return_requests/:return_request_id/reject","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders","return_requests",":return_request_id","reject"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"3705","key":"seller_code"},{"type":"any","value":"6908b0f4dc54f3b71de40587","key":"return_request_id"}]}},"response":[{"id":"6307bcec-0b87-4a16-aac3-250a86fc239f","name":"Success","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/return_requests/:return_request_id/reject","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders","return_requests",":return_request_id","reject"],"variable":[{"key":"seller_code","value":"3705"},{"key":"return_request_id","value":"6908b0f4dc54f3b71de40587"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 03 Nov 2025 13:42:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"8e4cf8e8-446a-4704-948b-465d04fde197"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"998c4ae04dacfab4-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": \"Return request rejected successfully\",\n \"meta\": null\n}"}],"_postman_id":"0a1c27b3-30a3-4be3-aa04-0e08c9b63fb5"}],"id":"88d01e7d-ccbe-4f03-857d-492ed30a25c7","_postman_id":"88d01e7d-ccbe-4f03-857d-492ed30a25c7","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Get Shipment Orders","id":"ceb0a2ef-dc7c-4154-86c8-229dae2f917f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

Page number of response

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

Number of shipment orders per page

\n","type":"text/plain"},"key":"per_page","value":"1"},{"disabled":true,"description":{"content":"

Unique identifier of shipment order

\n","type":"text/plain"},"key":"shipment_order_id","value":"SO-ORDER-81456"},{"disabled":true,"description":{"content":"

Unique identifier for customer

\n","type":"text/plain"},"key":"customer_id","value":"CUST-001"},{"disabled":true,"description":{"content":"

Customer Name

\n","type":"text/plain"},"key":"customer_name","value":"John Doe"},{"disabled":true,"description":{"content":"

Customer Email

\n","type":"text/plain"},"key":"customer_email","value":"johndoe@gmail.com"}],"variable":[{"description":{"content":"

Unique Identifier of Seller

\n","type":"text/plain"},"type":"any","value":"TC-076","key":"seller_code"}]}},"response":[{"id":"ffa4f89e-728a-4041-98b7-f6bdb2754ae3","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/TC-076/shipment_orders?page&per_page&shipment_order_id","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","tenants","sellers","TC-076","shipment_orders"],"query":[{"key":"page","value":null},{"key":"per_page","value":null},{"key":"shipment_order_id","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Sat, 20 Sep 2025 07:07:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"36dcf25d-6760-40e1-a1cd-383f2bd63e93"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"981f7d138a425a06-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": \"68ce5216b48263e5793e35f3\",\n \"display_order_id\": \"SO-ORDER-81456\",\n \"client_reference_id\": \"SO-REF-8139\",\n \"seller_code\": \"TC-076\",\n \"total\": 2,\n \"slot\": {},\n \"order_created_at\": \"2025-07-15T10:00:00Z\",\n \"customer\": {\n \"id\": \"CUST-001\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-1234567890\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"shipment_created_at\": \"0001-01-01T00:00:00Z\",\n \"order_delivered_at\": \"0001-01-01T00:00:00Z\",\n \"order_shipped_at\": \"0001-01-01T00:00:00Z\",\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"payment_method\": \"Postpaid\",\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"click_and_collect\",\n \"fulfillment_type\": \"\",\n \"sender_address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"receiver_address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"hub_detail\": {\n \"code\": \"\",\n \"hub_type\": \"\",\n \"virtual_hub_type\": \"\"\n },\n \"payment_info\": {\n \"currency\": \"\",\n \"payment_type\": \"\",\n \"payment_mode\": \"\",\n \"total\": 0,\n \"subtotal\": 0,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"tax_percent\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"shipping_price\": 0,\n \"additional_charges\": []\n },\n \"delivery_info\": {\n \"delivery_type\": \"\",\n \"recipient\": \"\",\n \"recipient_signature_url\": \"\",\n \"delivery_proof_urls\": null,\n \"recipient_photo_url\": \"\"\n }\n },\n {\n \"id\": \"68ce50b2b48263e5793e34e9\",\n \"display_order_id\": \"SO-ORDER-8142\",\n \"client_reference_id\": \"SO-REF-8139\",\n \"seller_code\": \"TC-076\",\n \"total\": 2,\n \"slot\": {},\n \"order_created_at\": \"2025-07-15T10:00:00Z\",\n \"customer\": {\n \"id\": \"CUST-001\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"+91-1234567890\",\n \"mobile_code\": \"+91\",\n \"email\": \"john.doe@example.com\",\n \"avatar\": \"https://cdn.example.com/avatar.jpg\",\n \"gender\": \"male\"\n },\n \"shipment\": {\n \"shipment_created_at\": \"0001-01-01T00:00:00Z\",\n \"order_delivered_at\": \"0001-01-01T00:00:00Z\",\n \"order_shipped_at\": \"0001-01-01T00:00:00Z\",\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"payment_method\": \"Postpaid\",\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"click_and_collect\",\n \"fulfillment_type\": \"\",\n \"sender_address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"receiver_address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"hub_detail\": {\n \"code\": \"\",\n \"hub_type\": \"\",\n \"virtual_hub_type\": \"\"\n },\n \"payment_info\": {\n \"currency\": \"\",\n \"payment_type\": \"\",\n \"payment_mode\": \"\",\n \"total\": 0,\n \"subtotal\": 0,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"tax_percent\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"shipping_price\": 0,\n \"additional_charges\": []\n },\n \"delivery_info\": {\n \"delivery_type\": \"\",\n \"recipient\": \"\",\n \"recipient_signature_url\": \"\",\n \"delivery_proof_urls\": null,\n \"recipient_photo_url\": \"\"\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 20,\n \"total\": 2\n }\n}"}],"_postman_id":"ceb0a2ef-dc7c-4154-86c8-229dae2f917f"},{"name":"Get Shipment Order By ID","id":"e33943b3-cc40-473a-90d7-d48b719a702d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/:id","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders",":id"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

Page number of response

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

Number of shipment orders per page

\n","type":"text/plain"},"key":"per_page","value":"1"},{"disabled":true,"description":{"content":"

Unique identifier of shipment order

\n","type":"text/plain"},"key":"shipment_order_id","value":"SO-ORDER-81456"},{"disabled":true,"description":{"content":"

Unique identifier for customer

\n","type":"text/plain"},"key":"customer_id","value":"CUST-001"},{"disabled":true,"description":{"content":"

Customer Name

\n","type":"text/plain"},"key":"customer_name","value":"John Doe"},{"disabled":true,"description":{"content":"

Customer Email

\n","type":"text/plain"},"key":"customer_email","value":"johndoe@gmail.com"}],"variable":[{"type":"any","value":"GI-430","key":"seller_code"},{"type":"any","value":"6916d59b1c8f96c3cfd34615","key":"id"}]}},"response":[{"id":"0849734a-c8c6-4ab6-aad3-2dea9ba4c7d0","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders/:id","host":["{{base_url}}"],"path":["sales-channel","public","v1","tenants","sellers",":seller_code","shipment_orders",":id"],"variable":[{"key":"seller_code","value":"GI-430"},{"key":"id","value":"6916d59b1c8f96c3cfd34615"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Nov 2025 11:09:43 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"afd0d790-796c-4b8d-96de-4ad98c1ac50f"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9a3874a8ffc159be-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"6916d59b1c8f96c3cfd34615\",\n \"display_order_id\": \"SHO_1763104155666347927_478\",\n \"client_reference_id\": \"\",\n \"seller_code\": \"GI-430\",\n \"order_items\": [\n {\n \"item_id\": \"\",\n \"sales_channel_item_id\": \"\",\n \"sku_code\": \"mango\",\n \"hs_code\": \"\",\n \"sku_id\": \"\",\n \"display_price\": 0,\n \"selling_price\": 83.33,\n \"is_substituted\": false,\n \"substitute_seller_sku_codes\": null,\n \"serialised_sku_codes\": null,\n \"item_barcodes\": null,\n \"quantity\": 2,\n \"tax_percent\": 20,\n \"tax\": 33.34,\n \"unit_price\": 83.33,\n \"total\": 200,\n \"discount\": 0,\n \"tax_inclusive\": false,\n \"sub_total\": 0,\n \"discount_percent\": 0,\n \"sku\": {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"images\": null\n },\n \"installation_required\": true\n }\n ],\n \"total\": 2,\n \"slot\": {},\n \"order_created_at\": \"0001-01-01T00:00:00Z\",\n \"customer\": {\n \"id\": \"6916d46765d7b7a09e590c65\",\n \"first_name\": \"Muntazir Delivery Address\",\n \"mobile\": \"+966-544567654\",\n \"mobile_code\": \"+966\"\n },\n \"shipment\": {\n \"shipment_created_at\": \"0001-01-01T00:00:00Z\",\n \"order_delivered_at\": \"0001-01-01T00:00:00Z\",\n \"order_shipped_at\": \"0001-01-01T00:00:00Z\",\n \"delivery_status\": \"\",\n \"shipping_account\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"courier_partner\": {\n \"id\": 0,\n \"name\": \"\",\n \"tag\": \"\",\n \"logo\": \"\"\n }\n },\n \"payment_method\": \"Prepaid\",\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"normal_delivery\",\n \"fulfillment_type\": \"shipment_only\",\n \"sender_address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"receiver_address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"country_calling_code\": \"\",\n \"national_address_code\": \"\"\n },\n \"hub_detail\": {\n \"code\": \"\"\n },\n \"payment_info\": {\n \"currency\": \"\",\n \"payment_type\": \"\",\n \"payment_mode\": \"\",\n \"total\": 0,\n \"subtotal\": 0,\n \"total_paid\": 0,\n \"total_due\": 0,\n \"tax_percent\": 0,\n \"tax\": 0,\n \"discount\": 0,\n \"shipping_price\": 0,\n \"additional_charges\": []\n },\n \"delivery_info\": {\n \"delivery_type\": \"\",\n \"recipient\": \"\",\n \"recipient_signature_url\": \"\",\n \"delivery_proof_urls\": null,\n \"recipient_photo_url\": \"\"\n }\n },\n \"meta\": null\n}"}],"_postman_id":"e33943b3-cc40-473a-90d7-d48b719a702d"},{"name":"Create Shipment Order","id":"2db30fbf-13ea-4f5c-9a73-33d3429d541b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"SO-81211\",\n \"display_order_id\": \"SO-ORDER-302\",\n \"client_reference_id\": \"SO-REF-8123\",\n \"installation_required\": true,\n \"order_items\": [\n {\n \"item_id\": \"item-001\",\n \"sku_code\": \"SKU-123\",\n \"hs_code\": \"HS999\",\n \"sku_id\": \"SKU-ID-456\",\n \"name\": \"Sample Product\",\n \"display_price\": 100.0,\n \"selling_price\": 90.0,\n \"is_substituted\": false,\n \"item_barcodes\": [\n \"BAR123\"\n ],\n \"quantity\": 2,\n \"tax_percent\": 5.0,\n \"tax\": 9.0,\n \"unit_price\": 45.5,\n \"subtotal\": 91.0,\n \"total\": 100.0,\n \"discount\": 0.0,\n \"tax_inclusive\": true,\n \"installation_required\": true\n }\n ],\n \"slot\": {\n \"delivery_date\": \"2025-07-20\",\n \"start_time\": 1000,\n \"end_time\": 1200\n },\n \"order_created_at\": \"2025-07-15T10:00:00Z\",\n \"customer\": {\n \"id\": \"CUST-001\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mobile\": \"1234567890\",\n \"mobile_code\": \"+91\",\n \"country_code\": \"IN\",\n \"email\": \"john.doe@example.com\",\n \"gender\": \"male\",\n \"country\": \"India\",\n \"country_calling_code\": \"+91\"\n },\n \"shipment\": {\n \"number_of_boxes\": 2,\n \"weight\": 4.5\n },\n \"payment_method\": \"postpaid\",\n \"is_cash_on_delivery\": true,\n \"shipment_type\": \"omniful_generated\",\n \"delivery_type\": \"click_and_collect\",\n \"note\": \"Handle with care\",\n \"no_of_boxes\": 2,\n \"labels\": [\n \"fragile\",\n \"priority\"\n ],\n \"fulfillment_type\": \"shipment_only\",\n \"sender_address\": {\n \"address1\": \"123 Warehouse St.\",\n \"address2\": \"Block A\",\n \"city\": \"Mumbai\",\n \"country\": \"India\",\n \"first_name\": \"Sender\",\n \"last_name\": \"Name\",\n \"phone\": \"9876543210\",\n \"state\": \"Maharashtra\",\n \"zip\": \"400001\",\n \"state_code\": \"MH\",\n \"country_code\": \"IN\",\n \"latitude\": 19.076,\n \"longitude\": 72.8777,\n \"email\": \"sender@example.com\",\n \"country_calling_code\": \"+91\",\n \"national_address_code\": \"code\"\n },\n \"receiver_address\": {\n \"address1\": \"456 Customer Lane\",\n \"address2\": \"Apt 202\",\n \"city\": \"Delhi\",\n \"country\": \"India\",\n \"first_name\": \"Receiver\",\n \"last_name\": \"Name\",\n \"phone\": \"9988776655\",\n \"state\": \"Delhi\",\n \"zip\": \"110001\",\n \"state_code\": \"DL\",\n \"country_code\": \"IN\",\n \"latitude\": 28.6139,\n \"longitude\": 77.209,\n \"email\": \"receiver@example.com\",\n \"country_calling_code\": \"+91\",\n \"national_address_code\": \"code\"\n },\n \"product_description\": \"Pack of electronics\",\n \"hub_detail\": {\n \"code\": \"H211125-3261-HXMJV\",\n \"hub_type\": \"virtual\",\n \"virtual_hub_type\": \"pickup_loction\"\n },\n \"payment_info\": {\n \"currency\": \"INR\",\n \"payment_type\": \"cash\",\n \"payment_mode\": \"cod\",\n \"total\": 100.0,\n \"subtotal\": 95.0,\n \"total_paid\": 100.0,\n \"total_due\": 0.0,\n \"tax_percent\": 5.0,\n \"tax\": 5.0,\n \"discount\": 0.0,\n \"shipping_price\": 10.0,\n \"additional_charges\": [\n {\n \"type\": \"platform_fee\",\n \"cost\": 5.0,\n \"tax_amount\": 0.5,\n \"tax_inclusive\": true,\n \"tax_percentage\": 10.0,\n \"is_applied\": true\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/sellers/:seller_code/shipment_orders","description":"

Description

📦 Create Shipment Order API

📥 Request Body

1. Order Information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`display_order_id`	string	✅	Unique human-readable order ID shown in Omniful.
`client_reference_id`	string	❌	Client-provided reference ID for internal tracking.
`automatic_shipment_order_shipment_enabled`	boolean	❌	If true, shipment order will auto-generate a shipment.
`order_created_at`	string (ISO 8601)	❌	Date-time when the order was originally created.
`slot.delivery_date`	string (YYYY-MM-DD)	❌	Requested delivery date.
`slot.start_time`	number (HHMM)	❌	Delivery start time in 24-hour HHMM format (e.g., 1000 = 10:00 AM).
`slot.end_time`	number (HHMM)	❌	Delivery end time in 24-hour HHMM format.
`note`	string	❌	Special instructions (e.g., “Handle with care”).
`labels[]`	array of strings	❌	Tags/labels for internal classification (e.g., fragile, priority).
`product_description`	string	❌	High-level description of order contents.

2. Order Items

Field	Type	Required	Description
`item_id`	string	❌	Unique identifier for the item in the order.
`sku_code`	string	✅	SKU code linked to catalog.
`hs_code`	string	❌	Harmonized System code for customs classification.
`sku_id`	string	❌	SKU ID mapped in Omniful.
`name`	string	❌	Display name of the item.
`display_price`	number	❌	Original display price before discounts.
`selling_price`	number	❌	Final selling price of the item.
`quantity`	number	❌	Quantity ordered.
`unit_price`	number	❌	Unit price per item.
`sub_total`	number	❌	Subtotal before taxes & discounts.
`total`	number	❌	Final total after adjustments.
`discount`	number	❌	Discount applied on item.
`discount_percent`	number	❌	Discount percentage.
`tax_percent`	number	❌	Tax percentage applied.
`tax`	number	❌	Tax amount applied.
`tax_inclusive`	boolean	❌	Whether prices are tax-inclusive.
`is_substituted`	boolean	❌	If item was substituted for another.
`item_barcodes[]`	array	❌	List of barcodes for the item.
`sku`	object	❌	Full SKU details.

sku object fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	SKU unique ID.
`code`	string	SKU code.
`name`	string	SKU name.
`type`	string	SKU type (e.g., physical, digital).
`images[]`	array	List of image URLs for SKU (default, thumbnail, medium, large, url, type, description).

3. Customer Information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`id`	string	❌	Customer ID if already exists.
`first_name`	string	❌	Customer’s first name.
`last_name`	string	❌	Customer’s last name.
`mobile`	string	❌	Customer’s phone number.
`mobile_code`	string	❌	Mobile code (e.g., +91).
`country_code`	string	❌	Country ISO code.
`email`	string	❌	Customer’s email.
`gender`	string	❌	Gender (male/female/other).
`country`	string	❌	Customer’s country name.
`country_calling_code`	string	❌	Country calling code.

4. Shipment Information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`shipment.number_of_boxes`	number	❌	Number of boxes in shipment.
`shipment.weight`	number	❌	Weight of shipment (kg).
`shipment_type`	string	❌	Type of shipment (e.g., omniful_generated, external).
`delivery_type`	string	❌	Delivery type (e.g., doorstep, click_and_collect).
`no_of_boxes`	number	❌	Number of boxes (duplicate of shipment.number_of_boxes).

5. Address Information

Sender Address & Receiver Address share same structure.

Field	Type	Required	Description
`address1`	string	✅	Primary address line.
`address2`	string	❌	Secondary address line.
`city`	string	✅	City.
`state`	string	❌	State/Province.
`zip`	string	❌	Postal code.
`country`	string	❌	Country name.
`country_code`	string	❌	ISO country code.
`state_code`	string	❌	State code.
`latitude`	number	❌	Latitude coordinates.
`longitude`	number	❌	Longitude coordinates.
`first_name`	string	❌	Contact first name.
`last_name`	string	❌	Contact last name.
`phone`	string	❌	Contact phone number.
`email`	string	❌	Contact email.
`country_calling_code`	string	❌	Country calling code.
`national_address_code`	string	❌	National address code.

6. Hub Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`code`	string	✅	Hub code assigned in Omniful.
`hub_type`	string	❌	Type of hub (physical/virtual).
`virtual_hub_type`	string	❌	Virtual hub type (e.g., pickup_location).

7. Payment Information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`currency`	string	❌	Currency code (ISO 4217, e.g., INR, USD).
`payment_type`	string	❌	Type of payment (cash, card, wallet).
`payment_mode`	string	❌	Mode (cod, prepaid, online).
`payment_method`	string	❌	Business-defined payment type (e.g., postpaid).
`is_cash_on_delivery`	boolean	❌	True if COD order.
`total`	number	✅	Total payable amount.
`subtotal`	number	❌	Subtotal before tax & shipping.
`total_paid`	number	❌	Amount already paid.
`total_due`	number	❌	Remaining due.
`tax_percent`	number	❌	Tax rate %.
`tax`	number	❌	Tax value.
`discount`	number	❌	Discount amount.
`shipping_price`	number	❌	Shipping charges.

Nested additional_charges[]

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`type`	string	Charge type (e.g., cod_fee).
`cost`	number	Charge cost.
`tax_amount`	number	Tax applied on charge.
`tax_inclusive`	boolean	If cost includes tax.
`tax_percentage`	number	Tax percentage.
`is_applied`	boolean	Whether charge is applied.

Page number of responses.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Number of responses per page

\n","type":"text/plain"},"key":"per_page","value":"2"},{"disabled":true,"description":{"content":"

Name filter of the courier partner.

\n","type":"text/plain"},"key":"name","value":"a"},{"disabled":true,"description":{"content":"

Unique Identifier of the courier partner.

\n","type":"text/plain"},"key":"tag","value":"aymakan"}],"variable":[]}},"response":[{"id":"49e5fc15-9e10-43ac-bf14-4dd7605b4e18","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/courier_partners?page=1&per_page=2&name=a&tag=aymakan","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v1","tenants","courier_partners"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"2"},{"key":"name","value":"a"},{"key":"tag","value":"aymakan"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 06 Oct 2025 10:16:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"450f3676-43e0-4acc-ad6b-b910945742e5"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"98a467366a390c2e-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": [\n {\n \"name\": \"Aymakan\",\n \"tag\": \"aymakan\",\n \"logo\": \"https://omniful-production-uploads.s3.eu-central-1.amazonaws.com/shipping/aymakan.png\",\n \"status\": \"active\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 2,\n \"total\": 1\n }\n}"}],"_postman_id":"68e94b90-c91f-424b-b7bd-be38d9a10dec"}],"id":"ea7829d0-116e-4997-947e-6ab1983080f8","_postman_id":"ea7829d0-116e-4997-947e-6ab1983080f8","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Packaging Materials","item":[{"name":"Order Packaging Materials","id":"201fafc5-993f-4c27-bf8a-d443663450eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/sales-channel/public/v1/tenants/hubs/:hub_code/orders/:id/packaging_materials","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}},"urlObject":{"path":["sales-channel","public","v1","tenants","hubs",":hub_code","orders",":id","packaging_materials"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"

Hub code of the order

\n","type":"text/plain"},"type":"any","value":"code","key":"hub_code"},{"description":{"content":"

oms order id of the order

\n","type":"text/plain"},"type":"any","value":"69c3ee0c12369f42a8c2b551","key":"id"}]}},"response":[{"id":"774d25e8-6e66-485b-b7ea-5c225e3f1284","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NzcwMjk0MTcsImp0aSI6IjYyODJhNDkzLTY1NTYtNDNkYy1hZmM2LTk0Njk4OTlhMDYwOCIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRDb2RlIjoiMzcxODEyNDk2OCIsIlRlbmFudElEIjoiIiwiVXNlcklEIjoiNDUwOCIsIlVzZXJOYW1lIjoiRGhydXYgQmhhdHQiLCJSYXRlTGltaXREZXRhaWxzIjp7IkVuYWJsZWQiOnRydWUsIlJlcXVlc3RzUGVyTWludXRlIjoxMjB9fSwidG9rZW5fdHlwZSI6IkJlYXJlciJ9.b8mVlSH0b_97JcqSysSL8-S4GiimRozc3wLcv6LqDTsUaGfwo0zYNP27-bEOsJViLWDJgm73BR7SwG-Vq6NU4tMp71g0RtnQZwCRpqVtROdVnJt0UvN3GDTS1IhZSmM4Y5iTJF3FHD4vy2k0IRCUavvxYBAX3L6-8FfqdzBN7YbZsl0OUgEjum-3pgtAy7WCQgGGqqLjCzN8zUh0I2XHiU0k11VZFJb4-Gf0EXTFtzwc4NbBEMpM1prZ3u7Q7PVzLBEykCFverBS5WKFyyNxYHbHe6b3gKmR6x1U_VE1zKE0c0D12iTCx5h6BbRO__VbUZS2eZvGE-uLas3Oi6MV3txz21pyoo_jERlQCr4_yqx6Y0x9iQVrkA3Thr9eBpRLWtUiYqgoZfGYuuDjNM0DxRUOT0_ld40_J6WccfKiCzs_YrjikAauEhiOb9qdTttKLMK8NoR3OeB68x5QPYXz0VdwIDzF3Yn1YlmOYdVKF5R4Q5fbinwwJqIlaJgUDgpTLU3T9511kyOt1hdmr4h_PPyB92ohEfStO5DbHMcCTpaRrWQ-oTl_XOdgZ7GFSO7FYzQ2ZrdrE7_Pppq_XRJFIiOyJ2cCHXLvqzztMNaI0waTAwyGxFOdknounl6Q-rMfG8X9xLzqed_c5A6mW9a33erktFeUm5MiVtYwER-UD6s"}],"url":"https://prodapi.omniful.com/sales-channel/public/v1/tenants/hubs/aryan-hub-location-on/orders/69c3ee0c12369f42a8c2b551/packaging_materials"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Thu, 26 Mar 2026 06:55:14 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"x-omniful-request-id","value":"cf530fe7-02a9-4719-8249-47b40cc9b6b5"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"content-encoding","value":"br"},{"key":"server","value":"cloudflare"},{"key":"cf-ray","value":"9e243fa26915d8a9-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"packaging_materials\": [\n {\n \"type\": \"hub_box\",\n \"details\": {\n \"name\": \"jeans\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": [\n \"BOX-DE340-1632831498\",\n \"BOX-DE340-309271638\"\n ],\n \"weight\": {\n \"value\": 0,\n \"uom\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"value\": 10,\n \"uom\": \"cm\"\n },\n \"breadth\": {\n \"value\": 10,\n \"uom\": \"cm\"\n },\n \"height\": {\n \"value\": 10,\n \"uom\": \"cm\"\n }\n },\n \"quantity\": 2\n }\n },\n {\n \"type\": \"hub_pallet\",\n \"details\": {\n \"name\": \"\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": [\n \"PL-DE340-3664295998\"\n ],\n \"weight\": {\n \"value\": 0,\n \"uom\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"value\": 0,\n \"uom\": \"cm\"\n },\n \"breadth\": {\n \"value\": 0,\n \"uom\": \"cm\"\n },\n \"height\": {\n \"value\": 0,\n \"uom\": \"cm\"\n }\n },\n \"quantity\": 1\n }\n },\n {\n \"type\": \"hub_pallet\",\n \"details\": {\n \"name\": \"\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": [\n \"PL-DE340-1407275152\"\n ],\n \"weight\": {\n \"value\": 0,\n \"uom\": \"\"\n },\n \"dimensions\": {\n \"length\": {\n \"value\": 0,\n \"uom\": \"cm\"\n },\n \"breadth\": {\n \"value\": 0,\n \"uom\": \"cm\"\n },\n \"height\": {\n \"value\": 0,\n \"uom\": \"cm\"\n }\n },\n \"quantity\": 1\n }\n },\n {\n \"type\": \"seller_box\",\n \"details\": {\n \"name\": \"snacc-box\",\n \"seller_sku_code\": \"snacc-box\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": [\n \"SBOX-DE340-1515853046\",\n \"SBOX-DE340-130264937\"\n ],\n \"weight\": {\n \"value\": 0,\n \"uom\": \"\"\n },\n \"seller_code\": \"aryan-seller\",\n \"dimensions\": {\n \"length\": {\n \"value\": 1,\n \"uom\": \"cm\"\n },\n \"breadth\": {\n \"value\": 1,\n \"uom\": \"cm\"\n },\n \"height\": {\n \"value\": 1,\n \"uom\": \"cm\"\n }\n },\n \"quantity\": 2\n }\n },\n {\n \"type\": \"seller_packaging_material\",\n \"details\": {\n \"name\": \"snacc-bag\",\n \"seller_sku_code\": \"snacc-bag\",\n \"images\": [],\n \"attributes\": [],\n \"barcodes\": [\n \"snacc-bag\"\n ],\n \"weight\": {\n \"value\": 0,\n \"uom\": \"\"\n },\n \"seller_code\": \"aryan-seller\",\n \"dimensions\": {\n \"length\": {\n \"value\": 0,\n \"uom\": \"\"\n },\n \"breadth\": {\n \"value\": 0,\n \"uom\": \"\"\n },\n \"height\": {\n \"value\": 0,\n \"uom\": \"\"\n }\n },\n \"quantity\": 4\n }\n }\n ]\n },\n \"meta\": null\n}"}],"_postman_id":"201fafc5-993f-4c27-bf8a-d443663450eb"}],"id":"7b63366a-5c31-4914-ad15-da354fdaa93a","_postman_id":"7b63366a-5c31-4914-ad15-da354fdaa93a","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","name":"Tenant APIs","type":"folder"}}},{"name":"Retrieve Access Token","id":"d80b8394-f6c6-4522-82c6-6eb88caae85d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"refresh_token\": \"{{refresh_token}}\",\n \"grant_type\": \"refresh_token\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/token","description":"

\n","urlObject":{"path":["sales-channel","public","v1","tenants","token"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"aac6dd98-4b9e-40ca-8f7e-a796c7ae9e4c","name":"Retrieve Access Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"refresh_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MjAyNDUwNTYsImp0aSI6IjYyZjZlMzk5LWM3NTMtNDk3Yy04ZWQ4LWNiMzdkMzUzZWQ0ZCIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRJRCI6IjEiLCJVc2VySUQiOiIxIiwiVXNlck5hbWUiOiJBZGFyc2gifSwidG9rZW5fdHlwZSI6IlJlZnJlc2gifQ.FpnJYOlgVjoKtXJ121AYsslqnsyoTNWHgTlFNzI_dJxZ-APAtZOkuwxBwf8j_xvvl8AII01JEUCY1ue0pzPvj87vtM-ZTPNXJdZiFdxzXAuowoMpKqBAcxbZst6c3C9uQCtOTJ4kToKdeXNHOcPmHFi33sgyjfg40AVf3abrvN91V3ZZOCVeFAkcX5REcIDzGHOKZhy1pMAc07y3_J42vvKj0m1NW-DUkp_qL4z1vcE_7FqCZrnJip1UuCbRXvO054xJ2j3tmb_7WsE9axkjcDJWG3j6VRtxxcqHLamvoiFzRpCfhCcTlk9ftGYqxpi4K_sgG0XHaA0sSLpEIPagHn4_mbpEKSVUFIToP85VoOctwKXlTatPUCKMvCKaRs9dpfwKDzagS2nDIruVnbUnQv4jh4AeABW0nWe-ZB0TTICmFsz7-ZpvXSCuiZsDZ1BD0OblVl7fITRKqh-7aZ-bIBxljZ_y5y7zJFh5iqIleZDj-Z_VX126GN-U1mtGvBieNQpUC1lNTrJP4oQ-4IiUrjIRg0b4vxIG4TzhUv2Sw67FbFVxjdGzpAidbhdcYuP9IfR-QN-SRl8r3-wiqFFXz2oLItgNTXLKpU9P6bNajIc49Icg9QKHSQ1X15V18NaxkvlOeKNVhiIT1fwbO2RDpAchwwjxNJweS-ZVTdIu5cM\",\n \"grant_type\": \"refresh_token\",\n \"client_id\": \"TQMr-_hB8R7knKe3CbczUw\",\n \"client_secret\": \"D7EsdwwcUaIAzHvJzvcyR-H_m6Rr2NoWUO1AXNXz1HA\"\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingEnv}}/sales-channel/public/v1/tenants/reports/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Jan 2024 06:23:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"eb9b0ded-d45a-4ab4-95db-d54dd8427647"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"842259c39e561be4-BOM"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDcyODY5OTQsImp0aSI6ImY0OWNlZDVkLWRhMmItNGFhMy05ZjI4LTQxMTlkY2MyZTZlNSIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRJRCI6IjEiLCJVc2VySUQiOiIxIiwiVXNlck5hbWUiOiJBZGFyc2gifSwidG9rZW5fdHlwZSI6IkJlYXJlciJ9.gEe40lbE9OpSSYHdmslbkG-QBC3n2sXVIzPMK9d4-e2w4IUlFup5b_S9xEKPufiyQlHy25r9aNrBFYpbOO0TEyC-6U6MDpZ-LRiY1r-q9a8zbPeiQmWN1DbOgmAKVASJnLgwbk8CSActMR8MrBoud1pjIWxFkDUF_weWs3MrUL6uJyh0-0tXhwomkdrzhcDtqb6XGKG6Ro7XLNFiR8GvW2b7gPPSOJFk27VH3a8dbe1JP7DIhkFhmeXqa_9U5dU61FdxTgprOByjgv5xbuRqbbGnYYrLpVJjQzup-qoXeIHS-NDfPl3OjrToZx-RSGRBhPX30KzUMFUIJn7KKIYPPV8JwFmL92M8IKJ1zojON5liZp-spAevEbQmHvD3g2pQ14xxI6_o2kdLzVai0LgRxoVUZXagW759mGokTj8U4eNzIctjalvmrO3Nlq1enl3_Jh8dwsvfOWUgjpLzlxorDJkZDdUTNQTwT8hajIg0vMZZX1REBFebBtEyY0_HYBkZ_phnub_AEmLwzpWG0ZntKoogGMnPtlSVVpiCID6ylWf1hrk6KC1JYS6MAN5zYqA2GSzMVD7PNK7A5_Tj787tkirasKwU8Veoy8wNi4mWfO3dBqDQ66E6nRnaYmV7ZNeooihTZWbamgUDATTN7HqJdw-LDDNXOOmTaHKYNfFijR4\",\n \"refresh_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MjAyNDY5OTQsImp0aSI6IjNmYmEyODU0LTlhNTYtNGQ2YS1iNjZmLTcyODExNTVmYjk2YSIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRJRCI6IjEiLCJVc2VySUQiOiIxIiwiVXNlck5hbWUiOiJBZGFyc2gifSwidG9rZW5fdHlwZSI6IlJlZnJlc2gifQ.Jvu2CVaduaXJ-U_FuH1qU0LVSxWRCgBjRUgR1-rSXttKtcy8P9dsQX5HXuox3I0CT0io49t9lc0svRP32z4xDDBpWwSo27MBltuJoff73ug7Wtp00Pq1pXZqjvawR7lDPlyq0z_f-TG6PGGpaoCkPAreBwscT4FR0XCG7laQam9atqol3atO9pJa7jErd6j-EFgiGgRnujJbwgMm1o85JKPBcXETfjIbU5klGkSdaawkqVhih3RpL4hr9a2f0_14sbjp7o4Ic1K-OLU92F5hEIKrKnShsNgnujIZUrWUT5E1WmHkSUFlYUnp7RiJRezuLlR9GHtOwYtkLTVfDzeV1T4XlsUSRvW6pD4WfFZ7oMcGhGwbQAS7kAdcDNrIFBwp0QBooiGm57uNZKjpTK2PWZPFbdKVlkMf5bupx4Qv1MpA_B4HYm2aZdfMB3h9lyXcOX0COzqOB1AVXXjMhWQG_oQG5ahnA_ezVEovmw92TuicpD0P5_kMHrWeFExIOG60FWuPmfoigg7j5puKLJkv6Oj2ORclUTk60_Y_G4GGXX60YBxpffh7zkT0R93xXOxgn2XOSqzdXSdPGGrqgYw8GULgcJGGiT0HKFCrcwyMt_OJ2SozJ2J4l8PEOSWAMvRq0Y9dhf2LKcSWq3222zUaU6rGtBFvU7Yuh55MqiRfD9o\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 2592000000000000\n },\n \"meta\": null\n}"}],"_postman_id":"d80b8394-f6c6-4522-82c6-6eb88caae85d"},{"name":"Retrieve Access Token - Deprecated","id":"24e3d10c-acc7-4a3f-aded-013ca3a60a12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"refresh_token\": \"{{refresh_token}}\",\n \"grant_type\": \"refresh_token\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/sales-channel/public/v1/tenants/reports/token","description":"

Note: This api has been marked Legacy, you can use the other endpoint for same purpose.
This api will get deprecated from `30 Oct 2025` onwards.

\n","urlObject":{"path":["sales-channel","public","v1","tenants","reports","token"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"69421d5b-17d3-4157-a9bd-ffa72f761d05","name":"Retrieve Access Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"refresh_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MjAyNDUwNTYsImp0aSI6IjYyZjZlMzk5LWM3NTMtNDk3Yy04ZWQ4LWNiMzdkMzUzZWQ0ZCIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRJRCI6IjEiLCJVc2VySUQiOiIxIiwiVXNlck5hbWUiOiJBZGFyc2gifSwidG9rZW5fdHlwZSI6IlJlZnJlc2gifQ.FpnJYOlgVjoKtXJ121AYsslqnsyoTNWHgTlFNzI_dJxZ-APAtZOkuwxBwf8j_xvvl8AII01JEUCY1ue0pzPvj87vtM-ZTPNXJdZiFdxzXAuowoMpKqBAcxbZst6c3C9uQCtOTJ4kToKdeXNHOcPmHFi33sgyjfg40AVf3abrvN91V3ZZOCVeFAkcX5REcIDzGHOKZhy1pMAc07y3_J42vvKj0m1NW-DUkp_qL4z1vcE_7FqCZrnJip1UuCbRXvO054xJ2j3tmb_7WsE9axkjcDJWG3j6VRtxxcqHLamvoiFzRpCfhCcTlk9ftGYqxpi4K_sgG0XHaA0sSLpEIPagHn4_mbpEKSVUFIToP85VoOctwKXlTatPUCKMvCKaRs9dpfwKDzagS2nDIruVnbUnQv4jh4AeABW0nWe-ZB0TTICmFsz7-ZpvXSCuiZsDZ1BD0OblVl7fITRKqh-7aZ-bIBxljZ_y5y7zJFh5iqIleZDj-Z_VX126GN-U1mtGvBieNQpUC1lNTrJP4oQ-4IiUrjIRg0b4vxIG4TzhUv2Sw67FbFVxjdGzpAidbhdcYuP9IfR-QN-SRl8r3-wiqFFXz2oLItgNTXLKpU9P6bNajIc49Icg9QKHSQ1X15V18NaxkvlOeKNVhiIT1fwbO2RDpAchwwjxNJweS-ZVTdIu5cM\",\n \"grant_type\": \"refresh_token\",\n \"client_id\": \"TQMr-_hB8R7knKe3CbczUw\",\n \"client_secret\": \"D7EsdwwcUaIAzHvJzvcyR-H_m6Rr2NoWUO1AXNXz1HA\"\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingEnv}}/sales-channel/public/v1/tenants/reports/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Jan 2024 06:23:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"eb9b0ded-d45a-4ab4-95db-d54dd8427647"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"842259c39e561be4-BOM"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDcyODY5OTQsImp0aSI6ImY0OWNlZDVkLWRhMmItNGFhMy05ZjI4LTQxMTlkY2MyZTZlNSIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRJRCI6IjEiLCJVc2VySUQiOiIxIiwiVXNlck5hbWUiOiJBZGFyc2gifSwidG9rZW5fdHlwZSI6IkJlYXJlciJ9.gEe40lbE9OpSSYHdmslbkG-QBC3n2sXVIzPMK9d4-e2w4IUlFup5b_S9xEKPufiyQlHy25r9aNrBFYpbOO0TEyC-6U6MDpZ-LRiY1r-q9a8zbPeiQmWN1DbOgmAKVASJnLgwbk8CSActMR8MrBoud1pjIWxFkDUF_weWs3MrUL6uJyh0-0tXhwomkdrzhcDtqb6XGKG6Ro7XLNFiR8GvW2b7gPPSOJFk27VH3a8dbe1JP7DIhkFhmeXqa_9U5dU61FdxTgprOByjgv5xbuRqbbGnYYrLpVJjQzup-qoXeIHS-NDfPl3OjrToZx-RSGRBhPX30KzUMFUIJn7KKIYPPV8JwFmL92M8IKJ1zojON5liZp-spAevEbQmHvD3g2pQ14xxI6_o2kdLzVai0LgRxoVUZXagW759mGokTj8U4eNzIctjalvmrO3Nlq1enl3_Jh8dwsvfOWUgjpLzlxorDJkZDdUTNQTwT8hajIg0vMZZX1REBFebBtEyY0_HYBkZ_phnub_AEmLwzpWG0ZntKoogGMnPtlSVVpiCID6ylWf1hrk6KC1JYS6MAN5zYqA2GSzMVD7PNK7A5_Tj787tkirasKwU8Veoy8wNi4mWfO3dBqDQ66E6nRnaYmV7ZNeooihTZWbamgUDATTN7HqJdw-LDDNXOOmTaHKYNfFijR4\",\n \"refresh_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MjAyNDY5OTQsImp0aSI6IjNmYmEyODU0LTlhNTYtNGQ2YS1iNjZmLTcyODExNTVmYjk2YSIsInVzZXJfZGV0YWlscyI6eyJUZW5hbnRJRCI6IjEiLCJVc2VySUQiOiIxIiwiVXNlck5hbWUiOiJBZGFyc2gifSwidG9rZW5fdHlwZSI6IlJlZnJlc2gifQ.Jvu2CVaduaXJ-U_FuH1qU0LVSxWRCgBjRUgR1-rSXttKtcy8P9dsQX5HXuox3I0CT0io49t9lc0svRP32z4xDDBpWwSo27MBltuJoff73ug7Wtp00Pq1pXZqjvawR7lDPlyq0z_f-TG6PGGpaoCkPAreBwscT4FR0XCG7laQam9atqol3atO9pJa7jErd6j-EFgiGgRnujJbwgMm1o85JKPBcXETfjIbU5klGkSdaawkqVhih3RpL4hr9a2f0_14sbjp7o4Ic1K-OLU92F5hEIKrKnShsNgnujIZUrWUT5E1WmHkSUFlYUnp7RiJRezuLlR9GHtOwYtkLTVfDzeV1T4XlsUSRvW6pD4WfFZ7oMcGhGwbQAS7kAdcDNrIFBwp0QBooiGm57uNZKjpTK2PWZPFbdKVlkMf5bupx4Qv1MpA_B4HYm2aZdfMB3h9lyXcOX0COzqOB1AVXXjMhWQG_oQG5ahnA_ezVEovmw92TuicpD0P5_kMHrWeFExIOG60FWuPmfoigg7j5puKLJkv6Oj2ORclUTk60_Y_G4GGXX60YBxpffh7zkT0R93xXOxgn2XOSqzdXSdPGGrqgYw8GULgcJGGiT0HKFCrcwyMt_OJ2SozJ2J4l8PEOSWAMvRq0Y9dhf2LKcSWq3222zUaU6rGtBFvU7Yuh55MqiRfD9o\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 2592000000000000\n },\n \"meta\": null\n}"}],"_postman_id":"24e3d10c-acc7-4a3f-aded-013ca3a60a12"}],"id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d","description":"

📌 Introduction to Tenant APIs

Overview

Omniful introduces Tenant APIs, enabling users to create custom integrations that operate at the tenant level instead of the seller level. These APIs will provide you with a centralized way to manage operations across multiple sellers, and ensure seamless automation and control at a higher organizational level.

🔹 Key Benefits

Scalability → You can now perform operations across all sellers under a single tenant.
\n
Centralized Management → Manage configurations, workflows, and data at the tenant level for all your sellers.
\n
Seamless Integrations → Develop custom applications using Omniful APIs that extend Omniful’s functionality to your software.
\n

🔹 What Can You Do with Tenant-Level APIs?

Create and manage tenant-wide integrations.
\n
Gain insights into aggregated analytics and reporting.
\n

With Tenant-Level APIs, users gain greater control, flexibility, and efficiency in managing their operations within Omniful.

Getting Started with Tenant Custom Integration

First, you need to have Tenant Custom Integration created in your Omniful dashboard.

Log in to your Omniful dashboard.
\n
Navigate to: Settings → Apps & Integrations → Custom Apps → Tenant Custom Integration
\n
Simply click the Integrate / View details button.
\n

Note: Enabling tenant custom integration is a permanent action and cannot be reversed once completed.

Note: For all operations in the KSA region, the national_address_code field must be included inside every request’s address object. This is mandatory across all APIs in this folder.

Post-Integration Access

After successful integration, you’ll get access to the following in three consecutive tabs within the Omniful dashboard:

Configuration : Manage authentication credentials and essential integration settings.
\n
Hub Mappings : Select which hubs are enabled or disabled for this integration.
\n
Order Status Mappings : Enable or disable order statuses that should trigger webhooks.
\n

⚡ Rate Limiting

To ensure fair usage and performance stability, Omniful APIs have a default rate limit of:

✅ 120 requests per minute

📌 Exceeding the limit may result in temporary API restrictions.

Refer to the API documentation below for detailed endpoints and usage guidelines. 🚀

⚠️ Error Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Error Code	Description
400	BadRequest / InvalidRequest	Invalid path parameters, query parameters or body.
401	Unauthorized	Missing or invalid authentication token
403	Forbidden	You are not authorized to perform this action
429	TooManyRequests	Rate limit exceeded
500	InternalServerError	Internal server error

","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"41a54f0d-53e8-40b3-8578-a6baad308dbc","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"17d101d0-8e93-479e-b7ab-8edf1ed2ccfc","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"761c6285-18b6-4e83-ba05-b081b8c9dc2d"},{"name":"TMS","item":[{"name":"Shipments","item":[{"name":"Create Shipment","id":"26971101-83ce-45cd-a998-9ead80281906","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ORD-2024-101\",\n \"seller_reference_id\": \"Display-Order-ID\",\n \"seller_hub_code\": \"seamlessretail\",\n \"customer_info\": {\n \"name\": \"John Doe\",\n \"code\": \"CUST001\",\n \"email\": \"john.doe@example.com\",\n \"country_code\": \"SA\",\n \"phone\": \"501234567\",\n \"address\": {\n \"code\": \"ADDR001\",\n \"address_line_1\": \"123 Business Street\",\n \"address_line_2\": \"Suite 100\",\n \"city\": \"Dubai\",\n \"state\": \"Dubai\",\n \"country\": \"United Arab Emirates\",\n \"country_code\": \"AE\",\n \"city_id\": \"city_001\",\n \"state_id\": \"state_001\",\n \"country_id\": \"country_001\",\n \"postal_code\": \"12345\",\n \"latitude\": 25.2048,\n \"longitude\": 55.2708,\n \"national_address_code\": \"new_code\"\n }\n },\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"product_type\": \"physical_product\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"handling_granularity\": \"package\",\n \"shipment_type\": \"forward\",\n \"delivery_preference\": {\n \"delivery_date\": \"2025-12-30T00:00:00Z\",\n \"start_time\": \"2025-12-30T09:00:00Z\",\n \"end_time\": \"2025-12-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"sales_channel_info\": {\n \"seller_sales_channel_id\": \"channel_001\",\n \"sales_channel\": {\n \"id\": \"amazon_ae\",\n \"tag\": \"amazon\",\n \"name\": \"Amazon UAE\",\n \"category\": \"marketplace\",\n \"logo_url\": \"https://example.com/amazon-logo.png\",\n \"link\": \"https://amazon.ae\",\n \"store_name\": \"Amazon UAE Store\"\n }\n },\n \"packages\": [\n {\n \"reference_id\": \"PKG-001\",\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"packaging_info\": {\n \"length\": 30.0,\n \"height\": 20.0,\n \"width\": 25.0,\n \"weight\": 2.5,\n \"volume\": 15000.0\n },\n \"items\": [\n {\n \"item_id\": \"item_001\",\n \"sku\": {\n \"id\": \"sku_001\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"code\": \"WH-001\",\n \"description\": \"High-quality wireless headphones with noise cancellation\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\",\n \"https://example.com/headphones-2.jpg\"\n ],\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"weight\": 0.5,\n \"currency\": \"AED\",\n \"selling_price\": 150.0\n },\n \"quantity\": 1,\n \"return_reason\": \"\",\n \"note\": \"\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\"\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments","description":"

📦 Shipment API Documentation

📌 Create Shipment– Overview

The Create Shipment API allows users to initiate and register a new shipment for an order or set of packages. This API enables sellers, logistics partners, and system integrators to define shipment details such as pickup location, delivery destination, package dimensions, product information, and service type.

It is useful for automating the shipping process, ensuring accurate order fulfillment, and integrating with logistics partners for real-time tracking. This API streamlines operational workflows by enabling batch creation of shipments, reducing manual effort, and ensuring shipments are ready for pickup or delivery according to business requirements.

Shipment Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
reference_id	string	A unique identifier for the shipment in your system. Used to map to the related order.	Required
seller_hub_code	string	Code of the hub/warehouse from which the shipment will be dispatched. Must match a valid hub.	Conditional (else seller_hub_info is requried)
seller_hub_info	struct	Information of the seller hub for which shipment need to be created, hub either can exists or will be created	Conditional (else seller_hub_code is requried)
product_type	string	Type of product being shipped (`physical_product`, `customer_service`).	Required
service_type	string	Type of logistics service (`standard`, `express`, `scheduled`).	Required
shipment_type	string	Indicates the shipment direction (`forward`, `reverse`).	Required
pickup_type	string	Defines how shipment is picked up (`pickup_by_logistics`, `pickup_by_party`).	Required
delivery_type	string	Defines how shipment is delivered (`delivery_by_logistics`, `pickup_by_party`).	Required
handling_granularity	string	Shipment handling granularity (`package`, `item`).	Required
payment_info	object	Payment and declared value information for the shipment.	Optional
customer_info	object	Details about the receiver of the shipment.	Required
delivery_preference	object	Delivery preference details.	Optional
sales_channel_info	object	Details about the seller/shipper’s sales channel.	Optional
packages	array	List of packages included in the shipment.	Required

Payment Info (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required / Conditional
currency	string	Three-letter ISO currency code (e.g., `SAR`, `USD`).	Conditional
payment_type	string	Payment method (`prepaid`, `postpaid`).	Conditional
declared_value	number	Value declared for insurance and customs.	Conditional
total_due	number	Shipping fee charged to the customer (if any).	Conditional
total_paid	number	Cash-on-delivery amount (if `payment_type = postpaid`).	Conditional

Customer Info (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required / Conditional
code	string	Unique identifier of the customer.	Optional
name	string	Full name of the customer.	Optional
email	string	Customer’s email address.	Conditional
phone	string	Customer’s phone number for delivery updates.	Conditional
country_code	string	ISO 2-letter country code (e.g., `SA`, `AE`).	Conditional
address	object	Full delivery address (street, building, landmarks).	Optional

Seller Hub Info (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
name	string	Name of the seller hub.	Required
hub_code	string	Unique identifier for the hub.	Required
email	string	Email address of the hub contact.	Optional
phone	string	Contact phone number of the hub.	Required
country_calling_code	string	International calling code of the phone number.	Required
address	object	Address details of the seller hub.	Required

Address (object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
code	string	Unique identifier of the address.	Optional
address_line_1	string	First line of the delivery address (e.g., street, building).	Required
address_line_2	string	Second line (apartment, suite, etc.).	Optional
city	string	City of the delivery address.	Conditional
state	string	State/province of the delivery address.	Optional
postal_code	string	Postal/ZIP code.	Optional
country	string	Country (ISO standard).	Conditional
country_code	string	ISO 2-letter country code of the address.	Conditional
city_id	string	Internal reference ID for the city.	Conditional
state_id	string	Internal reference ID for the state.	Optional
country_id	string	Internal reference ID for the country.	Conditional
latitude	number	Latitude coordinate.	Optional
longitude	number	Longitude coordinate.	Optional

Validation Rules

Provide either city_id OR city.
\n
Provide one of the following for country: country_id OR country_code OR country.
\n

Note

latitude and longitude are optional but recommended for better address visibility and accurate location mapping.

Delivery Preference (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
delivery_date	string	Preferred delivery date.	Optional
start_time	string	Preferred delivery window start time.	Optional
end_time	string	Preferred delivery window end time.	Optional
delivery_instruction	string	Special instructions for delivery.	Optional

Sales Channel Info (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
seller_sales_channel_id	string	Unique identifier of the seller.	Optional
sales_channel	object	Sales channel/store information.	Optional
sales_channel.id	string	Unique ID of the sales channel.	Optional
sales_channel.tag	string	Short code/tag of the sales channel.	Optional
sales_channel.name	string	Name of the sales channel/store.	Optional
sales_channel.category	string	Category (`marketplace`, `retail`, etc.).	Optional
sales_channel.logo_url	string	Logo of the sales channel (URL).	Optional
sales_channel.link	string	Store URL.	Optional
sales_channel.store_name	string	Store name in the sales channel.	Optional

Packages (Array)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
reference_id	string	Unique identifier of the package.	Optional
payment_info	object	Payment info specific to this package.	Required
packaging_info	object	Dimensions and weight of the package.	Required
items	array	List of items inside the package.	Optional

Package Payment Info

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
currency	string	ISO currency code (e.g., `SAR`, `USD`).	Required
payment_type	string	Payment method (`prepaid`, `postpaid`).	Required
declared_value	number	Declared value of the package (> 0).	Required
total_due	number	Shipping fee charged for the package.	Optional
total_paid	number	COD amount for the package.	Optional

Packaging Info

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
weight	number	Package weight (kg).	Required
length	number	Package length (cm).	Optional
width	number	Package width (cm).	Optional
height	number	Package height (cm).	Optional
volume	number	Package volume (cc³).	Optional

Items (Array)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required / Conditional
item_id	string	Unique identifier of the item.	Conditional
sku	object	SKU details of the product.	Optional
quantity	integer	Quantity of the item inside the package.	Conditional
return_reason	string	Reason for return (if return shipment).	Conditional
note	string	Additional notes about the item.	Optional
image_urls	array	List of image URLs of the item.	Optional

SKU (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required / Conditional
id	string	Unique ID of the SKU.	Conditional
name	string	Name of the product.	Conditional
code	string	SKU code.	Conditional
description	string	Description of the product.	Optional
image_urls	array	List of product image URLs.	Optional
barcodes	array	List of barcodes for the SKU.	Optional
weight	number	Weight of a single unit (kg).	Conditional
currency	string	Currency of the product’s selling price.	Conditional
selling_price	number	Selling price per unit.	Conditional

Enum Explanations

Product Type

physical_product → Tangible item that must be physically shipped, stored, packed, and delivered.
\n
customer_service → A service provided to the customer instead of a physical item.
\n

Service Type

standard → Regular delivery option, cost-effective.
\n
express → Faster delivery option (same day/next day).
\n
scheduled → Delivery happens on a specific date and time slot chosen by the customer.
\n

Shipment Type

forward → Normal flow: seller/warehouse → customer.
\n
reverse → Opposite flow: customer → seller/warehouse (returns, exchanges, recalls).
\n

Pickup Type

pickup_by_logistics → Courier/3PL picks up the shipment from the seller.
\n
pickup_by_party → The seller or customer drops off the shipment themselves.
\n

Delivery Type

delivery_by_logistics → Courier delivers shipment to the customer.
\n
pickup_by_party → Customer or vendor collects the shipment directly.
\n

Handling Granularity

item → Each product/item is tracked and managed individually.
\n
package → The shipment is tracked as a whole package/parcel.
\n

📌 Note:

If handling_granularity = item, then packages object is mandatory, and each package must contain at least one item inside packages.items.

Shipment Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
reference_id	string	A unique identifier for the shipment in your system. Used to map to the related order.	Required
seller_hub_code	string	Code of the hub/warehouse from which the shipment will be dispatched. Must match a valid hub.	Conditional (else seller_hub_info is requried)
seller_hub_info	struct	Information of the seller hub for which shipment need to be created, hub either can exists or will be created	Conditional (else seller_hub_code is requried)
product_type	string	Type of product being shipped (`physical_product`, `customer_service`).	Required
service_type	string	Type of logistics service (`standard`, `express`, `scheduled`).	Required
shipment_type	string	Indicates the shipment direction (`forward`, `reverse`).	Required
pickup_type	string	Defines how shipment is picked up (`pickup_by_logistics`, `pickup_by_party`).	Required
delivery_type	string	Defines how shipment is delivered (`delivery_by_logistics`, `pickup_by_party`).	Required
handling_granularity	string	Shipment handling granularity (`package`, `item`).	Required
payment_info	object	Payment and declared value information for the shipment.	Optional
customer_info	object	Details about the receiver of the shipment.	Required
delivery_preference	object	Delivery preference details.	Optional
sales_channel_info	object	Details about the seller/shipper’s sales channel.	Optional
packages	array	List of packages included in the shipment.	Required

Payment Info (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required / Conditional
currency	string	Three-letter ISO currency code (e.g., `SAR`, `USD`).	Conditional
payment_type	string	Payment method (`prepaid`, `postpaid`).	Conditional
declared_value	number	Value declared for insurance and customs.	Conditional
total_due	number	Shipping fee charged to the customer (if any).	Conditional
total_paid	number	Cash-on-delivery amount (if `payment_type = postpaid`).	Conditional

Customer Info (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required / Conditional
code	string	Unique identifier of the customer.	Optional
name	string	Full name of the customer.	Optional
email	string	Customer’s email address.	Conditional
phone	string	Customer’s phone number for delivery updates.	Conditional
country_code	string	ISO 2-letter country code (e.g., `SA`, `AE`).	Conditional
address	object	Full delivery address (street, building, landmarks).	Optional

Seller Hub Info (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
name	string	Name of the seller hub.	Required
hub_code	string	Unique identifier for the hub.	Required
email	string	Email address of the hub contact.	Optional
phone	string	Contact phone number of the hub.	Required
country_calling_code	string	International calling code of the phone number.	Required
address	object	Address details of the seller hub.	Required

Address (object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
code	string	Unique identifier of the address.	Optional
address_line_1	string	First line of the delivery address (e.g., street, building).	Required
address_line_2	string	Second line (apartment, suite, etc.).	Optional
city	string	City of the delivery address.	Conditional
state	string	State/province of the delivery address.	Optional
postal_code	string	Postal/ZIP code.	Optional
country	string	Country (ISO standard).	Conditional
country_code	string	ISO 2-letter country code of the address.	Conditional
city_id	string	Internal reference ID for the city.	Conditional
state_id	string	Internal reference ID for the state.	Optional
country_id	string	Internal reference ID for the country.	Conditional
latitude	number	Latitude coordinate.	Optional
longitude	number	Longitude coordinate.	Optional

Validation Rules

Provide either city_id OR city.
\n
Provide one of the following for country: country_id OR country_code OR country.
\n

Note

latitude and longitude are optional but recommended for better address visibility and accurate location mapping.

Delivery Preference (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
delivery_date	string	Preferred delivery date.	Optional
start_time	string	Preferred delivery window start time.	Optional
end_time	string	Preferred delivery window end time.	Optional
delivery_instruction	string	Special instructions for delivery.	Optional

Sales Channel Info (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
seller_sales_channel_id	string	Unique identifier of the seller.	Optional
sales_channel	object	Sales channel/store information.	Optional
sales_channel.id	string	Unique ID of the sales channel.	Optional
sales_channel.tag	string	Short code/tag of the sales channel.	Optional
sales_channel.name	string	Name of the sales channel/store.	Optional
sales_channel.category	string	Category (`marketplace`, `retail`, etc.).	Optional
sales_channel.logo_url	string	Logo of the sales channel (URL).	Optional
sales_channel.link	string	Store URL.	Optional
sales_channel.store_name	string	Store name in the sales channel.	Optional

Packages (Array)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
reference_id	string	Unique identifier of the package.	Optional
payment_info	object	Payment info specific to this package.	Required
packaging_info	object	Dimensions and weight of the package.	Required
items	array	List of items inside the package.	Optional

Package Payment Info

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
currency	string	ISO currency code (e.g., `SAR`, `USD`).	Required
payment_type	string	Payment method (`prepaid`, `postpaid`).	Required
declared_value	number	Declared value of the package (> 0).	Required
total_due	number	Shipping fee charged for the package.	Optional
total_paid	number	COD amount for the package.	Optional

Packaging Info

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required
weight	number	Package weight (kg).	Required
length	number	Package length (cm).	Optional
width	number	Package width (cm).	Optional
height	number	Package height (cm).	Optional
volume	number	Package volume (cc³).	Optional

Items (Array)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required / Conditional
item_id	string	Unique identifier of the item.	Conditional
sku	object	SKU details of the product.	Optional
quantity	integer	Quantity of the item inside the package.	Conditional
return_reason	string	Reason for return (if return shipment).	Conditional
note	string	Additional notes about the item.	Optional
image_urls	array	List of image URLs of the item.	Optional

SKU (Object)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Description	Required / Conditional
id	string	Unique ID of the SKU.	Conditional
name	string	Name of the product.	Conditional
code	string	SKU code.	Conditional
description	string	Description of the product.	Optional
image_urls	array	List of product image URLs.	Optional
barcodes	array	List of barcodes for the SKU.	Optional
weight	number	Weight of a single unit (kg).	Conditional
currency	string	Currency of the product’s selling price.	Conditional
selling_price	number	Selling price per unit.	Conditional

Enum Explanations

Product Type

physical_product → Tangible item that must be physically shipped, stored, packed, and delivered.
\n
customer_service → A service provided to the customer instead of a physical item.
\n

Service Type

standard → Regular delivery option, cost-effective.
\n
express → Faster delivery option (same day/next day).
\n
scheduled → Delivery happens on a specific date and time slot chosen by the customer.
\n

Shipment Type

forward → Normal flow: seller/warehouse → customer.
\n
reverse → Opposite flow: customer → seller/warehouse (returns, exchanges, recalls).
\n

Pickup Type

pickup_by_logistics → Courier/3PL picks up the shipment from the seller.
\n
pickup_by_party → The seller or customer drops off the shipment themselves.
\n

Delivery Type

delivery_by_logistics → Courier delivers shipment to the customer.
\n
pickup_by_party → Customer or vendor collects the shipment directly.
\n

Handling Granularity

item → Each product/item is tracked and managed individually.
\n
package → The shipment is tracked as a whole package/parcel.
\n

📌 Note:

If handling_granularity = item, then packages object is mandatory, and each package must contain at least one item inside packages.items.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["sales-channel","public","v2","tms","shipments"],"host":["prodapi","omniful","com"],"query":[],"variable":[]}},"response":[{"id":"d5d30b01-0a62-444e-95d9-ce602466230e","name":"Create Shipment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ORD-2024-101\",\n \"seller_reference_id\": \"Display-Order-ID\",\n \"seller_hub_code\": \"seamlessretail\",\n \"customer_info\": {\n \"name\": \"John Doe\",\n \"code\": \"CUST001\",\n \"email\": \"john.doe@example.com\",\n \"country_code\": \"SA\",\n \"phone\": \"501234567\",\n \"address\": {\n \"code\": \"ADDR001\",\n \"address_line_1\": \"123 Business Street\",\n \"address_line_2\": \"Suite 100\",\n \"city\": \"Dubai\",\n \"state\": \"Dubai\",\n \"country\": \"United Arab Emirates\",\n \"country_code\": \"AE\",\n \"city_id\": \"city_001\",\n \"state_id\": \"state_001\",\n \"country_id\": \"country_001\",\n \"postal_code\": \"12345\",\n \"latitude\": 25.2048,\n \"longitude\": 55.2708,\n \"national_address_code\": \"new_code\"\n }\n },\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"product_type\": \"physical_product\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"handling_granularity\": \"package\",\n \"shipment_type\": \"forward\",\n \"delivery_preference\": {\n \"delivery_date\": \"2025-12-30T00:00:00Z\",\n \"start_time\": \"2025-12-30T09:00:00Z\",\n \"end_time\": \"2025-12-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"sales_channel_info\": {\n \"seller_sales_channel_id\": \"channel_001\",\n \"sales_channel\": {\n \"id\": \"amazon_ae\",\n \"tag\": \"amazon\",\n \"name\": \"Amazon UAE\",\n \"category\": \"marketplace\",\n \"logo_url\": \"https://example.com/amazon-logo.png\",\n \"link\": \"https://amazon.ae\",\n \"store_name\": \"Amazon UAE Store\"\n }\n },\n \"packages\": [\n {\n \"reference_id\": \"PKG-001\",\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"packaging_info\": {\n \"length\": 30.0,\n \"height\": 20.0,\n \"width\": 25.0,\n \"weight\": 2.5,\n \"volume\": 15000.0\n },\n \"items\": [\n {\n \"item_id\": \"item_001\",\n \"sku\": {\n \"id\": \"sku_001\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"code\": \"WH-001\",\n \"description\": \"High-quality wireless headphones with noise cancellation\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\",\n \"https://example.com/headphones-2.jpg\"\n ],\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"weight\": 0.5,\n \"currency\": \"AED\",\n \"selling_price\": 150.0\n },\n \"quantity\": 1,\n \"return_reason\": \"\",\n \"note\": \"\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\"\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 22 Dec 2025 07:55:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"1b11ae84-b666-462e-9fe0-1db9e0c9ec1b"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9b1e0e4d0856d6ec-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"shipment\": {\n \"id\": \"6948f96314d01bd97cb39b00\",\n \"awb_number\": \"TMS-0F822612\",\n \"awb_label\": \"\",\n \"reference_id\": \"ORD-2024-101\",\n \"seller_reference_id\": \"Display-Order-ID\",\n \"tracking_number\": \"\",\n \"seller_info\": {\n \"name\": \"21\",\n \"code\": \"12\",\n \"email\": \"mohammad.noor@omniful.ai\"\n },\n \"status\": \"on_hold\",\n \"source\": \"sales_channel\",\n \"seller_hub\": {\n \"name\": \"000Retail Store Riyadh\",\n \"code\": \"seamlessretail\",\n \"address\": {\n \"code\": \"\",\n \"address_line_1\": \"New\",\n \"address_line_2\": \"As Sulimaniyah\",\n \"city\": \"Riyadh\",\n \"state\": \"Riyadh Region\",\n \"country\": \"Saudi Arabia\",\n \"country_code\": \"SA\",\n \"city_id\": \"7570\",\n \"state_id\": \"92\",\n \"country_id\": \"8\",\n \"postal_code\": \"12212\",\n \"latitude\": 24.692344,\n \"longitude\": 46.6844178,\n \"national_address_code\": \"\"\n }\n },\n \"customer_info\": {\n \"name\": \"John Doe\",\n \"code\": \"CUST001\",\n \"email\": \"john.doe@example.com\",\n \"country_code\": \"SA\",\n \"phone\": \"501234567\",\n \"address\": {\n \"code\": \"ADDR001\",\n \"address_line_1\": \"123 Business Street\",\n \"address_line_2\": \"Suite 100\",\n \"city\": \"Dubai\",\n \"state\": \"Dubai\",\n \"country\": \"Saudi Arabia\",\n \"country_code\": \"SA\",\n \"city_id\": \"city_001\",\n \"state_id\": \"state_001\",\n \"country_id\": \"8\",\n \"postal_code\": \"12345\",\n \"latitude\": 25.2048,\n \"longitude\": 55.2708,\n \"national_address_code\": \"\"\n }\n },\n \"product_type\": \"physical_product\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"custom_labels\": null,\n \"handling_granularity\": \"package\",\n \"shipment_type\": \"forward\",\n \"invoice_details\": {\n \"invoice_number\": \"\"\n },\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150,\n \"total_due\": 0,\n \"total_paid\": 150\n },\n \"details\": {\n \"total_weight\": 2.5,\n \"actual_weight\": 0,\n \"number_of_packages\": 1\n },\n \"tracking_history\": [\n {\n \"status\": \"new\",\n \"event_time\": \"2025-12-22T07:55:15.429198155Z\",\n \"description\": \"Shipment Created\"\n }\n ],\n \"tracking_url\": \"https://demo.beta.omniful.com/tms/v2/shipments/tracking/TMS-0F822612\",\n \"delivery_preference\": {\n \"delivery_date\": \"0001-01-01T00:00:00Z\",\n \"start_time\": \"0001-01-01T00:00:00Z\",\n \"end_time\": \"0001-01-01T00:00:00Z\",\n \"delivery_instruction\": \"\"\n },\n \"delivered_at\": \"0001-01-01T00:00:00Z\",\n \"on_hold_reasons\": [\n \"invalid_customer_address\",\n \"no_pickup_hub_found\",\n \"no_delivery_hub_found\"\n ],\n \"shipment_created_at\": \"2025-12-22T07:55:15.471278731Z\",\n \"packages\": [\n {\n \"reference_id\": \"PKG-001\",\n \"shipment_reference_id\": \"ORD-2024-101\",\n \"pickup_hub\": null,\n \"delivery_hub\": null,\n \"status\": \"on_hold\",\n \"handling_tags\": null,\n \"awb_number\": \"TMS-0F822612-1\",\n \"awb_label\": \"\",\n \"pickup_code\": \"7386\",\n \"delivery_code\": \"4574\",\n \"shipment_type\": \"forward\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"transaction_details\": null,\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150,\n \"total_due\": 0,\n \"total_paid\": 150\n },\n \"delivery_slot_info\": null,\n \"delivery_slots\": null,\n \"reattempted_details\": null,\n \"sender_info\": null,\n \"recipient_info\": null,\n \"packaging_info\": {\n \"length\": 30,\n \"height\": 20,\n \"width\": 25,\n \"weight\": 2.5,\n \"volume\": 15000\n },\n \"origin_stop\": null,\n \"current_stop\": null,\n \"next_stop\": null,\n \"destination_stop\": null,\n \"tags\": null,\n \"handling_granularity\": \"package\",\n \"items\": [\n {\n \"batch_number\": \"\",\n \"item_id\": \"\",\n \"reference_id\": \"item_001\",\n \"sku\": {\n \"id\": \"sku_001\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"code\": \"WH-001\",\n \"description\": \"High-quality wireless headphones with noise cancellation\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\",\n \"https://example.com/headphones-2.jpg\"\n ],\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"weight\": 0.5,\n \"currency\": \"AED\",\n \"selling_price\": 150\n },\n \"quantity\": 1,\n \"return_reason\": \"\",\n \"partial_return_reason\": \"\",\n \"partial_delivery_reason\": \"\",\n \"note\": \"\",\n \"expiry_date\": \"0001-01-01T00:00:00Z\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\"\n ]\n }\n ],\n \"delivery_preference\": {\n \"delivery_date\": \"2025-12-30T00:00:00Z\",\n \"start_time\": \"2025-12-30T09:00:00Z\",\n \"end_time\": \"2025-12-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"approved_at\": \"0001-01-01T00:00:00Z\",\n \"approved_by\": null\n }\n ]\n }\n },\n \"meta\": null\n}"},{"id":"7e18d98a-ca5a-41de-bc2f-b27b22661b7c","name":"Failed Example 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ORD-2024-001\",\n \"seller_hub_code\": \"3pl1\",\n \"customer_info\": {\n \"name\": \"John Doe\",\n \"code\": \"CUST001\",\n \"email\": \"john.doe@example.com\",\n \"country_code\": \"SA\",\n \"phone\": \"501234567\",\n \"address\": {\n \"code\": \"ADDR001\",\n \"address_line_1\": \"123 Business Street\",\n \"address_line_2\": \"Suite 100\",\n \"city\": \"Dubai\",\n \"state\": \"Dubai\",\n \"country\": \"United Arab Emirates\",\n \"country_code\": \"AE\",\n \"city_id\": \"city_001\",\n \"state_id\": \"state_001\",\n \"country_id\": \"country_001\",\n \"postal_code\": \"12345\",\n \"latitude\": 25.2048,\n \"longitude\": 55.2708,\n \"national_address_code\": \"new_code\"\n }\n },\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"product_type\": \"physical_product\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"handling_granularity\": \"package\",\n \"shipment_type\": \"forward\",\n \"delivery_preference\": {\n \"delivery_date\": \"2025-09-30T00:00:00Z\",\n \"start_time\": \"2025-09-30T09:00:00Z\",\n \"end_time\": \"2025-09-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"sales_channel_info\": {\n \"seller_sales_channel_id\": \"channel_001\",\n \"sales_channel\": {\n \"id\": \"amazon_ae\",\n \"tag\": \"amazon\",\n \"name\": \"Amazon UAE\",\n \"category\": \"marketplace\",\n \"logo_url\": \"https://example.com/amazon-logo.png\",\n \"link\": \"https://amazon.ae\",\n \"store_name\": \"Amazon UAE Store\"\n }\n },\n \"packages\": [\n {\n \"reference_id\": \"PKG-001\",\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"packaging_info\": {\n \"length\": 30.0,\n \"height\": 20.0,\n \"width\": 25.0,\n \"weight\": 2.5,\n \"volume\": 15000.0\n },\n \"items\": [\n {\n \"item_id\": \"item_001\",\n \"sku\": {\n \"id\": \"sku_001\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"code\": \"WH-001\",\n \"description\": \"High-quality wireless headphones with noise cancellation\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\",\n \"https://example.com/headphones-2.jpg\"\n ],\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"weight\": 0.5,\n \"currency\": \"AED\",\n \"selling_price\": 150.0\n },\n \"quantity\": 1,\n \"return_reason\": \"\",\n \"note\": \"\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\"\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 26 Sep 2025 06:33:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"333"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"58d2fdc1-03cf-4ee4-ae59-76164c01ee7a"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9850baddbfac8aeb-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"failed to create shipments: bulk write exception: write errors: [E11000 duplicate key error collection: transport_shipping_service_db.shipments index: tenant_id_1_seller_id_1_reference_id_1 dup key: { tenant_id: \\\"3\\\", seller_id: \\\"117\\\", reference_id: \\\"ORD-2024-001\\\" }]\"\n }\n}"},{"id":"32b4833c-5f77-4ec8-b006-4a6b9dd222d1","name":"Failed Example 2","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ORD-2024-101\",\n \"seller_hub_code\": \"3pl2\",\n \"customer_info\": {\n \"name\": \"John Doe\",\n \"code\": \"CUST001\",\n \"email\": \"john.doe@example.com\",\n \"country_code\": \"SA\",\n \"phone\": \"501234567\",\n \"address\": {\n \"code\": \"ADDR001\",\n \"address_line_1\": \"123 Business Street\",\n \"address_line_2\": \"Suite 100\",\n \"city\": \"Dubai\",\n \"state\": \"Dubai\",\n \"country\": \"United Arab Emirates\",\n \"country_code\": \"AE\",\n \"city_id\": \"city_001\",\n \"state_id\": \"state_001\",\n \"country_id\": \"country_001\",\n \"postal_code\": \"12345\",\n \"latitude\": 25.2048,\n \"longitude\": 55.2708,\n \"national_address_code\": \"new_code\"\n }\n },\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"product_type\": \"physical_product\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"handling_granularity\": \"package\",\n \"shipment_type\": \"forward\",\n \"delivery_preference\": {\n \"delivery_date\": \"2025-09-30T00:00:00Z\",\n \"start_time\": \"2025-09-30T09:00:00Z\",\n \"end_time\": \"2025-09-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"sales_channel_info\": {\n \"seller_sales_channel_id\": \"channel_001\",\n \"sales_channel\": {\n \"id\": \"amazon_ae\",\n \"tag\": \"amazon\",\n \"name\": \"Amazon UAE\",\n \"category\": \"marketplace\",\n \"logo_url\": \"https://example.com/amazon-logo.png\",\n \"link\": \"https://amazon.ae\",\n \"store_name\": \"Amazon UAE Store\"\n }\n },\n \"packages\": [\n {\n \"reference_id\": \"PKG-001\",\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"packaging_info\": {\n \"length\": 30.0,\n \"height\": 20.0,\n \"width\": 25.0,\n \"weight\": 2.5,\n \"volume\": 15000.0\n },\n \"items\": [\n {\n \"item_id\": \"item_001\",\n \"sku\": {\n \"id\": \"sku_001\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"code\": \"WH-001\",\n \"description\": \"High-quality wireless headphones with noise cancellation\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\",\n \"https://example.com/headphones-2.jpg\"\n ],\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"weight\": 0.5,\n \"currency\": \"AED\",\n \"selling_price\": 150.0\n },\n \"quantity\": 1,\n \"return_reason\": \"\",\n \"note\": \"\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\"\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 26 Sep 2025 06:34:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"79"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"c650abb6-2feb-4679-891c-849b2d21111f"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9850bc04ab588aeb-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"invalid seller hub\"\n }\n}"},{"id":"14232c50-7b88-466d-9de1-d62bbd578e33","name":"Failed Example 3","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ORD-2024-101\",\n \"seller_hub_code\": \"3pl1\",\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"product_type\": \"physical_product\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"handling_granularity\": \"package\",\n \"shipment_type\": \"forward\",\n \"delivery_preference\": {\n \"delivery_date\": \"2025-09-30T00:00:00Z\",\n \"start_time\": \"2025-09-30T09:00:00Z\",\n \"end_time\": \"2025-09-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"sales_channel_info\": {\n \"seller_sales_channel_id\": \"channel_001\",\n \"sales_channel\": {\n \"id\": \"amazon_ae\",\n \"tag\": \"amazon\",\n \"name\": \"Amazon UAE\",\n \"category\": \"marketplace\",\n \"logo_url\": \"https://example.com/amazon-logo.png\",\n \"link\": \"https://amazon.ae\",\n \"store_name\": \"Amazon UAE Store\"\n }\n },\n \"packages\": [\n {\n \"reference_id\": \"PKG-001\",\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"packaging_info\": {\n \"length\": 30.0,\n \"height\": 20.0,\n \"width\": 25.0,\n \"weight\": 2.5,\n \"volume\": 15000.0\n },\n \"items\": [\n {\n \"item_id\": \"item_001\",\n \"sku\": {\n \"id\": \"sku_001\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"code\": \"WH-001\",\n \"description\": \"High-quality wireless headphones with noise cancellation\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\",\n \"https://example.com/headphones-2.jpg\"\n ],\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"weight\": 0.5,\n \"currency\": \"AED\",\n \"selling_price\": 150.0\n },\n \"quantity\": 1,\n \"return_reason\": \"\",\n \"note\": \"\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\"\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 26 Sep 2025 06:34:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"87"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"df2b0864-2388-4776-9892-8b43c26dce5b"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9850bd05b8c48aeb-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"phone or email is required\"\n }\n}"},{"id":"91ab3113-845a-4f2d-9035-c0be451ccfd5","name":"Failed Example 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"ORD-2024-101\",\n \"seller_hub_code\": \"3pl1\",\n \"customer_info\": {\n \"name\": \"John Doe\",\n \"code\": \"CUST001\",\n \"email\": \"john.doe@example.com\",\n \"country_code\": \"SA\",\n \"phone\": \"501234567\",\n \"address\": {\n \"code\": \"ADDR001\",\n \"address_line_1\": \"123 Business Street\",\n \"address_line_2\": \"Suite 100\",\n \"city\": \"Dubai\",\n \"state\": \"Dubai\",\n \"country\": \"United Arab Emirates\",\n \"country_code\": \"AE\",\n \"city_id\": \"city_001\",\n \"state_id\": \"state_001\",\n \"country_id\": \"country_001\",\n \"postal_code\": \"12345\",\n \"latitude\": 25.2048,\n \"longitude\": 55.2708,\n \"national_address_code\": \"new_code\"\n }\n },\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"product_type\": \"physical_product\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"handling_granularity\": \"package\",\n \"shipment_type\": \"forward\",\n \"delivery_preference\": {\n \"delivery_date\": \"2025-09-30T00:00:00Z\",\n \"start_time\": \"2025-09-30T09:00:00Z\",\n \"end_time\": \"2025-09-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"sales_channel_info\": {\n \"seller_sales_channel_id\": \"channel_001\",\n \"sales_channel\": {\n \"id\": \"amazon_ae\",\n \"tag\": \"amazon\",\n \"name\": \"Amazon UAE\",\n \"category\": \"marketplace\",\n \"logo_url\": \"https://example.com/amazon-logo.png\",\n \"link\": \"https://amazon.ae\",\n \"store_name\": \"Amazon UAE Store\"\n }\n },\n \"packages\": [\n {\n \"reference_id\": \"PKG-001\",\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150.0,\n \"total_due\": 0.0,\n \"total_paid\": 150.0\n },\n \"packaging_info\": {\n \"length\": 30.0,\n \"height\": 20.0,\n \"width\": 25.0,\n \"weight\": 2.5,\n \"volume\": 15000.0\n },\n \"items\": [\n {\n \"item_id\": \"item_001\",\n \"sku\": {\n \"id\": \"sku_001\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"code\": \"WH-001\",\n \"description\": \"High-quality wireless headphones with noise cancellation\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\",\n \"https://example.com/headphones-2.jpg\"\n ],\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"weight\": 0.5,\n \"currency\": \"AED\",\n \"selling_price\": 150.0\n },\n \"quantity\": 1,\n \"return_reason\": \"\",\n \"note\": \"\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\"\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 26 Sep 2025 11:19:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"88"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"9dc7a78f-4216-4697-99fa-b1fa8558258b"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"98525e070d3087a7-SIN"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"reference id already exists\"\n }\n}"}],"_postman_id":"26971101-83ce-45cd-a998-9ead80281906"},{"name":"Get Shipment","id":"2edfcf28-aaa3-43e4-a45a-7331345d1ddf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"url":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments/:shipment_id","description":"

📌 Fetch Shipment by Shipment ID– Overview

The Fetch Shipment by Shipment ID API delivers complete shipment details using the system-generated Shipment ID. This API ensures accurate retrieval of shipment records directly tied to the internal database.

Response Body Format

Field	Data Type	Description
is_success	boolean	Indicates if the request was successful.
status_code	number	HTTP status code of the response.
data.shipment.id	string	Unique shipment identifier.
data.shipment.awb_number	string	The Airway Bill number for the shipment.
data.shipment.awb_label	string	The URL for the AWB label.
data.shipment.reference_id	string	The external reference ID for the shipment.
data.shipment.tracking_number	string	Tracking number assigned by the logistics partner.
data.shipment.seller_hub_id	string	ID of the seller's fulfillment hub.
data.shipment.pickup_hub_id	string	ID of the hub where the shipment was picked up.
data.shipment.status	string	Current status of the shipment.
data.shipment.source	string	Source of the shipment (e.g., sales_channel).
data.shipment.seller_customer_id	string	ID of the customer associated with the seller.
data.shipment.product_type	string	Type of product (e.g., physical_product).
data.shipment.service_type	string	Type of delivery service (e.g., standard).
data.shipment.pickup_type	string	Method of pickup (e.g., pickup_by_logistics).
data.shipment.delivery_type	string	Method of delivery (e.g., delivery_by_logistics).
data.shipment.handling_granularity	string	Level of handling (e.g., package).
data.shipment.shipment_type	string	Type of shipment (e.g., forward).
data.shipment.delivered_at	string	Timestamp when the shipment was delivered.
data.shipment.cancel_reason	string	Reason for the shipment's cancellation.
data.shipment.shipment_created_at	string	Timestamp when the shipment was created.
data.shipment.seller_info.name	string	Seller's name.
data.shipment.seller_info.code	string	Seller's unique code.
data.shipment.seller_info.email	string	Seller's email address.
data.shipment.seller_hub.name	string	Seller hub's name.
data.shipment.seller_hub.code	string	Seller hub's code.
data.shipment.seller_hub.address.address_line_1	string	Primary address line of the seller hub.
data.shipment.seller_hub.address.address_line_2	string	Secondary address line of the seller hub.
data.shipment.seller_hub.address.city	string	City of the seller hub.
data.shipment.seller_hub.address.state	string	State/province of the seller hub.
data.shipment.seller_hub.address.country	string	Country of the seller hub.
data.shipment.seller_hub.address.country_code	string	Two-letter country code.
data.shipment.seller_hub.address.postal_code	string	Postal code of the seller hub.
data.shipment.seller_hub.address.latitude	number	Latitude of the seller hub.
data.shipment.seller_hub.address.longitude	number	Longitude of the seller hub.
data.shipment.seller_hub.address.national_address_code	string	National Address Code of the hub.
data.shipment.customer_info.id	string	Unique customer identifier.
data.shipment.customer_info.name	string	Customer's full name.
data.shipment.customer_info.email	string	Customer's email address.
data.shipment.customer_info.country_code	string	Customer's country code.
data.shipment.customer_info.phone	string	Customer's phone number.
data.shipment.customer_info.address.address_line_1	string	Primary address line of the customer.
data.shipment.customer_info.address.address_line_2	string	Secondary address line of the customer.
data.shipment.customer_info.address.city	string	City of the customer.
data.shipment.customer_info.address.state	string	State/province of the customer.
data.shipment.customer_info.address.country	string	Country of the customer.
data.shipment.customer_info.address.country_code	string	Two-letter country code of the customer.
data.shipment.customer_info.address.postal_code	string	Postal code of the customer.
data.shipment.customer_info.address.latitude	number	Latitude of the customer's address.
data.shipment.customer_info.address.longitude	number	Longitude of the customer's address.
data.shipment.customer_info.address.national_address_code	string	National Address Code.
data.shipment.payment_info.currency	string	Currency code.
data.shipment.payment_info.payment_type	string	Payment method (e.g., prepaid).
data.shipment.payment_info.declared_value	number	Declared value of the shipment.
data.shipment.payment_info.total_due	number	Outstanding balance.
data.shipment.payment_info.total_paid	number	Amount paid.
data.shipment.details.total_weight	number	Total estimated weight.
data.shipment.details.actual_weight	number	Actual weight of the shipment.
data.shipment.details.number_of_packages	number	Number of packages in the shipment.
data.shipment.tracking_history[].status	string	Status of a specific tracking event.
data.shipment.tracking_history[].event_time	string	Timestamp of the tracking event.
data.shipment.tracking_history[].description	string	Description of the tracking event.
data.shipment.delivery_preference.delivery_date	string	Preferred delivery date.
data.shipment.delivery_preference.start_time	string	Start of the delivery window.
data.shipment.delivery_preference.end_time	string	End of the delivery window.
data.shipment.delivery_preference.delivery_instruction	string	Special delivery instructions.
data.shipment.delivery_zone_ids[]	array	List of delivery zone IDs.
data.shipment.sales_channel_info.sales_channel.id	string	ID of the sales channel.
data.shipment.sales_channel_info.sales_channel.name	string	Name of the sales channel.
data.shipment.on_hold_reasons[]	array	Reasons why the shipment is on hold.
data.shipment.packages[].reference_id	string	External reference ID for the package.
data.shipment.packages[].status	string	Current status of the package.
data.shipment.packages[].awb_number	string	AWB number for the package.
data.shipment.packages[].packaging_info.length	number	Length of the package in cm.
data.shipment.packages[].packaging_info.height	number	Height of the package in cm.
data.shipment.packages[].packaging_info.width	number	Width of the package in cm.
data.shipment.packages[].packaging_info.weight	number	Weight of the package in kg.
data.shipment.packages[].items[].reference_id	string	External reference ID for the item.
data.shipment.packages[].items[].sku.name	string	Name of the product.
data.shipment.packages[].items[].sku.selling_price	number	Selling price of the product.
data.shipment.packages[].items[].quantity	number	Quantity of the item.

","urlObject":{"protocol":"https","path":["sales-channel","public","v2","tms","shipments",":shipment_id"],"host":["prodapi","omniful","com"],"query":[],"variable":[{"id":"9e8df558-5ed4-41a8-b03a-69939a8fda4f","type":"any","value":"68d394b4ff009461959851e4","key":"shipment_id"}]}},"response":[{"id":"4d3cfa7c-5056-4f24-95ac-863811b5564a","name":"Get Shipment","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments/:shipment_id","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v2","tms","shipments",":shipment_id"],"variable":[{"key":"shipment_id","value":"68d394b4ff009461959851e4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 25 Sep 2025 06:26:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"e2667b1a-f5bb-4eed-98b6-d01a7a1131c9"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"984872d52a7e8ad9-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"shipment\": {\n \"id\": \"68d394b4ff009461959851e4\",\n \"awb_number\": \"FCD-0E01DD85\",\n \"awb_label\": \"\",\n \"reference_id\": \"ORD-2024-001\",\n \"tracking_number\": \"\",\n \"seller_hub_id\": \"68d394abff009461959851e1\",\n \"seller_info\": {\n \"name\": \"3PL Fulfillment 10\",\n \"code\": \"EX-637\",\n \"email\": \"dumy@net.com\"\n },\n \"pickup_hub_id\": \"5000034\",\n \"status\": \"cancelled\",\n \"source\": \"sales_channel\",\n \"seller_hub\": {\n \"name\": \"3pl1 \",\n \"code\": \"3pl1\",\n \"address\": {\n \"code\": \"\",\n \"address_line_1\": \"12\",\n \"address_line_2\": \"ds\",\n \"city\": \"Riyadh\",\n \"state\": \"Riyadh Region\",\n \"country\": \"Saudi Arabia\",\n \"country_code\": \"SA\",\n \"city_id\": \"7570\",\n \"state_id\": \"92\",\n \"country_id\": \"8\",\n \"postal_code\": \"\",\n \"latitude\": 24.7135517,\n \"longitude\": 46.6752957,\n \"national_address_code\": \"\"\n }\n },\n \"seller_customer_id\": \"68d394b4a6206606319c8a5b\",\n \"customer_info\": {\n \"id\": \"68d394b4a6206606319c8a5b\",\n \"name\": \"John Doe \",\n \"code\": \"\",\n \"email\": \"john.doe@example.com\",\n \"country_code\": \"SA\",\n \"phone\": \"501234567\",\n \"address\": {\n \"code\": \"\",\n \"address_line_1\": \"123 Business Street\",\n \"address_line_2\": \"Suite 100\",\n \"city\": \"Dubai\",\n \"state\": \"\",\n \"country\": \"United Arab Emirates\",\n \"country_code\": \"SA\",\n \"city_id\": \"0\",\n \"state_id\": \"0\",\n \"country_id\": \"0\",\n \"postal_code\": \"12345\",\n \"latitude\": 25.2048,\n \"longitude\": 55.2708,\n \"national_address_code\": \"\"\n }\n },\n \"product_type\": \"physical_product\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"handling_granularity\": \"package\",\n \"shipment_type\": \"forward\",\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150,\n \"total_due\": 0,\n \"total_paid\": 150\n },\n \"details\": {\n \"total_weight\": 2.5,\n \"actual_weight\": 0,\n \"number_of_packages\": 1\n },\n \"tracking_history\": [\n {\n \"status\": \"new\",\n \"event_time\": \"2025-09-24T06:50:28.297Z\",\n \"description\": \"Shipment Created\"\n },\n {\n \"status\": \"cancelled\",\n \"event_time\": \"2025-09-24T06:55:20.567Z\",\n \"description\": \"Shipment Cancelled: not required now\"\n }\n ],\n \"delivery_preference\": {\n \"delivery_date\": \"2025-09-30T00:00:00Z\",\n \"start_time\": \"2025-09-30T09:00:00Z\",\n \"end_time\": \"2025-09-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"delivery_zone_ids\": [\n \"68c952b532e39a06acf14d29\"\n ],\n \"sales_channel_info\": {\n \"seller_sales_channel_id\": \"channel_001\",\n \"sales_channel\": {\n \"id\": \"amazon_ae\",\n \"tag\": \"amazon\",\n \"name\": \"Amazon UAE\",\n \"category\": \"marketplace\",\n \"logo_url\": \"https://example.com/amazon-logo.png\",\n \"link\": \"https://amazon.ae\",\n \"store_name\": \"Amazon UAE Store\"\n }\n },\n \"delivered_at\": \"0001-01-01T00:00:00Z\",\n \"on_hold_reasons\": [\n \"no_delivery_hub_found\"\n ],\n \"cancel_reason\": \"not required now\",\n \"shipment_created_at\": \"2025-09-24T06:50:28.332Z\",\n \"packages\": [\n {\n \"reference_id\": \"PKG-001\",\n \"shipment_reference_id\": \"ORD-2024-001\",\n \"pickup_hub\": null,\n \"delivery_hub\": null,\n \"status\": \"cancelled\",\n \"awb_number\": \"FCD-0E01DD85-1\",\n \"awb_label\": \"\",\n \"pickup_code\": \"7714\",\n \"delivery_code\": \"5708\",\n \"shipment_type\": \"forward\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"transaction_details\": null,\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150,\n \"total_due\": 0,\n \"total_paid\": 150\n },\n \"sender_info\": null,\n \"recipient_info\": null,\n \"packaging_info\": {\n \"length\": 30,\n \"height\": 20,\n \"width\": 25,\n \"weight\": 2.5,\n \"volume\": 15000\n },\n \"origin_stop\": null,\n \"current_stop\": null,\n \"next_stop\": null,\n \"destination_stop\": null,\n \"tags\": null,\n \"handling_granularity\": \"package\",\n \"items\": [\n {\n \"id\": \"68d395d8a6496a983c355882\",\n \"item_id\": \"\",\n \"reference_id\": \"item_001\",\n \"sku\": {\n \"id\": \"sku_001\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"code\": \"WH-001\",\n \"description\": \"High-quality wireless headphones with noise cancellation\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\",\n \"https://example.com/headphones-2.jpg\"\n ],\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"weight\": 0.5,\n \"currency\": \"AED\",\n \"selling_price\": 150\n },\n \"quantity\": 1,\n \"return_reason\": \"\",\n \"note\": \"\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\"\n ]\n }\n ],\n \"current_hub_id\": \"\",\n \"delivery_preference\": {\n \"delivery_date\": \"2025-09-30T00:00:00Z\",\n \"start_time\": \"2025-09-30T09:00:00Z\",\n \"end_time\": \"2025-09-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"approved_at\": \"0001-01-01T00:00:00Z\",\n \"approved_by\": null\n }\n ]\n }\n },\n \"meta\": null\n}"},{"id":"943da5ae-6376-418e-adc7-c27f00d831c6","name":"Failed Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments/:shipment_id","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v2","tms","shipments",":shipment_id"],"variable":[{"key":"shipment_id","value":"68d394b4ff009461959851e1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 26 Sep 2025 06:27:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"79"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"7376e102-7170-487e-86c2-82d6d5f25afd"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9850b1b44f9289a2-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"shipment not found\"\n }\n}"}],"_postman_id":"2edfcf28-aaa3-43e4-a45a-7331345d1ddf"},{"name":"Get Shipment by Reference","id":"e23890ab-d66a-4470-af8e-543a2910285d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"url":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments/reference/:reference_id","description":"

📌 Fetch Shipment by Reference ID – Overview

The Fetch Shipment by Reference ID API allows users to retrieve shipment details based on a custom Reference ID assigned during order creation. This method is useful when shipments need to be linked to internal business processes or third-party systems.

\n","urlObject":{"protocol":"https","path":["sales-channel","public","v2","tms","shipments","reference",":reference_id"],"host":["prodapi","omniful","com"],"query":[],"variable":[{"id":"1e1c575e-30a3-460f-913b-20fde07b68ef","type":"any","value":"ORD-2024-001","key":"reference_id"}]}},"response":[{"id":"a821f3ec-ed2e-46a5-be7d-d11422661887","name":"Get Shipment by Reference","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments/reference/:reference_id","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v2","tms","shipments","reference",":reference_id"],"variable":[{"key":"reference_id","value":"ORD-2024-001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 26 Sep 2025 06:24:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"43449280-b41c-481f-8d7d-384ae3b4401c"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9850ae67ad0c1be1-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"shipment\": {\n \"id\": \"68d394b4ff009461959851e4\",\n \"awb_number\": \"FCD-0E01DD85\",\n \"awb_label\": \"\",\n \"reference_id\": \"ORD-2024-001\",\n \"tracking_number\": \"\",\n \"seller_hub_id\": \"68d394abff009461959851e1\",\n \"seller_info\": {\n \"name\": \"3PL Fulfillment 10\",\n \"code\": \"EX-637\",\n \"email\": \"dumy@net.com\"\n },\n \"pickup_hub_id\": \"5000034\",\n \"status\": \"cancelled\",\n \"source\": \"sales_channel\",\n \"seller_hub\": {\n \"name\": \"3pl1 \",\n \"code\": \"3pl1\",\n \"address\": {\n \"code\": \"\",\n \"address_line_1\": \"12\",\n \"address_line_2\": \"ds\",\n \"city\": \"Riyadh\",\n \"state\": \"Riyadh Region\",\n \"country\": \"Saudi Arabia\",\n \"country_code\": \"SA\",\n \"city_id\": \"7570\",\n \"state_id\": \"92\",\n \"country_id\": \"8\",\n \"postal_code\": \"\",\n \"latitude\": 24.7135517,\n \"longitude\": 46.6752957,\n \"national_address_code\": \"\"\n }\n },\n \"seller_customer_id\": \"68d394b4a6206606319c8a5b\",\n \"customer_info\": {\n \"id\": \"68d394b4a6206606319c8a5b\",\n \"name\": \"John Doe \",\n \"code\": \"\",\n \"email\": \"john.doe@example.com\",\n \"country_code\": \"SA\",\n \"phone\": \"501234567\",\n \"address\": {\n \"code\": \"\",\n \"address_line_1\": \"123 Business Street\",\n \"address_line_2\": \"Suite 100\",\n \"city\": \"Dubai\",\n \"state\": \"\",\n \"country\": \"United Arab Emirates\",\n \"country_code\": \"SA\",\n \"city_id\": \"0\",\n \"state_id\": \"0\",\n \"country_id\": \"0\",\n \"postal_code\": \"12345\",\n \"latitude\": 25.2048,\n \"longitude\": 55.2708,\n \"national_address_code\": \"\"\n }\n },\n \"product_type\": \"physical_product\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"handling_granularity\": \"package\",\n \"shipment_type\": \"forward\",\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150,\n \"total_due\": 0,\n \"total_paid\": 150\n },\n \"details\": {\n \"total_weight\": 2.5,\n \"actual_weight\": 0,\n \"number_of_packages\": 1\n },\n \"tracking_history\": [\n {\n \"status\": \"new\",\n \"event_time\": \"2025-09-24T06:50:28.297Z\",\n \"description\": \"Shipment Created\"\n },\n {\n \"status\": \"cancelled\",\n \"event_time\": \"2025-09-24T06:55:20.567Z\",\n \"description\": \"Shipment Cancelled: not required now\"\n }\n ],\n \"delivery_preference\": {\n \"delivery_date\": \"2025-09-30T00:00:00Z\",\n \"start_time\": \"2025-09-30T09:00:00Z\",\n \"end_time\": \"2025-09-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"delivery_zone_ids\": [\n \"68c952b532e39a06acf14d29\"\n ],\n \"sales_channel_info\": {\n \"seller_sales_channel_id\": \"channel_001\",\n \"sales_channel\": {\n \"id\": \"amazon_ae\",\n \"tag\": \"amazon\",\n \"name\": \"Amazon UAE\",\n \"category\": \"marketplace\",\n \"logo_url\": \"https://example.com/amazon-logo.png\",\n \"link\": \"https://amazon.ae\",\n \"store_name\": \"Amazon UAE Store\"\n }\n },\n \"delivered_at\": \"0001-01-01T00:00:00Z\",\n \"on_hold_reasons\": [\n \"no_delivery_hub_found\"\n ],\n \"cancel_reason\": \"not required now\",\n \"shipment_created_at\": \"2025-09-24T06:50:28.332Z\",\n \"packages\": [\n {\n \"reference_id\": \"PKG-001\",\n \"shipment_reference_id\": \"ORD-2024-001\",\n \"pickup_hub\": null,\n \"delivery_hub\": null,\n \"status\": \"cancelled\",\n \"awb_number\": \"FCD-0E01DD85-1\",\n \"awb_label\": \"\",\n \"pickup_code\": \"7714\",\n \"delivery_code\": \"5708\",\n \"shipment_type\": \"forward\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"transaction_details\": null,\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150,\n \"total_due\": 0,\n \"total_paid\": 150\n },\n \"sender_info\": null,\n \"recipient_info\": null,\n \"packaging_info\": {\n \"length\": 30,\n \"height\": 20,\n \"width\": 25,\n \"weight\": 2.5,\n \"volume\": 15000\n },\n \"origin_stop\": null,\n \"current_stop\": null,\n \"next_stop\": null,\n \"destination_stop\": null,\n \"tags\": null,\n \"handling_granularity\": \"package\",\n \"items\": [\n {\n \"id\": \"68d395d8a6496a983c355882\",\n \"item_id\": \"\",\n \"reference_id\": \"item_001\",\n \"sku\": {\n \"id\": \"sku_001\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"code\": \"WH-001\",\n \"description\": \"High-quality wireless headphones with noise cancellation\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\",\n \"https://example.com/headphones-2.jpg\"\n ],\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"weight\": 0.5,\n \"currency\": \"AED\",\n \"selling_price\": 150\n },\n \"quantity\": 1,\n \"return_reason\": \"\",\n \"note\": \"\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\"\n ]\n }\n ],\n \"current_hub_id\": \"\",\n \"delivery_preference\": {\n \"delivery_date\": \"2025-09-30T00:00:00Z\",\n \"start_time\": \"2025-09-30T09:00:00Z\",\n \"end_time\": \"2025-09-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"approved_at\": \"0001-01-01T00:00:00Z\",\n \"approved_by\": null\n }\n ]\n }\n },\n \"meta\": null\n}"},{"id":"ba2ae3f2-93ef-458b-ad62-a7bf76e6103d","name":"Failed Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments/reference/:reference_id","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v2","tms","shipments","reference",":reference_id"],"variable":[{"key":"reference_id","value":"ORD-2024-000"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 26 Sep 2025 06:27:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"79"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"e02b4158-7267-457e-acf2-09ba7c392e9c"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9850b209d9dd89a2-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"shipment not found\"\n }\n}"}],"_postman_id":"e23890ab-d66a-4470-af8e-543a2910285d"},{"name":"Get Shipment by Awb","id":"7b8f4d85-ec96-4af8-a3f4-b5034d1448be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"url":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments/awb/:awb","description":"

📌 Fetch Shipment by AWB– Overview

The Fetch Shipment by AWB API provides detailed information about a shipment using its unique Air Waybill (AWB) number. This method allows users to directly track the journey of a specific parcel without needing order-level references.

📌 Cancel Shipment – Overview

The Cancel Shipment by Shipment ID API lets users cancel a shipment using the system-assigned Shipment ID. This approach ensures accuracy by targeting shipments uniquely identified within the system, reducing the risk of errors in cancellation.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Required	Description
reason	string	Yes	The reason for cancelling the shipment.

","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["sales-channel","public","v2","tms","shipments",":shipment_id","cancel"],"host":["prodapi","omniful","com"],"query":[],"variable":[{"type":"any","value":"68d4e93f70eeed28e860ca91","key":"shipment_id"}]}},"response":[{"id":"02e0d7ae-9236-4d83-bf30-002a740362b0","name":"Cancel Shipment","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"not required now\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments/:shipment_id/cancel","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v2","tms","shipments",":shipment_id","cancel"],"variable":[{"key":"shipment_id","value":"68d4e93f70eeed28e860ca9f"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 25 Sep 2025 07:03:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"bfe31cbf-4f1b-4be4-81df-a05c4a788d65"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9848a9ba0c47c08d-MAA"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"shipment\": {\n \"id\": \"68d4e93f70eeed28e860ca9f\",\n \"awb_number\": \"FCD-157A3044\",\n \"awb_label\": \"\",\n \"reference_id\": \"ORD-2024-009\",\n \"tracking_number\": \"\",\n \"seller_hub_id\": \"68d394abff009461959851e1\",\n \"seller_info\": {\n \"name\": \"3PL Fulfillment 10\",\n \"code\": \"EX-637\",\n \"email\": \"dumy@net.com\"\n },\n \"pickup_hub_id\": \"5000034\",\n \"status\": \"cancelled\",\n \"source\": \"sales_channel\",\n \"seller_hub\": {\n \"name\": \"3pl1 \",\n \"code\": \"3pl1\",\n \"address\": {\n \"code\": \"\",\n \"address_line_1\": \"12\",\n \"address_line_2\": \"ds\",\n \"city\": \"Riyadh\",\n \"state\": \"Riyadh Region\",\n \"country\": \"Saudi Arabia\",\n \"country_code\": \"SA\",\n \"city_id\": \"7570\",\n \"state_id\": \"92\",\n \"country_id\": \"8\",\n \"postal_code\": \"\",\n \"latitude\": 24.7135517,\n \"longitude\": 46.6752957,\n \"national_address_code\": \"\"\n }\n },\n \"seller_customer_id\": \"68d394b4a6206606319c8a5b\",\n \"customer_info\": {\n \"id\": \"68d394b4a6206606319c8a5b\",\n \"name\": \"John Doe \",\n \"code\": \"\",\n \"email\": \"john.doe@example.com\",\n \"country_code\": \"SA\",\n \"phone\": \"501234567\",\n \"address\": {\n \"code\": \"\",\n \"address_line_1\": \"123 Business Street\",\n \"address_line_2\": \"Suite 100\",\n \"city\": \"Dubai\",\n \"state\": \"\",\n \"country\": \"United Arab Emirates\",\n \"country_code\": \"SA\",\n \"city_id\": \"0\",\n \"state_id\": \"0\",\n \"country_id\": \"0\",\n \"postal_code\": \"12345\",\n \"latitude\": 25.2048,\n \"longitude\": 55.2708,\n \"national_address_code\": \"\"\n }\n },\n \"product_type\": \"physical_product\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"handling_granularity\": \"package\",\n \"shipment_type\": \"forward\",\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150,\n \"total_due\": 0,\n \"total_paid\": 150\n },\n \"details\": {\n \"total_weight\": 2.5,\n \"actual_weight\": 0,\n \"number_of_packages\": 1\n },\n \"tracking_history\": [\n {\n \"status\": \"new\",\n \"event_time\": \"2025-09-25T07:03:27.873Z\",\n \"description\": \"Shipment Created\"\n },\n {\n \"status\": \"cancelled\",\n \"event_time\": \"2025-09-25T07:03:39.930243203Z\",\n \"description\": \"Shipment Cancelled: not required now\"\n }\n ],\n \"delivery_preference\": {\n \"delivery_date\": \"2025-09-30T00:00:00Z\",\n \"start_time\": \"2025-09-30T09:00:00Z\",\n \"end_time\": \"2025-09-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"delivery_zone_ids\": [\n \"68c952b532e39a06acf14d29\"\n ],\n \"sales_channel_info\": {\n \"seller_sales_channel_id\": \"channel_001\",\n \"sales_channel\": {\n \"id\": \"amazon_ae\",\n \"tag\": \"amazon\",\n \"name\": \"Amazon UAE\",\n \"category\": \"marketplace\",\n \"logo_url\": \"https://example.com/amazon-logo.png\",\n \"link\": \"https://amazon.ae\",\n \"store_name\": \"Amazon UAE Store\"\n }\n },\n \"delivered_at\": \"0001-01-01T00:00:00Z\",\n \"on_hold_reasons\": [\n \"no_delivery_hub_found\"\n ],\n \"cancel_reason\": \"not required now\",\n \"shipment_created_at\": \"2025-09-25T07:03:27.913Z\",\n \"packages\": [\n {\n \"reference_id\": \"PKG-001\",\n \"shipment_reference_id\": \"ORD-2024-009\",\n \"pickup_hub\": null,\n \"delivery_hub\": null,\n \"status\": \"cancelled\",\n \"awb_number\": \"FCD-157A3044-1\",\n \"awb_label\": \"\",\n \"pickup_code\": \"6921\",\n \"delivery_code\": \"9421\",\n \"shipment_type\": \"forward\",\n \"service_type\": \"standard\",\n \"pickup_type\": \"pickup_by_logistics\",\n \"delivery_type\": \"delivery_by_logistics\",\n \"transaction_details\": null,\n \"payment_info\": {\n \"currency\": \"AED\",\n \"payment_type\": \"prepaid\",\n \"declared_value\": 150,\n \"total_due\": 0,\n \"total_paid\": 150\n },\n \"sender_info\": null,\n \"recipient_info\": null,\n \"packaging_info\": {\n \"length\": 30,\n \"height\": 20,\n \"width\": 25,\n \"weight\": 2.5,\n \"volume\": 15000\n },\n \"origin_stop\": null,\n \"current_stop\": null,\n \"next_stop\": null,\n \"destination_stop\": null,\n \"tags\": null,\n \"handling_granularity\": \"package\",\n \"items\": [\n {\n \"id\": \"68d4e93f70eeed28e860ca9e\",\n \"item_id\": \"\",\n \"reference_id\": \"item_001\",\n \"sku\": {\n \"id\": \"sku_001\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"code\": \"WH-001\",\n \"description\": \"High-quality wireless headphones with noise cancellation\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\",\n \"https://example.com/headphones-2.jpg\"\n ],\n \"barcodes\": [\n \"1234567890123\",\n \"9876543210987\"\n ],\n \"weight\": 0.5,\n \"currency\": \"AED\",\n \"selling_price\": 150\n },\n \"quantity\": 1,\n \"return_reason\": \"\",\n \"note\": \"\",\n \"image_urls\": [\n \"https://example.com/headphones-1.jpg\"\n ]\n }\n ],\n \"current_hub_id\": \"\",\n \"delivery_preference\": {\n \"delivery_date\": \"2025-09-30T00:00:00Z\",\n \"start_time\": \"2025-09-30T09:00:00Z\",\n \"end_time\": \"2025-09-30T18:00:00Z\",\n \"delivery_instruction\": \"Please deliver to reception desk\"\n },\n \"approved_at\": \"0001-01-01T00:00:00Z\",\n \"approved_by\": null\n }\n ]\n }\n },\n \"meta\": null\n}"},{"id":"e1cfd48e-b4fe-4e9b-8974-0a3a2de0f67f","name":"Failed Example 1","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments/:shipment_id/cancel","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v2","tms","shipments",":shipment_id","cancel"],"variable":[{"key":"shipment_id","value":"68d4e93f70eeed28e860ca9f"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 26 Sep 2025 06:28:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"161"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"ebfde47e-f1c7-46b6-a53b-e20dc92f1fa8"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9850b322ecf989a2-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"cancellation reason is required\"\n }\n}"},{"id":"20cd963a-9819-4f49-9bd5-0f71accc0bdf","name":"Failed Example 2","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTM0Mzg2NzAsImp0aSI6ImIxMmQ5YWIyLWI1NGYtNGIyNy1iYmMxLWM2OWE1MGQ4Yjc3MSIsInVzZXJfZGV0YWlscyI6eyJTZWxsZXJTYWxlc0NoYW5uZWxJRCI6NzYwLCJTZWxsZXJJRCI6IjQ3OSIsIlRlbmFudElEIjoiMSIsIlVzZXJJRCI6IjQ3NzIiLCJVc2VyTmFtZSI6ImFudXBhbSIsIlJhdGVMaW1pdERldGFpbHMiOnsiRW5hYmxlZCI6dHJ1ZSwiUmVxdWVzdHNQZXJNaW51dGUiOjYwfX0sInRva2VuX3R5cGUiOiJCZWFyZXIifQ.Py-qDMfa7t0aP556mkXgzBbwM8B22IuFPLe_NTtsNiv7jtdC4uoKBtBTsntghEpY0JHVL2f9_M4I9_Plkp_PaxDJrfqOpu9X_PQSyNQfHtRjhpZRNegQkJ-k8MWpNZvO3sYWqVvdKI3COqDBdNC3S2fiZw0lPuD62twNZUOuiJIV160zbCRSrjKewR9khgL69GkScwKG7__ZzxMo611NBWeQxMmDRLB3ABuPi0j2YukFhomWck0ux6zVaqxkaISkwKo1xol0OzrBwnXgKqNsSd5IVlxZKQV5qgb8z0VEE6kqh8WonPSdnHef8bVMrTqm28f-0iNB5tkYnx_I1us3hGmtJSzDdeug-PAKGp2ZNkHbNEpMmWt2_dgJMRnKXTK634jno1qeBrdFqpbm5P97EjbqVgnZKJ-_Ps74qmzWqS2E_A7HZ9UPecVcGBBKe11NNJhxh1PZANSVDQIIfwB81cgTE2DkceQh7xJ7ipND8xCYEntD49FffC3JA-OFbEjnTGUs2TRo9YUaMvDf2HBJyF8D6cPBO-81z-o65ndpFEuBUm5nZBTWUXVF82M4yFBmd0UDU6XxkQQ0eVIWB8NKo4LjQQK3fo8lk2HnZ0nyJvKxFG3Bug4TrgQKkSNqgZ8sHuVK-ZFth9QnOiJYlxKGi2caCtjATUfzhVgwoK00ea4"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"not required now\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://prodapi.omniful.com/sales-channel/public/v2/tms/shipments/:shipment_id/cancel","protocol":"https","host":["prodapi","omniful","com"],"path":["sales-channel","public","v2","tms","shipments",":shipment_id","cancel"],"variable":[{"key":"shipment_id","value":"68d4e93f70eeed28e860ca9"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 26 Sep 2025 06:30:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"155"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"04ad03b6-92a2-4b74-a779-d9ab95089c06"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9850b6c18ff554de-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": false,\n \"status_code\": 400,\n \"error\": {\n \"message\": \"invalid object id\"\n }\n}"}],"_postman_id":"5768aa76-7004-423c-92b7-538626dab1af"}],"id":"6192f4f9-ae89-4f7f-8a28-bd466804e7de","_postman_id":"6192f4f9-ae89-4f7f-8a28-bd466804e7de","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}},{"name":"Webhook","item":[{"name":"Register Webhook","id":"c74e853a-c79b-42f3-862e-77130121a0b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"topic\": \"shipment_webhook\",\n \"webhook_url\": \"https://webhook.site/181a3c04-263d-4032-a8b0-d778ef5698fc\",\n \"is_enable\": true,\n \"custom_headers\": [\n {\n \"key\": \"X-AUTH-TOKEN\",\n \"value\": \"New_token\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v1/webhooks","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["sales-channel","public","v1","webhooks"],"host":["prodapi","omniful","com"],"query":[],"variable":[]}},"response":[{"id":"58880913-7efa-4c3b-9275-0cfee858691d","name":"New Request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":""}],"body":{"mode":"raw","raw":"[\n {\n \"topic\": \"shipment_webhook\",\n \"webhook_url\": \"https://webhook.site/181a3c04-263d-4032-a8b0-d778ef5698fc\",\n \"is_enable\": true,\n \"custom_headers\": [\n {\n \"key\": \"auth-token\",\n \"value\": \"New_token\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://prodapi.omniful.com/sales-channel/public/v1/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 26 Sep 2025 12:24:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-omniful-request-id","value":"7a6351e4-e47d-4a57-8e7a-958c1c591271"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9852bc78696559d0-DEL"}],"cookie":[],"responseTime":null,"body":"{\n \"is_success\": true,\n \"status_code\": 200,\n \"data\": {\n \"status\": \"Success: The webhook configurations were successfully updated.\"\n },\n \"meta\": null\n}"}],"_postman_id":"c74e853a-c79b-42f3-862e-77130121a0b6"}],"id":"520206a4-dcba-435f-a770-0caf11db2e7b","description":"

📌 Webhook Documentation

Webhooks allow your system to receive real-time notifications when specific events occur (e.g., shipment created, shipment cancelled, status updated). Instead of polling APIs repeatedly, webhooks push data to your endpoint as soon as the event happens.

🔗 Endpoint Information

URL: YOUR_WEBHOOK_URL_HERE
\n
Method: POST
\n
Content-Type: application/json
\n

🚀 Webhook Events and Shipment And Packages Statuses

The webhook sends a POST request to the specified URL with a JSON payload for each event.
The event_name field indicates the type of event, and the status field in the data object provides the current status of the shipment.

📦 Shipment Statuses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

event_name	status	Description
`shipment.create.event`	new	A new shipment has been created in the system.
`shipment.update.event`	dispatched	The shipment has been picked up by the courier.
`shipment.update.event`	in_transit	The shipment is moving between logistic hubs.
`shipment.update.event`	out_for_delivery	The shipment is with the courier for final delivery.
`shipment.update.event`	delivered	The shipment has been successfully delivered.
`shipment.update.event`	cancelled	The shipment has been cancelled by the user or system.
`shipment.update.event`	partially_delivered	The shipment has been partially_delivered where some packages are delivered and some are returened to origin.
`shipment.update.event`	returned	The shipment is being returned to the sender.

📦 Package Statuses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Value	Description
`New`	`new`	Shipment has been created but not yet processed.
`ArrivingAtHub`	`arriving_at_hub`	Shipment is on its way to a logistics hub.
`ToBePicked`	`to_be_picked`	Shipment is ready and waiting to be picked up by courier.
`InTransit`	`in_transit`	Shipment is moving between logistic hubs.
`PickupRejected`	`pickup_rejected`	Pickup attempt was rejected by courier or warehouse.
`ArrivedAtHub`	`arrived_at_hub`	Shipment has reached a logistics hub.
`ReceivedAtHub`	`received_at_hub`	Shipment has been received and processed at the hub.
`ReadyToDispatch`	`ready_to_dispatch`	Shipment is prepared for dispatch to next destination.
`OutForDelivery`	`out_for_delivery`	Shipment is with courier for final delivery.
`Returned`	`returned`	Shipment is being returned to the sender.
`Delivered`	`delivered`	Shipment has been successfully delivered.
`Cancelled`	`cancelled`	Shipment has been cancelled by user or system.
`ReturningToHub`	`returning_to_hub`	Shipment is on its way back to the logistics hub.

📝 Example Webhook Payload (`shipment.create.event`)

The following is a sample of the JSON data sent for a new shipment creation.
This structure is consistent across all events, with changes primarily in the status and tracking_history fields.

{\n  \"event_name\": \"shipment.create.event\",\n  \"data\": {\n    \"id\": \"\",\n    \"awb_number\": \"FCD-656ECB74\",\n    \"awb_label\": \"\",\n    \"reference_id\": \"ORD-2024-1101\",\n    \"tracking_number\": \"\",\n    \"seller_hub_id\": \"68d394abff009461959851e1\",\n    \"seller_info\": {\n      \"name\": \"3PL Fulfillment 10\",\n      \"code\": \"EX-637\",\n      \"email\": \"dumy@net.com\"\n    },\n    \"pickup_hub_id\": \"\",\n    \"status\": \"on_hold\",\n    \"source\": \"sales_channel\",\n    \"seller_hub\": {\n      \"name\": \"3pl1 \",\n      \"code\": \"3pl1\",\n      \"address\": {\n        \"code\": \"\",\n        \"address_line_1\": \"12\",\n        \"address_line_2\": \"ds\",\n        \"city\": \"Riyadh\",\n        \"state\": \"Riyadh Region\",\n        \"country\": \"Saudi Arabia\",\n        \"country_code\": \"SA\",\n        \"city_id\": \"7570\",\n        \"state_id\": \"92\",\n        \"country_id\": \"8\",\n        \"postal_code\": \"\",\n        \"latitude\": 24.7135517,\n        \"longitude\": 46.6752957\n      }\n    },\n    \"seller_customer_id\": \"\",\n    \"customer_info\": {\n      \"id\": \"\",\n      \"name\": \"John Doe\",\n      \"code\": \"CUST001\",\n      \"email\": \"john.doe@example.com\",\n      \"country_code\": \"SA\",\n      \"phone\": \"501234567\",\n      \"address\": {\n        \"code\": \"ADDR001\",\n        \"address_line_1\": \"123 Business Street\",\n        \"address_line_2\": \"Suite 100\",\n        \"city\": \"Dubai\",\n        \"state\": \"Dubai\",\n        \"country\": \"United Arab Emirates\",\n        \"country_code\": \"AE\",\n        \"city_id\": \"city_001\",\n        \"state_id\": \"state_001\",\n        \"country_id\": \"country_001\",\n        \"postal_code\": \"12345\",\n        \"latitude\": 25.2048,\n        \"longitude\": 55.2708\n      }\n    },\n    \"product_type\": \"physical_product\",\n    \"service_type\": \"\",\n    \"pickup_type\": \"\",\n    \"delivery_type\": \"delivery_by_logistics\",\n    \"handling_granularity\": \"package\",\n    \"shipment_type\": \"forward\",\n    \"payment_info\": {\n      \"currency\": \"AED\",\n      \"payment_type\": \"prepaid\",\n      \"declared_value\": 150,\n      \"total_due\": 0,\n      \"total_paid\": 150\n    },\n    \"details\": {\n      \"total_weight\": 2.5,\n      \"actual_weight\": 0,\n      \"number_of_packages\": 1\n    },\n    \"tracking_history\": [\n      {\n        \"status\": \"new\",\n        \"event_time\": \"2025-09-26T11:41:56.890689975Z\",\n        \"description\": \"Shipment Created\"\n      }\n    ],\n    \"delivery_preference\": {\n      \"delivery_date\": \"2025-09-30T00:00:00Z\",\n      \"start_time\": \"2025-09-30T09:00:00Z\",\n      \"end_time\": \"2025-09-30T18:00:00Z\",\n      \"delivery_instruction\": \"Please deliver to reception desk\"\n    },\n    \"delivery_zone_ids\": null,\n    \"sales_channel_info\": {\n      \"seller_sales_channel_id\": \"channel_001\",\n      \"sales_channel\": {\n        \"id\": \"amazon_ae\",\n        \"tag\": \"amazon\",\n        \"name\": \"Amazon UAE\",\n        \"category\": \"marketplace\",\n        \"logo_url\": \"https://example.com/amazon-logo.png\",\n        \"link\": \"https://amazon.ae\",\n        \"store_name\": \"Amazon UAE Store\"\n      }\n    },\n    \"delivered_at\": \"0001-01-01T00:00:00Z\",\n    \"on_hold_reasons\": [\n      \"invalid_customer_address\",\n      \"no_pickup_hub_found\",\n      \"no_delivery_hub_found\"\n    ],\n    \"shipment_created_at\": \"2025-09-26T11:41:56.913371463Z\",\n    \"packages\": [\n      {\n        \"reference_id\": \"PKG-001\",\n        \"shipment_reference_id\": \"ORD-2024-1101\",\n        \"pickup_hub\": {\n          \"name\": \"\",\n          \"code\": \"\",\n          \"address\": {\n            \"code\": \"\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"country_code\": \"\",\n            \"city_id\": \"\",\n            \"state_id\": \"\",\n            \"country_id\": \"\",\n            \"postal_code\": \"\",\n            \"latitude\": 0,\n            \"longitude\": 0\n          }\n        },\n        \"delivery_hub\": {\n          \"name\": \"\",\n          \"code\": \"\",\n          \"address\": {\n            \"code\": \"\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"country_code\": \"\",\n            \"city_id\": \"\",\n            \"state_id\": \"\",\n            \"country_id\": \"\",\n            \"postal_code\": \"\",\n            \"latitude\": 0,\n            \"longitude\": 0\n          }\n        },\n        \"status\": \"on_hold\",\n        \"awb_number\": \"FCD-656ECB74-1\",\n        \"awb_label\": \"\",\n        \"pickup_code\": \"9195\",\n        \"delivery_code\": \"0419\",\n        \"shipment_type\": \"forward\",\n        \"service_type\": \"standard\",\n        \"pickup_type\": \"pickup_by_logistics\",\n        \"delivery_type\": \"delivery_by_logistics\",\n        \"transaction_details\": null,\n        \"payment_info\": {\n          \"currency\": \"AED\",\n          \"payment_type\": \"prepaid\",\n          \"declared_value\": 150,\n          \"total_due\": 0,\n          \"total_paid\": 150\n        },\n        \"sender_info\": {\n          \"id\": \"\",\n          \"name\": \"\",\n          \"code\": \"\",\n          \"email\": \"\",\n          \"country_code\": \"\",\n          \"phone\": \"\",\n          \"address\": {\n            \"code\": \"\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"country_code\": \"\",\n            \"city_id\": \"\",\n            \"state_id\": \"\",\n            \"country_id\": \"\",\n            \"postal_code\": \"\",\n            \"latitude\": 0,\n            \"longitude\": 0\n          }\n        },\n        \"recipient_info\": {\n          \"recipient\": \"\",\n          \"recipient_photo\": \"\",\n          \"recipient_signature\": \"\",\n          \"delivery_proofs\": null\n        },\n        \"packaging_info\": {\n          \"length\": 30,\n          \"height\": 20,\n          \"width\": 25,\n          \"weight\": 2.5,\n          \"volume\": 15000\n        },\n        \"origin_stop\": {\n          \"id\": \"\",\n          \"type\": \"\",\n          \"name\": \"\",\n          \"code\": \"\",\n          \"country_code\": \"\",\n          \"phone\": \"\",\n          \"address\": {\n            \"code\": \"\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"country_code\": \"\",\n            \"city_id\": \"\",\n            \"state_id\": \"\",\n            \"country_id\": \"\",\n            \"postal_code\": \"\",\n            \"latitude\": 0,\n            \"longitude\": 0\n          }\n        },\n        \"current_stop\": {\n          \"id\": \"\",\n          \"type\": \"\",\n          \"name\": \"\",\n          \"code\": \"\",\n          \"country_code\": \"\",\n          \"phone\": \"\",\n          \"address\": {\n            \"code\": \"\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"country_code\": \"\",\n            \"city_id\": \"\",\n            \"state_id\": \"\",\n            \"country_id\": \"\",\n            \"postal_code\": \"\",\n            \"latitude\": 0,\n            \"longitude\": 0\n          }\n        },\n        \"next_stop\": {\n          \"id\": \"\",\n          \"type\": \"\",\n          \"name\": \"\",\n          \"code\": \"\",\n          \"country_code\": \"\",\n          \"phone\": \"\",\n          \"address\": {\n            \"code\": \"\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"country_code\": \"\",\n            \"city_id\": \"\",\n            \"state_id\": \"\",\n            \"country_id\": \"\",\n            \"postal_code\": \"\",\n            \"latitude\": 0,\n            \"longitude\": 0\n          }\n        },\n        \"destination_stop\": {\n          \"id\": \"\",\n          \"type\": \"\",\n          \"name\": \"\",\n          \"code\": \"\",\n          \"country_code\": \"\",\n          \"phone\": \"\",\n          \"address\": {\n            \"code\": \"\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"country_code\": \"\",\n            \"city_id\": \"\",\n            \"state_id\": \"\",\n            \"country_id\": \"\",\n            \"postal_code\": \"\",\n            \"latitude\": 0,\n            \"longitude\": 0\n          }\n        },\n        \"tags\": null,\n        \"handling_granularity\": \"package\",\n        \"items\": [\n          {\n            \"id\": \"\",\n            \"item_id\": \"\",\n            \"reference_id\": \"\",\n            \"sku\": {\n              \"id\": \"sku_001\",\n              \"name\": \"Wireless Bluetooth Headphones\",\n              \"code\": \"WH-001\",\n              \"description\": \"High-quality wireless headphones with noise cancellation\",\n              \"image_urls\": [\n                \"https://example.com/headphones-1.jpg\",\n                \"https://example.com/headphones-2.jpg\"\n              ],\n              \"barcodes\": [\n                \"1234567890123\",\n                \"9876543210987\"\n              ],\n              \"weight\": 0.5,\n              \"currency\": \"AED\",\n              \"selling_price\": 150\n            },\n            \"quantity\": 1,\n            \"return_reason\": \"\",\n            \"note\": \"\",\n            \"image_urls\": null\n          }\n        ],\n        \"current_hub_id\": \"\",\n        \"delivery_preference\": {\n          \"delivery_date\": \"2025-09-30T00:00:00Z\",\n          \"start_time\": \"2025-09-30T09:00:00Z\",\n          \"end_time\": \"2025-09-30T18:00:00Z\",\n          \"delivery_instruction\": \"Please deliver to reception desk\"\n        },\n        \"approved_at\": \"0001-01-01T00:00:00Z\",\n        \"approved_by\": {\n          \"id\": \"\",\n          \"name\": \"\"\n        }\n      }\n    ]\n  }\n}\n\n

\n","_postman_id":"520206a4-dcba-435f-a770-0caf11db2e7b","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}}],"id":"5c9fb43e-04a3-4948-92dc-efdbd0c4f7ec","description":"

Note: For all operations in the KSA region, the national_address_code field must be included inside every request’s address object. This is mandatory across all APIs in this folder.

\n","_postman_id":"5c9fb43e-04a3-4948-92dc-efdbd0c4f7ec","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"2714ea86-d918-46ac-a643-1a78d2a3c059","id":"2714ea86-d918-46ac-a643-1a78d2a3c059","name":"Omniful Integration APIs","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"}},"event":[{"listen":"prerequest","script":{"id":"5f846c3a-0896-4702-9d5f-b68701928dc9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eedaf8ef-f960-40a5-aef9-28832892fb14","type":"text/javascript","exec":[""]}}]}

⚠️ Important Notice

Welcome to Omniful’s API Documentation 🚀

Getting Started

📹 Watch our short video guide on setting up Custom Integrations: Video Link

📕API Documentation and API Usage Guidelines

📘 Overview

🔑 Authentication

🌍 Base URLs

🔄 Request & Response Formats

⚡ Rate Limiting

🔔 Webhooks: Get Real-Time Updates

🔄 API Functionality & Button Status

⏱ Timestamp Format

📝 Request Body Parameters

📌 Update Order Invoice API - Overview

📝 Request Body Parameters

📌 Overview

📌 Approve Order API - Overview

📌 Get Seller Orders API - Overview

📝 Response Body Parameters

Important Notes:

Pagination

Query Parameters

Status Codes

📌 Get Seller Order by Order ID API - Overview

📝 Response Body Parameters

🔹 Key Information

⚠️ Important Notice

📌 Get Orders API - Overview

Response Body Parameters

Important Notes:

Response Structure

Pagination

Query Parameters

Status Codes

List Of Order Statuses in Omniful:

Important Points to Consider

⚠️ Important Notice

📌 Get Order by Order ID API - Overview

📝 Response Body Parameters

Important Notes:

Time Formats

Status Codes

📌 Get Order Logs API – Overview

Response Body Parameters

Important Notes

Event Types

Time Format

Event Sources

Log Structure

Status Codes

📌 Update Shipping Address API – Overview

Request Body Parameters

📌 Update Shipping Details API - Overview

📝 Request Body Parameters

Root Level Fields

Address Object Parameters

Slot Object Parameters

🛒 Order Resource (orders)

📦 Order Items (orders.order_items)

🏠 Shipping & Billing Address (orders.shipping_address & orders.billing_address)

🧾 Invoice (orders.invoice)

👤 Customer (orders.customer)

🚚 Shipment Type (orders.shipment_type)

🚛 Delivery Type (orders.delivery_type)

💳 Transaction Details (orders.transactions)

🌍 External Fields (order.external_fields)

⏳ Order Auto-Cancellation (order.cancel_order_after_seconds)

📌 Create Shipment API – Overview

Request Body Parameters

Response Body Parameters

📌 Add Shipment Details API – Overview

📌 Key Information

Request Body Parameters

📌 Update Shipment Status API - Overview

📌 Create Shipment API Collection - Overview

📌 Create SKU API – Overview

⚠️ Important Considerations for Creating a SKU

Request Body Parameters

📌 Overview

🛒 Order Resource (`orders`)

📦 Order Items (`orders.order_items`)

🏠 Shipping & Billing Address (`orders.shipping_address` & `orders.billing_address`)

🧾 Invoice (`orders.invoice`)

👤 Customer (`orders.customer`)

🚚 Shipment Type (`orders.shipment_type`)

🚛 Delivery Type (`orders.delivery_type`)

💳 Transaction Details (`orders.transactions`)

🌍 External Fields (`order.external_fields`)

⏳ Order Auto-Cancellation (`order.cancel_order_after_seconds`)

`order_id` (String)

`order_alias` (String)

`customer` (Object)

`hub_code` (String)

`order_created_at` (String)

`order_items` (Array)

`invoice` (Object)

`return_order_id` (String)

`order_id` (String)

`return_order_alias` (String)

`hub_code` (String)

`customer` (Object)

`order_items` (Array)

`refund_status` (String)