Welcme to Shiprocket Omuni! Omuni, now a part of Shiprocket, is India’s leading omnichannel retail enablement platform. Originally built by Arvind Internet and developed by retail industry experts, Omuni has been at the forefront of solving the technological and operational complexities of unified commerce. Today, as part of the Shiprocket ecosystem, we power the omnichannel journeys of 100+ global and Indian brands across 10,000+ stores, marketplaces, and digital touchpoints. This document is designed to help developer teams from Omuni customers & partners to fully understand and integrate Omuni API(s). The APIs are listed along with their required parameters if any, and their example requests and responses on the right, for easy understanding. The easiest way to start using the Omuni APIs, is by clicking the Run in Postman button above. Postman is a free tool that helps developers run and debug API requests. Our APIs are based around REST architecture and use the basic HTTP request methods. Our APIs accept JSON - encoded body requests and return back data in the same form.
\n
Instructions for Onboarding
\n
\n
First step is to signup for an Omuni account. Reach out to your Account or Delivery manager for the same.
\n
\n
Follow the API specs mentioned here to integrate for specific omnichannel journeys.
\n
\n
For any questions/queries/doubts - please reach out to your Account or Delivery Manager. Or Write to us at csm_team@omuni.com.
\n
\n
Your Account or Delivery manager will also provide you with the credentials needed for authentications of the APIs
\n
\n
\n
Document and API Usage Guidelines
\n
\n
Our APIs use the basic HTTP request codes: POST, GET, etc.
\n
\n
You can select the required response and request code language by selecting it from the drop-down menu on the top.
\n
\n
You can test all our APIs by importing the full API collection through the 'Run in Postman' button and running them in the Postman app.
\n
\n
To use Omuni APIs, a proper data setup needs to be done for inventory, catalog, stores, and mappings. The given payloads are samples and can't be used for your testing. It will return an error/ bad payload response.
\n
\n
The base URL, credentials differ for QA/ Staging and Production. Few examples:
Note: Any requests made using the valid API credentials will affect the production data in your Omuni account.
\n
\n
All the APIs are provided with their appropriate example requests and responses. The example definitions are:
\n
\n
Successful Call : The correct API call was made.
\n
\n
Invalid Data : The data entered was incorrect.
\n
\n
Missing Fields : Some of the required fields are missing.
\n
\n
Wrong Format : There is a syntax error in the code.
\n
\n
\n
\n
\n
Errors and Response codes
\n
While using Omuni APIs, you may run into some standard response and error codes. The most common ones are listed along with their descriptions as follows:
\n
\n\n
\n
RESPONSE CODE
\n
DESCRIPTION
\n
\n\n\n
\n
200 & 202 - OK & Accepted
\n
Everything worked as expected. The response is displayed or the processing starts. Some API's may respond with an error message if data is invalid.
\n
\n
\n
400 - Bad Request
\n
The request was unacceptable, often due to missing a required parameter.
\n
\n
\n
401 - Unauthorized
\n
There is some error in validation. You need to check your token or credentials.
\n
\n
\n
404 - Not Found
\n
The URL is inaccessible. This is either due to the wrong URL input or the resource being depreciated.
\n
\n
\n
405 - Method Not Allowed
\n
The API was accessed using a wrong method. Check your HTTP method.
\n
\n
\n
422 - Unprocessable Entity
\n
It means the request contains incorrect syntax or cannot be fulfilled. Try checking your code for errors.
\n
\n
\n
429 - Too Many Requests
\n
Too many hits were attempted at the API too quickly. Provide the API some time to process.
\n
\n
\n
500, 502, 503, 504 - Server Errors
\n
Some server error occurred. Some APIs may show this due to syntax or parameter errors. Try contacting support if this persists.
\n
\n\n
\n
Support:
\n
\n
For any integration and API related support, please feel free to drop us an email at csm_team@omuni.com.
\n
\n
For any other issues, please contact your Account or Delivery manager.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Instructions for Onboarding","slug":"instructions-for-onboarding"},{"content":"Document and API Usage Guidelines","slug":"document-and-api-usage-guidelines"},{"content":"Errors and Response codes","slug":"errors-and-response-codes"}],"owner":"12807531","collectionId":"fc955907-89f0-42ba-87f6-2907e0d75a7d","publishedId":"TVejhptE","public":true,"customColor":{"top-bar":"ffffff","right-sidebar":"303030","highlight":"EC008C"},"publishDate":"2021-03-31T16:14:45.000Z"},"item":[{"name":"Headless Commerce","item":[{"name":"Authentication","item":[{"name":"Generate API Tokens","id":"0116d483-cff6-4f24-bbed-e1cf4fd704ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\":\"Your Username\",\n \"password\":\"Your Password\"\n}"},"url":"https://api-preprod.ailiens.com/b/namo/api/v1/token","description":"
This API is used to generate access token and refresh token which will be used as a parameter for the API to function properly. To generate the tokens, you will be asked for a username and password, which will be provide once you onboard as Omuni client. The access token generated lasts for a limited time period. This API acts as a validation point.
\n
General Flow:
\n
\n
A new client onboards and signs for Omuni product suite.
\n
The user gets their specific username and password after onboarding.
\n
Then calls this API for generating the access token.
\n
The token generated is then used for running other APIs
\n
\n
Process Flow:
\n
\n
The user calls this API to generate an Access token.
\n
The user is asked for a username and password to validate themselves as an authorized user.
\n
Inputs the username and password specific to them provided by Omuni.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input - Access token and Refresh token generated.
The access token generated earlier is only valid for a limited period of time and hence it gets expired after some time. To generate a new access token, this API must be called. You need to pass the Refresh token generated earlier as an input for generating the new Access token which again can be used as a parameter for running the APIs.
\n
General Flow:
\n
\n
The user calls the Generate API token request for generating the access token and refresh token.
\n
The Access token generated expires after some time.
\n
To generate a new access token the Refresh token API is called
\n
The new access token generated is then used for running the APIs
\n
\n
Process Flow:
\n
\n
The user calls this API to generate a new Access token.
\n
The user is asked for a Refresh token as an input parameter.
\n
The Refresh token generated earlier is then provided as the input to run this API
The purpose of this authentication is to validate the request as an authorised Omuni account. It basically acts as a gateway for letting only authorised requests go ahead. The authentication token is the authorisation that you need to pass in order to access omuni.cloud's resources. All the API calls to the Omuni are via HTTPS and authenticated via token based.
\n
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret token in publicly accessible areas such as GitHub, client-side code, and so forth.
\n
API Token
\n
An API user gets two types of tokens i.e. Access token and Refresh token which are needed further to pass as a parameter for the APIs to function properly. For generation of these tokens you will require a username and password - which will be provided once you have onboarded and signed in as Omuni customer.
\n
\n
Access token: The validity is only for a limited period of time. Use \nRefresh token to renew your access token
\n
Refresh token: The validity of this also is time-bound but longer than the access token. Use the username and password to get the new refresh token.
This API is called to check the inventory availability & logistics serviceability options for products & the end-consumer's pin code. Also, this API provides the stores nearby when asked for the Store Pickup option.
\n
If the store_pickup parameter is set to \"Yes\" in the request, the API will return all stores within a 5 KM radius which have that particular product and exercises the Store Pick up option.
\n
Note:The 5 KM radius is configurable. To request a change, please contactcsm_team@omuni.com.
\n
This API can be be used in
\n
\n
Product pages for pincode serviceability check.
\n
\n
Checkout / Cart pages to check for inventory & logistics serviceability for all items.
\n
\n
\n
Below is the list of all available Delivery Modes
\n
\n
Standard Delivery
\n
\n
Expedited Delivery (Same day or next day)
\n
\n
Store Pickup
\n
\n
\n
General Flow:
\n
\n
Customer comes to the user’s E-Commerce site and wants to check whether his or her pin code is serviceable.
\n
\n
The user calls this API to get information on the serviceability status of the customer’s given pin code.
\n
\n
The user passes the pin code and other mandatory parameters.
\n
\n
The serviceability status and the delivery modes available are displayed back and a list of stores are displayed if asked for the Store pickup option.
\n
\n
\n
Process Flow:
\n
\n
The user wants to know about the serviceability status of the customer’s given pin code.
\n
\n
Calls this API to get information about the serviceability status.
\n
\n
The user is asked for an Access token as an input parameter in the headers and other mandatory parameters such as location, SkuId, Store Pickup, etc. in the body of the API request.
\n
\n
The user passes all the mandatory parameters.
\n
\n
Hits the API request.
\n
\n
\n
Outcome:
\n
\n
Correct Input – Serviceability status and available delivery modes gets displayed. Also, if asked for Store pickup then the stores available nearby will be displayed.
\n
\n
Incorrect Input - Errored response.
\n
\n
\n\n\n
\n\n
\n
field
\n
description
\n
Mandatory
\n
Datatype
\n
constraints
\n
\n\n\n
\n
Delivery Type
\n
Valid Delivery types provided by Omuni
\n
No
\n
String
\n
255 characters
\n
\n
\n
Store Pick up
\n
Near by Store based on the customer given pincode
\n
No
\n
String
\n
255 Characters
\n
\n
\n
warehouseId
\n
Cluster Id given by Omuni team
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Quantity
\n
SKU Quantity
\n
No
\n
Integer
\n
255 characters
\n
\n
\n
location
\n
Valid Pin code
\n
Yes
\n
Integer
\n
255 characters
\n
\n
\n
latitude
\n
Latitude of the drop location
\n
No
\n
String
\n
255 characters
\n
\n
\n
longitude
\n
Longitude of the drop location
\n
No
\n
String
\n
255 characters
\n
\n
\n
skuId
\n
SKU/EAN
\n
Yes
\n
Integer
\n
255 characters
\n
\n
\n
eoisSkuId
\n
External SKU(optional).Need to pass this value only if you use mapping feature, otherwise dont pass this key/value pair
This API can be used for the creation of orders in Omuni. The user can add all the orders coming to its E-commerce websites and ordering channel directly to the Omuni platform using this API. The user can process all the information such as Customer details, Product details, Payment details, Shipping details, etc. through this API request.
\n
Please note that the following fields will be shared by the Integration team once you get Onboarded.
\n
\n
channelId
\n
marketPlaceName
\n
orderingStoreID
\n
clusterId
\n
warehouseId
\n
\n
These fields will change for each User
\n
General Flow:
\n
\n
A customer places an order in the brand's E-Commerce sites and ordering channels.
\n
The user/brand calls this API to add this order to the Omuni platform.
\n
The user then passes all the parameters of the order and creates the order in Omuni.
\n
A new order gets created in Omuni
\n
\n
Process Flow:
\n
\n
The user calls this API to add a new order into Omuni platform.
\n
The user is asked for an Access token as an input parameter in the headers and other mandatory parameters such as orderReference, channelId, marketplacename etc. in the body of the API request.
\n
The user passes all the mandatory parameters and other order details such as Customer details, Payment details, etc.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input - New order gets created in Omuni platform.
\n
Incorrect Input - Errored response.
\n
\n
\n
Note:
\n
\n
Quantity always has to be 1. If the EAN is the same, need to send it as two item object
\n
\n
\n\n
\n
field
\n
description
\n
Mandatory
\n
Datatype
\n
constraints
\n
\n\n\n
\n
orderReference
\n
Unique Reference order number(min 6 digits)
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
channelId
\n
To be provided by OMUNI (Static)
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
marketPlacceName
\n
To be provided by OMUNI (Static)
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
orderingStoreID
\n
store ID from where order is placed & To be provided by OMUNI (Static)
\n
No
\n
String
\n
255 Characters
\n
\n
\n
clusterId
\n
Cluster to which order is assigned & To be provided by OMUNI (Static)
\n
No
\n
String
\n
255 characters
\n
\n
\n
orderStatus
\n
Status of the order
\n
No
\n
String
\n
255 Characters
\n
\n
\n
grossValue
\n
Gross Value
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
Currency
\n
Currency
\n
No
\n
String
\n
255 Characters
\n
\n
\n
netAmount
\n
Total amount of the order - Inclusive of discounts/ offers and taxes
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
Service
\n
NA
\n
No
\n
String
\n
255 Characters
\n
\n
\n
meta data
\n
object. can pass any key/ values. its optional both @ order/ item level
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Financialstatus
\n
Prepaid,Postpaid
\n
Yes
\n
Object
\n
NA
\n
\n
\n
paymentStatus
\n
Paid,Unpaid
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
paymentMode
\n
COD,Wallet
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
amount
\n
order amount
\n
Yes
\n
double
\n
2 digit precision
\n
\n
\n
typeOfTaxes
\n
LOV
\n
No
\n
double
\n
LOV
\n
\n
\n
customer
\n
Customer Info
\n
No
\n
Object
\n
NA
\n
\n
\n
username
\n
Username
\n
No
\n
String
\n
255 Characters
\n
\n
\n
userId
\n
User Id
\n
No
\n
String
\n
255 characters
\n
\n
\n
title
\n
Title
\n
No
\n
String
\n
255 Characters
\n
\n
\n
firstName
\n
User first name
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
middleName
\n
Middle Name
\n
No
\n
String
\n
255 Characters
\n
\n
\n
lastName
\n
last name
\n
No
\n
String
\n
255 characters
\n
\n
\n
gender
\n
User Gender
\n
No
\n
String
\n
255 Characters
\n
\n
\n
dateOfBirth
\n
User DoB
\n
No
\n
String
\n
255 characters
\n
\n
\n
phonenumber
\n
User Phone Number
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
email
\n
User Email
\n
No
\n
String
\n
255 characters
\n
\n
\n
channelId
\n
To be provided by OMUNI
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
shippingAddress
\n
Shipping Address
\n
Yes
\n
Object
\n
255 characters
\n
\n
\n
address_line1
\n
Address
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
city
\n
shipping City
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
state
\n
Shipping State
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
country
\n
Shipping Country
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
zip
\n
Zip code of shipping address
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
phone
\n
Phone
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
customerName
\n
Phone
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
grossAmount
\n
Gross amount for item
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
netAmount
\n
Total amount for item - Inclusive of discounts/ offers and exculsive of taxes
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
taxAmount
\n
Tax amount for item
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
itemId
\n
Unique item id
\n
Yes
\n
String
\n
255 varchar
\n
\n
\n
quantity
\n
quantity of items
\n
Yes
\n
number (1), has to be 1 always. Multi quantity is not allowed
\n
NA
\n
\n
\n
mrp
\n
MRP of the product (order)
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
tradeSp
\n
MRP
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
discount
\n
Discount on the product
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
discountCode
\n
Discount Code of the discount
\n
No
\n
String
\n
255 Characters
\n
\n
\n
taxPercentage
\n
Tax in percentage.
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
gstBenefit
\n
gstBenefit
\n
No
\n
Double
\n
2 digit precision
\n
\n
\n
shippingAmount
\n
Shipping Amount on item
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
itemReference
\n
Unique item id
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
productDetails
\n
Product details
\n
Yes
\n
Object
\n
NA
\n
\n
\n
skuId
\n
SKU ID to uniquely identify product
\n
Yes
\n
String
\n
255 varchar
\n
\n
\n
eoisSkuId
\n
External SKU(optional).Need to pass this value only if you use mapping feature, otherwise dont pass this key/value pair
\n
No
\n
String
\n
255 varchar
\n
\n
\n
size
\n
Size of procuct L/M/S
\n
No
\n
String
\n
NA
\n
\n
\n
color
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
brand
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
mrp
\n
MRP (Item level)
\n
No
\n
String
\n
Integer
\n
\n
\n
styleId
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
category1
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
category2
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
category3
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
image
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
description
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
eanCode
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
sapStyleId
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
sapSkuId
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
warehouseId
\n
Can pass the brand name here
\n
Yes
\n
String
\n
255 character
\n
\n
\n
ship_by_date
\n
Promoised SLA/ delivery/ shipping date (however depends on the courier and contract with omuni
\n
No
\n
String
\n
255 character
\n
\n
\n
paymentRatioMetadata
\n
The key should be string and value should be integer.
\n
No
\n
Object
\n
NA
\n
\n
\n
createdAt
\n
Timestamp when the order is created
\n
No
\n
Timestamp
\n
255 character
\n
\n
\n
fulfillmentType
\n
Allowed values = STANDARD/ STOREPICK/ SAME_DAY_DELIVERY/ NEXT_DAY_DELIVERY [Default will be STANDARD]
\n
No
\n
Enum
\n
NA
\n
\n\n
\n
\n\n
\n
field
\n
description
\n
Example
\n
\n\n\n
\n
MRP
\n
Inclusive of tax & Listing price
\n
1000
\n
\n
\n
Base Price (before discount)
\n
Exclusive of tax
\n
952.38
\n
\n
\n
Tax percentage
\n
Tax in percentage
\n
5
\n
\n
\n
Tax amount (before discount)
\n
Exclusive of tax
\n
47.61
\n
\n
\n
Discount %
\n
Discount %. Applied on MRP
\n
5
\n
\n
\n
Discount Amount
\n
Absolute discount. Discount amt subtracted from MRP
\n
50
\n
\n
\n
MRP (after discount)
\n
Inclusive of tax & Listing price
\n
950
\n
\n
\n
Base Price (after discount)
\n
Exclusive of tax
\n
904.76
\n
\n
\n
Tax amount (after discount)
\n
Exclusive of tax
\n
45.23
\n
\n
\n
Net amount (after discount)
\n
Inclusive of discounts/ offers and inclusive of taxes
\n
950
\n
\n
\n
Shipping amount/ Delivery charges/ Convenient Fee/ Special Fee/ Same day delivery/ Express delivery
\n
Inclusive of applicable taxes
\n
30
\n
\n
\n
Gross amount (after discount)
\n
Inclusive of taxes
\n
980
\n
\n
\n
Selling Price (after discount)
\n
Inclusive of all amount + taxes
\n
950
\n
\n
\n
Trade Price (after discount)
\n
Same as selling price
\n
950
\n
\n
\n
Amount
\n
Total (Item 1+ Shipping charge)
\n
980
\n
\n\n
\n
\n\n
\n
RESPONSE CODE
\n
DESCRIPTION
\n
\n\n\n
\n
200 - OK & Accepted
\n
Everything worked as expected. The order got created successfully.
\n
\n
\n
401 - Unauthorized
\n
There is some error in validation. You need to check your token or credentials.
\n
\n
\n
500 - Server Errors Some server error occurred.
\n
Payload issue such as, orderingStoreId / SKU is not present or missing/ incorrect parameter
This API is used to get the list of nearby brand stores for a given pin code or for the latitude and longitude coordinates provided by the user.
\n
For example, if a customer wants to view the list of brand stores near their location, the brand can call this API by passing either the pin code or the latitude and longitude. Omuni will then return a list of nearby stores for that brand.
\n
By default, the API returns stores within a 5 KM radius of the provided location.
\n
Note:The 5 KM radius is configurable. To request a change, please contactcsm_team@omuni.com.
\n
The API also provides additional store details such as:
\n
\n
Store working days and hours
\n
\n
Contact number
\n
\n
Full address
\n
\n
\n
General Flow:
\n
\n
Customer visits the brand’s E-Commerce site and wants to check the nearby stores available with the brand for a given pin code or the coordinates
\n
\n
The user/brand calls this API, passes the pin code or coordinates as an Input.
\n
\n
The API in turn returns complete details on the available brand stores nearby.
\n
\n
\n
Process Flow:
\n
\n
The user wants to give a list of available brand stores nearby.
\n
\n
Calls this API to get the store list.
\n
\n
The user passes the access token in headers and Pin code or coordinates as an input in the body of the API request.
\n
\n
Hits the API request
\n
\n
\n
Outcome:
\n
\n
Correct Input – Displays complete details on the nearby available brand stores.
APIs below can be used before placing the order and to create orders.
\n
\n
Serviceability API - to check logistics serviceability as well as inventory position. This should be called to confirm before placing an order. Items which are out of stock or non-serviceable should be communicated to the end consumer and removed from the cart.
\n
\n
Add/Create Orders is to create the order in Omuni. Only call this post payment confirmation for prepaid orders.
This API is called to provide information on all the orders across channels powered by Omuni for a given customer. The user can display all the orders of a particular customer with the help of this API. Suppose a customer goes to his online account page made with the user/brand and wants to see all the orders he has placed till now. Then the user can simply call this API, provide certain information about the customer such as mobile no., user type, etc., and display the list of orders to their customer. Using this API you can enable your My Account Page of your website.
\n
General Flow:
\n
\n
Customer comes to the brand's E-Commerce site and wants to check the list of orders he placed.
\n
The user calls this API to get information on a customer’s orders in the Omuni platform.
\n
The user passes the mobile no. and other mandatory parameters.
\n
The whole list of orders is displayed to the user which in turn is returned to the particular customer.
\n
\n
Process Flow:
\n
\n
The user wants to know about a particular customer’s list of orders.
\n
Calls this API to get information about the customer’s orders in the Omuni platform.
\n
The user is asked for an Access token as an input parameter in the headers and other mandatory parameters such as mobile no., user type, etc. in the body of the API request.
ORDER DETAIL:\nSuppose a customer comes to a brand’s website and wants to get information about a particular order. The user can then call this API and pass the OrderId for which the customer needs information. The API will return all the details about the order such as product details, Shipping details, Pricing and payment details, customer details, order status, etc. Basically, this API is used to retrieve all the relevant information from Omuni about a particular order.
\n
General Flow:
\n
\n
Customer visits the brand’s E-Commerce site and wants to check details about a particular order.
\n
The user/brand calls this API to get information on the particular orderId being passed by the customer.
\n
The user passes the OrderId.
\n
Omuni returns all the details about that particular order.
\n
\n
Process Flow:
\n
\n
The user wants to know all the details of a given order.
\n
Calls this API to get information about the order details.
\n
The user is asked for an Access token as an input parameter in the headers and OrderId in the endpoint of the API request.
\n
The user passes all the mandatory parameters.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input – All the relevant details about that particular order gets displayed.
\n
Incorrect Input - Errored response.
\n
\n
\n
Order statuses:
\n
\n\n
\n
Status
\n
Description
\n
\n\n\n
\n
INITIATED
\n
Order accepted
\n
\n
\n
CANCELLED
\n
Order cancelled
\n
\n
\n
PAYMENTCONFIRMED
\n
Order Payment confirmed
\n
\n
\n
CODPAYMENTPENDING
\n
Order Payment pending
\n
\n
\n
PAYMENTCONFIRMATIONPENDING
\n
Order Payment pending
\n
\n
\n
DELIVERED
\n
Order Delivered
\n
\n
\n
RETURNED
\n
Order Returned
\n
\n\n
\n
Consignment statuses:
\n
\n\n
\n
Status
\n
Description
\n
\n\n\n
\n
INITIATED
\n
Consignment accepted
\n
\n
\n
UNASSIGNED
\n
Consignment waiting to be assigned to Store / Warehouse
\n
\n
\n
NOSTORETOSERVICE
\n
No store to service
\n
\n
\n
NOSTOCKATSTORE
\n
No Stock At Store
\n
\n
\n
ASSIGNED
\n
Consignment assigned to Store / Warehouse
\n
\n
\n
SAPPICKPASS
\n
Item QC'ed Successfully from Warehouse
\n
\n
\n
SAPPICKFAIL
\n
Item QC Unsuccessful from Warehouse
\n
\n
\n
PICKPASS
\n
Consignment confirmation from Store / Warehouse
\n
\n
\n
PICKFAIL
\n
Consignment confirmation failed from Store / Warehouse
\n
\n
\n
QCFAIL
\n
Item QC Unsuccessful
\n
\n
\n
QCPASS
\n
Item QC'ed Successfully
\n
\n
\n
DELIVERYMODIFIED
\n
Payment mode/Delivery mode modification
\n
\n
\n
CANCELLED
\n
Consignment cancelled
\n
\n
\n
WAITING_FOR_INVOICE
\n
Waiting for Courier Information
\n
\n
\n
READY_TO_INVOICE
\n
Consignment is ready for Invoicing
\n
\n
\n
INVOICED
\n
Invoice Generated
\n
\n
\n
PACKED
\n
Item(s) Packed at Store / Warehouse
\n
\n
\n
REPRINTINVOICE
\n
Re-print required due to data modification
\n
\n
\n
SHIPPED
\n
Consignment Shipped
\n
\n
\n
READYFORCUSTOMERPICK
\n
Consignment is ready for Customer Pickup
\n
\n
\n
CUSTOMERPICKCOMPLETE
\n
Consignment is picked by Customer
\n
\n
\n
CANDIDATE_FOR_RTO
\n
Consignment is eligible for RTO
\n
\n
\n
RTO_CONFIRMED
\n
Consignment is Confirmed for Courier return
\n
\n
\n
RTO_INTRANSIT
\n
In transit
\n
\n
\n
RTO_REATTEMPT
\n
Reattempt by courier
\n
\n
\n
DELIVERED
\n
Consignment Delivered
\n
\n
\n
RTO_DELIVERED
\n
Consignment received by the store/warehouse
\n
\n
\n
RTO_COMPLETED
\n
Consignment Accepted by Store/Warehouse
\n
\n
\n
RTO_RECEIVED
\n
Consignment received by the store
\n
\n
\n
RTO_COMPLETE_INTACT
\n
Consignment received by the store
\n
\n
\n
RTO_COMPLETE_DAMAGED
\n
Consignment received by the store with damage product
\n
\n
\n
RETURNED
\n
Consignment Returned
\n
\n\n
\n
Item statuses:
\n
\n\n
\n
Status
\n
Description
\n
\n\n\n
\n
INITIATED
\n
Item accepted
\n
\n
\n
UNASSIGNED
\n
Item waiting to be assigned to Store / Warehouse
\n
\n
\n
NOSTORETOSERVICE
\n
No store to service
\n
\n
\n
NOSTOCKATSTORE
\n
No Stock At Store
\n
\n
\n
ASSIGNED
\n
Item assigned to Store / Warehouse
\n
\n
\n
SAPPICKPASS
\n
Item QC'ed Successfully from Warehouse
\n
\n
\n
SAPPICKFAIL
\n
Item QC Unsuccessful from Warehouse
\n
\n
\n
PICKPASS
\n
Item confirmation from Store / Warehouse
\n
\n
\n
PICKFAIL
\n
Item confirmation failed from Store / Warehouse
\n
\n
\n
QCFAIL
\n
Item QC Unsuccessful
\n
\n
\n
QCPASS
\n
Item QC'ed Successfully
\n
\n
\n
DELIVERYMODIFIED
\n
Payment mode/Delivery mode modification
\n
\n
\n
CANCELLED
\n
Item cancelled
\n
\n
\n
WAITING_FOR_INVOICE
\n
Waiting for Courier Information
\n
\n
\n
READY_TO_INVOICE
\n
Item is ready for Invoicing
\n
\n
\n
INVOICED
\n
Invoice Generated
\n
\n
\n
PACKED
\n
Item(s) Packed at Store / Warehouse
\n
\n
\n
REPRINTINVOICE
\n
Re-print required due to data modification
\n
\n
\n
SHIPPED
\n
Item Shipped
\n
\n
\n
READYFORCUSTOMERPICK
\n
Item is ready for Customer Pickup
\n
\n
\n
CUSTOMERPICKCOMPLETE
\n
Item is picked by Customer
\n
\n
\n
CANDIDATE_FOR_RTO
\n
Item is eligible for RTO
\n
\n
\n
RTO_CONFIRMED
\n
Item is Confirmed for Courier return
\n
\n
\n
RTO_INTRANSIT
\n
In transit
\n
\n
\n
RTO_REATTEMPT
\n
Reattempt by courier
\n
\n
\n
DELIVERED
\n
Item Delivered
\n
\n
\n
RTO_DELIVERED
\n
Item received by the store/warehouse
\n
\n
\n
RTO_COMPLETED
\n
Item Accepted by Store/Warehouse
\n
\n
\n
RTO_RECEIVED
\n
Item received by the store
\n
\n
\n
RTO_COMPLETE_INTACT
\n
Item received by the store
\n
\n
\n
RTO_COMPLETE_DAMAGED
\n
Item received by the store with damage product
\n
\n
\n
RETURNED
\n
Item Returned
\n
\n\n
\n
Return statuses:
\n
\n\n
\n
Status
\n
Description
\n
\n\n\n
\n
RET_REQUESTED
\n
Return Requested by Customer
\n
\n
\n
RET_INITIATED
\n
Return Initiated by end customer
\n
\n
\n
RET_PICKUP_GENERATED
\n
Return Pickup request sent to Courier
\n
\n
\n
RET_CANCELLED
\n
Return Cancelled
\n
\n
\n
RET_OUT_FOR_PICKUP
\n
Return pickup is scheduled
\n
\n
\n
RET_PICKUP_FAILED
\n
Item Pickup failed by Courier
\n
\n
\n
RET_PICKEDUP
\n
Item Picked up by Courier
\n
\n
\n
RET_DELIVERED
\n
Return Delivered to Store/Warehouse
\n
\n
\n
RET_RECEIVED
\n
Return Item received by Store/Warehouse
\n
\n
\n
RET_DAMAGED
\n
Damaged Package Return received by Store/Warehouse
This API is used to update Order & Item level metadata. Only one item metadata can be updated in a single api call. When one wants to update the order level metadata, order ID is mandatory to be passed but not item ID. Similarly, with respect to updating item level metadata, item ID is mandatory to be passed but not order ID. In case you pass order Id or item ID, then order level metadata or item level metadata cannot be blank respectively.
\n
\n\n
\n
Field
\n
Description
\n
Mandatory
\n
Datatype
\n
Constraints
\n
\n\n\n
\n
Order ID
\n
Unique order Id.
\n
Yes (Mandatory in case of updating order level metadata. Not required when only item level metadata to be updated)
\n
string
\n
255 characters
\n
\n
\n
Item ID
\n
Unique item ID.
\n
Yes (Mandatory in case of updating item level metadata. Not required when only order level metadata to be updated)
This API is called to retrieve the status of an order in Omuni platform. The user can check for the current status of any item existing in Omuni platform with the help of this API. Suppose a customer wants to know about the status of any order placed on the brand's website, the user can display the order status to the customer by calling this Omuni API to provide the recent status of the item.
\n
General Flow:
\n
\n
Customer comes to the brand's E-Commerce site and wants to check the status of an order he placed.
\n
The user calls this API to check for the item status in the Omuni platform.
\n
The user passes the OrderId for which the status is needed.
\n
The status of the order is displayed and the same is returned to the customer.
\n
\n
Process Flow:
\n
\n
The user wants to know about the status of a particular order.
\n
Calls this API to get information about the order status in Omuni platform.
\n
The user is asked for an Access token as an input parameter in the headers and orderId in the endpoint of the API request.
Thi API is called to get the tracking URL of the order based on the order id passwd in request. Order id can be omuni order id as well as marketplace or shopify or magento order id. Response will provide omuni tracking order id as well as logistics tracking url. Along with tracking URL response will also include if otp authentication is enabled or not and status of the items in order.
\n
General Flow:
\n
\n
Customer calls the API using order id. It can be omuni order id or external order id (Ex. Shopify/Magento/Marketplace order id)
\n
Customer gets back the order tracking URL, Logistics URL and status
\n
Customer can redirect the end user to the location shared in the api response
\n
\n
Process Flow:
\n
\n
The user wants to know about the tracking url so that order can be tracked
\n
User calls the API ad passes required parameters
\n
Get the relevant information
\n
\n
Outcome:
\n
\n
Correct Input – Order tracking details gets displayed.
API is used to mark the order as delivered. User should pass order id, item ids of the consignment in request to mark that consignment delivered. AWB and reason are non mandatory
This get API helps to check refund & cancellation eligibility, this API to be called before cancellation & return call
\n
\n\n
\n
Field
\n
mandatory
\n
\n\n\n
\n
Item Id
\n
Yes
\n
\n
\n
Action type
\n
Returns Or Cancellation
\n
\n\n
\n
Enter a valid refund type return/cancellation
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"78d097be-23b9-4852-9965-84c649e5b25c","id":"78d097be-23b9-4852-9965-84c649e5b25c","name":"Headless Commerce","type":"folder"}},"urlObject":{"protocol":"https","path":["b","namo","api","refund","{refundType}","{itemId}"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"d503b82a-2530-4c7a-9182-b31dd4a5ffb6","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"ACCESS_TOKEN"}],"url":"https://api-preprod.ailiens.com/b/namo/api/refund/{refundType}/{itemId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"cancellable\": true,\n \"reason\": \"eligible\",\n \"refundAmount\": 2000,\n \"refundRatio\": {\n \"\": 400,\n \" \": 400,\n \" \": 400,\n \" \": 400,\n \"e\": 400\n }\n }\n}"},{"id":"027721b4-289a-40d4-a578-b7c9b517a76e","name":"Return already initiated(Not Eligible for Return)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"ACCESS_TOKEN"}],"body":{"mode":"raw","raw":""},"url":"https://api-preprod.ailiens.com/b/namo/api/refund/{refundType}/{itemId}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"returnable\": false,\n \"reason\": \"Return already initiated\"\n }\n}"},{"id":"c6cee64b-5d0d-405a-8a3b-a9987a232afd","name":"Eligible for Return","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"ACCESS_TOKEN"}],"body":{"mode":"raw","raw":""},"url":"https://api-preprod.ailiens.com/b/namo/api/refund/{refundType}/{itemId}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"returnable\": true,\n \"reason\": \"eligible\",\n \"refundAmount\": 799,\n \"refundRatio\": {}\n }\n}"},{"id":"dd7f063b-a6f8-4cb3-ac9e-2c17114667db","name":"Eligible for Cancellation","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"ACCESS_TOKEN"}],"body":{"mode":"raw","raw":""},"url":"https://api-preprod.ailiens.com/b/namo/api/refund/{refundType}/{itemId}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"cancellable\": true,\n \"reason\": \"eligible\",\n \"refundAmount\": 0,\n \"refundRatio\": {}\n }\n}"},{"id":"a13fdfa8-d1f4-4a9f-b941-390e55c50d80","name":"Not Eligible for Cancellation","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"ACCESS_TOKEN"}],"body":{"mode":"raw","raw":""},"url":"https://api-preprod.ailiens.com/b/namo/api/refund/{refundType}/{itemId}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"cancellable\": false,\n \"reason\": \"orderLines for cancellation is not possible as orderline is already invoiced\"\n }\n}"},{"id":"74fc5401-1db9-46fa-b4b2-315b55922b7b","name":"invalid refund type","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"ACCESS_TOKEN"}],"body":{"mode":"raw","raw":""},"url":"https://api-preprod.ailiens.com/b/namo/api/refund/{refundType}/{itemId}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"Enter a valid refund type returns/cancellation\"\n }\n}"}],"_postman_id":"dc966e4e-c7ee-42b4-9905-b84a543bed2f"},{"name":"Cancel an item","id":"7bf32709-8273-4422-8cf2-e6b493f5eb59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"accessToken","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source\" : \"Tenant Name\",\n \"orderId\" : \"18134775035\", \n \"itemIds\" : [ \"12943539255\"], // Pass single Item ID to update\n \"status\" : \"CANCELLED\", // Ex: CANCELLED, RTO_REQUESTED, RETURN_REQUESTED\n \"reason\" : \"Size is too small\", // (Not mandatory) Reason for Cancellation or Return\n \"createdAt\" : 1539598799000, // Timestamp\n \"metadata\": =======> Optional\n { \n \"RET_SITE\": \"14050201\", \n \"I_CREDITFLAG\": \"XYZ1\" \n }\n}"},"url":"https://api-preprod.ailiens.com/b/namo/api/v1//order/status","description":"
Once the order is created in omuni, you can use this API to initiate or update the status of the order to 'Cancel' in omuni platform. This helps in keeping track of the order and gives visibility on the current status of the order. You can call this API to initiate a Cancel order in omuni. ‘The status can be updated only for a single item at a time. To update the status for multiple items, the API needs to be called multiple times. Omuni Cloud will maintain the status update Validations and will give proper responses in case you have sent in Invalid Status. For Example, Once the Order is Shipped and your Application send Cancel status to Omuni, omuni will not accept that and send you a Valid Response.
\n
General Flow:
\n
\n
The Customer has ordered a particular item on the brand's site.
\n
The order gets created in Omuni via. Add/create Orders in Omuni.
\n
Customer cancels the particular order on the brand's site.
\n
The user calls this API to 'cancel' it in the Omuni platform.
\n
The user passes the mandatory parameters and changes the order status.
\n
Order status gets moved to cancelled in Omuni
\n
\n
Process Flow:
\n
\n
The user calls this API to update the order status to 'cancel' into Omuni platform.
\n
The user is asked for an Access token as an input parameter in the headers and other mandatory parameters such as orderId, ItemID, Status (Cancel), etc. in the body of the API request
\n
The user passes all the mandatory parameters.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input – Order status gets updated or initiated to (Cancel) in Omuni platform.
\n
Incorrect Input - Errored response.
\n
\n
\n
Note
\n
\n
Only one single item to be passed at a time during this API call.
\n
In the case of multiple items, this API to be called multiple times.
\n
\n
Request Parameters
\n
\n\n
\n
field
\n
description
\n
Mandatory
\n
Datatype
\n
constraints
\n
\n\n\n
\n
source
\n
Order source
\n
No
\n
String
\n
255 characters
\n
\n
\n
orderId
\n
Order Id
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
itemIds
\n
Item Id (Single item)
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
status
\n
Order Status (e.g. CANCELLED)
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
reason
\n
Cancel Reason
\n
No
\n
String
\n
255 characters
\n
\n
\n
createdAt
\n
request Created Time stamp
\n
Yes
\n
Timestamp
\n
255 characters
\n
\n\n
\n
Response
\n
\n\n
\n
RESPONSE CODE
\n
DESCRIPTION
\n
\n\n\n
\n
200 & 202 - OK & Accepted
\n
Everything worked as expected. The response is displayed or the processing starts. Some APIs may respond with an error message if data is invalid.
\n
\n
\n
400 - Bad Request
\n
The request was unacceptable, often due to missing a required parameter.
\n
\n
\n
401 - Unauthorized
\n
There is some error in validation. You need to check your token or credentials.
\n
\n
\n
404 - Not Found
\n
The URL is inaccessible. This is either due to the wrong URL input or the resource being depreciated.
\n
\n
\n
405 - Method Not Allowed
\n
The API was accessed using the wrong method. Check your HTTP method.
\n
\n
\n
422 - Unprocessable Entity
\n
It means the request contains incorrect syntax or cannot be fulfilled. Try checking your code for errors.
\n
\n
\n
429 - Too Many Requests
\n
Too many hits were attempted at the API too quickly. Provide the API some time to process.
\n
\n
\n
500, 502, 503, 504 - Server Errors Some server error occurred.
\n
Some APIs may show this due to syntax or parameter errors. Try contacting support if this persists.
\n
\n\n
\n
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"78d097be-23b9-4852-9965-84c649e5b25c","id":"78d097be-23b9-4852-9965-84c649e5b25c","name":"Headless Commerce","type":"folder"}},"urlObject":{"protocol":"https","path":["b","namo","api","v1","","order","status"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"f5747eaf-b87c-432f-80b7-7e99c746de39","name":"Cancel API","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"accessToken","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source\" : \"Tenant Name\",\n \"orderId\" : \"18134775035\", \n \"itemIds\" : [ \"12943539255\"], // Pass single Item ID to update\n \"status\" : \"CANCELLED\", // Ex: CANCELLED, RTO_REQUESTED, RETURN_REQUESTED\n \"reason\" : \"Size is too small\", // (Not mandatory) Reason for Cancellation or Return\n \"createdAt\" : 1539598799000, // Timestamp\n \"metadata\": =======> Optional\n { \n \"RET_SITE\": \"14050201\", \n \"I_CREDITFLAG\": \"XYZ1\" \n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/namo/api/v1/cloud/order/status"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Order CANCELLED successfully\",\r\n \"status\": \"OK\",\r\n \"status_code\": 200\r\n}"}],"_postman_id":"7bf32709-8273-4422-8cf2-e6b493f5eb59"},{"name":"Return an item","id":"b7edcf1d-05d3-43da-b95e-aa808c0f3146","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"accessToken"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"source\": \"API\",\n \"orderId\": \"UNI-68106649\",\n \"itemIds\": [\"68106649\" ], // Pass single Item ID to return\n \"status\": \"RETURN_INITIATED\",\n \"reason\": \"\",\n \"createdAt\": null,\n \"awb\": \"1458589\", =======> Optional (If its brand/website owned courier, then pass AWB no, otherwise ignore\n \"metadata\": =======> Optional\n{\n \"RET_SITE\": \"14050201\",\n \"I_CREDITFLAG\": \"XYZ1\"\n \n},\n\"neftDetails\": { =======> Optional\n \"customerName\": \"hena\",\n \"bankName\": \"HDFC\",\n \"branchAddress\": \"garudaMall\",\n \"accountNature\": \"Savings\",\n \"branchName\": \"Old Airport Road\",\n \"accountNumber\": \"1234564447890\",\n \"ifscCode\": \"HDFC0000045\"\n}\n}"},"url":"https://api-preprod.ailiens.com/b/namo/api/v1//order/status","description":"
Initiate Returns in Omuni
\n
This API is called to initiate return into omuni platform. If the customer returns an item of the order placed in user’s E-Commerce sites, the user can process the same status into omuni and initiate return for the same item in Omuni platform. ‘Only a single item status can be updated at a time when this API is to be called. To initiate a return for multiple items, the user needs to call this API multiple times.’Omuni Cloud will maintain all the status update Validations and will give proper responses in case you have sent in Invalid Status. For Example, If the Order that you want to initiate return is Delivered, Omuni will give an Error response.
\n
General Flow:
\n
\n
Customer comes to the brand's E-Commerce site and initiates the return process for an order item.
\n
The user calls this API to initiate a return for the same item in the Omuni platform.
\n
The user passes the mandatory parameters and changes the item order status.
\n
Return for the item passed gets initiated in Omuni
\n
\n
Process Flow:
\n
\n
The user calls this API to initiate the return for an item into Omuni platform.
\n
The user is asked for an Access token as an input parameter in the headers and other mandatory parameters such as orderId, ItemID, Status, etc. in the body of the API request.
\n
The user passes all the mandatory parameters.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input – Order item return gets initiated in Omuni platform.
\n
Incorrect Input - Errored response.
\n
\n
\n
Note
\n
\n
Only one single item to be passed at a time during this API call.
\n
In the case of multiple items, this API to be called multiple times.
\n
The NEFT details in the body of the request are optional but can be passed in case of Refunds.
\n
\n
Request Parameters
\n
\n\n
\n
field
\n
description
\n
Mandatory
\n
Datatype
\n
constraints
\n
\n\n\n
\n
order_id
\n
Order ID for order
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
status
\n
Return Status ,should be RETAWB
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
shipment_track_number
\n
AWB Number
\n
No
\n
String
\n
255 characters
\n
\n
\n
shipment_carried_code
\n
Courier Code
\n
No
\n
String
\n
255 Characters
\n
\n
\n
shipment_title
\n
Courier Name
\n
No
\n
String
\n
255 Characters
\n
\n
\n
shipment_created
\n
Shipment date
\n
No
\n
String
\n
255 Characters
\n
\n
\n
items
\n
List of Item description
\n
Yes
\n
\n
\n
\n
\n
item_id
\n
Item Id of Order (single item id is allowed)
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
qty_id
\n
quantity, always 1
\n
No
\n
String
\n
255 Characters
\n
\n
\n
sku
\n
Barcode of Item
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
AWB
\n
Courier unique tracking id. If the logistics is handled by brand, then Unique AWB number to be sent for earh item
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Customer Name
\n
As per Bank record
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Bank Name
\n
As per Bank record
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Branch Address
\n
Bank branch address
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Account Number
\n
As per Bank length
\n
No
\n
String
\n
255 Characters
\n
\n
\n
IFSC Code
\n
11 Digits as per Banking standard
\n
No
\n
String
\n
255 Characters
\n
\n\n
\n
Response
\n
\n\n
\n
RESPONSE CODE
\n
DESCRIPTION
\n
\n\n\n
\n
200 & 202 - OK & Accepted
\n
Everything worked as expected. The response is displayed or the processing starts. Some APIs may respond with an error message if data is invalid.
\n
\n
\n
400 - Bad Request
\n
The request was unacceptable, often due to missing a required parameter.
\n
\n
\n
401 - Unauthorized
\n
There is some error in validation. You need to check your token or credentials.
\n
\n
\n
404 - Not Found
\n
The URL is inaccessible. This is either due to the wrong URL input or the resource being deprecated.
\n
\n
\n
405 - Method Not Allowed
\n
The API was accessed using the wrong method. Check your HTTP method.
\n
\n
\n
422 - Unprocessable Entity
\n
It means the request contains incorrect syntax or cannot be fulfilled. Try checking your code for errors.
\n
\n
\n
429 - Too Many Requests
\n
Too many hits were attempted at the API too quickly. Provide the API some time to process.
\n
\n
\n
500, 502, 503, 504 - Server Errors Some server error occurred.
\n
Some APIs may show this due to syntax or parameter errors. Try contacting support if this persists.
This API is called to initiate return into omuni platform. If the customer returns an item of the order placed in user’s E-Commerce sites, the user can process the same status into omuni and initiate return for the same item in Omuni platform. Omuni Cloud will maintain all the status update Validations and will give proper responses in case you have sent in Invalid Status. For Example, If the Order that you want to initiate return is Delivered, Omuni will give an Error response.
\n
General Flow:
\n
\n
Customer comes to the brand's E-Commerce site and initiates the return process for an order item.
\n
The user calls this API to initiate a return for the same item in the Omuni platform.
\n
User can use external item id and order id to initiate this return. Example in case if shopify - shopify order id and itemm id can be passed
\n
The user passes the mandatory parameters and changes the item order status.
\n
Return for the item passed gets initiated in Omuni
\n
\n
Process Flow:
\n
\n
The user calls this API to initiate the return for an item into Omuni platform.
\n
The user is asked for an Access token as an input parameter in the headers and other mandatory parameters such as orderId, ItemID, Status, etc. in the body of the API request.
\n
The user passes all the mandatory parameters.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input – Order item return gets initiated in Omuni platform.
update refund status for cases where order is prepaid and refund is managed by the source (not Omuni)
\n
\n","_postman_id":"14c8d65f-bbee-48af-b4e6-c0d5b4ef0985","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"78d097be-23b9-4852-9965-84c649e5b25c","id":"78d097be-23b9-4852-9965-84c649e5b25c","name":"Headless Commerce","type":"folder"}}},{"name":"Webhooks","item":[{"name":"Status update - omuni to source","id":"46e168f7-a2b5-4b1f-b020-4a22c5c5d984","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Apikey","value":"Your Auth Key","type":"text"}],"url":"https://yourdomain/order/status","description":"
This API gets called whenever a status change has occurred in Omuni. The user needs to share his URL and Omuni will make a post request to the same and push the Order status to your system in real-time. Assume an order has been moved to the Shipped state in omuni system, then the same status update for the given order will be pushed to your application through the given URL and the status for the order will be updated in real-time. This API helps in keeping status check and both the applications in sync.
\n
General Flow
\n
\n
The status of an order gets changed in the omuni system
\n
This API gets called to update the status change in brand's system
\n
Omuni pushes the status change to the user’s system through the given URL in the endpoint
\n
The status gets updated in the brand’s system
\n
\n
Process Flow
\n
\n
The user has shared his URL endpoint to omuni
\n
A status update happens at Omuni side
\n
Omuni calls the user’s URL endpoint, pushes the status update and other parameters to the brand’s system
\n
\n
Outcome
\n
\n
Correct Input - the status gets updated in brand’s system in real-time
\n
Incorrect Input – Errored response.
\n
\n
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"99650c5c-c511-4d2b-ab7e-c8aa8304cd9b","id":"99650c5c-c511-4d2b-ab7e-c8aa8304cd9b","name":"Webhooks","type":"folder"}},"urlObject":{"protocol":"https","path":["order","status"],"host":["yourdomain"],"query":[],"variable":[]}},"response":[{"id":"94e2e268-3f63-4223-970f-82b85970ce2c","name":"Omuni Update Order status in your Webstore","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Apikey","value":"Your Auth Key","type":"text"}],"body":{"mode":"raw","raw":"'{\n\t\"orderReference\": \"5277267272\",\n\t\"itemIds\": [\"5266542\"],\n\t\"status\": \"ASSIGNED\",\n\t\"createdAt\": 1553680810,\n\t\"reason\": \"Not mandatory will only use time of RTO and CANCELATION\"\n\t\"awbNo\": \"1233\",\n\t\"courierName\": \"dhl\",\n \"invoiceNumber\" :\"INV001\",\n \"invoiceUrl\": \"https://download/INV001\",\n \"trackingUrl\": \"https://trackyourproduct/article\"\n}\n'","options":{"raw":{"language":"json"}}},"url":"https://yourdomain/order/status"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Order Invoiced successfully\",\n \"status\": \"success\",\n \"status_code\": 200\n}"},{"id":"7d555d48-1703-4b7e-83dc-96cd6e476d95","name":"Status update - omuni to source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Apikey","value":"Your Auth Key","type":"text"}],"url":"https://yourdomain/order/status"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"46e168f7-a2b5-4b1f-b020-4a22c5c5d984"},{"name":"Inventory update - omuni to source","id":"2eb2716e-825b-4888-9030-b210a0f7c5d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Apikey","value":"Shared API Key","type":"text"}],"url":"https://yourdomain/inventory/update","description":"
This API gets called whenever an inventory change has occurred in Omuni. The user needs to share his URL and Omuni will make a post request to the same and push the delta inventory change to your system in real-time. The Inventory count shared in the webhook is the Available quantity in Omuni enabled stores and warehouses and the same should be Overwritten in your Application. Assume there is an inventory change in Omuni system, then the same delta change in inventory will be pushed to your application through the given URL and the inventory will be updated in real-time. This API helps in keeping inventory in sync. \nPlease note Omuni will not change the Webhook format and you have to subscribe to the JSON format shared in the Curl request
\n
General Flow
\n
\n
There is an inventory change in the Omuni system
\n
This API gets called to update the delta inventory change in the brand’s system
\n
Omuni pushes the inventory change to the user’s system through the given URL in the endpoint
\n
The inventory gets updated in brand's system
\n
\n
Process Flow
\n
\n
The user has shared his URL endpoint with Omuni
\n
A inventory change happens at Omuni’s side
\n
Omuni calls the user’s URL endpoint and pushes the EAN and quantity to the brand's system
\n
\n
Outcome
\n
\n
Correct Input - the inventory gets updated in the brand's system in real-time
Webhooks allow you to build or set up integrations that subscribe to certain events on Omuni Cloud APIs. When one of those events is triggered, we send an HTTP POST payload in JSON to the webhook's configured URL. It allows for the real time update in case of the event being triggered. These APIs act in outward fashion i.e., from Omuni to external system.
This API is called by the user to add/update product/article information in Omuni system. A product can be added in omuni by passing complete product details with the help of this API. An article master file will be provided by omuni on successful onboarding and then to add the products a payload similar to the fashion of the Article file should be passed through this API. It will help in smooth and easy addition and update of the products in omuni system.
\n
General Flow
\n
\n
User wants to add products in omuni
\n
A sample article file is provided to the user for reference
\n
The user calls this API and passes the payload in the same fashion
\n
Passes the required parameters
\n
The product gets successfully added/updated in omuni.
\n
\n
Process Flow
\n
\n
User wants to add or update product information in omuni
\n
Passes the authentication token in the headers and payload similar to the article file in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Product gets successfully added/updated in Omuni
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Parameter
\n
Description
\n
Data Type
\n
Mandatory
\n
Sample Values
\n
\n\n\n
\n
merchLevel1
\n
Gender
\n
String
\n
Yes
\n
Men
\n
\n
\n
merchLevel2
\n
Merchandising Category
\n
String
\n
Yes
\n
Apparel, Footwear
\n
\n
\n
merchLevel3
\n
Article Type
\n
String
\n
Yes
\n
Shirts, Shoes
\n
\n
\n
articleNumber
\n
Article number
\n
String
\n
Yes
\n
4.00015E+11
\n
\n
\n
uom
\n
Unit of Measure (EA - each, PCS - Pieces, NO - Number)
This API is used to display a list of products to a customer on the brand's website. Suppose a customer comes to your website and then browses to the products page to see for a formal shirt of large size. Then at that instance, the brand/client will call for this API and pass the requested category and size in the body of the request and then in return the API will provide a list of similar products to the customer. Please contact Omuni Integration team for a detailed demo of this API.
\n
General Flow:
\n
\n
Customer visits brand’s E-Commerce site and wants to checklist of products available with the brand under formal wear section.
\n
The user/brand calls this API, passes the Product category and size as an Input.
\n
The API in turn returns a complete list of formal wear products on the Products page of brand’s website.
\n
\n
Process Flow:
\n
\n
The client wants to display a list of products on the website.
\n
Calls this API to get a complete range of products to be displayed on their website.
\n
The client passes the categories and filters in the body of the request as an input.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input – Displays a complete range of products on the brand’s website.
This API can be used to display the complete details of a particular product requested by the customer on the client's website. Assume that the customer comes to your website, scrolls down to the products page, and clicks on a particular product. Then this API can be called and the style id of that product needs to be passed in the body of the request and in turn, the API will display the details of that specific product. It will display the pricing details, sizes and variants available, and many more attributes. Again, please contact Omuni Integration team for a detailed demo of this API
\n
General Flow:
\n
\n
Customer visits the brand’s E-Commerce site and wants to check a particular product available with the brand.
\n
The user/brand calls this API, passes the particular style ID as an Input.
\n
The API in turn returns complete details on that particular product on the brand’s website.
\n
\n
Process Flow:
\n
\n
The client wants to provide complete Product details to the customer on the website.
\n
Calls this API to get the details of a particular product requested
\n
The client passes the style ID of that product as an input.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input – Displays complete details about that particular product on the brand’s website.
This API is called to check the inventory count for a particular EAN in the respective fulfillment centers of the user in Omuni system. The user can basically get the exact quantity of a particular EAN present at their respective stores being displayed in Omuni system. It helps in having a tally of the inventory present with the user and the inventory present in Omuni system. The user can pass the authentication token and the EAN as an input parameter in the API request and get the inventory count. To get the inventory count for a specific fulfilment center, they can pass the FcId in the body parameter \"currentFcId\" and they will get the inventory count for that particular EAN-FcId combination. Also, there is a parameter \"WarehouseId\" in the request url, where you can pass a particular clusterId and then the API will give inventory count for the FCs in the particular cluster that have the EAN present. The parameter \"WarehouseId\" is an optional parameter.
\n
General Flow
\n
\n
User wants to get the inventory count for a particular EAN in Omuni
\n
The user calls this API and passes the particular EAN.
\n
The user gets a total count of the EAN present in different stores in Omuni.
\n
\n
Process Flow
\n
\n
User wants to get the inventory count for a particular EAN in Omuni
\n
The user calls this API and passes the particular EAN.
\n
Passes the authentication token in the headers and EAN, fcId in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – gets a total inventory count at different stores for the particular EAN
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Field
\n
Description
\n
Mandatory
\n
Datatype
\n
Constraints
\n
\n\n\n
\n
ean
\n
This is a value to indicate a sellable item
\n
Yes (In case eoisEan is not passed\")
\n
String
\n
255 Characters
\n
\n
\n
currentFcId
\n
This indicates the fulfilment center
\n
No
\n
String
\n
255 Characters
\n
\n
\n
eoisEan
\n
External ean.Need to pass this value only if you use mapping feature, otherwise dont pass this key/value pair
\n
Yes (In case ean is not passed)
\n
String
\n
255 Characters
\n
\n
\n
warehouseId
\n
Cluster Id given by Omuni team
\n
No
\n
String
\n
255 Characters
\n
\n\n
\n
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c0d2de37-413b-49a4-b934-75f9aa1732a4","id":"c0d2de37-413b-49a4-b934-75f9aa1732a4","name":"Product & Inventory APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["b","namo","api","v1","","inventory","lookup"],"host":["api-preprod","ailiens","com"],"query":[{"key":"warehouseId","value":""}],"variable":[]}},"response":[{"id":"52834cc3-da23-4b1a-b249-e3b816d8e89c","name":"Inventory Look up API","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"ACCESS_TOKEN"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"This is optional but recommended. This is useful for tracing a request. If you want to uniquely identify a request please use this header to pass a trace id for the request. This is used by us internally ","key":"X-TRACE-ID","type":"text","value":"","disabled":true},{"key":"Cache-Control","value":"no-cache","type":"text","disabled":true}],"body":{"mode":"raw","raw":"[\n{\n\"ean\": \"41815541860005\",\n\"currentFcId\": \"\",\n\"eoisEan\": \"eoisEan123\"\n}\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-preprod.ailiens.com/b/namo/api/v1//inventory/lookup?warehouseId=","protocol":"https","host":["api-preprod","ailiens","com"],"path":["b","namo","api","v1","","inventory","lookup"],"query":[{"key":"warehouseId","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"ean\": \"41815541860005\",\r\n \"eoisEan\": \"eoisEan123\",\r\n \"totalQuantity\": 9963,\r\n \"currentFcId\": \"\",\r\n \"fcData\": [\r\n {\r\n \"fcId\": \"Test_001\",\r\n \"qty\": 9968\r\n },\r\n {\r\n \"fcId\": \"Test_002\",\r\n \"qty\": 2\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"11130487-022d-4c7d-b85c-9ad400358258"}],"id":"c0d2de37-413b-49a4-b934-75f9aa1732a4","description":"
The following APIs help in adding or updating the product information in Omuni, adding inventory, keeping the inventory at both the places in sync. They also help in getting the inventory count to have a track of the inventory.\nAfter successful onboarding, you will be able to receive a sample article file for updating and addition of products as well as a sample inventory file to keep the inventory in sync at all places.
Headless Commerce APIs of omuni.cloud can power any e-commerce site or app, conversational commerce channels & commerce interfaces with full fledged omnichannel journeys.
\n
omuni's unified omnichannel commerce backend is the 1-shot solution covering
\n
\n
Unified inventory management
\n
Order management & orchestration
\n
Logistics management
\n
Pricing & Promotions
\n
Product catalogue management
\n
Content management
\n
Customer relationship management
\n
\n
This covers
\n
\n
Easy to integrate APIs
\n
Webhooks for updates
\n
Ready integrations with multiple ecosystem platforms
\n
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d013d451-6b0d-43fb-82d6-0b1ff8885b87","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"afbe9795-c7d1-44ad-867a-de52f2918c30","type":"text/javascript","exec":[""]}}],"_postman_id":"78d097be-23b9-4852-9965-84c649e5b25c"},{"name":"Store/POS","item":[{"name":"Authentication","item":[{"name":"Generate API token","id":"f759c53f-d3bc-445f-b4bd-95fe05ac4a9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"grant_type\":\"password\",\r\n\"username\":\"Your username\",\r\n\"password\":\"Your Password\"\r\n}\r\n"},"url":"https://api-preprod.ailiens.com/login/users/mp_business-user/token/v3","description":"
This API is used to generate access token and refresh token which will be used as a parameter for the API to function properly. To generate the tokens, you will be asked for a username and password, which will be provided once you onboard as Omuni client. The access token generated lasts for a limited time period. This API acts as a validation point.
\n
General Flow
\n
\n
A new client onboards and signs for Omuni product suite
\n
\n
The user gets their specific username and password after onboarding.
\n
\n
Then calls this API for generating the access token.
\n
\n
The token generated is then used for running other APIs
\n
\n
\n
Process Flow:
\n
\n
The user calls this API to generate an Access token.
\n
\n
The user is asked for a username and password to validate themselves as an authorized user.
\n
\n
Inputs the username and password specific to them provided by Omuni.
\n
\n
Hits the API request
\n
\n
\n
Outcome:
\n
\n
Correct Input - Access token and Refresh token generated.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f47a0f22-4bee-4ec7-a727-9ec591d235de","id":"f47a0f22-4bee-4ec7-a727-9ec591d235de","name":"Authentication","type":"folder"}},"urlObject":{"protocol":"https","path":["login","users","mp_business-user","token","v3"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"d8be008c-f4b8-4288-91f4-0c6394165b33","name":"Generate API token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"grant_type\":\"password\",\r\n\"username\":\"Your username\",\r\n\"password\":\"Your Password\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/login/users/mp_business-user/token/v3"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJlbWFpbF9pZCI6ImpheWFzaW1oYS5jc19hbGJsQGFydmluZGludGVybmV0LmNvbSIsImxhc3ROYW1lIjoiIiwic2Vzc2lvbiI6IjBhYTRhYjAwLWM3NzMtNGJlYi04MDIxLWQ5ZGRjMmJmNjI1ZiIsImFzc29jaWF0ZWRTdG9yZUlkcyI6W10sInJvbGVzIjpbIlJPTEVfQUlMX1NUQUZGIiwiUk9MRV9CVVNJTkVTU19VU0VSIiwiUk9MRV9TSElFTEQiXSwiaXNzIjoiYmxhY2tib2x0IiwidHlwIjoiQmVhcmVyIiwiYXVkIjoib2RpbiIsImZpcnN0TmFtZSI6IiIsInVzZXJfaWQiOiI5NjNiY2ExMy0zYWRkLTRmNTUtYWUwZC00ZjZjN2QwNDAyNGUiLCJ0ZW5hbnRJZCI6IjVmOWQzMzZhLWVlZGItNGZhNC1iNDA4LWNmMzhjZWZjOTZlMCIsIm1pZGRsZU5hbWUiOiIiLCJleHAiOjE2MTEzMDU5ODAsImlhdCI6MTYxMTMwNTM4MCwianRpIjoiN2IxNjc4ZjMtMDYzMC00NzcxLTk4ZmQtNDc3OGQwOGM4OGI0In0.K6JPg4OlwRTfC6YU57x-WsgW9qPyg2Nr33S6slSmiapS66g1MtUxk5rZhb27Fya-D6NRL6jDEuo9ueAl6wqhnytgQoZkoeZ20zaiIHED0N7qYv6JPBMcUDnbvtmlHdJKHRd3d3jqL5XRFbzcWjLWqueardOsuwYYj84HDyYa83FTAbKWSq9yisRIxtBAYaxQTHWThbMQU4eR7tKjZIbndNdcuOjI6JgZ9qHBB2VsNJMuaraAwkKcr4NDuM4ipRXH1z_216gyky5-RoXj0uMovKYZ_PGs86r_O7Y3tnCnL1s2AJ9gsT9kkYCc3fJ9ARosDAPAuCouk7cTv6-8ZabdDA\",\r\n \"refresh_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJvZGluIiwic2Vzc2lvbiI6IjBhYTRhYjAwLWM3NzMtNGJlYi04MDIxLWQ5ZGRjMmJmNjI1ZiIsImlzcyI6ImJsYWNrYm9sdCIsInR5cCI6IlJlZnJlc2giLCJleHAiOjE2MTY0ODkzODAsImlhdCI6MTYxMTMwNTM4MCwianRpIjoiODJhOWVkMWYtNTJiMC00YWI1LThkNDEtNDE5MWE2Yjk5ZGZiIn0.DUTmLiKUISS7EOvUyozYNPnt5FAcvpmOnvry26rcCOj4Hhppy_wgOh_RQjF6ZvPIEJXB6Zq9Pbh6x1aDSMqpt4d1JBt17hbTttbRiRV0Ob9cOIKZU4Nbvpi2aQhDFR0m1jNcADLYCyUIWJ5R3bUYyISzV96LtmB5WrBUCW0SZUfqFlTgrrEBMjG3H1lKR6q76SKWtSOKEPDrzt-SJdBPKAQcXQEMSws1J9piaLTDjamDvS12-oxBmZKTEywnqNA5loKAxSQNeEI4OMcP3elDdfTn_qmihZ1MkJwgVk3wIweC4-yE0G2b3XwNucSyh8QtVlZEeGTPCPvU4VP1GiENmg\"\r\n }\r\n}\r\n"}],"_postman_id":"f759c53f-d3bc-445f-b4bd-95fe05ac4a9f"},{"name":"Refresh API token","id":"9918f501-3a06-437c-a22c-259eda01bee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"grant_type\":\"refresh_token\",\r\n\"refresh_token\":\"REFRESH_TOKEN\"\r\n}\r\n"},"url":"https://api-preprod.ailiens.com/login/users/mp_business-user/token/v3","description":"
The access token generated earlier is only valid for a limited period of time and hence it gets expired after some time. To generate a new access token, this API must be called. You need to pass the Refresh token generated earlier as an input for generating the new Access token which again can be used as a parameter for running the APIs.
\n
General Flow:
\n
\n
The user calls the Generate API token request for generating the access token and refresh token.
\n
\n
The Access token generated expires after some time.
\n
\n
To generate a new access token the Refresh token API is called
\n
\n
The new access token generated is then used for running the APIs
\n
\n
\n
Process Flow:
\n
\n
The user calls this API to generate a new Access token.
\n
\n
The user is asked for a Refresh token as an input parameter.
\n
\n
The Refresh token generated earlier is then provided as the input to run this API
\n
\n
Hits the API request
\n
\n
\n
Outcome:
\n
\n
Correct Input - New Access token generated.
\n
\n
Incorrect Input - Errored response.
\n
\n
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f47a0f22-4bee-4ec7-a727-9ec591d235de","id":"f47a0f22-4bee-4ec7-a727-9ec591d235de","name":"Authentication","type":"folder"}},"urlObject":{"protocol":"https","path":["login","users","mp_business-user","token","v3"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"0f8ecf71-1494-4a36-ae9a-a533f117c9a7","name":"Refresh API token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"grant_type\":\"refresh_token\",\r\n\"refresh_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJvZGluIiwic2Vzc2lvbiI6IjBhYTRhYjAwLWM3NzMtNGJlYi04MDIxLWQ5ZGRjMmJmNjI1ZiIsImlzcyI6ImJsYWNrYm9sdCIsInR5cCI6IlJlZnJlc2giLCJleHAiOjE2MTY0ODkzODAsImlhdCI6MTYxMTMwNTM4MCwianRpIjoiODJhOWVkMWYtNTJiMC00YWI1LThkNDEtNDE5MWE2Yjk5ZGZiIn0.DUTmLiKUISS7EOvUyozYNPnt5FAcvpmOnvry26rcCOj4Hhppy_wgOh_RQjF6ZvPIEJXB6Zq9Pbh6x1aDSMqpt4d1JBt17hbTttbRiRV0Ob9cOIKZU4Nbvpi2aQhDFR0m1jNcADLYCyUIWJ5R3bUYyISzV96LtmB5WrBUCW0SZUfqFlTgrrEBMjG3H1lKR6q76SKWtSOKEPDrzt-SJdBPKAQcXQEMSws1J9piaLTDjamDvS12-oxBmZKTEywnqNA5loKAxSQNeEI4OMcP3elDdfTn_qmihZ1MkJwgVk3wIweC4-yE0G2b3XwNucSyh8QtVlZEeGTPCPvU4VP1GiENmg\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/login/users/mp_business-user/token/v3"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJlbWFpbF9pZCI6ImpheWFzaW1oYS5jc19hbGJsQGFydmluZGludGVybmV0LmNvbSIsImxhc3ROYW1lIjoiIiwic2Vzc2lvbiI6IjBhYTRhYjAwLWM3NzMtNGJlYi04MDIxLWQ5ZGRjMmJmNjI1ZiIsImFzc29jaWF0ZWRTdG9yZUlkcyI6W10sInJvbGVzIjpbIlJPTEVfQUlMX1NUQUZGIiwiUk9MRV9CVVNJTkVTU19VU0VSIiwiUk9MRV9TSElFTEQiXSwiaXNzIjoiYmxhY2tib2x0IiwidHlwIjoiQmVhcmVyIiwiYXVkIjoib2RpbiIsImZpcnN0TmFtZSI6IiIsInVzZXJfaWQiOiI5NjNiY2ExMy0zYWRkLTRmNTUtYWUwZC00ZjZjN2QwNDAyNGUiLCJ0ZW5hbnRJZCI6IjVmOWQzMzZhLWVlZGItNGZhNC1iNDA4LWNmMzhjZWZjOTZlMCIsIm1pZGRsZU5hbWUiOiIiLCJleHAiOjE2MTEzMzg5NDAsImlhdCI6MTYxMTMzODM0MCwianRpIjoiYmQwMTI4N2QtNDVhMS00OTY1LTliMjYtMGUzMWY4Njc1Yjg4In0.UJm_JMnUKvw33DMu7e8eWe1yacqeMbCt3fYSDhrTmWe4HZAeTXty7Xtx33tJnRWBT-woA75W76jG13PPV2sDjX1FMEam9eSDCShFyAA87MAv5VnQdmR4jBHcz9nNplbKRHLrzougwVALFtgPkUxyrNoalqcUd1-CGMP9sB55R6QZ3VYYYBtgvNkUfeNjnVkInUGvRwok8YxlImZS0dcJkVzkFfqlSBIbtO4aoDyOqBHf6XUSe90sJPVlRChjfkyPwXbEKNtHcN8gU5N9NjRdf5OEgJJpB7stsnUUaBkkA8WiRslcmYvS_8qRTv0BHMS8EsNDosmNg4oYX0OPmdcdgQ\",\r\n \"refresh_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJvZGluIiwic2Vzc2lvbiI6IjBhYTRhYjAwLWM3NzMtNGJlYi04MDIxLWQ5ZGRjMmJmNjI1ZiIsImlzcyI6ImJsYWNrYm9sdCIsInR5cCI6IlJlZnJlc2giLCJleHAiOjE2MTY1MjIzNDAsImlhdCI6MTYxMTMzODM0MCwianRpIjoiN2MwMzAyM2YtOWU0Yi00ZjYwLTkwMWEtNjkzNzljODUzNzZiIn0.Y5ebaFdTDPQcuPUHzT7ALfMcP5HDkhyjkJOUuq7aNKRyOw2ejJpRTZTDBaF105_aH9CAXjZuko6PwF40QnccB4fThIZcEfOqhDA8i-JNRhbNLOa6nIJZdnE9I9qKwGoiVebAXFvMlYIqH12sSuO2vgBq77NHEmH9ibAG66u9fTRTNeNiON76s__Kg8tvupHk0fh0kQJisMy_NOt-fezDvaOR6gp-SOiZqYOMfimevzR_jfA05z4KDue1kG3beuAnZIVb-0DW6zoN5QDBhtdrQxMzxDo-cKZtcL1ZHCzOBotY9j-Ibw7bIXdlu-AFdWI0aENsyP8eyI_XY_76jIpphQ\"\r\n }\r\n}\r\n"}],"_postman_id":"9918f501-3a06-437c-a22c-259eda01bee3"}],"id":"f47a0f22-4bee-4ec7-a727-9ec591d235de","description":"
The purpose of this authentication is to validate the request as an authorized Omuni account. It basically acts as a gateway for letting only authorized requests go ahead. The authentication token is the authorization that you need to pass in order to access omuni.cloud's resources. All the API calls to the Omuni are via HTTPS and authenticated via token based.
\n
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret token in publicly accessible areas such as GitHub, client-side code, and so forth.
\n
API Token
\n
An API user gets two types of tokens i.e. Access token and Refresh token which are needed further to pass as a parameter for the APIs to function properly. For generation of these tokens you will require a username and password - which will be provided once you have onboarded and signed in as Omuni customer.
\n
\n
Access token: The validity is only for a limited period of time. Use \nRefresh token to renew your access token
\n
Refresh token: The validity of this also is time-bound but longer than the access token. Use the username and password to get the new refresh token.
This API is called to update the delta inventory changes occurring at user’s side into the omuni system. As and when inventory changes at user front, the user can call this API to update that change into omuni at real time. This helps in keeping the inventory at both places in sync. Any small or major inventory change can be updated through credit, debit and overwrite of inventory in omuni. This basically helps in keeping track and real time synchronization of inventory at user and omuni level.
User wants to update the change of inventory into omuni
\n
\n
The user calls this API and passes the inventory change for a particular ean.
\n
\n
Passes the required parameters
\n
\n
The inventory gets successfully added/updated in omuni.
\n
\n
Inventory at both levels in sync
\n
\n
\n
Outcome
\n
\n
Correct Input – Inventory get successfully added/updated in Omuni
\n
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Field
\n
Data Type
\n
Mandatory
\n
Significance
\n
\n\n\n
\n
inventories
\n
list
\n
Yes
\n
This is an outer wrapper which holds all the inventory details.
\n
\n
\n
ean
\n
string
\n
Yes
\n
This is a value to indicate a sellable item.
\n
\n
\n
fcId
\n
string
\n
Yes
\n
This indicates the fulfillment center.
\n
\n
\n
quantity
\n
int
\n
Yes
\n
Quantity for ean in a fulfillment center.
\n
\n
\n
transactionDetail
\n
Object
\n
No
\n
This is a metadata kind of field which is optional.
\n
\n
\n
customerDetail
\n
Object
\n
No
\n
This is a metadata kind of field which is optional.
\n
\n
\n
movementType
\n
String
\n
No
\n
This indicates the way inventory got populated at the pos system. This as well is optional.
\n
\n
\n
transactionType
\n
string
\n
Yes
\n
It can hold values such as - OVERWRITE,CREDIT,DEBIT. This indicates the operation on quantity.
\n
\n\n
\n
Note
\n
\n
The allowed values in transaction type are Overwrite, Credit, Debit
\n
\n
The quantity to be passed should be an integer. No decimal values.
\n
\n
\n","urlObject":{"protocol":"https","path":["b","velocity","delta","inventory","v2"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"644bc10b-befc-4211-a647-fcfc6f70b186","name":"Delta Inventory Update","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer{token}","disabled":true},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-TRACE-ID","value":"","description":"This is optional but recommended. This is useful for tracing a request. If you want to uniquely identify a request please use this header to pass a trace id for the request. This is used by us internally ","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n\t\"inventories\": [{\n\t\t\t\"ean\": \"1234\",\n\t\t\t\"fcId\": \"2234\",\n\t\t\t\"quantity\": 1,\n\t\t\t\"transactionDetails\": {\n\t\t\t\t\"transactionRefNo\": \"ASD123\",\n\t\t\t\t\"salePrice\": 123\n\t\t\t},\n\t\t\t\"customerDetails\": {\n\t\t\t\t\"callingCode\": \"+91\",\n\t\t\t\t\"phoneNumber\": \"8102508687\"\n\t\t\t},\n\t\t\t\"movementType\": \"RTW\",\n\t\t\t\"transactionType\": \"Overwrite\"\n\t\t},\n\t\t{\n\t\t\t\"ean\": \"09876\",\n\t\t\t\"fcId\": \"4322\",\n\t\t\t\"quantity\": 1,\n\t\t\t\"transactionDetails\": {\n\t\t\t\t\"transactionRefNo\": \"ASD123\",\n\t\t\t\t\"salePrice\": 128\n\t\t\t},\n\t\t\t\"customerDetails\": {\n\t\t\t\t\"callingCode\": \"+91\",\n\t\t\t\t\"phoneNumber\": \"8109538687\"\n\t\t\t},\n\t\t\t\"movementType\": \"RTW\",\n\t\t\t\"transactionType\": \"Overwrite\"\n\t\t}\n\t],\n\t\"createdDateTime\": \"2020-10-30 10:00:01\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/velocity/delta/inventory/v2"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\":”All EANs successfully processed.”,\r\n \"correlationId\": \"511ecaa3-2f21-442e-b692-73c306b392b0\"\r\n}"}],"_postman_id":"20be5887-7640-47a8-a44b-ce9227b7d338"},{"name":"Full Inventory Sync","event":[{"listen":"test","script":{"id":"25bb5838-69c4-453f-9c75-c2af7ca0b075","exec":["","","S7aece9","C7aece901","I7aece901","return","BLRA007","BLRA010","BLRA010","OMUNI","S7aece9","20190121","11:08:31","KA","8903338144113","1","0.0","1159.82","1299.0","139.18","IGST","12.0","0.0","CGST","0.0","0.0","false","I7aece901","1299.0","","1299.0","PS ","","","shashikant","","M AIL","Bangalore560001","KarnatakaIndia","9916805245","shashikant.kumar@arvindinternet.com","","","S7aece9","C7aece901","I7aece902","return","BLRA007","BLRA010","BLRA010","OMUNI","S7aece9","20190121","11:08:31","KA","8903338144113","1","0.0","1159.82","1299.0","139.18","IGST","12.0","0.0","CGST","0.0","0.0","false","I7aece902","1299.0","","1299.0","PS","","","shashikant","","M AIL","Bangalore560001","KarnatakaIndia","9916805245","shashikant.kumar@arvindinternet.com"," "],"type":"text/javascript","packages":{},"requests":{}}}],"id":"17e60413-5ba3-4f55-aa41-7766f9a2cb72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {auth token}","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","description":"
This API helps to refresh the inventory of a store via csv upload. It replaces the existing inventory to the provided inventory by the user. This API helps in syncing of the inventory at user and omuni level. The user passes the CSV file in which the ean, its respective quantity and other inputs are given. Then it processes the ean’s which have quantity > 0 and reset the inventory for all other ean’s to zero, which are not present in the CSV file. The sample inventory file will be given after you have successfully onboarded as omuni client.
The Inventory Sync section enables external systems to push and sync inventory data into the Omuni platform. Using these APIs, users can update stock levels across warehouses, stores, or fulfillment centers in real time or via batch uploads.
\n
User can use this section to understand:
\n
\n
Push inventory updates for SKUs across different locations
Channel from where order is placed from eg. android, som, odin
\n
String
\n
255
\n
\n
\n
consignmentStatus
\n
Mandatory
\n
current status of the consignment
\n
String
\n
255
\n
\n
\n
items.itemId
\n
Mandatory
\n
unique Id of item generated by omuni
\n
itemId
\n
255
\n
\n
\n
items.qty
\n
Mandatory
\n
Quantity of ordered items
\n
int
\n
18
\n
\n
\n
items.ean
\n
Mandatory
\n
SKU or EAN of item
\n
String
\n
255
\n
\n
\n
items.hsn
\n
Mandatory
\n
HSN of item
\n
String
\n
255
\n
\n
\n
items.mrp
\n
Mandatory
\n
MRP of the item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.sellingPrice
\n
Mandatory
\n
selling price of the item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.basicAmount
\n
Mandatory
\n
basic amount of the item excluding total tax
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.netAmount
\n
Mandatory
\n
net amount of the item includes selling price and total charges
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalTax
\n
Mandatory
\n
total tax of the item, additional of all taxes
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.taxSummary
\n
Mandatory
\n
Taxation summary or breakup of taxation
\n
\n
\n
\n
\n
poDetails
\n
Mandatory
\n
Purchase order details
\n
\n
\n
\n
\n
poDetails.poNumber
\n
Mandatory
\n
Purchase order number
\n
String
\n
255
\n
\n
\n
poDetails.poDate
\n
Mandatory
\n
creation date of the purchase order which is created
\n
String
\n
127
\n
\n
\n
poDetails.poAmount
\n
Mandatory
\n
Purchase order amount
\n
BigDecimal
\n
15
\n
\n
\n
billToAddress
\n
Mandatory
\n
Address of master seller
\n
\n
\n
\n
\n
billToAddress.zipCode
\n
Mandatory
\n
zipcode of master seller
\n
String
\n
45
\n
\n
\n
billToAddress.city
\n
Mandatory
\n
city detail of master seller
\n
String
\n
45
\n
\n
\n
billToAddress.addressLine1
\n
Mandatory
\n
address line of master seller
\n
String
\n
255
\n
\n
\n
billToAddress.state
\n
Mandatory
\n
state of master seller
\n
String
\n
45
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
stateMasterSellerCode
\n
optional
\n
code of master seller based on state
\n
String
\n
45
\n
\n
\n
orderingFcId
\n
Optional
\n
fcid of order which is placed at, this will be there only in case of som order
\n
String
\n
255
\n
\n
\n
invoiceId
\n
Optional
\n
invoice id of consignment
\n
String
\n
18
\n
\n
\n
invoiceDate
\n
Optional
\n
date at which invoice is generated
\n
String
\n
127
\n
\n
\n
sourceOrderId2
\n
Optional
\n
order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceOrderId1
\n
Optional
\n
customer order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
metadata
\n
Optional
\n
extra data from upstream
\n
Map
\n
40KB
\n
\n
\n
items.sourceItemId
\n
Optional
\n
item id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
items.brand
\n
Optional
\n
brand name of item
\n
String
\n
255
\n
\n
\n
items.totalDiscount
\n
Optional
\n
discount amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalCharge
\n
Optional
\n
charges added for an item, eg shipping charge, cod charge
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstAmount
\n
Optional
\n
cgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstAmount
\n
Optional
\n
igst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstAmount
\n
Optional
\n
sgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstAmount
\n
Optional
\n
ugst amount of item (union teritorry)
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstPercentage
\n
Optional
\n
cgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstPercentage
\n
Optional
\n
igst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstPercentage
\n
Optional
\n
sgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstPercentage
\n
Optional
\n
ugst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
metadata
\n
Optional
\n
extra data from upstream
\n
Map
\n
40KB
\n
\n
\n
itemAttributes
\n
Optional
\n
extra data from upstream( eg: IMEI number)
\n
Map
\n
40KB
\n
\n
\n
poDetails.poPdfUrl
\n
Optional
\n
purchase order Pdf Url
\n
String
\n
1024
\n
\n
\n
billToAddress.addressLine2
\n
Optional
\n
Master seller address details
\n
String
\n
255
\n
\n
\n
billToAddress.addressLine3
\n
Optional
\n
Master seller address details
\n
String
\n
255
\n
\n
\n
billToAddress.mobileNumber
\n
Optional
\n
mobile number of master seller
\n
String
\n
45
\n
\n
\n
billToAddress.country
\n
Optional
\n
country of master seller
\n
String
\n
255
\n
\n
\n
shipToAddress
\n
Optional
\n
Customer's address details
\n
Map
\n
255
\n
\n
\n
shipToAddress.city
\n
Optional
\n
Customer's city
\n
String
\n
255
\n
\n
\n
shipToAddress.state
\n
Optional
\n
Customer's state
\n
String
\n
255
\n
\n
\n
shipToAddress.country
\n
Optional
\n
Customer's country
\n
String
\n
255
\n
\n
\n
shipToAddress.zipCode
\n
Optional
\n
Customer's zipcode
\n
String
\n
255
\n
\n
\n
shipToAddress.addressLine1
\n
Optional
\n
Customer's address line
\n
String
\n
255
\n
\n
\n
shipToAddress.addressLine2
\n
Optional
\n
Customer's address line
\n
String
\n
255
\n
\n
\n
shipToAddress.addressLine3
\n
Optional
\n
Customer's address line
\n
String
\n
255
\n
\n
\n
shipToAddress.mobileNumber
\n
Optional
\n
Customer's mobile number
\n
\n
\n
\n\n
\n
\n
For optional fields which have null value, then either field itself won't be sent or the field will be sent with null value. This depends on whether the field is static or dynamic at our end.
\n
For optional fields which have empty array value, then either the field itself won't be sent or the field will be sent with [] value. This depends on whether the field is static or dynamic at our end.
\n
any new field not mentioned in this contract can be treated as optional
- Ordering channel in omuni. Allowed channels are odin,som,android,ios,xyz, cloud. - odin -Website, - som - Store Order Module(includes omuni.one orders), - android - Android app, - ios - IOS app, - xyz - marketplaces, - cloud - headless commerce.
\n
Array of String
\n
\n
\n
sources
\n
optional
\n
Sources can be PAYTM, AMAZON, MYNTRA, FLIPKART, AJIO, TATACLIQ
\n
Array of String
\n
\n
\n
fulfillingFcIds
\n
optional
\n
Omuni fcId of the center that is fulfilling the order
\n
Array of String
\n
\n
\n
consignmentIds
\n
optional
\n
Omuni consignmentId of the order
\n
Array of String
\n
\n
\n
poNumbers
\n
optional
\n
Purchase order number of the order
\n
Array of String
\n
\n
\n
businessTypes
\n
optional
\n
Business type of the which we want to pull It can B2C Or B2B2C
\n
Array of String
\n
\n
\n
pageNumber
\n
optional
\n
Page number requested Default is 0
\n
Int
\n
\n
\n
pageSize
\n
optional
\n
Page size requested Default is 20 Max is 50
\n
Int
\n
\n\n
\n
\n
Authorization token is mandatory
\n
\n
Filters are : - Channels, sources, fulfillingFcIds, consignmentIds, poNumbers, businessTypes
\n
\n
All the filters in request body is optional
\n
\n
This is paginated API And Default page size is 20
\n
\n
Max page size can be given in single request is 50
\n
\n
If po number is given in request, then max po number can be given in single request is 50
\n
\n
If businessTypes is given in request, then Allowed businessTypes filters are “B2C” And “B2B2C”
\n
\n
If businessType B2C is passed in request, then response will be having only B2C type of orders. If B2B2C is passed, then response will be having only B2B2C type of orders. If both are passed, then the response will be having both B2C and B2B2C orders.
Fulfilling center to which the return order is assigned
\n
String
\n
255
\n
\n
\n
source
\n
Mandatory
\n
source of the return order eg. MYNTRA_DIRECT\"
\n
String
\n
255
\n
\n
\n
channel
\n
Mandatory
\n
Channel from where order is placed from eg. android, som, odin\"
\n
String
\n
255
\n
\n
\n
returnMode
\n
Mandatory
\n
Mode of return orders eg: SELFSHIP, REVERSEPICKUP, RTO, RETURNTOSTORE, CANCELLATION
\n
String
\n
255
\n
\n
\n
returnType
\n
Mandatory
\n
Type of the returns Eg. CANCEL, RTO, RETURN
\n
String
\n
255
\n
\n
\n
items.itemId
\n
Mandatory
\n
unique Id of item generated by omuni
\n
String
\n
255
\n
\n
\n
items.qty
\n
Mandatory
\n
Quantity of items which are ordered
\n
int
\n
18
\n
\n
\n
items.ean
\n
Mandatory
\n
SKU or EAN of item
\n
String
\n
255
\n
\n
\n
items.hsn
\n
Mandatory
\n
HSN of item
\n
String
\n
255
\n
\n
\n
items.mrp
\n
Mandatory
\n
MRP of the item
\n
String
\n
precision - 10 scale - 2
\n
\n
\n
items.sellingPrice
\n
Mandatory
\n
selling price of the item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.basicAmount
\n
Mandatory
\n
basic amount of the item excluding total tax
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.netAmount
\n
Mandatory
\n
net amount of the item includes selling price and total charges
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalTax
\n
Mandatory
\n
total tax of the item, addition of all taxes
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.taxSummary
\n
Mandatory
\n
Taxation summary or breakup of taxation
\n
Map
\n
40KB
\n
\n
\n
Items.returnStatus
\n
Mandatory
\n
current status of return item
\n
String
\n
255
\n
\n
\n
destinationAddress
\n
Mandatory
\n
Destination address of order which is being returned
\n
\n
\n
\n
\n
destinationAddress.address
\n
Mandatory
\n
destination address of return order
\n
String
\n
255
\n
\n
\n
destinationAddress.city
\n
Mandatory
\n
City name of return destination address
\n
String
\n
45
\n
\n
\n
destinationAddress.pincode
\n
Mandatory
\n
pincode of return destination address
\n
String
\n
45
\n
\n
\n
destinationAddress.state
\n
Mandatory
\n
state details of return destination address
\n
\n
\n
\n
\n
state.gstCode
\n
Mandatory
\n
gst of return destination address
\n
String
\n
255
\n
\n
\n
state.name
\n
Mandatory
\n
State name of return destination address
\n
String
\n
255
\n
\n
\n
state.code
\n
Mandatory
\n
State code of return destination address
\n
String
\n
255
\n
\n
\n
destinationAddress.country
\n
Mandatory
\n
Country name of return destination address
\n
String
\n
45
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
omuniInvoiceNumber
\n
Optional
\n
Invoice number generated by omuni
\n
String
\n
255
\n
\n
\n
sourceOrderId1
\n
Optional
\n
customer order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceOrderId2
\n
Optional
\n
order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceReturnId
\n
Optional
\n
item id of source or marketplace, this return will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceItemId
\n
Optional
\n
item id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
items.brand
\n
Optional
\n
brand name of item
\n
String
\n
255
\n
\n
\n
items.totalDiscount
\n
Optional
\n
discount amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalCharge
\n
Optional
\n
charges added for an item, eg shipping charge, cod charge
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstAmount
\n
Optional
\n
cgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstAmount
\n
Optional
\n
igst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstAmount
\n
Optional
\n
sgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstAmount
\n
Optional
\n
ugst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstPercentage
\n
Optional
\n
cgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstPercentage
\n
Optional
\n
igst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstPercentage
\n
Optional
\n
sgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstPercentage
\n
Optional
\n
ugst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.metadata
\n
Optional
\n
extra data from upstream
\n
Map
\n
40KB
\n
\n
\n
items.itemAttributes
\n
Optional
\n
extra data from upstream( eg: IMEI number)
\n
Map
\n
40KB
\n
\n
\n
items.returnMetadata
\n
Optional
\n
extra return details data from upstream
\n
Map
\n
40KB
\n
\n
\n
items.refundAmount
\n
Optional
\n
Amount which got refunded for customer
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.returnReason
\n
Optional
\n
Reason for returning an item
\n
String
\n
255
\n
\n
\n
items.logistics
\n
Optional
\n
Logistics details for returned item
\n
\n
\n
\n
\n
logistics.CODAmount
\n
Optional
\n
Cod amount of logistics
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
logistics.courierName
\n
Optional
\n
Courier name to which returns items assigned
\n
String
\n
255
\n
\n
\n
logistics.airwayBillNumber
\n
Optional
\n
Air way bill number of the courier
\n
String
\n
255
\n
\n\n
\n
\n
For optional fields which have null value, then either field itself won't be sent or the field will be sent with null value. This depends on whether the field is static or dynamic at our end.
\n
For optional fields which have empty array value, then either the field itself won't be sent or the field will be sent with [] value. This depends on whether the field is static or dynamic at our end.
\n
any new field not mentioned in this contract can be treated as optional
Channel from where order is placed from eg. android, som, odin
\n
String
\n
255
\n
\n
\n
consignmentStatus
\n
Mandatory
\n
current status of the consignment
\n
String
\n
255
\n
\n
\n
items.itemId
\n
Mandatory
\n
unique Id of item generated by omuni
\n
itemId
\n
255
\n
\n
\n
items.qty
\n
Mandatory
\n
Quantity of ordered items
\n
int
\n
18
\n
\n
\n
items.ean
\n
Mandatory
\n
SKU or EAN of item
\n
String
\n
255
\n
\n
\n
items.hsn
\n
Mandatory
\n
HSN of item
\n
String
\n
255
\n
\n
\n
items.mrp
\n
Mandatory
\n
MRP of the item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.sellingPrice
\n
Mandatory
\n
selling price of the item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.basicAmount
\n
Mandatory
\n
basic amount of the item excluding total tax
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.netAmount
\n
Mandatory
\n
net amount of the item includes selling price and total charges
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalTax
\n
Mandatory
\n
total tax of the item, additional of all taxes
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.taxSummary
\n
Mandatory
\n
Taxation summary or breakup of taxation
\n
\n
\n
\n
\n
poDetails
\n
Mandatory
\n
Purchase order details
\n
\n
\n
\n
\n
poDetails.poNumber
\n
Mandatory
\n
Purchase order number
\n
String
\n
255
\n
\n
\n
poDetails.poDate
\n
Mandatory
\n
creation date of the purchase order which is created
\n
String
\n
127
\n
\n
\n
poDetails.poAmount
\n
Mandatory
\n
Purchase order amount
\n
BigDecimal
\n
15
\n
\n
\n
billToAddress
\n
Mandatory
\n
Address of master seller
\n
\n
\n
\n
\n
billToAddress.zipCode
\n
Mandatory
\n
zipcode of master seller
\n
String
\n
45
\n
\n
\n
billToAddress.city
\n
Mandatory
\n
city detail of master seller
\n
String
\n
45
\n
\n
\n
billToAddress.addressLine1
\n
Mandatory
\n
address line of master seller
\n
String
\n
255
\n
\n
\n
billToAddress.state
\n
Mandatory
\n
state of master seller
\n
String
\n
45
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
stateMasterSellerCode
\n
optional
\n
code of master seller based on state
\n
String
\n
45
\n
\n
\n
orderingFcId
\n
Optional
\n
fcid of order which is placed at, this will be there only in case of som order
\n
String
\n
255
\n
\n
\n
invoiceId
\n
Optional
\n
invoice id of consignment
\n
String
\n
18
\n
\n
\n
invoiceDate
\n
Optional
\n
date at which invoice is generated
\n
String
\n
127
\n
\n
\n
sourceOrderId2
\n
Optional
\n
order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceOrderId1
\n
Optional
\n
customer order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
metadata
\n
Optional
\n
extra data from upstream
\n
Map
\n
40KB
\n
\n
\n
items.sourceItemId
\n
Optional
\n
item id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
items.brand
\n
Optional
\n
brand name of item
\n
String
\n
255
\n
\n
\n
items.totalDiscount
\n
Optional
\n
discount amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalCharge
\n
Optional
\n
charges added for an item, eg shipping charge, cod charge
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstAmount
\n
Optional
\n
cgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstAmount
\n
Optional
\n
igst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstAmount
\n
Optional
\n
sgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstAmount
\n
Optional
\n
ugst amount of item (union teritorry)
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstPercentage
\n
Optional
\n
cgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstPercentage
\n
Optional
\n
igst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstPercentage
\n
Optional
\n
sgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstPercentage
\n
Optional
\n
ugst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
metadata
\n
Optional
\n
extra data from upstream
\n
Map
\n
40KB
\n
\n
\n
itemAttributes
\n
Optional
\n
extra data from upstream( eg: IMEI number)
\n
Map
\n
40KB
\n
\n
\n
poDetails.poPdfUrl
\n
Optional
\n
purchase order Pdf Url
\n
String
\n
1024
\n
\n
\n
b2bInvoiceDetails
\n
Optional
\n
b2b invoice details generated by omuni
\n
\n
\n
\n
\n
billToAddress.addressLine2
\n
Optional
\n
Master seller address details
\n
String
\n
255
\n
\n
\n
billToAddress.addressLine3
\n
Optional
\n
Master seller address details
\n
String
\n
255
\n
\n
\n
billToAddress.mobileNumber
\n
Optional
\n
mobile number of master seller
\n
String
\n
45
\n
\n
\n
billToAddress.country
\n
Optional
\n
country of master seller
\n
String
\n
255
\n
\n
\n
shipToAddress
\n
Optional
\n
Customer's address details
\n
Map
\n
255
\n
\n
\n
shipToAddress.city
\n
Optional
\n
Customer's city
\n
String
\n
255
\n
\n
\n
shipToAddress.state
\n
Optional
\n
Customer's state
\n
String
\n
255
\n
\n
\n
shipToAddress.country
\n
Optional
\n
Customer's country
\n
String
\n
255
\n
\n
\n
shipToAddress.zipCode
\n
Optional
\n
Customer's zipcode
\n
String
\n
255
\n
\n
\n
shipToAddress.addressLine1
\n
Optional
\n
Customer's address line
\n
String
\n
255
\n
\n
\n
shipToAddress.addressLine2
\n
Optional
\n
Customer's address line
\n
String
\n
255
\n
\n
\n
shipToAddress.addressLine3
\n
Optional
\n
Customer's address line
\n
String
\n
255
\n
\n
\n
shipToAddress.mobileNumber
\n
Optional
\n
Customer's mobile number
\n
String
\n
45
\n
\n\n
\n
\n
For optional fields which have null value, then either field itself won't be sent or the field will be sent with null value. This depends on whether the field is static or dynamic at our end.
\n
For optional fields which have empty array value, then either the field itself won't be sent or the field will be sent with [] value. This depends on whether the field is static or dynamic at our end.
\n
any new field not mentioned in this contract can be treated as optional
- Ordering channel in omuni. Allowed channels are odin,som,android,ios,xyz, cloud. - odin -Website, - som - Store Order Module(includes omuni.one orders), - android - Android app, - ios - IOS app, - xyz - marketplaces, - cloud - headless commerce.
\n
Array of String
\n
\n
\n
sources
\n
optional
\n
Sources can be PAYTM, AMAZON, MYNTRA, FLIPKART, AJIO, TATACLIQ
\n
Array of String
\n
\n
\n
fulfillingFcIds
\n
optional
\n
Omuni fcId of the center that is fulfilling the order
\n
Array of String
\n
\n
\n
consignmentIds
\n
optional
\n
Omuni consignmentId of the order
\n
Array of String
\n
\n
\n
poNumbers
\n
optional
\n
Purchase order number of the order
\n
Array of String
\n
\n
\n
businessTypes
\n
optional
\n
Business type of the which we want to pull It can B2C Or B2B2C
\n
Array of String
\n
\n
\n
pageNumber
\n
optional
\n
Page number requested Default is 0
\n
Int
\n
\n
\n
pageSize
\n
optional
\n
Page size requested Default is 20 Max is 50
\n
Int
\n
\n\n
\n
\n
Authorization token is mandatory
\n
Filters are : - Channels, sources, fulfillingFcIds, consignmentIds, poNumbers, businessTypes
\n
All the filters in request body is optional
\n
This is paginated API And Default page size is 20
\n
Max page size can be given in single request is 50
\n
If po number is given in request, then max po number can be given in single request is 50
\n
If businessTypes is given in request, then Allowed businessTypes filters are “B2C” And “B2B2C”
\n
If businessType B2C is passed in request, then response will be having only B2C type of orders. If B2B2C is passed, then response will be having only B2B2C type of orders. If both are passed, then the response will be having both B2C and B2B2C orders.
Fulfilling center to which the return order is assigned
\n
String
\n
255
\n
\n
\n
source
\n
Mandatory
\n
source of the return order eg. MYNTRA_DIRECT\"
\n
String
\n
255
\n
\n
\n
channel
\n
Mandatory
\n
Channel from where order is placed from eg. android, som, odin\"
\n
String
\n
255
\n
\n
\n
returnMode
\n
Mandatory
\n
Mode of return orders eg: SELFSHIP, REVERSEPICKUP, RTO, RETURNTOSTORE, CANCELLATION
\n
String
\n
255
\n
\n
\n
returnType
\n
Mandatory
\n
Type of the returns Eg. CANCEL, RTO, RETURN
\n
String
\n
255
\n
\n
\n
items.itemId
\n
Mandatory
\n
unique Id of item generated by omuni
\n
String
\n
255
\n
\n
\n
items.qty
\n
Mandatory
\n
Quantity of items which are ordered
\n
int
\n
18
\n
\n
\n
items.ean
\n
Mandatory
\n
SKU or EAN of item
\n
String
\n
255
\n
\n
\n
items.hsn
\n
Mandatory
\n
HSN of item
\n
String
\n
255
\n
\n
\n
items.mrp
\n
Mandatory
\n
MRP of the item
\n
String
\n
precision - 10 scale - 2
\n
\n
\n
items.sellingPrice
\n
Mandatory
\n
selling price of the item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.basicAmount
\n
Mandatory
\n
basic amount of the item excluding total tax
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.netAmount
\n
Mandatory
\n
net amount of the item includes selling price and total charges
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalTax
\n
Mandatory
\n
total tax of the item, addition of all taxes
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.taxSummary
\n
Mandatory
\n
Taxation summary or breakup of taxation
\n
Map
\n
40KB
\n
\n
\n
Items.returnStatus
\n
Mandatory
\n
current status of return item
\n
String
\n
255
\n
\n
\n
destinationAddress
\n
Mandatory
\n
Destination address of order which is being returned
\n
\n
\n
\n
\n
destinationAddress.address
\n
Mandatory
\n
destination address of return order
\n
String
\n
255
\n
\n
\n
destinationAddress.city
\n
Mandatory
\n
City name of return destination address
\n
String
\n
45
\n
\n
\n
destinationAddress.pincode
\n
Mandatory
\n
pincode of return destination address
\n
String
\n
45
\n
\n
\n
destinationAddress.state
\n
Mandatory
\n
state details of return destination address
\n
\n
\n
\n
\n
state.gstCode
\n
Mandatory
\n
gst of return destination address
\n
String
\n
255
\n
\n
\n
state.name
\n
Mandatory
\n
State name of return destination address
\n
String
\n
255
\n
\n
\n
state.code
\n
Mandatory
\n
State code of return destination address
\n
String
\n
255
\n
\n
\n
destinationAddress.country
\n
Mandatory
\n
Country name of return destination address
\n
String
\n
45
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
omuniInvoiceNumber
\n
Optional
\n
Invoice number generated by omuni
\n
String
\n
255
\n
\n
\n
sourceOrderId1
\n
Optional
\n
customer order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceOrderId2
\n
Optional
\n
order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceReturnId
\n
Optional
\n
item id of source or marketplace, this return will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceItemId
\n
Optional
\n
item id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
items.brand
\n
Optional
\n
brand name of item
\n
String
\n
255
\n
\n
\n
items.totalDiscount
\n
Optional
\n
discount amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalCharge
\n
Optional
\n
charges added for an item, eg shipping charge, cod charge
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstAmount
\n
Optional
\n
cgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstAmount
\n
Optional
\n
igst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstAmount
\n
Optional
\n
sgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstAmount
\n
Optional
\n
ugst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstPercentage
\n
Optional
\n
cgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstPercentage
\n
Optional
\n
igst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstPercentage
\n
Optional
\n
sgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstPercentage
\n
Optional
\n
ugst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.metadata
\n
Optional
\n
extra data from upstream
\n
Map
\n
40KB
\n
\n
\n
items.itemAttributes
\n
Optional
\n
extra data from upstream( eg: IMEI number)
\n
Map
\n
40KB
\n
\n
\n
items.returnMetadata
\n
Optional
\n
extra return details data from upstream
\n
Map
\n
40KB
\n
\n
\n
items.refundAmount
\n
Optional
\n
Amount which got refunded for customer
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.returnReason
\n
Optional
\n
Reason for returning an item
\n
String
\n
255
\n
\n
\n
items.logistics
\n
Optional
\n
Logistics details for returned item
\n
\n
\n
\n
\n
logistics.CODAmount
\n
Optional
\n
Cod amount of logistics
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
logistics.courierName
\n
Optional
\n
Courier name to which returns items assigned
\n
String
\n
255
\n
\n
\n
logistics.airwayBillNumber
\n
Optional
\n
Air way bill number of the courier
\n
String
\n
255
\n
\n
\n
items.returnCreditNote
\n
Optional
\n
Returns credit note details
\n
\n
\n
\n
\n
returnCreditNote.ackNumber
\n
Optional
\n
acknowledgement number of return credit note
\n
String
\n
255
\n
\n
\n
returnCreditNote.ackDate
\n
Optional
\n
acknowledgement date of return credit note
\n
String
\n
255
\n
\n
\n
returnCreditNote.irnNumber
\n
Optional
\n
irn number of return credit note
\n
String
\n
255
\n
\n
\n
returnCreditNote.signedQrCode
\n
Optional
\n
signed qr code of return credit note
\n
String
\n
255
\n
\n
\n
returnCreditNote.signedInvoice
\n
Optional
\n
signed invoice of return credit note
\n
String
\n
255
\n
\n
\n
returnCreditNote.status
\n
Optional
\n
status of return credit note
\n
String
\n
255
\n
\n\n
\n
\n
For optional fields which have null value, then either field itself won't be sent or the field will be sent with null value. This depends on whether the field is static or dynamic at our end.
\n
For optional fields which have empty array value, then either the field itself won't be sent or the field will be sent with [] value. This depends on whether the field is static or dynamic at our end.
\n
any new field not mentioned in this contract can be treated as optional
Channel from where order is placed from eg. android, som, odin
\n
String
\n
255
\n
\n
\n
consignmentStatus
\n
Mandatory
\n
current status of the consignment
\n
String
\n
255
\n
\n
\n
items.itemId
\n
Mandatory
\n
unique Id of item generated by omuni
\n
itemId
\n
255
\n
\n
\n
items.qty
\n
Mandatory
\n
Quantity of ordered items
\n
int
\n
18
\n
\n
\n
items.ean
\n
Mandatory
\n
SKU or EAN of item
\n
String
\n
255
\n
\n
\n
items.hsn
\n
Mandatory
\n
HSN of item
\n
String
\n
255
\n
\n
\n
items.mrp
\n
Mandatory
\n
MRP of the item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.sellingPrice
\n
Mandatory
\n
selling price of the item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.basicAmount
\n
Mandatory
\n
basic amount of the item excluding total tax
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.netAmount
\n
Mandatory
\n
net amount of the item includes selling price and total charges
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalTax
\n
Mandatory
\n
total tax of the item, additional of all taxes
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.taxSummary
\n
Mandatory
\n
Taxation summary or breakup of taxation
\n
\n
\n
\n
\n
poDetails
\n
Mandatory
\n
Purchase order details
\n
\n
\n
\n
\n
poDetails.poNumber
\n
Mandatory
\n
Purchase order number
\n
String
\n
255
\n
\n
\n
poDetails.poDate
\n
Mandatory
\n
creation date of the purchase order which is created
\n
String
\n
127
\n
\n
\n
poDetails.poAmount
\n
Mandatory
\n
Purchase order amount
\n
BigDecimal
\n
15
\n
\n
\n
billToAddress
\n
Mandatory
\n
Address of master seller
\n
\n
\n
\n
\n
billToAddress.zipCode
\n
Mandatory
\n
zipcode of master seller
\n
String
\n
45
\n
\n
\n
billToAddress.city
\n
Mandatory
\n
city detail of master seller
\n
String
\n
45
\n
\n
\n
billToAddress.addressLine1
\n
Mandatory
\n
address line of master seller
\n
String
\n
255
\n
\n
\n
billToAddress.state
\n
Mandatory
\n
state of master seller
\n
String
\n
45
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
stateMasterSellerCode
\n
optional
\n
code of master seller based on state
\n
String
\n
45
\n
\n
\n
orderingFcId
\n
Optional
\n
fcid of order which is placed at, this will be there only in case of som order
\n
String
\n
255
\n
\n
\n
invoiceId
\n
Optional
\n
invoice id of consignment
\n
String
\n
18
\n
\n
\n
invoiceDate
\n
Optional
\n
date at which invoice is generated
\n
String
\n
127
\n
\n
\n
sourceOrderId2
\n
Optional
\n
order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceOrderId1
\n
Optional
\n
customer order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
metadata
\n
Optional
\n
extra data from upstream
\n
Map
\n
40KB
\n
\n
\n
items.sourceItemId
\n
Optional
\n
item id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
items.brand
\n
Optional
\n
brand name of item
\n
String
\n
255
\n
\n
\n
items.totalDiscount
\n
Optional
\n
discount amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalCharge
\n
Optional
\n
charges added for an item, eg shipping charge, cod charge
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstAmount
\n
Optional
\n
cgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstAmount
\n
Optional
\n
igst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstAmount
\n
Optional
\n
sgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstAmount
\n
Optional
\n
ugst amount of item (union teritorry)
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstPercentage
\n
Optional
\n
cgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstPercentage
\n
Optional
\n
igst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstPercentage
\n
Optional
\n
sgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstPercentage
\n
Optional
\n
ugst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
metadata
\n
Optional
\n
extra data from upstream
\n
Map
\n
40KB
\n
\n
\n
itemAttributes
\n
Optional
\n
extra data from upstream( eg: IMEI number)
\n
Map
\n
40KB
\n
\n
\n
poDetails.poPdfUrl
\n
Optional
\n
purchase order Pdf Url
\n
String
\n
1024
\n
\n
\n
b2bInvoiceDetails
\n
Optional
\n
b2b invoice details generated by omuni - This will be present in case of OMUNI driven b2b invoice - This won't be present in case of BRAND driven b2b invoice
\n
\n
\n
\n
\n
billToAddress.addressLine2
\n
Optional
\n
Master seller address details
\n
String
\n
255
\n
\n
\n
billToAddress.addressLine3
\n
Optional
\n
Master seller address details
\n
String
\n
255
\n
\n
\n
billToAddress.mobileNumber
\n
Optional
\n
mobile number of master seller
\n
String
\n
45
\n
\n
\n
billToAddress.country
\n
Optional
\n
country of master seller
\n
String
\n
255
\n
\n
\n
shipToAddress
\n
Optional
\n
Customer's address details
\n
Map
\n
255
\n
\n
\n
shipToAddress.city
\n
Optional
\n
Customer's city
\n
String
\n
255
\n
\n
\n
shipToAddress.state
\n
Optional
\n
Customer's state
\n
String
\n
255
\n
\n
\n
shipToAddress.country
\n
Optional
\n
Customer's country
\n
String
\n
255
\n
\n
\n
shipToAddress.zipCode
\n
Optional
\n
Customer's zipcode
\n
String
\n
255
\n
\n
\n
shipToAddress.addressLine1
\n
Optional
\n
Customer's address line
\n
String
\n
255
\n
\n
\n
shipToAddress.addressLine2
\n
Optional
\n
Customer's address line
\n
String
\n
255
\n
\n
\n
shipToAddress.addressLine3
\n
Optional
\n
Customer's address line
\n
String
\n
255
\n
\n
\n
shipToAddress.mobileNumber
\n
Optional
\n
Customer's mobile number
\n
String
\n
45
\n
\n\n
\n
\n
For optional fields which have null value, then either field itself won't be sent or the field will be sent with null value. This depends on whether the field is static or dynamic at our end.
\n
For optional fields which have empty array value, then either the field itself won't be sent or the field will be sent with [] value. This depends on whether the field is static or dynamic at our end.
\n
any new field not mentioned in this contract can be treated as optional
- Ordering channel in omuni. Allowed channels are odin,som,android,ios,xyz, cloud. - odin -Website, - som - Store Order Module(includes omuni.one orders), - android - Android app, - ios - IOS app, - xyz - marketplaces, - cloud - headless commerce.
\n
Array of String
\n
\n
\n
sources
\n
optional
\n
Sources can be PAYTM, AMAZON, MYNTRA, FLIPKART, AJIO, TATACLIQ
\n
Array of String
\n
\n
\n
fulfillingFcIds
\n
optional
\n
Omuni fcId of the center that is fulfilling the order
\n
Array of String
\n
\n
\n
consignmentIds
\n
optional
\n
Omuni consignmentId of the order
\n
Array of String
\n
\n
\n
poNumbers
\n
optional
\n
Purchase order number of the order
\n
Array of String
\n
\n
\n
pullTypes
\n
optional
\n
pull type of the order which we want to pull It can B2C Or B2C
\n
Array of String
\n
\n
\n
pageNumber
\n
optional
\n
Page number requested Default is 0
\n
Int
\n
\n
\n
pageSize
\n
optional
\n
Page size requested Default is 20 Max is 50
\n
Int
\n
\n\n
\n
\n
Authorization token is mandatory
\n
Filters are : - Channels, sources, fulfillingFcIds, consignmentIds, poNumbers, businessTypes
\n
All the filters in request body is optional
\n
This is paginated API And Default page size is 20
\n
Max page size can be given in single request is 50
\n
If po number is given in request, then max po number can be given in single request is 50
\n
If pullTypes is given in request, then Allowed pullTypes filters are “B2C” And “B2B”
\n
If pullTypes B2C is passed in request, then response will be having only B2C type of orders. If B2B is passed, then response will be having only B2B type of orders. If both are passed, then the response will be having both B2C and B2B orders.
Fulfilling center to which the return order is assigned
\n
String
\n
255
\n
\n
\n
source
\n
Mandatory
\n
source of the return order eg. MYNTRA_DIRECT\"
\n
String
\n
255
\n
\n
\n
channel
\n
Mandatory
\n
Channel from where order is placed from eg. android, som, odin\"
\n
String
\n
255
\n
\n
\n
returnMode
\n
Mandatory
\n
Mode of return orders eg: SELFSHIP, REVERSEPICKUP, RTO, RETURNTOSTORE, CANCELLATION
\n
String
\n
255
\n
\n
\n
returnType
\n
Mandatory
\n
Type of the returns Eg. CANCEL, RTO, RETURN
\n
String
\n
255
\n
\n
\n
items.itemId
\n
Mandatory
\n
unique Id of item generated by omuni
\n
String
\n
255
\n
\n
\n
items.qty
\n
Mandatory
\n
Quantity of items which are ordered
\n
int
\n
18
\n
\n
\n
items.ean
\n
Mandatory
\n
SKU or EAN of item
\n
String
\n
255
\n
\n
\n
items.hsn
\n
Mandatory
\n
HSN of item
\n
String
\n
255
\n
\n
\n
items.mrp
\n
Mandatory
\n
MRP of the item
\n
String
\n
precision - 10 scale - 2
\n
\n
\n
items.sellingPrice
\n
Mandatory
\n
selling price of the item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.basicAmount
\n
Mandatory
\n
basic amount of the item excluding total tax
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.netAmount
\n
Mandatory
\n
net amount of the item includes selling price and total charges
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalTax
\n
Mandatory
\n
total tax of the item, addition of all taxes
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.taxSummary
\n
Mandatory
\n
Taxation summary or breakup of taxation
\n
Map
\n
40KB
\n
\n
\n
Items.returnStatus
\n
Mandatory
\n
current status of return item
\n
String
\n
255
\n
\n
\n
destinationAddress
\n
Mandatory
\n
Destination address of order which is being returned
\n
\n
\n
\n
\n
destinationAddress.address
\n
Mandatory
\n
destination address of return order
\n
String
\n
255
\n
\n
\n
destinationAddress.city
\n
Mandatory
\n
City name of return destination address
\n
String
\n
45
\n
\n
\n
destinationAddress.pincode
\n
Mandatory
\n
pincode of return destination address
\n
String
\n
45
\n
\n
\n
destinationAddress.state
\n
Mandatory
\n
state details of return destination address
\n
\n
\n
\n
\n
state.gstCode
\n
Mandatory
\n
gst of return destination address
\n
String
\n
255
\n
\n
\n
state.name
\n
Mandatory
\n
State name of return destination address
\n
String
\n
255
\n
\n
\n
state.code
\n
Mandatory
\n
State code of return destination address
\n
String
\n
255
\n
\n
\n
destinationAddress.country
\n
Mandatory
\n
Country name of return destination address
\n
String
\n
45
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
omuniInvoiceNumber
\n
Optional
\n
Invoice number generated by omuni
\n
String
\n
255
\n
\n
\n
sourceOrderId1
\n
Optional
\n
customer order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceOrderId2
\n
Optional
\n
order id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceReturnId
\n
Optional
\n
item id of source or marketplace, this return will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
sourceItemId
\n
Optional
\n
item id of source or marketplace, this field will be present only in case xyz channel orders
\n
String
\n
255
\n
\n
\n
items.brand
\n
Optional
\n
brand name of item
\n
String
\n
255
\n
\n
\n
items.totalDiscount
\n
Optional
\n
discount amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.totalCharge
\n
Optional
\n
charges added for an item, eg shipping charge, cod charge
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstAmount
\n
Optional
\n
cgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstAmount
\n
Optional
\n
igst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstAmount
\n
Optional
\n
sgst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstAmount
\n
Optional
\n
ugst amount of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.cgstPercentage
\n
Optional
\n
cgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.igstPercentage
\n
Optional
\n
igst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.sgstPercentage
\n
Optional
\n
sgst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
taxSummary.utgstPercentage
\n
Optional
\n
ugst percentage of item
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.metadata
\n
Optional
\n
extra data from upstream
\n
Map
\n
40KB
\n
\n
\n
items.itemAttributes
\n
Optional
\n
extra data from upstream( eg: IMEI number)
\n
Map
\n
40KB
\n
\n
\n
items.returnMetadata
\n
Optional
\n
extra return details data from upstream
\n
Map
\n
40KB
\n
\n
\n
items.refundAmount
\n
Optional
\n
Amount which got refunded for customer
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
items.returnReason
\n
Optional
\n
Reason for returning an item
\n
String
\n
255
\n
\n
\n
items.logistics
\n
Optional
\n
Logistics details for returned item
\n
\n
\n
\n
\n
logistics.CODAmount
\n
Optional
\n
Cod amount of logistics
\n
BigDecimal
\n
precision - 10 scale - 2
\n
\n
\n
logistics.courierName
\n
Optional
\n
Courier name to which returns items assigned
\n
String
\n
255
\n
\n
\n
logistics.airwayBillNumber
\n
Optional
\n
Air way bill number of the courier
\n
String
\n
255
\n
\n
\n
items.returnCreditNote
\n
Optional
\n
Returns credit note details - This will be present in case of OMUNI driven b2b invoice - This won't be present in case of BRAND driven b2b invoice
\n
\n
\n
\n
\n
returnCreditNote.ackNumber
\n
Optional
\n
acknowledgement number of return credit note
\n
String
\n
255
\n
\n
\n
returnCreditNote.ackDate
\n
Optional
\n
acknowledgement date of return credit note
\n
String
\n
255
\n
\n
\n
returnCreditNote.irnNumber
\n
Optional
\n
irn number of return credit note
\n
String
\n
255
\n
\n
\n
returnCreditNote.signedQrCode
\n
Optional
\n
signed qr code of return credit note
\n
String
\n
255
\n
\n
\n
returnCreditNote.signedInvoice
\n
Optional
\n
signed invoice of return credit note
\n
String
\n
255
\n
\n
\n
returnCreditNote.status
\n
Optional
\n
status of return credit note
\n
String
\n
255
\n
\n\n
\n
\n
For optional fields which have null value, then either field itself won't be sent or the field will be sent with null value. This depends on whether the field is static or dynamic at our end.
\n
For optional fields which have empty array value, then either the field itself won't be sent or the field will be sent with [] value. This depends on whether the field is static or dynamic at our end.
\n
any new field not mentioned in this contract can be treated as optional
This API is called to pull the list of pending orders in the omuni system. The POS/store system can call this API to get a complete list of orders pending in the Omuni system for it to be processed further. Once the orders get created from the website to omuni system, then the orders can be further passed to Stores/ POS through this API for further processing. In order to do so the user needs to pass the entity name assigned by omuni and the storeId for which it needs the complete list of orders. After the parameters being passed Omuni will return all the pending orders for that particular store.
\n
General Flow
\n
\n
A list of orders has been created in omuni through user’s website.
\n
The user needs these orders to pass to the respective stores for further processing
\n
The user calls this API for pushing the pending orders to the respective stores
\n
The user passes the required input parameters
\n
Omuni returns a complete list of pending orders to the respective store.
\n
\n
Process Flow
\n
\n
The user calls this API to push the list of pending orders to the stores
\n
The user passes the Access token in the headers and the entity name & storeId in the endpoint of the API request
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – List of pending orders returned by Omuni to the respective stores
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Parameters
\n
Description
\n
Mandatory
\n
Possible Values
\n
Sample Data
\n
\n\n\n
\n
Order
\n
Contains order detail
\n
Y
\n
\n
\n
\n
\n
order_id
\n
Order unique id
\n
Y
\n
ID with varchar value
\n
Sc34149
\n
\n
\n
consignment _id
\n
Splitted order unique ID
\n
Y
\n
ID with varchar value
\n
Cc3414901
\n
\n
\n
id
\n
Splitted order unique ID
\n
Y
\n
ID with varchar value
\n
Cc3414901
\n
\n
\n
order_type
\n
Order Type
\n
Y
\n
sale/booking/return
\n
sale
\n
\n
\n
order_location
\n
Store ID of ordering store
\n
Mandate in ordering xml
\n
Store ID
\n
110345
\n
\n
\n
collection_location
\n
Store ID of amount collection store
\n
Mandate in ordering/f ullfilment xml if payment info available
\n
Store ID
\n
114212
\n
\n
\n
inventoryfullf ilment_locati on
\n
Store ID of fullfilment store
\n
Mandate in ordering xml
\n
Store ID
\n
114212
\n
\n
\n
order_datetime
\n
Date when order placed at omni platform
\n
Y
\n
\n
20180721 09:07:13
\n
\n
\n
statecode
\n
State code of Shipment location
\n
Y
\n
\n
KA
\n
\n
\n
item
\n
Contains Item details
\n
Y
\n
\n
\n
\n
\n
eancode
\n
BarCode of the product
\n
Y
\n
\n
89075400
\n
\n
\n
qty
\n
Quantity of the Product in that Item details
\n
Y
\n
\n
1
\n
\n
\n
discount_amount
\n
Discount amount on that item
\n
Y
\n
0 to MRP
\n
239
\n
\n
\n
basic_amount
\n
Basic amount on that item
\n
Y
\n
\n
342.86
\n
\n
\n
mrp
\n
MRP of the Product
\n
Y
\n
\n
599
\n
\n
\n
tax1_amount
\n
Tax component amount of the product
\n
Y
\n
\n
17.14
\n
\n
\n
tax1_description
\n
Tax component description of the Product
\n
Y
\n
SGST/UTG ST/IGST
\n
IGST
\n
\n
\n
tax_percentage
\n
Tax component percentage of the Product
\n
Y
\n
\n
5
\n
\n
\n
tax2_amount
\n
Tax component amount of the product
\n
Y
\n
\n
0
\n
\n
\n
tax2_description
\n
Tax component description of the Product
\n
Y
\n
CGST
\n
CGST
\n
\n
\n
tax2_percentage
\n
Tax component percentage of the Product
\n
Y
\n
\n
0
\n
\n
\n
discount_percentage
\n
Discount percentage of the product
\n
Y
\n
0 to 100
\n
39.9
\n
\n
\n
tax_exclusive
\n
Flag to indicate item is tax exclusive or inclusive
\n
N
\n
TRUE/FALS E
\n
TRUE
\n
\n
\n
total_amount
\n
Total amount of the order
\n
Y
\n
\n
360
\n
\n
\n
tenders
\n
all tender details of the order
\n
Y
\n
\n
\n
\n
\n
tender
\n
tender detail of the order
\n
Y
\n
\n
\n
\n
\n
Value
\n
Total value of the order
\n
Y
\n
\n
360
\n
\n
\n
Type
\n
Type of Payment Mode
\n
Y
\n
DEL/COD/ PS/CA/DC /CC
\n
DEL
\n
\n\n
\n
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b2392360-b3a4-4db4-aa7c-c40c39b0e938","id":"b2392360-b3a4-4db4-aa7c-c40c39b0e938","name":"Booking Orders","type":"folder"}},"urlObject":{"protocol":"https","path":["b","chandler","v3","status","{"],"host":["api-preprod","ailiens","com"],"query":[{"key":"storeId","value":"}"}],"variable":[]}},"response":[{"id":"e0fc3038-41f1-49ea-9a10-a7c1524b2f95","name":"Retrieve Orders From Omuni (POS)","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {auth token}"}],"url":{"raw":"https://api-preprod.ailiens.com/b/chandler/v3/status/demo_entity?storeId=Dummy1","protocol":"https","host":["api-preprod","ailiens","com"],"path":["b","chandler","v3","status","demo_entity"],"query":[{"key":"storeId","value":"Dummy1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"cache-control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Content-Type","value":"application/xml;charset=UTF-8"},{"key":"Date","value":"Thu, 20 May 2021 12:46:29 GMT"},{"key":"expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"pragma","value":"no-cache"},{"key":"Server","value":"nginx/1.19.10"},{"key":"set-cookie","value":"JSESSIONID=node0lm2cti6em8371recjvz6es5q7310.node0;Path=/"},{"key":"x-application-context","value":"Chandler:preprod"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-envoy-upstream-service-time","value":"1465"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Content-Length","value":"138547"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\n\n\n\nObf5d89\nCbf5d8901\nCbf5d8901\nsale\nDummy1\nDemo22\nDemo22\nOMUNI\nObf5d89\n\n20210518 14:28:42\nDL\n\nReturn Meta data only for sale type return\nBD07\nBD07\nBD07\n\n\n\nItem meta data\nBD07\nBD07\nBD07\n\nNNNOW59595863\n1\n0.0\n1524.58\n1799.0\n137.21\nUTGST\n9.0\n137.21\nCGST\n9.0\n\n\n\n0.0\nfalse\n\n\n0\n0\n0\n0\n0\n0\n0\n0\n0\nfalse\n\n0\n0\n0\n0\n0\n0\n0\n0\n0\n0\n\n0\n0\n\n\n1799.0\n\n\n1799.0\nCOD\n\n\n\n\nsushmita\n\nM\nAIL\nNew Delhi\n110001\nDelhi\nIndia\n9480492408\nsushmita.govekar@arvindinternet.com\n\n\ndemo1859\n\n\n\n\n\nnull\n\ndemo1@nnnow.com\n+91\ntestname\n\n\n\nOa38a04\nCa38a0401\nCa38a0401\nbooking\nDummy1\nDummy1\n\nOMUNI\nOa38a04\n\n20210518 14:44:44\nDL\n\nReturn Meta data only for sale type return\nBD07\nBD07\nBD07\n\n\n\nItem meta data\nBD07\nBD07\nBD07\n\nNNNOW59596020\n1\n0.0\n1355.08\n1599.0\n243.91\nIGST\n18.0\n0.0\nCGST\n0.0\n\n\n\n0.0\nfalse\n\n\n0\n0\n0\n0\n0\n0\n0\n0\n0\nfalse\n\n0\n0\n0\n0\n0\n0\n0\n0\n0\n0\n\n0\n0\n\n\n1598.99\n\n\n1598.99\nPS\n\n\n\n\nsushmita\n\nM\nhshs shs\nNew Delhi\n110001\nDelhi\nIndia\n9480492408\nsushmita.govekar@arvindinternet.com\n\n\ndemo1859\n\n\n\n\n\nnull\n\ndemo1@nnnow.com\n+91\ntestname\n\n\n\n"}],"_postman_id":"df4ac5de-6b9a-4cae-9735-d6775c1b329d"},{"name":"Tender API","id":"036b6e3d-e1d4-40b0-87c9-2be369ba5cf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {auth token}"}],"body":{"mode":"raw","raw":"\n\n Tender\n Cf5c5e101\n H80CR17245\n H80\n 2019-08-15\n \n \n CA\n \n 4599.0\n \n \n"},"url":"http://api-preprod.ailiens.com/b/chandler/order/pos/tender/","description":"
After the booking order is received by a particular store, the store calls this API to confirm the payment transaction details. This API helps in the confirmation of payment details for the particular booking order received by store. Once the details are passed to omuni, then Omuni assigns that particular order to a fulfilment location as a Sale order.
\n
General Flow
\n
\n
A list of booking orders has been pushed to the POS/ store channel.
\n
The user calls this API to send in the payment transaction details to omuni
\n
The user passes the required input parameters
\n
The transaction details get successfully updated in omuni system.
\n
\n
Process Flow
\n
\n
The user calls this API to send in transaction details to omuni
\n
The user passes the Access token in the headers, entity name in the endpoint, and payload in the body of the API request
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Transaction details get successfully updated in omuni system
Booking orders are the ones where the stores confirm on the order payment details before sending it for fulfilment. This practice is very specific to certain brands and only few brands go for this flow. So, once the payment details are confirmed using the Tender API after pulling the booking orders, then it hops to a fulfilment location as a sale order and then fulfilled. It can be better understood by the following flow diagram.
If businessTypes is given in request, then Allowed businessTypes filters are “B2C” And “B2B2C”
\n
\n
If businessType B2C is passed in request, then response will be having only B2C type of orders. If B2B2C is passed, then response will be having only B2B2C type of orders. If both are passed, then the response will be having both B2C and B2B2C orders.
Ordering channel in omuni. Read notes to check for allowed channels
\n
Array of String
\n
\n
\n
sources
\n
No
\n
Read notes to check for allowed sources
\n
Array of String
\n
\n
\n
buisnessTypes
\n
No
\n
Allowed values - B2C & B2B2C
\n
Array of String
\n
\n
\n
fulfillingFcIds
\n
No
\n
Omuni fcId of the center that is fulfilling the order
\n
Array of String
\n
\n
\n
consignmentIds
\n
No
\n
Omuni consignmentId of the order
\n
Array of String
\n
\n
\n
poNumbers
\n
No
\n
Purchase order numbers
\n
Array of String
\n
\n
\n
Status
\n
No
\n
Status can be \"Pending\", \"Pulled\", this can be used until order is acknowleged
\n
Array of String
\n
\n
\n
pageNumber
\n
Yes
\n
Page number requested
\n
Int
\n
\n
\n
pageSize
\n
Yes
\n
Page size requested
\n
Int
\n
\n\n
\n
Defaults: pageNumber = 0, pageSize = 20
\n
Limits: pageSize = 50
\n
Notes:
\n
\n
There are only 2 mandatory fields in this API pageNumber and pageSize
\n
\n
Remaining fileds can be used to filter this pull transaction
\n
\n
If po number is given in request, then max po number can be given in single request is 50
\n
\n
If businessTypes is given in request, then Allowed businessTypes filters are “B2C” And “B2B2C”
\n
\n
If businessType B2C is passed in request, then response will be having only B2C type of orders. If B2B2C is passed, then response will be having only B2B2C type of orders. If both are passed, then the response will be having both B2C and B2B2C orders.
\n
\n
Allowed channels in Omuni
\n
\n
xyz (marketplace)
\n
\n
cloud(websites)
\n
\n
android (.one app)
\n
\n
ios (.one app)
\n
\n
som (Omuni desktop site)
\n
\n
odin (nnnow app & website)
\n
\n
\n
\n
Allowed sources in Omuni
\n
\n
xyz (under xyz channel user can use mentioned sources to filter) - MYNTRA_DIRECT, AJIO, AJIO, AMAZON, CLIQ, CLIQ_MALL, FLIPKART_DIRECT, FLIPKART_STANDARD, INORBIT, MYNTRA, MYNTRA_LUX, MEESHO, NYKAA, NYKAA_FASHION, ZILO
\n
\n
cloud(under cloud channel user can use mentioned sources to filter) - MULESOFT, SHOPIFY,SHOPIFY_USPA, ANSCOMMERCE, CLOUD, Cloud_ONDC, CLOUD_STOREWISE, MULESOFT, ONDC_HIMALAYA, MEGAMART
Ordering channel in omuni. Read notes to check for allowed channels
\n
Array of String
\n
\n
\n
sources
\n
No
\n
Read notes to check for allowed sources
\n
Array of String
\n
\n
\n
buisnessTypes
\n
No
\n
Allowed values - B2C & B2B2C
\n
Array of String
\n
\n
\n
returningFcIds
\n
No
\n
Omuni fcId of the center that is accepting the return
\n
Array of String
\n
\n
\n
fulfillingFcIds
\n
No
\n
Omuni fcId of the center that fulfilled the order
\n
Array of String
\n
\n
\n
returnIds
\n
No
\n
Omuni returnIds
\n
Array of String
\n
\n
\n
status
\n
No
\n
Status can be \"Pending\", \"Pulled\", this can be used until order is acknowleged
\n
Array of String
\n
\n
\n
pageNumber
\n
Yes
\n
Page number requested
\n
Int
\n
\n
\n
pageSize
\n
Yes
\n
Page size requested
\n
Int
\n
\n\n
\n
Defaults: pageNumber = 0, pageSize = 20
\n
Limits: pageSize = 50
\n
Notes:
\n
\n
There are only 2 mandatory fields in this API pageNumber and pageSize
\n
\n
Remaining fileds can be used to filter this pull transaction
\n
\n
If po number is given in request, then max po number can be given in single request is 50
\n
\n
If businessTypes is given in request, then Allowed businessTypes filters are “B2C” And “B2B2C”
\n
\n
If businessType B2C is passed in request, then response will be having only B2C type of returns. If B2B2C is passed, then response will be having only B2B2C type of returns. If both are passed, then the response will be having both B2C and B2B2C returns.
\n
\n
Allowed channels in Omuni
\n
\n
xyz (marketplace)
\n
\n
cloud(websites)
\n
\n
android (.one app)
\n
\n
ios (.one app)
\n
\n
som (Omuni desktop site)
\n
\n
odin (nnnow app & website)
\n
\n
\n
\n
Allowed sources in Omuni
\n
\n
xyz (under xyz channel user can use mentioned sources to filter) - MYNTRA_DIRECT, AJIO, AJIO, AMAZON, CLIQ, CLIQ_MALL, FLIPKART_DIRECT, FLIPKART_STANDARD, INORBIT, MYNTRA, MYNTRA_LUX, MEESHO, NYKAA, NYKAA_FASHION, ZILO
\n
\n
cloud(under cloud channel user can use mentioned sources to filter) - MULESOFT, SHOPIFY,SHOPIFY_USPA, ANSCOMMERCE, CLOUD, Cloud_ONDC, CLOUD_STOREWISE, MULESOFT, ONDC_HIMALAYA, MEGAMART
This API is called to update the delta inventory changes occurring at user’s side into the omuni system. As and when inventory changes at user front, the user can call this API to update that change into omuni at real time. This helps in keeping the inventory at both places in sync. Any small or major inventory change can be updated through credit, debit and overwrite of inventory in omuni. This basically helps in keeping track and real time synchronization of inventory at user and omuni level.
User wants to update the change of inventory into omuni
\n
\n
The user calls this API and passes the inventory change for a particular ean.
\n
\n
Passes the required parameters
\n
\n
The inventory gets successfully added/updated in omuni.
\n
\n
Inventory at both levels in sync
\n
\n
\n
Outcome
\n
\n
Correct Input – Inventory get successfully added/updated in Omuni
\n
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Field
\n
Data Type
\n
Mandatory
\n
Significance
\n
\n\n\n
\n
inventories
\n
list
\n
Yes
\n
This is an outer wrapper which holds all the inventory details.
\n
\n
\n
ean
\n
string
\n
Yes
\n
This is a value to indicate a sellable item.
\n
\n
\n
fcId
\n
string
\n
Yes
\n
This indicates the fulfillment center.
\n
\n
\n
quantity
\n
int
\n
Yes
\n
Quantity for ean in a fulfillment center.
\n
\n
\n
transactionDetail
\n
Object
\n
No
\n
This is a metadata kind of field which is optional.
\n
\n
\n
customerDetail
\n
Object
\n
No
\n
This is a metadata kind of field which is optional.
\n
\n
\n
movementType
\n
String
\n
No
\n
This indicates the way inventory got populated at the pos system. This as well is optional.
\n
\n
\n
transactionType
\n
string
\n
Yes
\n
It can hold values such as - OVERWRITE,CREDIT,DEBIT. This indicates the operation on quantity.
\n
\n\n
\n
Note
\n
\n
The allowed values in transaction type are Overwrite, Credit, Debit
\n
\n
The quantity to be passed should be an integer. No decimal values.
\n
\n
\n","urlObject":{"protocol":"https","path":["b","velocity","delta","inventory","v2"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"c698f230-095a-4f5e-bc68-6239a6228381","name":"Delta Inventory Update","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer{token}","disabled":true},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-TRACE-ID","value":"","description":"This is optional but recommended. This is useful for tracing a request. If you want to uniquely identify a request please use this header to pass a trace id for the request. This is used by us internally ","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n\t\"inventories\": [{\n\t\t\t\"ean\": \"1234\",\n\t\t\t\"fcId\": \"2234\",\n\t\t\t\"quantity\": 1,\n\t\t\t\"transactionDetails\": {\n\t\t\t\t\"transactionRefNo\": \"ASD123\",\n\t\t\t\t\"salePrice\": 123\n\t\t\t},\n\t\t\t\"customerDetails\": {\n\t\t\t\t\"callingCode\": \"+91\",\n\t\t\t\t\"phoneNumber\": \"8102508687\"\n\t\t\t},\n\t\t\t\"movementType\": \"RTW\",\n\t\t\t\"transactionType\": \"Overwrite\"\n\t\t},\n\t\t{\n\t\t\t\"ean\": \"09876\",\n\t\t\t\"fcId\": \"4322\",\n\t\t\t\"quantity\": 1,\n\t\t\t\"transactionDetails\": {\n\t\t\t\t\"transactionRefNo\": \"ASD123\",\n\t\t\t\t\"salePrice\": 128\n\t\t\t},\n\t\t\t\"customerDetails\": {\n\t\t\t\t\"callingCode\": \"+91\",\n\t\t\t\t\"phoneNumber\": \"8109538687\"\n\t\t\t},\n\t\t\t\"movementType\": \"RTW\",\n\t\t\t\"transactionType\": \"Overwrite\"\n\t\t}\n\t],\n\t\"createdDateTime\": \"2020-10-30 10:00:01\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/velocity/delta/inventory/v2"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\":”All EANs successfully processed.”,\r\n \"correlationId\": \"511ecaa3-2f21-442e-b692-73c306b392b0\"\r\n}"}],"_postman_id":"2ae117b7-be08-4882-8eda-b7eaeec3180d"},{"name":"Full Inventory Sync","event":[{"listen":"test","script":{"id":"25bb5838-69c4-453f-9c75-c2af7ca0b075","exec":["","","S7aece9","C7aece901","I7aece901","return","BLRA007","BLRA010","BLRA010","OMUNI","S7aece9","20190121","11:08:31","KA","8903338144113","1","0.0","1159.82","1299.0","139.18","IGST","12.0","0.0","CGST","0.0","0.0","false","I7aece901","1299.0","","1299.0","PS ","","","shashikant","","M AIL","Bangalore560001","KarnatakaIndia","9916805245","shashikant.kumar@arvindinternet.com","","","S7aece9","C7aece901","I7aece902","return","BLRA007","BLRA010","BLRA010","OMUNI","S7aece9","20190121","11:08:31","KA","8903338144113","1","0.0","1159.82","1299.0","139.18","IGST","12.0","0.0","CGST","0.0","0.0","false","I7aece902","1299.0","","1299.0","PS","","","shashikant","","M AIL","Bangalore560001","KarnatakaIndia","9916805245","shashikant.kumar@arvindinternet.com"," "],"type":"text/javascript","packages":{},"requests":{}}}],"id":"59130b40-3010-46b0-b1d9-8287c056edef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {auth token}","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","description":"
This API helps to refresh the inventory of a store via csv upload. It replaces the existing inventory to the provided inventory by the user. This API helps in syncing of the inventory at user and omuni level. The user passes the CSV file in which the ean, its respective quantity and other inputs are given. Then it processes the ean’s which have quantity > 0 and reset the inventory for all other ean’s to zero, which are not present in the CSV file. The sample inventory file will be given after you have successfully onboarded as omuni client.
The Inventory Sync section enables external systems to push and sync inventory data into the Omuni platform. Using these APIs, users can update stock levels across warehouses, stores, or fulfillment centers in real time or via batch uploads.
\n
User can use this section to understand:
\n
\n
Push inventory updates for SKUs across different locations
This API will call WMS to push the orders from omuni to the user’s/brand’s Warehouse. Once the orders get created from the website to omuni system, then the orders can be further passed to Warehouse through this API for further processing. In order to do so the user needs to provide their API url/endpoint where omuni can push the orders. The payload should be in the same fashion as that of omuni for the order details to go in the same format. Complete details of the order will be sent through this API.
\n
General Flow
\n
\n
A list of orders gets created in the omuni system.
\n
Omuni wants to push the orders to the respective warehouses
\n
Omuni calls the user’s API endpoint where the orders have to be pushed
\n
Omuni passes all the details of the order
\n
The order details get successfully pushed from omuni system to user’s warehouse
\n
\n
Process Flow
\n
\n
Omuni calls the user’s API endpoint for pushing the orders to their warehouse
\n
Omuni passes the complete order details through this API
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Order details get successfully updated in warehouse
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Field
\n
Description
\n
Datatype
\n
\n\n\n
\n
orderId
\n
Unique parent order ID
\n
String
\n
\n
\n
fcId
\n
Warehouse ID
\n
String
\n
\n
\n
consignmentId
\n
Unique ID to be consumed by WMS
\n
String
\n
\n
\n
paymentMethod
\n
Payment Method for the order i.e. PREPAID/POSTPAID/PREPAID_POSTPAID
\n
String
\n
\n
\n
DeliveryType
\n
Type of Delivery Eg. Standard
\n
String
\n
\n
\n
timeToFulfill
\n
Tentative Delivery Date
\n
Date
\n
\n
\n
orderingChannel
\n
Channel from where the order is placed Eg. Cloud
\n
String
\n
\n
\n
orderingSource
\n
Source of the order Eg. Shopify
\n
String
\n
\n
\n
orderItems
\n
List of items within the sub order
\n
List
\n
\n
\n
ean
\n
Bar Code of the product
\n
String
\n
\n
\n
itemId
\n
Unique ID assigned to the Item (One level below EAN)
\n
String
\n
\n
\n
productImageUrl
\n
Image URL of the Product
\n
String
\n
\n
\n
productName
\n
Name of the product
\n
String
\n
\n
\n
brandName
\n
Name of the brand
\n
String
\n
\n
\n
mrp
\n
MRP of the product
\n
int
\n
\n
\n
discuntAmount
\n
Total Discount Amount
\n
int
\n
\n
\n
sellingPrice
\n
Selling Price of the Product, it includes all the taxes but doesn't includes the charges like shippping charges, cod charges
This API can be called to do QC Pass/Fail for the orders in omuni system. Basically the Warehouse acknowledges the order that has been passed to them and processes it further. If WMS does QC Pass for a given order the same should be updated to omuni and then it goes for Invoicing. If WMS does QC fail for an order, the same status needs to be updated to omuni, so that omuni can reallocate the same order for fulfillment. In case of partial rejection, Omuni will split the consignment and hop the rejected(pick/QC failed) item to another Fulfillment center.
\n
Reallocation/ Warehouse hopping logic
\n
\n
Omuni will keep a check on order source before reassignment
\n
If new inventory has come in to the same WH which was previously unable to fulfill this Item, there will be an option to re-assign the item to the same Warehouse
\n
If it is still unable to fulfill then it will pass the order to another fulfillment center.
\n
\n
General Flow
\n
\n
WMS wants to QC Pass/Fail a particular item
\n
The WMS calls this API and passes the particular item Id, status etc.
\n
The status for that particular item gets updated in omuni system
\n
\n
Process Flow
\n
\n
WMS wants to QC Pass/Fail a particular item
\n
The WMS calls this API and passes the status in the API request
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – The status and inventory changes for that particular item in omuni.
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Field
\n
Description
\n
Mandatory
\n
Datatype
\n
\n\n\n
\n
consignmentId
\n
Unique ID to be consumed by WMS
\n
Yes
\n
String
\n
\n
\n
orderItems
\n
List of items within the sub order
\n
Yes
\n
List
\n
\n
\n
itemId
\n
Unique ID assigned to the Item (One level below EAN)
This user can call Omuni using this API to create Invoice and Shipping label for a particular order. This API will give a downloadable url link to the user for downloading the Invoice and Shipping label for a particular order. The user needs to pass the orderId, ConsignmentId in the payload of the API request.
\n
General Flow
\n
\n
The user calls this API to create invoice and shipping label for a particular order
\n
The user passes the shipmentId, ConsignmentId, etc in the API request
\n
The API gives back the url links to download the Shipping label and invoice.
\n
\n
Process Flow
\n
\n
User wants to get the invoice and shipping label for an order.
\n
The user calls this API and passes the required parameters in the payload of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – User gets back the downloadable url link for Invoice and shipping label.
Once the brand/client passes the shipment to the courier partner, then can call the Shipped/Handover API to inform Omuni about the handover. This API is to be called in sequence after getting the invoice and shipping label url through the Get Invoice and Shippinglabel url API. The client needs to pass the required parameters in the body of the API request and hit this API thus informing Omuni about the handover that took place and in return omuni will move the state to shipped.
\n
General Flow
\n
\n
User gets the Invoice and ShippingLabel information through Get Invoice and ShippingLabel url API
\n
The user/client hands over the shipment to the Courier partner.
\n
The user calls this API to inform omuni about the Handover.
\n
The user passes the required parameters in the API request
\n
The API gives back the response saying it has acknowledged it as a successful shipment.
\n
\n
Process Flow
\n
\n
User wants to inform omuni about the handover that took place between user and courier partner.
\n
The user calls this API and passes the parameters in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – User gets back the response saying it has acknowledged it as a successful shipment.
This section corresponds to the orders initiated by customers for fulfillment. Omuni pushes this orders to WMS for processing. Omuni and WMS communicate to each other with the following APIs in this section. The APIs need to be called in the sequence and can be better understood by the following representation.
This API deals with the orders that are cancelled by the Customers. Omuni pushes those cancelled order details with the help of this API. List of cancelled item IDs against a order will be sent out. Once the Cancelled items have been sent, then a check is done to see whether the items have been cancelled before QC Pass or after. Based on that, if it is after QC Pass then a delta inventory update is sent to Omuni for the inventory changes. And if it is before QC pass then there is no action from Omuni side.
\n
General Flow
\n
\n
Customer Cancels a order
\n
Omuni pushes the cancelled order to WMS
\n
WMS acknowledges it
\n
A check happens to see whether QC pass has happened for that item before being cancelled
\n
If Yes, an inventory update happens at omuni side
\n
If No, then there is no action.
\n
\n
Process Flow
\n
\n
Customer cancels a particular item
\n
Omuni sends the complete details of the cancelled order in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – WMS receives the Cancelled order details successfully.
This section talks about the orders that are cancelled by the customers. Omuni passes this orders to WMS informing them about the orders that have been cancelled by customers. Based on the QC check by WMS, the inventory changes happen subsequently. The following API will explain it more elaborately.
\n","_postman_id":"87528516-3e86-4326-b8d0-a561d46dc5bd","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0b259697-a569-4141-b4ab-75c57d8f18c5","id":"0b259697-a569-4141-b4ab-75c57d8f18c5","name":"WMS Integrations v2","type":"folder"}}},{"name":"Returns & RTO","item":[{"name":"Create Return Order and Return Cancel Order","id":"16ddfbc7-a574-4092-a1de-deef5b2bb917","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"forwardConsignmentId\": \"uasdwe223\",\r\n \"returnId\": \"10078\",\r\n \"itemId\": \"I10098\",\r\n \"reason\": \"Different Size\",\r\n \"returnType\": \"CUSTOMER_RETURN/SELF_SHIP\",\r\n \"awbNumber\": \"HYN402\", // (AWB number will not be available for self ship)\r\n \"metadata\": { // Item level meta data object (Optional). Any key/ values. Below is just an example only\r\n \"ORDER_REFSITE\": \"BD07\",\r\n \"ABCD\": \"XYZ\"\r\n },\r\n \"fcId\": \"fc123\",\r\n \"courierName\": \"WowExpress\",\r\n \"ean\": \"12345\",\r\n \"returnStatus\": \"INITIATION\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://customerurl.com","description":"
This API deals with the orders that are requested to return by the Customers. Omuni pushes those Return order details with the help of this API. Return would be item wise. WMS to scan the AWB in their system to take the return back in their system
\n
General Flow
\n
\n
Customer Requests to return a order
\n
Omuni pushes the Return order to WMS
\n
WMS scans the AWB number in their system to take the return item.
\n
WMS then further acknowledge the item and process it.
\n
\n
Process Flow
\n
\n
Customer requests to return a order
\n
Omuni sends the complete details of the Return order in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – WMS receives the Return order details successfully.
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Field
\n
Description
\n
Datatype
\n
\n\n\n
\n
forwardConsignmentId
\n
Unique ID of the forward consignment
\n
String
\n
\n
\n
returnId
\n
Return ID created against the item
\n
String
\n
\n
\n
itemId
\n
Unique ID assigned to the Item (One level below EAN)
\n
String
\n
\n
\n
reason
\n
Reason for the return
\n
String
\n
\n
\n
returnType
\n
This is type of return, can be Courier or Self Ship
\n
String
\n
\n
\n
awbNumber
\n
AWB of the return shipment, not applicable for Self Ship cases
\n
String
\n
\n
\n
metadata
\n
List of Metadata
\n
List
\n
\n
\n
fcId
\n
Warehouse ID
\n
String
\n
\n
\n
courierName
\n
Name of the courier
\n
String
\n
\n
\n
ean
\n
Bar Code of the product
\n
String
\n
\n
\n
returnStatus
\n
if returnStatue is INITIATION, then its return create order If returnStatue is CANCELLATION, then its return cancellation order
\n
String : INITIATION / CANCELLATION
\n
\n\n
\n
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0b259697-a569-4141-b4ab-75c57d8f18c5","id":"0b259697-a569-4141-b4ab-75c57d8f18c5","name":"WMS Integrations v2","type":"folder"}},"urlObject":{"protocol":"https","host":["customerurl","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"16ddfbc7-a574-4092-a1de-deef5b2bb917"},{"name":"Return Processed notification","id":"d1098687-30d1-4d8f-82a6-7bb0ae4e373e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"returnId\": \"10078\",\r\n \"qcStatus\": \"FAIL\",\r\n \"qcReasonCode\": 2, //Reason Code Mandatory when status is Pass/Fail\r\n \"imageUrls\": [\r\n \"https://wms.com/img.jpg\",\r\n \"https://wms.com/img2.jpg\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/v2/chandler/headless/return-status","description":"
This API will call Omuni with return order processing details. This API will only get triggered after the return order is received and processed. This API basically notifies Omuni about the Return process being done.
\n
General Flow
\n
\n
Warehouse receives the Return Order details
\n
Warehouse processes the return at their side
\n
It calls this API to notify Omuni about the Return process being done.
\n
A subsequent delta inventory update happens.
\n
\n
Process Flow
\n
\n
User receives the return order details and processes the return.
\n
The user calls this API and passes the parameters in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Omuni gets return process details.
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Field
\n
Description
\n
Mandatory
\n
Datatype
\n
\n\n\n
\n
returnId
\n
Return ID created against the item
\n
Yes
\n
String
\n
\n
\n
qcStatus
\n
Item level QC status i.e. PASS/FAIL
\n
Yes
\n
String
\n
\n
\n
qcReasonCode
\n
Reason Code for QC Fail
\n
Yes
\n
int
\n
\n
\n
imageUrls
\n
List of image URLs
\n
No
\n
List
\n
\n\n
\n
QC Reason Code Mapping :
\n
\n\n
\n
id
\n
reason
\n
return_states_id
\n
\n\n\n
\n
121
\n
Q1
\n
32
\n
\n
\n
122
\n
Q2
\n
32
\n
\n
\n
123
\n
Q3
\n
32
\n
\n
\n
141
\n
Q1 - Correct product
\n
32
\n
\n
\n
151
\n
Q2 - Accessory Missing - Warranty Missing
\n
33
\n
\n
\n
152
\n
Q2 - MD - Broken Stitch
\n
33
\n
\n
\n
153
\n
Q2 - MD - Fabric/Material Defect
\n
33
\n
\n
\n
154
\n
Q2 - MD - Stained
\n
33
\n
\n
\n
155
\n
Q2 - MD - Tag Mismatch
\n
33
\n
\n
\n
156
\n
Q2 - MD – Un even Length
\n
33
\n
\n
\n
157
\n
Q2 - Product Mismatch – Color
\n
33
\n
\n
\n
158
\n
Q2 - Product Mismatch - Pattern
\n
33
\n
\n
\n
159
\n
Q2 - Product Mismatch - Size
\n
33
\n
\n
\n
160
\n
Q2 - Used Product Brand Approved
\n
33
\n
\n
\n
161
\n
Q2 - Other
\n
33
\n
\n
\n
162
\n
Q3 - Accessory Missing - Part Missing
\n
33
\n
\n
\n
163
\n
Q3 - Transit Damage
\n
33
\n
\n
\n
164
\n
Q3 - Used Product
\n
33
\n
\n
\n
165
\n
Q3 - Accessory Missing - Tag Missing
\n
33
\n
\n
\n
166
\n
Q3 - Other
\n
33
\n
\n
\n
193
\n
Paytm - QC fail - Non Brand QC
\n
33
\n
\n\n
\n
return_states_id
\n
32 - Return Qc Pass
\n
33 - Return Qc Fail
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0b259697-a569-4141-b4ab-75c57d8f18c5","id":"0b259697-a569-4141-b4ab-75c57d8f18c5","name":"WMS Integrations v2","type":"folder"}},"urlObject":{"protocol":"https","path":["b","v2","chandler","headless","return-status"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"b27c860b-c671-41b6-ac9f-053a1369aecb","name":"Return Processed notification with success response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"returnId\": \"10078\",\r\n \"qcStatus\": \"FAIL\",\r\n \"qcReasonCode\": 2, //Reason Code Mandatory when status is Pass/Fail\r\n \"imageUrls\": [\r\n \"https://wms.com/img.jpg\",\r\n \"https://wms.com/img2.jpg\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/v2/chandler/headless/return-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\":\"Return Item data captured.\"\n}\n"},{"id":"0da97610-6874-4b00-9e2a-0bc0e4c8d7ba","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"returnId\": \"10078\",\r\n \"qcStatus\": \"FAIL\",\r\n \"qcReasonCode\": 2, //Reason Code Mandatory when status is Pass/Fail\r\n \"imageUrls\": [\r\n \"https://wms.com/img.jpg\",\r\n \"https://wms.com/img2.jpg\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/v2/chandler/headless/return-status"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2021-12-29T18:26:20.003+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"path\": \"/api/headless/return-status\"\n}"},{"id":"b17617ef-2366-49ce-8209-b6a8b6954409","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"returnId\": \"10078\",\r\n \"qcStatus\": \"FAIL\",\r\n \"qcReasonCode\": 2, //Reason Code Mandatory when status is Pass/Fail\r\n \"imageUrls\": [\r\n \"https://wms.com/img.jpg\",\r\n \"https://wms.com/img2.jpg\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/v2/chandler/headless/return-status"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": \"400 BAD_REQUEST\",\n \"message\": \"Sorry! this consignment is not available for you anymore.\"\n }\n}"},{"id":"381778ca-89b8-49aa-bb08-f9dbe25bff38","name":"5XX Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"returnId\": \"10078\",\r\n \"qcStatus\": \"FAIL\",\r\n \"qcReasonCode\": 2, //Reason Code Mandatory when status is Pass/Fail\r\n \"imageUrls\": [\r\n \"https://wms.com/img.jpg\",\r\n \"https://wms.com/img2.jpg\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/v2/chandler/headless/return-status"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"Internal Server Error\"\n }\n}"}],"_postman_id":"d1098687-30d1-4d8f-82a6-7bb0ae4e373e"},{"name":"Create RTO Order","id":"b7213898-95aa-40dd-b91d-f83a18e9698d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"forwardConsignmentId\": \"uasdwe223\",\r\n \"awbNumber\": \"HYN402\",\r\n \"fcId\": \"fc123\",\r\n \"courierName\": \"XAHVH\"\r\n}"},"url":"https://customerurl.com","description":"
This API deals with the orders that are not collected or delivered to the Customers. Omuni pushes those RTO order details with the help of this API. RTO would be at Consignment/Order level. WMS to scan the AWB in their system to take the RTO order back in their system
\n
General Flow
\n
\n
Customer doesn't collect the order or the order is not received by the customer
\n
Such orders get returned to Origin.
\n
Omuni pushes the RTO order to WMS
\n
WMS scans the AWB number in their system to take the RTO Order.
\n
WMS then further acknowledge the item and process it.
\n
\n
Process Flow
\n
\n
Customer doesn't collect the order or the order is not received by the customer
\n
Omuni sends the complete details of the RTO order in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – WMS receives the RTO order details successfully.
This API will call Omuni with RTO order processing details. This API will only get triggered after the RTO order is received and processed. This API basically notifies Omuni about the RTO process being done.
\n
General Flow
\n
\n
Warehouse receives the RTO Order details
\n
Warehouse processes the return at their side
\n
It calls this API to notify Omuni about the RTO process being done.
\n
A subsequent delta inventory update happens.
\n
\n
Process Flow
\n
\n
User receives the RTO order details and processes the return.
\n
The user calls this API and passes the parameters in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Omuni gets RTO process details.
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Field
\n
Description
\n
Mandatory
\n
Datatype
\n
\n\n\n
\n
forwardConsignmentId
\n
Unique ID of the forward consignment
\n
Yes(This or returnId is mandatory)
\n
String
\n
\n
\n
qcStatus
\n
Consignment level QC status i.e. INTACT/DAMAGED
\n
Yes
\n
String
\n
\n
\n
imageUrls
\n
List of image URLs
\n
No
\n
List
\n
\n\n
\n
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0b259697-a569-4141-b4ab-75c57d8f18c5","id":"0b259697-a569-4141-b4ab-75c57d8f18c5","name":"WMS Integrations v2","type":"folder"}},"urlObject":{"protocol":"https","path":["b","v2","chandler","headless","rto-status"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"c996d71b-2701-411f-a9b4-3dec2e47dcfc","name":"RTO Processed Notification With Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"forwardConsignmentId\": \"awewed\",\r\n \"qcStatus\": \"DAMAGED/INTACT\",\r\n \"imageUrls\": [\r\n \"https://wms.com/img.jpg\",\r\n \"https://wms.com/img2.jpg\"\r\n ]\r\n}"},"url":"https://api-preprod.ailiens.com/b/v2/chandler/headless/rto-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\":\"RTO data captured.\"\n}\n"},{"id":"28e6e193-5829-4d6f-83b6-b9c4ef35f7a9","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"forwardConsignmentId\": \"awewed\",\r\n \"qcStatus\": \"DAMAGED/INTACT\",\r\n \"imageUrls\": [\r\n \"https://wms.com/img.jpg\",\r\n \"https://wms.com/img2.jpg\"\r\n ]\r\n}"},"url":"https://api-preprod.ailiens.com/b/v2/chandler/headless/rto-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2021-12-29T18:26:20.003+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"path\": \"/api/headless/rto-status\"\n}"},{"id":"265955d7-e2ed-45ff-a4c0-8d3a2a06ce70","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"forwardConsignmentId\": \"awewed\",\r\n \"qcStatus\": \"DAMAGED/INTACT\",\r\n \"imageUrls\": [\r\n \"https://wms.com/img.jpg\",\r\n \"https://wms.com/img2.jpg\"\r\n ]\r\n}"},"url":"https://api-preprod.ailiens.com/b/v2/chandler/headless/rto-status"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": \"400 BAD_REQUEST\",\n \"message\": \"Sorry! this consignment is not available for you anymore.\"\n }\n}"},{"id":"9c672845-f2e9-417a-bec5-033aed092cb5","name":"5XX Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"forwardConsignmentId\": \"awewed\",\r\n \"qcStatus\": \"DAMAGED/INTACT\",\r\n \"imageUrls\": [\r\n \"https://wms.com/img.jpg\",\r\n \"https://wms.com/img2.jpg\"\r\n ]\r\n}"},"url":"https://api-preprod.ailiens.com/b/v2/chandler/headless/rto-status"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"Internal Server Error\"\n }\n}"}],"_postman_id":"5cd0d1ec-b726-4ad4-aeb7-f0779b5877d1"}],"id":"6b49fac8-a31a-4de6-8e9e-ce28bd0662f7","description":"
This section talks about the Return/RTO orders. Suppose a customer request a return for a particular order. Omuni pushes the Return order details to WMS. Suppose a item was never collected by the Customer then Omuni pushes the item details in RTO order to WMS.The following APIs in the section help in receiving and processing the Return/RTO orders. The following representation will better explain the flow.
This folder contains a list of API requests which will help WMS in fulfilling the orders and requests. The API integrations would help WMS to make the most of Omuni functionalities. These integrations will cover the following aspects:
\n
\n
Processing the orders
\n
QC pass/fail
\n
Invoicing
\n
Inventory update
\n
Handling Return/RTO requests
\n
Handling Customer cancellation etc.
\n
\n
Note
\n
\n
The APIs need to be called in a sequence for smooth and effective operation.
\n
The requested payload should be in the same format as given in this API document.
\n
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"9be762a9-47e2-4686-a7cd-02c6915fc121","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fe6ffd44-cfc6-4b4b-9938-db786693a688","type":"text/javascript","exec":[""]}}],"_postman_id":"0b259697-a569-4141-b4ab-75c57d8f18c5"},{"name":"Old","item":[{"name":"ERP Integrations","item":[{"name":"Push Order to ERP","id":"8b88a455-0d9c-4d8c-ab3a-c3051cef069b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{},"isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {auth token}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"id\": \"Cdb465101\",\n\"orderId\": \"Padb4651\",\n\"marketPlace\": \"PayTm\",\n\"orderReference\": \"6118167904\",\n\"consignmentId\": \"Cdb465101\",\n\"orderType\": \"booking\",\n\"collectionLocation\": \"FC2\",\n\"fulfillmentLocation\": \"FC2\",\n\"orderLocation\": null,\n\"returnLocation\": \"\",\n\"wharehouseId\": \"FC2\",\n\"dateTime\": \"20180802 09:53:06\",\n\"deliveryPriority\": \"standard\",\n\"requestedDeliveryDate\": \"\",\n\"stateCode\": \"TEL\",\n\"customerCity\": \"Hyderabad\",\n\"customerState\": \"Telangana\",\n\"customerCountry\": \"India\",\n\"entity\": \"ALBL\",\n\"billingDocumentId\": \"\",\n\"itemDetailList\": [\n{\n\"itemId\": \"Idb465101\",\n\"skuId\": \"400015545754\",\n\"articleNumber\": \"USTS5643\",\n\"eanCode\": \"400015545754\",\n\"brand\": \"U.S. Polo Assn.\",\n\"uom\": \"EA\",\n\"status\": \"INITIATED\",\n\"quantity\": 1,\n\"discountAmount\": 2597,\n\"basicAmount\": 1.85,\n\"mrp\": 2599,\n\"tax1Amount\": 0.15,\n\"tax1Description\": \"SGST\",\n\"taxPercentage\": 8,\n\"tax2Amount\": 0,\n\"tax2Description\": \"CGST\",\n\"tax2Percentage\": 0,\n\"discountPercentage\": 99.92,\n\"taxExclusive\": \"N\",\n\"sapOrderNo\": \"Idb46510100\",\n\"returnReason\": \"\"\n}\n],\n\"qualityBucket\": \"Q1\",\n\"totalAmount\": 2"},"url":"https://customerurl.com","description":"
This API is called to push the orders from omuni to the user’s/brand’s ERP/Warehouse. Once the orders get created from the website to omuni system, then the orders can be further passed to ERP/Warehouse through this API for further processing. In order to do so the user needs to provide their API url/endpoint where omuni can push the orders. The payload should be in the same fashion as that of omuni for the order details to go in the same format. Complete details of the order such as customer details, pricing details, product details etc. will be sent through this API.
\n
General Flow
\n
\n
A list of orders gets created in the omuni system.
\n
Omuni wants to push the orders to the respective ERP/warehouses
\n
Omuni calls the user’s API endpoint where the orders have to be pushed
\n
Omuni passes all the details of the order
\n
The order details get successfully pushed from omuni system to user’s ERP system.
\n
\n
Process Flow
\n
\n
Omuni calls the user’s API endpoint for pushing the orders to their ERP system/warehouse
\n
Omuni passes the complete order details through this API
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Order details get successfully updated in user’s ERP system
\n
Incorrect Input – Errored response.
\n
\n
\n","urlObject":{"protocol":"https","host":["customerurl","com"],"query":[],"variable":[]}},"response":[{"id":"0b0f0df1-3a28-46a2-a9bc-161bef640d82","name":"Default","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"acessToken","type":"text"}],"url":"https://customerurl.com"},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8b88a455-0d9c-4d8c-ab3a-c3051cef069b"},{"name":"Pick Pass/ Pick Fail","id":"bbe7d99d-5abb-4bd6-aa0b-1db050a7ae85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"accessToken"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"source\" : \"Tenant Name\",\n \"orderId\" : \"18134775035\", \n \"itemIds\" : [ \"12943539255\"], // Pass single Item ID to update\n \"status\" : \"CANCELLED\", // Ex: CANCELLED, RTO_REQUESTED, RETURN_REQUESTED\n \"reason\" : \"Size is too small\", // (Not mandatory) Reason for Cancellation or Return\n \"createdAt\" : 1539598799000 // Timestamp\n}"},"url":"https://api-preprod.ailiens.com/api/v1//order/status","description":"
This API can be called to cancel/ERP Pick Pass/ERP Pick Fail the orders in omuni system. Only one item can be passed at a time during this API call. To cancel/ ERP Pick Pass/ERP Pick Fail multiple items, the user needs to call this API multiple times. The user needs to pass the access token, orderId, item Id, status, etc. in the API request for the API to function properly.
\n
Request Parameters
\n
\n\n
\n
field
\n
description
\n
Mandatory
\n
Datatype
\n
constraints
\n
\n\n\n
\n
source
\n
Order source
\n
No
\n
String
\n
255 characters
\n
\n
\n
orderId
\n
Order Id
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
itemIds
\n
Single item id
\n
Yes
\n
List
\n
255 characters
\n
\n
\n
status
\n
Order Status
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
reason
\n
Cancel Reason
\n
No
\n
String
\n
255 characters
\n
\n
\n
createdAt
\n
request Created Time stamp
\n
Yes
\n
Timestamp
\n
255 characters
\n
\n\n
\n
General Flow
\n
\n
User wants to cancel/ERP Pick pass/ERP Pick fail a particular item
\n
The user calls this API and passes the particular item Id, status etc.
\n
The status for that particular item gets updated in omuni system
\n
\n
Process Flow
\n
\n
User wants to cancel/ERP Pick pass/ERP Pick fail a particular item
\n
The user calls this API and passes the particular item Id, status, access token in the API request
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – The status changes for that particular item in omuni.
This contains the list of APIs useful for you to intagrate with our Omuni platform. The APIs provided umder this section can help you with status updates, getting the orders etc. With the help of these APIs, you can make the most of Omuni's functionalities.
\n
ERP order API:
\n
For ERP integration, we expect an API/ rest endpoint from client systems (matching to our payload) where omuni will trigger order details in\nreal time.
\n
Once order is pushed into your system, you can use our status update API to post status updates on order.
\n
\n
Order Push API:\nAs explained above, we would need this API to push order to your system. The API details and specifications are given below
This API is called to push the orders from omuni to the user’s/brand’s Warehouse. Once the orders get created from the website to omuni system, then the orders can be further passed to Warehouse through this API for further processing. In order to do so the user needs to provide their API url/endpoint where omuni can push the orders. The payload should be in the same fashion as that of omuni for the order details to go in the same format. Complete details of the order will be sent through this API.
\n
General Flow
\n
\n
A list of orders gets created in the omuni system.
\n
Omuni wants to push the orders to the respective warehouses
\n
Omuni calls the user’s API endpoint where the orders have to be pushed
\n
Omuni passes all the details of the order
\n
The order details get successfully pushed from omuni system to user’s warehouse
\n
\n
Process Flow
\n
\n
Omuni calls the user’s API endpoint for pushing the orders to their warehouse
\n
Omuni passes the complete order details through this API
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Order details get successfully updated in warehouse
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Parameters
\n
Sample data
\n
Description
\n
Mandatory
\n
Possible Values
\n
\n\n\n
\n
id
\n
Cc341490 1
\n
Splitted order Unique ID
\n
Y
\n
ID with varchar value
\n
\n
\n
order_id
\n
Sc34149
\n
Order unique id
\n
Y
\n
ID with varchar value
\n
\n
\n
marketPlace
\n
PayTm
\n
Ordering platform
\n
Y
\n
OMUNI,PayTm other marketplace
\n
\n
\n
orderReference
\n
61181679 04
\n
Id of marketplace order
\n
\n
\n
\n
\n
consignmentId
\n
Cc341490 1
\n
Splitted order unique ID
\n
Y
\n
ID with varchar value
\n
\n
\n
orderType
\n
Booking
\n
Order Type
\n
Y
\n
Booking/Return
\n
\n
\n
collectionLocation
\n
114212
\n
Plant ID of amount collection Warehouse
\n
Mandate in ordering/f ullfilment xml if paymet info available
\n
Plant ID
\n
\n
\n
fullfilmentLocation
\n
114212
\n
Plant ID of fulfilment warehouse
\n
Mandate in ordering xml
\n
Plant ID
\n
\n
\n
orderLocation
\n
110345
\n
Plant ID of ordering plant
\n
Mandate in ordering xml
\n
Plant ID
\n
\n
\n
returnLocation
\n
110345
\n
pant ID of return warehouse
\n
Mandate in ordering xml
\n
Plant ID
\n
\n
\n
wharehouseId
\n
110345
\n
Pant ID of Warehouse
\n
N
\n
\n
\n
\n
dateTime
\n
20180721 09:07:13
\n
Date when order placed at omuni platform
\n
Y
\n
\n
\n
\n
deliveryPriority
\n
standard
\n
Type of delivery
\n
N
\n
NDD,SDD, Standard
\n
\n
\n
requestedDeliveryDate
\n
20180728 09:07:13
\n
Delivery Date
\n
N
\n
\n
\n
\n
stateCode
\n
KA
\n
State code of Shipment location
\n
Y
\n
All State code
\n
\n
\n
customerCity
\n
Hyderaba d
\n
City of Delivery location
\n
Y
\n
City Name
\n
\n
\n
customerState
\n
Telangana
\n
State of Delivery location
\n
Y
\n
State Name
\n
\n
\n
customerCountry
\n
India
\n
Country ofDelivery location
\n
Y
\n
Country Name
\n
\n
\n
entity
\n
ALBL
\n
Org name
\n
Y
\n
Org Name
\n
\n
\n
billingDocumentId
\n
unique id
\n
\n
N
\n
\n
\n
\n
itemDetailList
\n
\n
Contains Item details
\n
Y
\n
\n
\n
\n
itemId
\n
Idb465101
\n
unique id for each item
\n
Y
\n
\n
\n
\n
skuId
\n
40001554 5754
\n
BarCode of the product
\n
Y
\n
\n
\n
\n
articleNumber
\n
USTS5643
\n
Style id of the product
\n
Y
\n
\n
\n
\n
eanCode
\n
40001554 5754
\n
BarCode of the product
\n
Y
\n
\n
\n
\n
brand
\n
U.S. Polo Assn.
\n
Brand of the product
\n
Y
\n
\n
\n
\n
uom
\n
EA
\n
Unit of Measurment
\n
N
\n
\n
\n
\n
status
\n
INITIATED
\n
Order status
\n
Y
\n
INITIATED
\n
\n
\n
quantity
\n
1
\n
Quantity of the Product in that Item details
\n
Y
\n
\n
\n
\n
discountAmount
\n
239
\n
Discount amount on that item
\n
Y
\n
0 to MRP
\n
\n
\n
basicAmount
\n
342.86
\n
Basic amount on that item
\n
Y
\n
\n
\n
\n
mrp
\n
599
\n
MRP of the Product
\n
Y
\n
\n
\n
\n
tax1Amount
\n
17.14
\n
Tax component amount of the product
\n
Y
\n
\n
\n
\n
tax1Description
\n
IGST
\n
Tax component description of the Product
\n
Y
\n
SGST/UTG ST/IGST
\n
\n
\n
taxPercentage
\n
5
\n
Tax component percentage of the Product
\n
Y
\n
\n
\n
\n
tax2Amount
\n
0
\n
Tax component amount of the product
\n
Y
\n
\n
\n
\n
tax2Description
\n
CGST
\n
Tax component description of the Product
\n
Y
\n
CGST
\n
\n
\n
tax2Percentage
\n
0
\n
Tax component percentage of the Product
\n
Y
\n
\n
\n
\n
discountPercentage
\n
39.9
\n
Discount percentage of the product
\n
Y
\n
0 to 100
\n
\n
\n
taxExclusive
\n
N
\n
Flag to indicate item is tax exclusive or inclusive
This API can be called to do SapPickPass for the orders in omuni system. Basically the Warehouse acknowledges the order that has been passed to them and processes it further. Only one item can be passed at a time during this API call. To do SapPickpass for multiple items, the user needs to call this API multiple times. The user needs to pass the access token,status, etc. in the API request for the API to function properly.
\n
General Flow
\n
\n
User wants to SapPickPass a particular item
\n
The user calls this API and passes the particular item Id, status etc.
\n
The status for that particular item gets updated in omuni system
\n
\n
Process Flow
\n
\n
User wants to SapPickPass a particular item
\n
The user calls this API and passes the status, access token in the API request
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – The status changes for that particular item in omuni.
This user can call this API to generate invoice for an order. The user can call this API and pass the orderId, itemId, skuId etc. along with the access token in the API request. The API will in turn generate invoice for the particular order in the omuni system. It simply helps in generating invoice for any order.
\n
General Flow
\n
\n
User wants to generate invoice for a particular order
\n
The user calls this API and passes the orderId, itemId, skuId etc.
\n
The API will generate the invoice for that particular order.
\n
\n
Process Flow
\n
\n
User wants to generate invoice for a particular order
\n
The user calls this API and passes the access token in the headers and iorderId, itemId, skuId etc. in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – The particular order will get invoiced.
This user can call this API to get Invoice and Shipping label url after the invoice has been generated for a particular order using the previous create Invoice API. Due to this, these APIs need to be called in sequence. This API will give a downloadable url link to the user for downloading the Invoice and Shipping label for a particular order. It also provides details on the AWB number and the courier/logistics name. The user needs to pass the orderId and shipmentId in the endpoint of the API request.
\n
General Flow
\n
\n
User has generated invoice for a particular order using the create Invoice API
\n
The user calls this API to get the invoice and shipping label for that particular order
\n
The user passes the shipmentId, OrderId and access token in the API request
\n
The API gives back the url links to download the Shipping label and invoice.
\n
\n
Process Flow
\n
\n
User wants to get the invoice and shipping label for an order.
\n
The user calls this API and passes the access token in the headers and shipmentId, orderID in the endpoint of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – User gets back the downloadable url link for Invoice and shipping label.
Once the brand/client passes the shipment to the courier partner, then can call the Handover API to inform Omuni about the handover. this API is to be called in sequence after getting the invoice and shipping label url through the Get Invoice and Shippinglabel url API. The client needs to pass the shipmentId, manifestId and awb number in the body of the API request and hit this API thus informing Omuni about the handover that took place and in return omuni will move the state to shipped.
\n
General Flow
\n
\n
User has generated invoice for a particular order using the create Invoice API
\n
User gets the Invoice and ShippingLabel information through Get Invoice and ShippingLabel url API
\n
The user/client hands over the shipment to the Courier partner.
\n
The user calls this API to inform omuni about the Handover.
\n
The user passes the shipmentId, manifestId, awb number and access token in the API request
\n
The API gives back the response saying it has acknowledged it as a successful shipment.
\n
\n
Process Flow
\n
\n
User wants to inform omuni about the handover that took place between user and courier partner.
\n
The user calls this API and passes the access token in the headers and shipmentId, maifestId, awb number in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – User gets back the response saying it has acknowledged it as a successful shipment.
This API can be called to do a seller cancellation. So, whenever a particular order comes in to the warehouse and that particular warehouse is not capable of fulfilling that order, then the user can call this API to cancel the order. Only one item can be passed at a time during this API call. To cancel multiple items, the user needs to call this API multiple times. The user needs to pass the access token, orderId, item Id, skuId, quantity etc. in the API request for cancelling a particular order item request. It will get cancelled and omuni will assign it to different warehouse.
\n
General Flow
\n
\n
User receives an order through Push order to Warehouse API.
\n
User wants to cancel a particular item in the order as it can't fulfill.
\n
The user calls this API and passes the particular item Id, orderId, skuId etc.
\n
The particular order item request gets cancelled for that particular warehouse.
\n
\n
Process Flow
\n
\n
User wants to cancel a particular item
\n
The user calls this API and passes the particular item Id, orderId, access token in the API request
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – The particular order item request gets cancelled for that warehouse.
This API is called by the user’s Warehouse/ERP system to update the invoice details for a particular order into omuni’s system. Once the user’s ERP/ warehouse has processed the order and invoiced it, then it sends in the invoice details to omuni with the help of this API The user sends in the Invoice Id, orderID, authentication token and other parameters along with this API for posting the Invoice details in omuni .
\n
General Flow
\n
\n
A list of orders gets created in the omuni system.
\n
Omuni pushes the orders to the respective ERP/warehouses
\n
The ERP/warehouse processes the order and invoices it.
\n
It calls this API to update the invoice details to omuni
\n
Passes the required parameters
\n
The invoice details get successfully updated into omuni.
\n
\n
Process Flow
\n
\n
User’s ERP/warehouse system calls this API to update invoice details
\n
Passes the invoice id, itemid, orderId etc. in the body and the authentication token in the headers of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Invoice details get successfully updated in Omuni
This contains the list of APIs necessary for you to integrate your warehouse with omuni. The APIs follow the functionality of pushing orders, providing status updates, invoicing etc. With the help of this APIs, one can take benefit of the Omuni functionalities.
If brand decides to use WMS/ ERP to process and fulfill the order then shall use these APIs
\n
Call this API with invoice id, courier name, awb/ tracking no. Omuni will move the order state from order 'assigned' 'ERP Pick Pass' 'QC Pass' to order 'invoiced/ packed' state.
\n
There are few APIs available
\n
\n
QC Pass API (Order is picked up by the items)
\n
QC Fail API/ Seller cancellation (Order is rejected (or) pick failed hence the item will get routed to other warehouse)
\n
Generate Invoice (with & without logistics)
\n
Get Invoice Copy - PDF
\n
\n
Use case of warehouse APIs is to skip the OMS UI/ process.
\n
Note:
\n
All the APIs need to be called in the sequence, if the APIs are not in the sequence then it leads to exception (or) incorrect cancellation/ invoice.
\n
\n
Option1: Invoiced items & Cancelled item can be called at the same time
\n
Option2: Cancelled item API can be called separately with items
\n
\n
Item will be in wait state to invoice until all the items canceled (or) invoiced. Omuni comes with multi configurations
This API is called to update the delta inventory changes occurring at user’s side into the omuni system. As and when inventory changes at user front, the user can call this API to update that change into omuni at real time. This helps in keeping the inventory at both places in sync. Any small or major inventory change can be updated through credit, debit and overwrite of inventory in omuni. This basically helps in keeping track and real time synchronization of inventory at user and omuni level. In this API, a bearer token is passed in the Authorization of the API request.
\n
General Flow
\n
\n
Inventory changes at user level
\n
User wants to update the change of inventory into omuni
\n
The user calls this API and passes the inventory change for a particular ean.
\n
Passes the required parameters
\n
The inventory gets successfully added/updated in omuni.
\n
Inventory at both levels in sync
\n
\n
Process Flow
\n
\n
User wants to add or update inventory change in omuni
\n
Passes the bearer token in the authorization and ean, fcId, quantity and other parameters in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Inventory get successfully added/updated in Omuni
\n
Incorrect Input – Errored response.
\n
\n
\n
Note
\n
\n
The allowed values in transaction type are Overwrite, Credit, Debit
\n
The quantity to be passed should be an integer. No decimal values.
\n
\n","urlObject":{"protocol":"https","path":["b","namo","inventory","delta"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"9d975256-b184-4742-9839-881084abb508","name":"Update Inventory","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {auth token}","disabled":true},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-ENTERPRISE-ID","value":"","description":"An Enterprise identifies a client which owns the brands for which articles information is sent. It will be provided by Arvind Internet to you.","type":"text","disabled":true},{"key":"X-TRACE-ID","value":"","description":"This is optional but recommended. This is useful for tracing a request. If you want to uniquely identify a request please use this header to pass a trace id for the request. This is used by us internally ","type":"text","disabled":true}],"body":{"mode":"raw","raw":"[\n {\n \"fcId\": \"ABQF9645\",\n \"ean\": \"8907259380112\",\n \"quantity\": 0,\n \"transactionType\": \"Overwrite\",\n \"timestamp\": \"\",\n \"destination\": \"Stock\",\n \"source\": \"Out\",\n \"recordReceivedTime\": \"\"\n },\n{\n \"fcId\": \"ABQF9645\",\n \"ean\": \"8907259380179\",\n \"quantity\": 100,\n \"transactionType\": \"Overwrite\",\n \"timestamp\": \"\",\n \"destination\": \"Stock\",\n \"source\": \"Out\",\n \"recordReceivedTime\": \"\"\n },\n {\n \"fcId\": \"ABQF9645\",\n \"ean\": \"8907259380133\",\n \"quantity\": 1,\n \"transactionType\": \"Overwrite\",\n \"timestamp\": \"\",\n \"destination\": \"Stock\",\n \"source\": \"Out\",\n \"recordReceivedTime\": \"\"\n }\n]\n","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/namo/inventory/delta"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n \"67f795c1-5982-44b7-aa05-4236a9f126eb\"\r\n]"}],"_postman_id":"34723eaf-6547-4c1a-b001-5fb4d8ba2faf"},{"name":"Update Inventory - Basic Auth","id":"b280efd3-eed8-4175-9c17-f63f77787fde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"","username":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n{\r\n\"fcId\": \"Dummy1\",\r\n\"ean\": \"NNNOW59658414\",\r\n\"quantity\": 20000,\r\n\"transactionType\": \"Overwrite\",\r\n\"timestamp\": \"\",\r\n\"source\": \"Out\",\r\n\"destination\": \"Stock\",\r\n\"recordReceivedTime\": \"\"\r\n}\r\n]\r\n"},"url":"https://api-preprod.ailiens.com/b/velocity/delta/inventory/demo","description":"
This API is called to update the delta inventory changes occurring at user’s side into the omuni system. As and when inventory changes at user front, the user can call this API to update that change into omuni at real time. This helps in keeping the inventory at both places in sync. Any small or major inventory change can be updated through credit, debit and overwrite of inventory in omuni. This basically helps in keeping track and real time synchronization of inventory at user and omuni level. In this API, the basic authentication token is passed in the authorization of the API request.
\n
General Flow
\n
\n
Inventory changes at user level
\n
User wants to update the change of inventory into omuni
\n
The user calls this API and passes the inventory change for a particular ean.
\n
Passes the required parameters
\n
The inventory gets successfully added/updated in omuni.
\n
Inventory at both levels in sync
\n
\n
Process Flow
\n
\n
User wants to add or update inventory change in omuni
\n
Passes the basic authentication token in the authorization and ean, fcId, quantity and other parameters in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Inventory get successfully added/updated in Omuni
\n
Incorrect Input – Errored response.
\n
\n
\n
Note
\n
\n
The allowed values in transaction type are Overwrite, Credit, Debit
\n
The quantity to be passed should be an integer. No decimal values.
This API can be used for creation of orders in Omuni. The user can add all the orders coming to its E-commerce websites and ordering channel directly to the Omuni platform using this API. The user can process all the information such as Customer details, Product details, Payment details, Shipping details, etc. through this API request.
\n
Please note that the following fields will be shared by the Integration team once you get Onboarded.
\n
\n
channelId
\n
marketPlaceName
\n
orderingStoreID
\n
clusterId
\n
warehouseId
\n
\n
These fields will change for each User
\n
General Flow:
\n
\n
A Customer places an order in user’s E-Commerce sites and ordering channels.
\n
The user/brand calls this API to add this order in the omuni platform.
\n
The user then passes all the parameters of the order and creates the order in omuni.
\n
A new order gets created in omuni
\n
\n
Process Flow:
\n
\n
The user calls this API to add a new order into omuni platform.
\n
The user is asked for Access token as an input parameter in the headers and other mandatory parameters such as orderReference, channelId, marketplacename etc. in the body of the API request.
\n
The user passes all the mandatory parameters and other order details such as Customer details, Payment details etc.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input - New order gets created in omuni platform.
\n
Incorrect Input - Errored response.
\n
\n
\n
Note:
\n
\n
Quantity always has to be 1. If the EAN is Same, need to send it as two item object
\n
\n
\n\n
\n
field
\n
description
\n
Mandatory
\n
Datatype
\n
constraints
\n
\n\n\n
\n
orderReference
\n
Unique Reference order number(min 6 digits)
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
channelId
\n
To be provided by OMUNI
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
marketPlaceName
\n
Name of the Market Place
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
orderingStoreID
\n
store ID from where order is placed
\n
No
\n
String
\n
255 Characters
\n
\n
\n
clusterId
\n
Cluster to which order is assigned
\n
No
\n
String
\n
255 characters
\n
\n
\n
orderStatus
\n
Status of the order
\n
No
\n
String
\n
255 Characters
\n
\n
\n
grossValue
\n
Gross Value
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
Currency
\n
Currency
\n
No
\n
String
\n
255 Characters
\n
\n
\n
netAmount
\n
Total amount of the order
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
Service
\n
NA
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Financialstatus
\n
Prepaid,Postpaid
\n
Yes
\n
Object
\n
NA
\n
\n
\n
paymentStatus
\n
Paid,Unpaid
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
paymentMode
\n
COD,NCOD,Wallet
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
amount
\n
order amount
\n
Yes
\n
double
\n
2 digit precision
\n
\n
\n
customer
\n
Customer Info
\n
No
\n
Object
\n
NA
\n
\n
\n
username
\n
Username
\n
No
\n
String
\n
255 Characters
\n
\n
\n
userId
\n
User Id
\n
No
\n
String
\n
255 characters
\n
\n
\n
title
\n
Title
\n
No
\n
String
\n
255 Characters
\n
\n
\n
firstName
\n
User first name
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
middleName
\n
Middle Name
\n
No
\n
String
\n
255 Characters
\n
\n
\n
lastName
\n
last name
\n
No
\n
String
\n
255 characters
\n
\n
\n
gender
\n
User Gender
\n
No
\n
String
\n
255 Characters
\n
\n
\n
dateOfBirth
\n
User DoB
\n
No
\n
String
\n
255 characters
\n
\n
\n
phonenumber
\n
User Phone Number
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
email
\n
User Email
\n
No
\n
String
\n
255 characters
\n
\n
\n
channelId
\n
To be provided by OMUNI
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
shippingAddress
\n
Shipping Address
\n
No
\n
Object
\n
255 characters
\n
\n
\n
address_line1
\n
Address
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
city
\n
shipping City
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
state
\n
Shipping State
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
country
\n
Shipping Country
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
zip
\n
Zip code of shipping address
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
phone
\n
Phone
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
customerName
\n
Phone
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
grossAmount
\n
Gross amount for item
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
netAmount
\n
Total amount for item
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
taxAmount
\n
Tax amount for item
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
itemId
\n
Unique item id
\n
Yes
\n
String
\n
255 varchar
\n
\n
\n
quantity
\n
quantity of items
\n
Yes
\n
number (1), has to be 1 always. Multi quantity is not allowed
\n
NA
\n
\n
\n
mrp
\n
MRP of the product
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
tradeSp
\n
Selling Price
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
discount
\n
Discount on the product
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
discountCode
\n
Discount Code of the discount
\n
No
\n
String
\n
255 Characters
\n
\n
\n
taxPercentage
\n
Tax percentage
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
gstBenefit
\n
gstBenefit
\n
No
\n
Double
\n
2 digit precision
\n
\n
\n
shippingAmount
\n
Shipping Amount on item
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
itemReference
\n
Unique item id
\n
Yes
\n
Double
\n
2 digit precision
\n
\n
\n
productDetails
\n
Product details
\n
Yes
\n
Object
\n
NA
\n
\n
\n
skuId
\n
SKU ID to uniquely identify product
\n
Yes
\n
String
\n
255 varchar
\n
\n
\n
size
\n
Size of procuct L/M/S
\n
No
\n
String
\n
NA
\n
\n
\n
color
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
brand
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
mrp
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
grossSP
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
styleId
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
category1
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
category2
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
category3
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
image
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
description
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
eanCode
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
sapStyleId
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
sapSkuId
\n
NA
\n
No
\n
String
\n
NA
\n
\n
\n
warehouseId
\n
Warehouse ID
\n
Yes
\n
String
\n
255 character
\n
\n
\n
createdAt
\n
Timestamp when the order is created
\n
Yes
\n
Timestamp
\n
255 character
\n
\n\n
\n
\n\n
\n
RESPONSE CODE
\n
DESCRIPTION
\n
\n\n\n
\n
200 - OK & Accepted
\n
Everything worked as expected. Order got created successfully.
\n
\n
\n
401 - Unauthorized
\n
There is some error in validation. You need to check your token or credentials.
\n
\n
\n
500 - Server Errors Some server error occurred.
\n
Payload issue such as, orderingStoreId / SKU is not present or missing/ incorrect parameter
Once the order is created in omuni, you can use this API to initiate or update the status of the order to 'Cancel' in omuni platform. This helps in keeping track of the order and gives visibility on the current status of the order. You can call this API to initiate Cancel order in omuni. ‘The status can be updated only for a single item at a time. To update status for multiple items, the API needs to be called multiple times.’ Omuni Cloud will maintain the status update Validations and will give proper responses incase you have sent in Invalid Status. For Example, Once the Order is Shipped and your Application send Cancel status to Omuni, omuni will not accept that and send you a Valid Response.
\n
General Flow:
\n
\n
The Customer has ordered a particular item in user's site.
\n
The order gets created in Omuni via. Add/create Orders in Omuni.
\n
Customer cancels the particular order in user's site.
\n
The user calls this API to 'cancel' it in the omuni platform.
\n
The user passes the mandatory parameters and changes the order status.
\n
Order status gets moved to cancelled in omuni
\n
\n
Process Flow:
\n
\n
The user calls this API to update the order status to 'cancel' into omuni platform.
\n
The user is asked for Access token as an input parameter in the headers and other mandatory parameters such as orderId, ItemID, Status (Cancel) etc. in the body of the API request
\n
The user passes all the mandatory parameters.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input – Order status gets updated or initiated to (Cancel) in omuni platform.
\n
Incorrect Input - Errored response.
\n
\n
\n
Note
\n
\n
Only one single item to be passed at a time during this API call.
\n
In case of multiple items, this API to be called multiple times.
\n
\n
Request Parameters
\n
\n\n
\n
field
\n
description
\n
Mandatory
\n
Datatype
\n
constraints
\n
\n\n\n
\n
source
\n
Order source
\n
No
\n
String
\n
255 characters
\n
\n
\n
orderId
\n
Order Id
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
itemIds
\n
Item Id (Single item)
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
status
\n
Order Status (e.g. CANCELLED)
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
reason
\n
Cancel Reason
\n
No
\n
String
\n
255 characters
\n
\n
\n
createdAt
\n
request Created Time stamp
\n
Yes
\n
Timestamp
\n
255 characters
\n
\n\n
\n
Response
\n
\n\n
\n
RESPONSE CODE
\n
DESCRIPTION
\n
\n\n\n
\n
200 & 202 - OK & Accepted
\n
Everything worked as expected. The response is displayed or the processing starts. Some API's may respond with an error message if data is invalid.
\n
\n
\n
400 - Bad Request
\n
The request was unacceptable, often due to missing a required parameter.
\n
\n
\n
401 - Unauthorized
\n
There is some error in validation. You need to check your token or credentials.
\n
\n
\n
404 - Not Found
\n
The URL is inaccessible. This is either due to the wrong URL input or the resource being depreciated.
\n
\n
\n
405 - Method Not Allowed
\n
The API was accessed using a wrong method. Check your HTTP method.
\n
\n
\n
422 - Unprocessable Entity
\n
It means the request contains incorrect syntax or cannot be fulfilled. Try checking your code for errors.
\n
\n
\n
429 - Too Many Requests
\n
Too many hits were attempted at the API too quickly. Provide the API some time to process.
\n
\n
\n
500, 502, 503, 504 - Server Errors Some server error occurred.
\n
Some APIs may show this due to syntax or parameter errors. Try contacting support if this persists.
This API is called to initiate return into omuni platform. If the customer returns an item of the order placed in user’s E-Commerce sites, the user can process the same status into omuni and initiate return for the same item in Omuni platform. ‘Only a single item status can be updated at a time when this API is to be called. To initiate return for multiple items, the user needs to call this API multiple times.’Omuni Cloud will maintain all the status update Validations and will give proper responses incase you have sent in Invalid Status. For Example, If the Order that you want to initiate return is Delivered, Omuni will give an Error response.
\n
General Flow:
\n
\n
Customer comes to user’s E-Commerce site and initiates the return process for an order item.
\n
The user calls this API to initiate return for the same item in the omuni platform.
\n
The user passes the mandatory parameters and changes the item order status.
\n
Return for the item passed gets initiated in omuni
\n
\n
Process Flow:
\n
\n
The user calls this API to initiate the return for an item into omuni platform.
\n
The user is asked for Access token as an input parameter in the headers and other mandatory parameters such as orderId, ItemID, Status etc. in the body of the API request.
\n
The user passes all the mandatory parameters.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input – Order item return gets initiated in omuni platform.
\n
Incorrect Input - Errored response.
\n
\n
\n
Note
\n
\n
Only one single item to be passed at a time during this API call.
\n
In case of multiple items, this API to be called multiple times.
\n
The NEFT details in the body of the request is optional but can be passed in case of Refunds.
\n
\n
Request Parameters
\n
\n\n
\n
field
\n
description
\n
Mandatory
\n
Datatype
\n
constraints
\n
\n\n\n
\n
order_id
\n
Order ID for order
\n
Yes
\n
String
\n
255 characters
\n
\n
\n
status
\n
Return Status ,should be RETAWB
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
shipment_track_number
\n
AWB Number
\n
No
\n
String
\n
255 characters
\n
\n
\n
shipment_carried_code
\n
Courier Code
\n
No
\n
String
\n
255 Characters
\n
\n
\n
shipment_title
\n
Courier Name
\n
No
\n
String
\n
255 Characters
\n
\n
\n
shipment_created
\n
Shipment date
\n
No
\n
String
\n
255 Characters
\n
\n
\n
items
\n
List of Item description
\n
Yes
\n
\n
\n
\n
\n
item_id
\n
Item Id of Order (single item id is allowed)
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
qty_id
\n
quantity, always 1
\n
No
\n
String
\n
255 Characters
\n
\n
\n
sku
\n
Barcode of Item
\n
Yes
\n
String
\n
255 Characters
\n
\n
\n
AWB
\n
Courier unique tracking id. If the logistics is handled by brand, then Unique AWB number to be sent for earh item
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Customer Name
\n
As per Bank record
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Bank Name
\n
As per Bank record
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Branch Address
\n
Bank branch address
\n
No
\n
String
\n
255 Characters
\n
\n
\n
Account Number
\n
As per Bank length
\n
No
\n
String
\n
255 Characters
\n
\n
\n
IFSC Code
\n
11 Digits as per Banking standard
\n
No
\n
String
\n
255 Characters
\n
\n\n
\n
Response
\n
\n\n
\n
RESPONSE CODE
\n
DESCRIPTION
\n
\n\n\n
\n
200 & 202 - OK & Accepted
\n
Everything worked as expected. The response is displayed or the processing starts. Some API's may respond with an error message if data is invalid.
\n
\n
\n
400 - Bad Request
\n
The request was unacceptable, often due to missing a required parameter.
\n
\n
\n
401 - Unauthorized
\n
There is some error in validation. You need to check your token or credentials.
\n
\n
\n
404 - Not Found
\n
The URL is inaccessible. This is either due to the wrong URL input or the resource being depriciated.
\n
\n
\n
405 - Method Not Allowed
\n
The API was accessed using a wrong method. Check your HTTP method.
\n
\n
\n
422 - Unprocessable Entity
\n
It means the request contains incorrect syntax or cannot be fulfilled. Try checking your code for errors.
\n
\n
\n
429 - Too Many Requests
\n
Too many hits were attempted at the API too quickly. Provide the API some time to process.
\n
\n
\n
500, 502, 503, 504 - Server Errors Some server error occurred.
\n
Some APIs may show this due to syntax or parameter errors. Try contacting support if this persists.
\n
\n\n
\n
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ba8ba116-e8d6-433c-893e-79e242995ce7","id":"ba8ba116-e8d6-433c-893e-79e242995ce7","name":"Archive","type":"folder"}},"urlObject":{"protocol":"https","path":["b","namo","api","v1","","order","status"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"3a9c3535-d186-4922-bb36-f6768af3a232","name":"Return API (Item-Single Qty)","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"accessToken"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source\" : \"API\",\n \"orderId\" : \"UNI-68106649\",\n \"itemIds\" : [ \"68106649\" ], // Pass single Item ID to return\n \"status\" : \"RETURN_INITIATED\",\n \"reason\" : \"\",\n \"createdAt\" : null,\n \"awb\" : \"1458589\",\n \"neftDetails\":{\n\t\t\"customerName\": \"null\", (or) dont pass the key/ value\n \"bankName\": \"null\", (or) dont pass the key/ value\n \"branchAddress\": \"null\", (or) dont pass the key/ value\n \"accountNature\": \"null\", (or) dont pass the key/ value\n \"branchName\": \"null\", (or) dont pass the key/ value\n \"accountNumber\": \"null\", (or) dont pass the key/ value\n \"ifscCode\": \"null\" (or) dont pass the key/ value\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/namo/api/v1//order/status"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Return Created successfully\",\r\n \"status\": \"OK\",\r\n \"status_code\": 200\r\n}\r\n"}],"_postman_id":"14e9c74b-d459-447f-8217-da43b46f45ee"},{"name":"Order History","id":"08b9a432-b9c2-4166-b9aa-acb0cd4c17ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"accessToken"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"mobileNo\":\"9938852511\",\n\t\"countryCallingCode\":\"+91\",\n\t\"userType\":\"CUSTOMER\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/namo/api/v1/order/history","description":"
Order History API Description:
\n
This API is called to provide information on all the orders across channels powered by omuni for a given customer. The user can display all the orders of a particular customer with the help of this API. Suppose a customer goes to his online account page made with the user/brand and wants to see all the orders he has placed till now. Then the user can simply call this API, provide certain information about the customer such as mobile no., user type etc. and display the list of orders to their customer. Using this API you can enable your My Account Page of your website.
\n
General Flow:
\n
\n
Customer comes to user’s E-Commerce site and wants to check the list of orders he placed.
\n
The user calls this API to get information on a customer’s orders in the omuni platform.
\n
The user passes the mobile no. and other mandatory parameters.
\n
The whole list of orders is displayed to the user which in turn is returned to the particular customer.
\n
\n
Process Flow:
\n
\n
The user wants to know about a particular customer’s list of orders.
\n
Calls this API to get information about the customer’s orders in omuni platform.
\n
The user is asked for Access token as an input parameter in the headers and other mandatory parameters such as mobile no., user type, etc. in the body of the API request.
This API is called to retrieve the status of an order in Omuni platform. The user can check for the current status of any item existing in Omuni platform with the help of this API. Suppose a customer wants to know about the status of any order placed in user’s website, the user can display the order status to the customer by calling this omuni API to provide the recent status of the item.
\n
General Flow:
\n
\n
Customer comes to user’s E-Commerce site and wants to check the status for an order he placed.
\n
The user calls this API to check for the item status in the omuni platform.
\n
The user passes the OrderId for which the status is needed.
\n
The status of the order is displayed and the same is returned to the customer.
\n
\n
Process Flow:
\n
\n
The user wants to know about the status of a particular order.
\n
Calls this API to get information about the order status in omuni platform.
\n
The user is asked for Access token as an input parameter in the headers and orderId in the endpoint of the API request.
ORDER DETAIL:\nSuppose a customer comes to a brand’s website and wants to get information about a particular order. The user can then call this API and pass the OrderId for which the customer needs information. The API will return all the details about the order such as product details, Shipping details, Pricing and payment details, customer details, order status etc. Basically, this API is used to retrieve all the relevant information from omuni about a particular order.
\n
General Flow:
\n
\n
Customer visits brand’s E-Commerce site and wants to check details about a particular order.
\n
The user/brand calls this API to get information on the particular orderId being passed by the customer.
\n
The user passes the OrderId.
\n
Omuni returns all the details about that particular order.
\n
\n
Process Flow:
\n
\n
The user wants to know all the details of a given order.
\n
Calls this API to get information about the order details.
\n
The user is asked for Access token as an input parameter in the headers and OrderId in the endpoint of the API request.
\n
The user passes all the mandatory parameters.
\n
Hits the API request
\n
\n
Outcome:
\n
\n
Correct Input – All the relevant details about that particular order gets displayed.
This API is called to check the serviceability options for a particular pin code. This API gives details about the delivery options available for the given pin code. Suppose a customer wants to check whether their given pin code is serviceable or not, they can simply type in the pin code and then the user/ brand can call this API push the pin code and omuni will return on the status of its serviceability. Also, this API provides the stores nearby when asked for the Store Pickup option. If the parameter Store Pickup is given as Yes in the request then it will give all the stores which has that particular product and exercises the Store Pick up option. Serviceability check for the given pin code and what are all the delivery modes supported for the given pin code\nUse this API in your PDP page as a Pin code Serviceability Check. Also use this API once your cart is fully created to check for all the serviceability modes of Delivery.
\n
Below is the list of all available Delivery Modes
\n
\n
Standard Delivery
\n
Expedited Delivery (Same day or next day)
\n
Store Pickup
\n
\n
General Flow:
\n
\n
Customer comes to user’s E-Commerce site and wants to check whether his or her pin code is serviceable.
\n
The user calls this API to get information on the serviceability status of the customer’s given pin code.
\n
The user passes the pin code and other mandatory parameters.
\n
The serviceability status and the delivery modes available are displayed back and list of stores are displayed if asked for Store pickup option.
\n
\n
Process Flow:
\n
\n
The user wants to know about the serviceability status of the customer’s given pin code.
\n
Calls this API to get information about the serviceability status.
\n
The user is asked for Access token as an input parameter in the headers and other mandatory parameters such as location, SkuId, Store Pickup etc. in the body of the API request.
\n
The user passes all the mandatory parameters.
\n
Hits the API request.
\n
\n
Outcome:
\n
\n
Correct Input – Serviceability status and available delivery modes gets displayed. Also, if asked for Store pickup then the stores available nearby will be displayed.
This API is called by the user to add/update product/Article information in Omuni system. A product can be added in omuni by passing complete product details with the help of this API. An article master file will be provided by omuni on successful onboarding and then to add the products a payload similar to the fashion of the Article file should be passed through this API. It will help in smooth and easy addition and update of the products in omuni system.
\n
General Flow
\n
\n
User wants to add products in omuni
\n
A sample article file is provided to the user for reference
\n
The user calls this API and passes the payload in the same fashion
\n
Passes the required parameters
\n
The product get successfully added/updated in omuni.
\n
\n
Process Flow
\n
\n
User wants to add or update product information in omuni
\n
Passes the authentication token in the headers and payload similar to article file in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – Product gets successfully added/updated in Omuni
\n
Incorrect Input – Errored response.
\n
\n
\n
\n\n
\n
Parameter
\n
Description
\n
Data Type
\n
Mandatory
\n
Sample Values
\n
\n\n\n
\n
merchLevel1
\n
Gender
\n
String
\n
Yes
\n
Men
\n
\n
\n
merchLevel2
\n
Merchandising Category
\n
String
\n
Yes
\n
Apparel, Footwear
\n
\n
\n
merchLevel3
\n
Article Type
\n
String
\n
Yes
\n
Shirts, Shoes
\n
\n
\n
articleNumber
\n
Article number
\n
String
\n
Yes
\n
4.00015E+11
\n
\n
\n
uom
\n
Unit of Measure (EA - each, PCS - Pieces, NO - Number)
This API is called to check the inventory count for a particular ean in the respective fulfilment centers of the user in omuni system. The user can basically get the exact quantity of a particular ean present at their respective stores being displayed in omuni system. It helps in having a tally of the inventory present with the user and the inventory present in omuni system. The user can pass the authentication token and the ean as an input parameter in the API request and get the inventory count.
\n
General Flow
\n
\n
User wants to get the inventory count for a particular ean in omuni
\n
The user calls this API and passes the particular ean.
\n
The user gets a total count of the ean present in different stores in omuni.
\n
\n
Process Flow
\n
\n
User wants to get the inventory count for a particular ean in omuni
\n
The user calls this API and passes the particular ean.
\n
Passes the authentication token in the headers and ean, fcId in the body of the API request.
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – gets a total inventory count at different stores for the particular ean
\n
Incorrect Input – Errored response.
\n
\n
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ba8ba116-e8d6-433c-893e-79e242995ce7","id":"ba8ba116-e8d6-433c-893e-79e242995ce7","name":"Archive","type":"folder"}},"urlObject":{"protocol":"https","path":["b","namo","api","v1","","inventory","lookup"],"host":["api-preprod","ailiens","com"],"query":[],"variable":[]}},"response":[{"id":"18c6a783-28a9-425a-81bf-12acd79cc50b","name":"Inventory Look up API","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"ACCESS_TOKEN"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"This is optional but recommended. This is useful for tracing a request. If you want to uniquely identify a request please use this header to pass a trace id for the request. This is used by us internally ","key":"X-TRACE-ID","type":"text","value":"","disabled":true},{"key":"Cache-Control","value":"no-cache","type":"text"}],"body":{"mode":"raw","raw":"[\n{\n\"currentFcId\": \"\",\n\"ean\": \"41815541860005\"\n}\n]","options":{"raw":{"language":"json"}}},"url":"https://api-preprod.ailiens.com/b/namo/api/v1//inventory/lookup"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"ean\": \"41815541860005\",\r\n \"totalQuantity\": 9963,\r\n \"currentFcId\": \"\",\r\n \"fcData\": [\r\n {\r\n \"fcId\": \"Test_001\",\r\n \"qty\": 9968\r\n },\r\n {\r\n \"fcId\": \"Test_002\",\r\n \"qty\": 2\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"d0c12fe8-97f5-4abd-a5a5-c073c660a998"},{"name":"Retrieve Orders from Omuni (POS)","event":[{"listen":"test","script":{"id":"0033d399-b087-4c3e-bba3-0e86555c4e10","exec":["","","S7aece9","C7aece901","I7aece901","return","BLRA007","BLRA010","BLRA010","OMUNI","S7aece9","20190121","11:08:31","KA","8903338144113","1","0.0","1159.82","1299.0","139.18","IGST","12.0","0.0","CGST","0.0","0.0","false","I7aece901","1299.0","","1299.0","PS ","","","shashikant","","M AIL","Bangalore560001","KarnatakaIndia","9916805245","shashikant.kumar@arvindinternet.com","","","S7aece9","C7aece901","I7aece902","return","BLRA007","BLRA010","BLRA010","OMUNI","S7aece9","20190121","11:08:31","KA","8903338144113","1","0.0","1159.82","1299.0","139.18","IGST","12.0","0.0","CGST","0.0","0.0","false","I7aece902","1299.0","","1299.0","PS","","","shashikant","","M AIL","Bangalore560001","KarnatakaIndia","9916805245","shashikant.kumar@arvindinternet.com"," "],"type":"text/javascript"}}],"id":"b85f4bf3-9881-4e90-8799-2e53fff9f18d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {auth token}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api-preprod.ailiens.com/b/chandler/status/{?storeId=}","description":"
This API is called to pull the list of pending orders in the omuni system. The POS/store system can call this API to get a complete list of orders pending in the Omuni system for it to be processed further. Once the orders get created from the website to omuni system, then the orders can be further passed to Stores/ POS through this API for further processing. In order to do so the user needs to pass the entity name assigned by omuni and the storeId for which it needs the complete list of orders. After the parameters being passed Omuni will return all the pending orders for that particular store.
\n
General Flow
\n
\n
A list of orders has been created in omuni through user’s website.
\n
The user needs these orders to pass to the respective stores for further processing
\n
The user calls this API for pushing the pending orders to the respective stores
\n
The user passes the required input parameters
\n
Omuni returns a complete list of pending orders to the respective store.
\n
\n
Process Flow
\n
\n
The user calls this API to push the list of pending orders to the stores
\n
The user passes the Access token in the headers and the entity name & storeId in the endpoint of the API request
\n
Hits the API request
\n
\n
Outcome
\n
\n
Correct Input – List of pending orders returned by Omuni to the respective stores
This section contains all the APIs that are not in use anymore. These APIs were used before and their use also has been described in detail with the API requests. They are not in use currently either because they have been upgraded to a different API or the use case that they fulfilled is not met anymore.