Skip to content

Business

Type: schema

TypeScript Definition

typescript
Business: {{
            type: string;
            name: string;
            /** @description Additional metadata about the business. */
            metadata?: {
                [key: string]: string;
            };
            /** @description The registered address of the business. */
            registered_address?: components["schemas"]["CustomerAddress"];
        };
        /** BuyXGetYCouponPromotion */
}

Component References

ReferenceResolves To
components["schemas"]["CustomerAddress"]CustomerAddress

OpenAPI Schema

json
{
  "title": "Business",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/Business",
    "description": "API reference for the Business schema"
  },
  "required": [
    "type",
    "name"
  ],
  "properties": {
    "type": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "metadata": {
      "description": "Additional metadata about the business.",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "registered_address": {
      "description": "The registered address of the business.",
      "$ref": "#/components/schemas/CustomerAddress"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: