A seller app refers to an application that will allow providers (seller on record or actual seller) to interact with the buyers/ end consumers through the buyer application. Seller app manages the actual fulfillment of orders.
A detailed user manual for the seller reference app is available here.
| Feature | Sub Feature | Status |
|---|---|---|
| Incremental catalog refresh | Provider disabling | |
| Store disabling | ||
| Store closed (known duration) | ||
| Store closed (unknown duration) | ||
| Item record changes | ||
| Offers | ||
| Full catalog refresh | RET codes for L1 categories | |
| Catalog directly to BNP | ||
| Updated taxonomy (BPC, H&K, H&W) | ||
| Store open / close / disable / enable | ||
| Customization (input - selection) | ||
| Customization (input - free text) | ||
| Handling of make-to-order items display price having base price of 0 | ||
| Variants | ||
| Custom Menu | ||
| Definition of ISN/MSN | ||
| Item availability schedule | ||
| Order tracking | Hyperlocal - using gps coordinates | |
| Hyperlocal & inter-city - using URL | ||
| Live Order Tracking | ||
| Order flow | Addition of quote type | |
| Updated /confirm, /on_confirm flow | ||
| Customization (input - selection: all pre-order APIs) | ||
| Customization (input - free text: all pre-order APIs) | ||
| Customization (input - selection: all post-order APIs) | ||
| Customization (input - free text: all post-order APIs) | ||
| Payment collection by SNP | ||
| Exchange of GST no between BNP & SNP | ||
| PAN no for provider for verification of ISN / MSN | ||
| Offers | Offer definition in catalog | |
| Applying offers during checkout | ||
| Offer support in other pre-order APIs | ||
| Offer support in other post-order APIs | ||
| Cancellation | Updated cancel API (non-RTO) | |
| RTO flow for cancellation | ||
| Definition & communication of cancellation terms (fees, etc) | ||
| Force cancellation (for fulfillment TAT breach) | ||
| Linking cancellation with IGM issue | ||
| Static terms | Enabling static terms | |
| BNP + logistics | Enabling logistics integration with BNP | |
| Update API | Merchant part cancel | |
| Return with pickup | ||
| Return with liquidation | ||
| Cancel return request | ||
| Linking return with IGM issue | ||
| Fulfillment | Enabling self-pickup | |
| Enabling slotted delivery | ||
| Enabling additional fulfillment states - hyperlocal | ||
| Enabling additional fulfillment states - inter-city | ||
| Enabling authorization options | ||
| Cascading discount, taxes on fulfillment from LSP | ||
| Payment on Delivery | ||
| Notification from LSP on fulfillment delay | ||
| Catalog (others) | Polygon serviceability | |
| Pincode serviceability | ||
| QR code deep link (Enablement and Generation) | ||
| Distributed search by city | ||
| Back image for items | ||
| SNP communicating acceptable finder fee | ||
| Min order value | ||
| Different store timings for delivery, pickup, order processing | ||
| Provider credentials | ||
| Catalog download zip file link | ||
| Communication from buyer NP to seller NP (catalog ingestion feedback, etc) | ||
| Rating | rating, on_rating | |
| Others | /info, /on_info APIs | |
| Off Network Logistics Option | ||
| Option to select logistics delivery type | ||
| Bhashini Integration | ||
| Catalog Indexing | ||
| Category Seller Panel |
This repo is ONDC Seller App with micro-service architecture which contains
- Seller-app - Node.js
- Seller-app-frontend - Frontend application (react) being served via nginx.
- Seller-app-protocol - Protocol layer(python).
- Seller-app-igm - IGM layer(node).
- Seller-bugzilla-service - Bugzilla layer(node).
- Who wants to refer the seller app.
- Who wants the same setup to be available in their infra.
- You can pick any component of it and use separately.
- Make sure you've pulled all sub-directories .
git submodule init
git submodule update
- Firebase Authentication.
- Create the application under firebase console.
- Once the application is created, visit the application and click on authentication tab.
- Enable the following sign methods in the authentication sign-in method tab.
- In project settings create different projects supported for various platforms like Android, iOS and web, (this will help in downloading the config files, required for authentication)
REACT_APP_FIREBASE_API_KEY=”API_KEY”
REACT_APP_FIREBASE_AUTH_DOMAIN=”www.example.com”
- SMTP Requirement
Our seller application requires SMTP configuration to send notification emails either for login one time password, or to recieve welcome emails.
SMTP_HOST=<SMTP_HOST>
SMTP_PORT=<SMTP_PORT>
SMTP_AUTH_USERNAME=<SMTP_AUTH_USERNAME>
SMTP_AUTH_PASSWORD=<SMTP_AUTH_PASSWORD>
SMTP_EMAIL_SENDER=<SMTP_EMAIL_SENDER>
- S3 Requirement
Our seller application requires S3 configuration as per our implementation to store the assets which we need for application logics.
AWS_ACCESS_KEY_ID=<AWS_S3_ACCESS_KEY>
AWS_SECRET_ACCESS_KEY=<AWS_S3_ACCESS_KEY>
S3_VERSION=<S3_VERSION>
S3_REGION=<S3_REGION>
S3_BUCKET=<S3_BUCKET>
- Map My India (MMI)
For location based information, integration with MMI has been used. MMI has been used as follows - Get detailed address information by typing in search query Get list of addresses for a given PIN code Get state and city by PIN code Get Latitude and longitude of the provided address
MMI API that have been used are as follows - https://outpost.mapmyindia.com/api https://atlas.mapmyindia.com/api/places/search/json https://explore.mappls.com https://apis.mapmyindia.com/advancedmaps/v1 https://atlas.mappls.com/api/places/geocode
MMI Configuration in the white labeled buyer app
MMI_CLIENT_SECRET=”MMI_SERVICE”
MMI_CLIENT_ID=”MMI_CLIENT_ID”
MMI_ADVANCE_API_KEY=”MMI_ADVANCE_API_KEY”- Pick the .env file and ask the admin for keys that need to replaced.
- By the use of signing_and_verification utility, we will get these keys.
Signing_private_key: some-key
Signing_public_key: some-key
Crypto_Privatekey: some-key
Crypto_Publickey: some-key
- For accessing the ONDC gateway one must be registered in the staging registry, and fill out this Form and get in touch with ONDC officials or contact Slack Channel.
- One must submit the payload in the form, Refer to the Document, or here is the example JSON.
- The date format is OpenAPI date-time notation.
{
"country": "IND",
"city": "std:0801",
"type": "BPP4",
"subscriber_id": "https://integration-qa.gofrugalretail.com/ecommerce/ondc6",
"subscriber_url": "https://integration-qa.gofrugalretail.com/ecommerce/ondc8",
"domain": "nic2004:521109",
"signing_public_key": "SIGNING_PRIVATE_KEY",
"encr_public_key": "CRYPTO_PUBLICKEY",
"created": "2021-11-09T05:56:52.470Z2",
"valid_from": "2021-11-10T05:56:52.470Z3",
"valid_until": "2023-11-09T05:56:52.470Z7",
"updated": "2021-11-09T13:15:58.349Z11"
}
- A ngrok instance is required to be running locally to publish to the internet
brew install --cask ngrok
ngrok http 5555
-
Copy the url to the clipboard and paste in BAP_URL and PROTOCOL_BASE_URL in .env-local.
-
Run docker-compose -f docker-compose-for-local.yaml --env-file .env-local up -d
-
Open http://localhost.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
- For the white label app, ONDC has used ansible to deploy and generate ssl certificates.
- The public key of the node to generate ssl and make it available for the seller apps to identify the buyer app.
- Docker and docker compose needs to be installed.
- Access to github repository to clone.
- Create a copy of .env-local with valid credentials and name it .env-. E.g. .env-prod.
First ansible is to install the apps and generate ssl certificate
CMDs (commands)
ansible-playbook -i ansible_hosts buyer-app-install-for-ssl.yaml
it will ask for
Hostname - which needs to be mentioned in hostname file
it will ask for domain to host
E.g. buyer-app.ondc.org
it will ask for stage name, which is used to copy the .env file, to copy
If a env file of .env-prod is already created, then prod
- Try to run to generate lets encrypt ssl certificates
ansible-playbook -i seller-app-install-for-ssl.yaml
- Once above ansible playbook is successfully installed we can run
ansible-playbook -i seller-app-run.yaml
This project is licensed under the ONDC - see the LICENSE.md file for details.