Skip to content

StoreRecord ​

Type: schema

Description ​

A store: its name, type, visibility and setup state.

TypeScript Definition ​

typescript
StoreRecord: {{
            id: string;
            name: string;
            description: null | string;
            /** @description `b2c`, `b2b` or `marketplace`; `null` until chosen, on the store created at signup. */
            store_type: string | null;
            product_category: string[] | null;
            active: boolean;
            is_public: boolean;
            is_default: boolean;
            /** @description Whether the store's setup is complete. */
            is_store_setup_complete: boolean;
            slug: null | string;
            /** @description Where the store's setup stands. */
            workflow_status: string;
            created_at: string;
            modified_at: string;
            marketplace_id: null | string;
        };
        /** ShippingBox */
}

OpenAPI Schema ​

json
{
  "title": "StoreRecord",
  "description": "A store: its name, type, visibility and setup state.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/StoreRecord",
    "description": "API reference for the StoreRecord schema"
  },
  "required": [
    "active",
    "created_at",
    "description",
    "id",
    "is_default",
    "is_public",
    "is_store_setup_complete",
    "marketplace_id",
    "modified_at",
    "name",
    "product_category",
    "slug",
    "store_type",
    "workflow_status"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "null",
        "string"
      ]
    },
    "store_type": {
      "description": "`b2c`, `b2b` or `marketplace`; `null` until chosen, on the store created at signup.",
      "type": [
        "string",
        "null"
      ]
    },
    "product_category": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "active": {
      "type": "boolean"
    },
    "is_public": {
      "type": "boolean"
    },
    "is_default": {
      "type": "boolean"
    },
    "is_store_setup_complete": {
      "description": "Whether the store's setup is complete.",
      "type": "boolean"
    },
    "slug": {
      "type": [
        "null",
        "string"
      ]
    },
    "workflow_status": {
      "description": "Where the store's setup stands.",
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "modified_at": {
      "type": "string"
    },
    "marketplace_id": {
      "type": [
        "null",
        "string"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: