Skip to content

AdminSellerInfo ​

Type: schema

TypeScript Definition ​

typescript
AdminSellerInfo: {{
            id?: string;
            /** @description Display name of the seller. Sent in place of `trade_name` and `legal_name` on the abbreviated form of this object. */
            name?: string;
            trade_name?: string;
            legal_name?: string;
            business_type?: components["schemas"]["SellerBusinessType"];
            tax_identification_number?: string;
            status?: components["schemas"]["SellerAccountStatus"];
            kyc_status?: components["schemas"]["SellerKycStatus"];
            /**
             * @description Visibility of the products of the seller. public: products are visible to all users, private: products are visible to only authenticated users.
             * @enum {string}
             */
            visibility?: "public" | "private";
            logo?: string | null;
        };
        /**
         * AppliedCoupon
         * @description Details about an active coupon applied to a cart/order
         */
}

Component References ​

ReferenceResolves To
components["schemas"]["SellerBusinessType"]SellerBusinessType
components["schemas"]["SellerAccountStatus"]SellerAccountStatus
components["schemas"]["SellerKycStatus"]SellerKycStatus

OpenAPI Schema ​

json
{
  "title": "SellerInfo",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "Display name of the seller. Sent in place of `trade_name` and `legal_name` on the abbreviated form of this object.",
      "type": "string"
    },
    "trade_name": {
      "type": "string"
    },
    "legal_name": {
      "type": "string"
    },
    "business_type": {
      "$ref": "#/components/schemas/SellerBusinessType"
    },
    "tax_identification_number": {
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/SellerAccountStatus"
    },
    "kyc_status": {
      "$ref": "#/components/schemas/SellerKycStatus"
    },
    "visibility": {
      "description": "Visibility of the products of the seller. public: products are visible to all users, private: products are visible to only authenticated users.",
      "type": "string",
      "enum": [
        "public",
        "private"
      ]
    },
    "logo": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: