SellerAccount
Type: schema
Description
A marketplace seller's account, with its channel_id and its KYC documents; custom fields the marketplace's seller form defines appear as extra top-level fields.
TypeScript Definition
typescript
SellerAccount: {{
/** @description The seller's store id. */
id: string;
trade_name: string;
legal_name: string;
business_type: string;
tax_identification_number: string | null;
/**
* @description The marketplace's approval of the seller.
* @enum {string}
*/
status: "pending_approval" | "approved" | "rejected";
/**
* @description Follows the seller's documents against the marketplace's required ones.
* @enum {string}
*/
kyc_status: "document_pending" | "document_submitted" | "approved" | "rejected";
/**
* @description `public`: the seller's products are visible to everyone; `private`: to signed-in customers only.
* @enum {string}
*/
visibility: "public" | "private";
logo: string | null;
created_at: string;
/** @description The seller's primary address. */
registered_address: {
id: string;
name: string;
address_line1: string;
address_line2: string | null;
landmark: string | null;
city: string;
pincode: string;
state: string;
country: string | null;
phone: string;
country_code: string;
is_phone_verified: boolean;
is_primary: boolean;
} | null;
/** @description The seller's primary notification contact. */
primary_contact: {
id: string;
/** @enum {string} */
notification_type: "email" | "sms" | "whatsapp" | "push";
name: string;
email: string;
phone: string | null;
is_primary: boolean;
is_email_verified: boolean;
is_phone_verified: boolean;
is_whatsapp_verified: boolean;
} | null;
/** @description The marketplace's note on its last approval or rejection; `verification_at` its time. */
verification_message: string | null;
/** Format: date-time */
verification_at: string | null;
/** @description The marketplace the seller sells on. */
marketplace_id: string;
marketplace_name: string;
/** @description The seller's marketplace channel; the event's key. */
channel_id: string;
/** @description The seller's KYC documents, oldest first, without download links. */
documents: {
id: string;
/** @description The marketplace's KYC document type; `document_type` is its code. */
document_type_id: string;
/** @enum {string} */
document_type: "gst" | "pan" | "other";
title: string;
document_number: string;
file_name: string | null;
file_size: number | null;
/** @enum {string} */
status: "submitted" | "approved" | "rejected" | "expired";
is_verified: boolean;
/** @enum {string} */
verification_type: "manual" | "automatic";
/** @description Email or username of the admin who approved or rejected it. */
verification_by: null | string;
verification_at: null | string;
verification_message: null | string;
note: string | null;
/** Format: date-time */
expires_at: string | null;
}[];
};
/**
* SellerAccountStatus
* @enum {string}
*/
}OpenAPI Schema
json
{
"title": "SellerAccount",
"description": "A marketplace seller's account, with its `channel_id` and its KYC documents; custom fields the marketplace's seller form defines appear as extra top-level fields.",
"type": "object",
"externalDocs": {
"url": "https://llm-docs.commercengine.io/storefront/schemas/SellerAccount",
"description": "API reference for the SellerAccount schema"
},
"required": [
"business_type",
"channel_id",
"created_at",
"documents",
"id",
"kyc_status",
"legal_name",
"logo",
"marketplace_id",
"marketplace_name",
"primary_contact",
"registered_address",
"status",
"tax_identification_number",
"trade_name",
"verification_at",
"verification_message",
"visibility"
],
"properties": {
"id": {
"description": "The seller's store id.",
"type": "string"
},
"trade_name": {
"type": "string"
},
"legal_name": {
"type": "string"
},
"business_type": {
"type": "string"
},
"tax_identification_number": {
"type": [
"string",
"null"
]
},
"status": {
"description": "The marketplace's approval of the seller.",
"type": "string",
"enum": [
"pending_approval",
"approved",
"rejected"
]
},
"kyc_status": {
"description": "Follows the seller's documents against the marketplace's required ones.",
"type": "string",
"enum": [
"document_pending",
"document_submitted",
"approved",
"rejected"
]
},
"visibility": {
"description": "`public`: the seller's products are visible to everyone; `private`: to signed-in customers only.",
"type": "string",
"enum": [
"public",
"private"
]
},
"logo": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"registered_address": {
"description": "The seller's primary address.",
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"address_line1": {
"type": "string"
},
"address_line2": {
"type": [
"string",
"null"
]
},
"landmark": {
"type": [
"string",
"null"
]
},
"city": {
"type": "string"
},
"pincode": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": [
"string",
"null"
]
},
"phone": {
"type": "string"
},
"country_code": {
"type": "string"
},
"is_phone_verified": {
"type": "boolean"
},
"is_primary": {
"type": "boolean"
}
},
"required": [
"address_line1",
"address_line2",
"city",
"country",
"country_code",
"id",
"is_phone_verified",
"is_primary",
"landmark",
"name",
"phone",
"pincode",
"state"
]
},
"primary_contact": {
"description": "The seller's primary notification contact.",
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string"
},
"notification_type": {
"type": "string",
"enum": [
"email",
"sms",
"whatsapp",
"push"
]
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": [
"string",
"null"
]
},
"is_primary": {
"type": "boolean"
},
"is_email_verified": {
"type": "boolean"
},
"is_phone_verified": {
"type": "boolean"
},
"is_whatsapp_verified": {
"type": "boolean"
}
},
"required": [
"email",
"id",
"is_email_verified",
"is_phone_verified",
"is_primary",
"is_whatsapp_verified",
"name",
"notification_type",
"phone"
]
},
"verification_message": {
"description": "The marketplace's note on its last approval or rejection; `verification_at` its time.",
"type": [
"string",
"null"
]
},
"verification_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"marketplace_id": {
"description": "The marketplace the seller sells on.",
"type": "string"
},
"marketplace_name": {
"type": "string"
},
"channel_id": {
"description": "The seller's marketplace channel; the event's key.",
"type": "string"
},
"documents": {
"description": "The seller's KYC documents, oldest first, without download links.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"document_type_id": {
"description": "The marketplace's KYC document type; `document_type` is its code.",
"type": "string"
},
"document_type": {
"type": "string",
"enum": [
"gst",
"pan",
"other"
]
},
"title": {
"type": "string"
},
"document_number": {
"type": "string"
},
"file_name": {
"type": [
"string",
"null"
]
},
"file_size": {
"type": [
"integer",
"null"
]
},
"status": {
"type": "string",
"enum": [
"submitted",
"approved",
"rejected",
"expired"
]
},
"is_verified": {
"type": "boolean"
},
"verification_type": {
"type": "string",
"enum": [
"manual",
"automatic"
]
},
"verification_by": {
"description": "Email or username of the admin who approved or rejected it.",
"type": [
"null",
"string"
]
},
"verification_at": {
"type": [
"null",
"string"
]
},
"verification_message": {
"type": [
"null",
"string"
]
},
"note": {
"type": [
"string",
"null"
]
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"document_number",
"document_type",
"document_type_id",
"expires_at",
"file_name",
"file_size",
"id",
"is_verified",
"note",
"status",
"title",
"verification_at",
"verification_by",
"verification_message",
"verification_type"
]
}
}
}
}Auto-generated from OpenAPI spec and TypeScript definitions