Class: MetaobjectsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:29

Extends

• BaseService

Constructors

Constructor

new MetaobjectsService(client): MetaobjectsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:12

Parameters

client

TanqoryClient

Returns

MetaobjectsService

Inherited from

BaseService.constructor

Properties

client

protected client: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:10

Inherited from

BaseService.client

Methods

addMetaobjectField()

addMetaobjectField(storeId, definitionId, field): Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:189

Add a field to a metaobject definition

Parameters

storeId

string

definitionId

string

field

description?

string

isDisplayName?

boolean

isList?

boolean

key

string

name

string

required?

boolean

type

"id" | "json" | "color" | "product" | "variant" | "order" | "dimension" | "date" | "money" | "weight" | "page" | "url" | "collection" | "file" | "integer" | "link" | "volume" | "single_line_text" | "multi_line_text" | "rich_text" | "decimal" | "rating" | "date_time" | "true_or_false" | "metaobject"

useAsFilter?

boolean

validations?

{ limitToPresetChoices?: boolean; maxCharacters?: number; maxDate?: string; maxDecimalPlaces?: number; maxMeasurement?: number; maxRating?: number; maxValue?: number; minCharacters?: number; minDate?: string; minMeasurement?: number; minRating?: number; minValue?: number; presetChoices?: string[]; regex?: string; required?: boolean; uniqueValues?: boolean; unit?: string; }

validations.limitToPresetChoices?

boolean

validations.maxCharacters?

number

validations.maxDate?

string

validations.maxDecimalPlaces?

number

validations.maxMeasurement?

number

validations.maxRating?

number

validations.maxValue?

number

validations.minCharacters?

number

validations.minDate?

string

validations.minMeasurement?

number

validations.minRating?

number

validations.minValue?

number

validations.presetChoices?

string[]

validations.regex?

string

validations.required?

boolean

validations.uniqueValues?

boolean

validations.unit?

string

Returns

Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

---

buildQuery()

protected buildQuery(options?): Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:26

Build query parameters

Parameters

options?

ListOptions

Returns

Record<string, any>

Inherited from

BaseService.buildQuery

---

createMetaobjectDefinition()

createMetaobjectDefinition(storeId, data): Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:145

Create a new metaobject definition

Parameters

storeId

string

data

description?

string

fields

object[]

name

string

options?

{ activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }

options.activeDraftStatus

boolean

options.customerAccountApiAccess

boolean

options.publishAsWebPages

boolean

options.storefrontApiAccess

boolean

options.translations

boolean

options.webPagesConfig?

{ enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }

options.webPagesConfig.enableOnlineStore

boolean

options.webPagesConfig.metaDescriptionField?

string

options.webPagesConfig.pageTitleField?

string

options.webPagesConfig.themeTemplate?

string

options.webPagesConfig.urlHandle?

string

type

string

Returns

Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

---

createMetaobjectEntry()

createMetaobjectEntry(storeId, definitionId, data): Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:297

Create a new entry

Parameters

storeId

string

definitionId

string

data

handle?

string

status

"active" | "draft"

values

Record<string, unknown>

Returns

Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

---

createMetaobjectEntryByType()

createMetaobjectEntryByType(storeId, type, data): Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:100

Create a new entry for a metaobject by type (for system taxonomy types)

Parameters

storeId

string

type

string

data

handle?

string

status

"active" | "draft"

values

Record<string, unknown>

Returns

Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

---

deleteMetaobjectDefinition()

deleteMetaobjectDefinition(storeId, id): Promise<{ deleted: true; id: string; object: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:172

Delete a metaobject definition

Parameters

storeId

string

id

string

Returns

Promise<{ deleted: true; id: string; object: string; }>

---

deleteMetaobjectEntry()

deleteMetaobjectEntry(storeId, definitionId, entryId): Promise<{ deleted: true; id: string; object: "metaobject_entry"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:328

Delete an entry

Parameters

storeId

string

definitionId

string

entryId

string

Returns

Promise<{ deleted: true; id: string; object: "metaobject_entry"; }>

---

deleteMetaobjectEntryByType()

deleteMetaobjectEntryByType(storeId, type, entryId): Promise<{ deleted: true; id: string; object: "metaobject_entry"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:131

Delete an entry for a metaobject by type (for system taxonomy types)

Parameters

storeId

string

type

string

entryId

string

Returns

Promise<{ deleted: true; id: string; object: "metaobject_entry"; }>

---

deleteMetaobjectField()

deleteMetaobjectField(storeId, definitionId, fieldId): Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:220

Delete a field from a metaobject definition

Parameters

storeId

string

definitionId

string

fieldId

string

Returns

Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

---

generateIdempotencyKey()

protected generateIdempotencyKey(prefix): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:19

Generate idempotency key

Parameters

prefix

string

Returns

string

Inherited from

BaseService.generateIdempotencyKey

---

getAllMetaobjectEntries()

getAllMetaobjectEntries(storeId, options?): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:254

List ALL entries for a store (across all definitions) This is the simplest query - fetches from metaobject_entries by storeId only

Parameters

storeId

string

options?

limit

number

page

number

search?

string

sortBy

"createdAt" | "updatedAt" | "status" | "displayName"

sortOrder

"asc" | "desc"

status?

"active" | "draft"

Returns

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

---

getExportMimeType()

protected getExportMimeType(format): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:45

Get MIME type for export format

Parameters

format

string

Returns

string

Inherited from

BaseService.getExportMimeType

---

getMetaobjectDefinition()

getMetaobjectDefinition(storeId, id): Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:51

Get a metaobject definition by ID

Parameters

storeId

string

id

string

Returns

Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

---

getMetaobjectDefinitionByType()

getMetaobjectDefinitionByType(storeId, type): Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:58

Get a metaobject definition by type

Parameters

storeId

string

type

string

Returns

Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

---

getMetaobjectDefinitions()

getMetaobjectDefinitions(storeId, options?): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:37

List all metaobject definitions

Parameters

storeId

string

options?

includeTaxonomy?

boolean

limit

number

page

number

search?

string

sortBy?

"name" | "createdAt" | "updatedAt" | "type" | "entriesCount"

sortOrder?

"asc" | "desc"

Returns

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

---

getMetaobjectEntries()

getMetaobjectEntries(storeId, definitionId, options?): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:268

List all entries for a metaobject definition

Parameters

storeId

string

definitionId

string

options?

limit

number

page

number

search?

string

sortBy

"createdAt" | "updatedAt" | "status" | "displayName"

sortOrder

"asc" | "desc"

status?

"active" | "draft"

Returns

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

---

getMetaobjectEntriesByType()

getMetaobjectEntriesByType(storeId, type, options?): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:71

List all entries for a metaobject type (for system taxonomy types)

Parameters

storeId

string

type

string

options?

limit

number

page

number

search?

string

sortBy

"createdAt" | "updatedAt" | "status" | "displayName"

sortOrder

"asc" | "desc"

status?

"active" | "draft"

Returns

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

---

getMetaobjectEntry()

getMetaobjectEntry(storeId, definitionId, entryId): Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:283

Get a single entry by ID

Parameters

storeId

string

definitionId

string

entryId

string

Returns

Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

---

getMetaobjectEntryByType()

getMetaobjectEntryByType(storeId, type, entryId): Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:86

Get a single entry by ID for a metaobject type (for system taxonomy types)

Parameters

storeId

string

type

string

entryId

string

Returns

Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

---

getMetaobjectEntryReferences()

getMetaobjectEntryReferences(storeId, definitionId, entryId, options?): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:346

Get resources that reference a metaobject entry

Parameters

storeId

string

definitionId

string

entryId

string

options?

limit

number

page

number

resourceType?

"ORDER" | "CUSTOMER" | "PRODUCT" | "COLLECTION" | "LOCATION" | "MARKET" | "COMPANY" | "VARIANT" | "DRAFT_ORDER" | "PAGE" | "BLOG" | "BLOG_POST" | "SHOP" | "COMPANY_LOCATION"

Returns

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

---

getMetaobjectEntryReferencesByType()

getMetaobjectEntryReferencesByType(storeId, type, entryId, options?): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:363

Get resources that reference a metaobject entry (by type) Used for system taxonomy types (tanqory--{handle})

Parameters

storeId

string

type

string

entryId

string

options?

limit

number

page

number

resourceType?

"ORDER" | "CUSTOMER" | "PRODUCT" | "COLLECTION" | "LOCATION" | "MARKET" | "COMPANY" | "VARIANT" | "DRAFT_ORDER" | "PAGE" | "BLOG" | "BLOG_POST" | "SHOP" | "COMPANY_LOCATION"

Returns

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

---

reorderMetaobjectFields()

reorderMetaobjectFields(storeId, definitionId, fieldIds): Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:234

Reorder fields in a metaobject definition

Parameters

storeId

string

definitionId

string

fieldIds

string[]

Returns

Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

---

updateMetaobjectDefinition()

updateMetaobjectDefinition(storeId, id, data): Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:157

Update an existing metaobject definition

Parameters

storeId

string

id

string

data

description?

string

expected_updated_at?

string

name?

string

options?

{ activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }

options.activeDraftStatus

boolean

options.customerAccountApiAccess

boolean

options.publishAsWebPages

boolean

options.storefrontApiAccess

boolean

options.translations

boolean

options.webPagesConfig?

{ enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }

options.webPagesConfig.enableOnlineStore

boolean

options.webPagesConfig.metaDescriptionField?

string

options.webPagesConfig.pageTitleField?

string

options.webPagesConfig.themeTemplate?

string

options.webPagesConfig.urlHandle?

string

Returns

Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

---

updateMetaobjectEntry()

updateMetaobjectEntry(storeId, definitionId, entryId, data): Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:312

Update an existing entry

Parameters

storeId

string

definitionId

string

entryId

string

data

expected_updated_at?

string

handle?

string

status?

"active" | "draft"

values?

Record<string, unknown>

Returns

Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

---

updateMetaobjectEntryByType()

updateMetaobjectEntryByType(storeId, type, entryId, data): Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:115

Update an entry for a metaobject by type (for system taxonomy types)

Parameters

storeId

string

type

string

entryId

string

data

expected_updated_at?

string

handle?

string

status?

"active" | "draft"

values?

Record<string, unknown>

Returns

Promise<{ createdAt: Date; definitionId: string; definitionType: string; displayName: string; handle: string; id: string; publishedAt?: Date; status: "active" | "draft"; storeId: string; updatedAt: Date; values: Record<string, unknown>; }>

---

updateMetaobjectField()

updateMetaobjectField(storeId, definitionId, fieldId, data): Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/metaobjects.ts:204

Update a field in a metaobject definition

Parameters

storeId

string

definitionId

string

fieldId

string

data

description?

string

isDisplayName?

boolean

isList?

boolean

key?

string

name?

string

required?

boolean

type?

"id" | "json" | "color" | "product" | "variant" | "order" | "dimension" | "date" | "money" | "weight" | "page" | "url" | "collection" | "file" | "integer" | "link" | "volume" | "single_line_text" | "multi_line_text" | "rich_text" | "decimal" | "rating" | "date_time" | "true_or_false" | "metaobject"

useAsFilter?

boolean

validations?

{ limitToPresetChoices?: boolean; maxCharacters?: number; maxDate?: string; maxDecimalPlaces?: number; maxMeasurement?: number; maxRating?: number; maxValue?: number; minCharacters?: number; minDate?: string; minMeasurement?: number; minRating?: number; minValue?: number; presetChoices?: string[]; regex?: string; required?: boolean; uniqueValues?: boolean; unit?: string; }

validations.limitToPresetChoices?

boolean

validations.maxCharacters?

number

validations.maxDate?

string

validations.maxDecimalPlaces?

number

validations.maxMeasurement?

number

validations.maxRating?

number

validations.maxValue?

number

validations.minCharacters?

number

validations.minDate?

string

validations.minMeasurement?

number

validations.minRating?

number

validations.minValue?

number

validations.presetChoices?

string[]

validations.regex?

string

validations.required?

boolean

validations.uniqueValues?

boolean

validations.unit?

string

Returns

Promise<{ addedBy?: string; createdAt: Date; description?: string; entriesCount: number; fields: object[]; id: string; name: string; options?: { activeDraftStatus: boolean; customerAccountApiAccess: boolean; publishAsWebPages: boolean; storefrontApiAccess: boolean; translations: boolean; webPagesConfig?: { enableOnlineStore: boolean; metaDescriptionField?: string; pageTitleField?: string; themeTemplate?: string; urlHandle?: string; }; }; storeId: string; type: string; updatedAt: Date; }>