Skip to main content

​
Create Seller Application (Customer)

Submits an application to become a seller. Customers must be authenticated and can only apply for their own account.

​
Path Parameters

​
accountId
string (uuid)
required
Account identifier (must match authenticated user)

​
Request Body (multipart/form-data)

​
shopName
string
required
Proposed shop name
​
shopDescription
string
required
Description of the shop and products
​
businessDocument
file
required
Business license or registration document
​
phoneNumber
string
required
Business contact phone number
​
address
object
required
Business address details

​
Response Codes

  • 204 No Content - Application submitted successfully
  • 400 Bad Request - Invalid application data or account already a seller
  • 404 Not Found - Account not found

​
Examples

curl -X POST "https://your-server.com/api/seller-applications/account-uuid" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -F "shopName=AudioPro Electronics" \
  -F "shopDescription=Premium audio equipment and accessories" \
  -F "businessDocument=@/path/to/license.pdf" \
  -F "phoneNumber=+1-555-123-4567" \
  -F 'address={"street":"123 Business Ave","city":"New York","state":"NY","zipCode":"10001","country":"USA"}'

​
Error Response Examples

Already a Seller (400 Bad Request): 
"Account is already registered as a seller"
Missing Required Fields (400 Bad Request): 
"Shop name is required"
Invalid Document Format (400 Bad Request): 
"Business document must be PDF format"

​
Get All Pending Applications (Admin)

Retrieves all pending seller applications for review.

​
Response

​
applications
array
Array of pending seller application objects

​
Response Codes

  • 200 OK - Applications retrieved successfully

​
Example

cURL
curl -X GET "https://your-server.com/api/seller-applications" \
  -H "Authorization: Bearer YOUR_ADMIN_JWT_TOKEN"

​
Success Response

[
  {
    "id": "application-uuid-1",
    "accountId": "account-uuid-1",
    "applicantEmail": "[email protected]",
    "shopName": "AudioPro Electronics",
    "shopDescription": "Premium audio equipment",
    "phoneNumber": "+1-555-123-4567",
    "address": {
      "street": "123 Business Ave",
      "city": "New York",
      "state": "NY",
      "zipCode": "10001",
      "country": "USA"
    },
    "businessDocumentUrl": "https://storage.example.com/docs/license-1.pdf",
    "status": "Pending",
    "submittedAt": "2024-01-15T10:30:00Z"
  },
  {
    "id": "application-uuid-2",
    "accountId": "account-uuid-2",
    "applicantEmail": "[email protected]",
    "shopName": "TechGadgets Store",
    "shopDescription": "Latest tech gadgets and accessories",
    "phoneNumber": "+1-555-987-6543",
    "address": {
      "street": "456 Commerce St",
      "city": "San Francisco",
      "state": "CA",
      "zipCode": "94102",
      "country": "USA"
    },
    "businessDocumentUrl": "https://storage.example.com/docs/license-2.pdf",
    "status": "Pending",
    "submittedAt": "2024-01-16T14:20:00Z"
  }
]

​
Approve Seller Application (Admin)

Approves a seller application, creating a seller account and granting seller role.

​
Path Parameters

​
sellerApplicationId
string (uuid)
required
Seller application identifier

​
Response Codes

  • 204 No Content - Application approved, seller account created
  • 400 Bad Request - Application already processed
  • 404 Not Found - Application not found
  • 409 Conflict - Account already has seller role
  • 500 Internal Server Error - Error creating seller account

​
Example

cURL
curl -X PATCH "https://your-server.com/api/seller-applications/application-uuid/approve" \
  -H "Authorization: Bearer YOUR_ADMIN_JWT_TOKEN"

​
Error Response Examples

Already Processed (400 Bad Request): 
"Application has already been processed"
Conflict (409 Conflict): 
"Account already has seller role"

​
Reject Seller Application (Admin)

Rejects a seller application.

​
Path Parameters

​
sellerApplicationId
string (uuid)
required
Seller application identifier

​
Response Codes

  • 204 No Content - Application rejected
  • 400 Bad Request - Application already processed
  • 404 Not Found - Application not found

​
Example

cURL
curl -X PATCH "https://your-server.com/api/seller-applications/application-uuid/reject" \
  -H "Authorization: Bearer YOUR_ADMIN_JWT_TOKEN"

​
Seller Onboarding Process

1

Customer Creates Account

User registers as a customer on the platform
2

Submit Seller Application

Customer submits application with business details and documents
3

Application Review

Admin reviews application and verifies business documents
4

Approval or Rejection

Admin approves or rejects the application
5

Seller Account Creation

If approved, seller account is created and seller role is granted
6

Setup Shop

New seller can now log in with seller role and start adding products

​
Application Requirements

​
Required Information

​
shopName
string
Shop Name: Unique, professional name for your shop (3-100 characters)
​
shopDescription
string
Description: Clear description of your business and products (minimum 50 characters)
​
businessDocument
file
Business Document: Valid business license, registration, or tax ID (PDF format, max 5MB)
​
phoneNumber
string
Contact Number: Valid business phone number
​
address
object
Business Address: Complete business address

​
Document Guidelines

Accepted Documents:
  • Business license
  • Company registration certificate
  • Tax identification documents
  • Seller permit or authorization
Documents must be:
  • Clear and legible
  • Current (not expired)
  • In PDF format
  • Under 5MB file size

​
Application Status

Applications can have the following statuses:
  • Pending - Awaiting admin review
  • Approved - Application approved, seller account created
  • Rejected - Application rejected by admin

​
After Approval

Once approved:
  1. Seller Role Granted - Account gains “Seller” role
  2. Shop Created - Shop is set up with provided details
  3. Access Seller Features - Can access seller dashboard and features
  4. Add Products - Can start listing products
  5. Manage Orders - Can view and fulfill orders

​
Tips for Successful Application

Choose a Unique Shop Name: Make it memorable and relevant to your products
Write a Detailed Description: Explain what makes your shop unique and what products you’ll offer
Provide Clear Documents: Ensure all business documents are current, legible, and properly formatted
Use Accurate Contact Information: Admins may need to contact you during the review process

Build docs developers (and LLMs) love

Get started for freeTalk to us