Introduction

Overview Authentication Request Response

API Reference

Sellers

(ms.sellers)

It lets you manage sellers who sell products on your store.

Fields
EndPoints

Fields

ValueDescription
title   
Type: string
Required
Unique title of the seller.
MegaMart
alias   
Type: string
Unique alias of the seller.
megamart
logo   
Type: file
Logo for sellers.
images   
Type: array
Image for the seller profile.
image
Type: file
Required
A single image for the seller profile.
legal_name   
Type: string
Legal name of the seller.
Dennis
info   
Type: string
Any extra information about the seller.
website   
Type: string
Website of the seller.
www.megamart.com
address   
Type: string
Address of the seller.
153, MG Road
city   
Type: string
City of the seller.
Gurgaon
country   
Type: string
Country of the seller.
India
state   
Type: string
State of the seller.
Haryana
zip_code   
Type: string
Zip code of the city to which the seller belongs.
122001
invoice_prefix   
Type: string
Invoice prefix to be used for the seller.
MGMRT
role   
Type: string
bank_details   
Type: object
Bank details of the seller.
{
  "bank_details": {
    "account_holder_name": "dennis",
    "account_number": "41341413131331134",
    "bank_name": "HDFC",
    "city": "Gurgaon",
    "branch": "Sohna Road",
    "ifsc_code": "HDFC0000583"
  }
}
account_holder_name
Type: string
Name on the bank account holder.
account_number
Type: string
Bank account number of the seller.
bank_name
Type: string
Name of bank of the seller.
city
Type: string
City where the seller's bank is located.
branch
Type: string
Branch of the seller's bank.
ifsc_code
Type: string
IFSC code of the seller's bank.
pan   
Type: string
Pan number of the seller.
ABCDE1234F
pan_proof   
Type: file
Pan proof of the seller.
image_of_proof.png
cin_number   
Type: string
CIN number of the seller.
L27000MH1234PLC240004
tin   
Type: string
TIN number of the seller.
23434546789
tin_proof   
Type: file
Tin proof of the seller.
image_of_proof.png
tan   
Type: string
Tan number of the seller.
HYDD00592E
tan_proof   
Type: file
Tan proof of the seller.
image_of_proof.png
gstin   
Type: string
GSTIN number of the seller.
cancelled_cheque   
Type: file
Image of a cancelled cheque of the seller.
image_of_cheque.jpg
address_proof   
Type: file
Address proof of the seller.
image_of_proof.png
id_proof   
Type: file
Identity proof of the seller.
image_of_proof.png
signature   
Type: file
Digital copy of signature of the seller.
notes   
Type: array
Any information, related to the seller.
note
Type: string
files
Type: array
tax   
Type: custom
balance   
Type: string
Balance amount of the seller for which the invoice will be generated.

Commands (Endpoints)

POST /api/1/entity/ms.sellers   
Creates a new seller
DEL /api/1/entity/ms.sellers/{resource_id}   
Deletes a seller
PUT /api/1/entity/ms.sellers/{resource_id}   
Updates an existing seller
GET /api/1/entity/ms.sellers/{resource_id}   
Retrieves a single seller
GET /api/1/entity/ms.sellers   
Retrieves a list of sellers
csvExport