IAttributeModuleService Reference

This section of the documentation provides a reference to the IAttributeModuleService interface’s methods. This is the interface developers use to use the functionalities provided by the Attribute Module.

You should only use the methods in this reference when implementing complex customizations. For common cases, check out available workflows instead.

The main service interface for the Attribute Module.

Methods

createAttributes
updateAttributes
deleteAttributes
retrieveAttribute
listAttributes
listAndCountAttributes
softDeleteAttributes
restoreAttributes
createAttributeValues
updateAttributeValues
deleteAttributeValues
retrieveAttributeValue
listAttributeValues
listAndCountAttributeValues
softDeleteAttributeValues
restoreAttributeValues
createAttributePossibleValues
updateAttributePossibleValues
deleteAttributePossibleValues
retrieveAttributePossibleValue
listAttributePossibleValues
listAndCountAttributePossibleValues
softDeleteAttributePossibleValues
restoreAttributePossibleValues
updateAttributeWithUpsertOrReplacePossibleValues

createAttributes

This section provides a reference to the createAttributes method. This belongs to the Attribute Module.

createAttributes(data, sharedContext?): Promise<AttributeDTO[]>

This method creates attributes.

Example

const attributes = await attributeModuleService.createAttributes([
  {
    name: "Material",
    handle: "material",
    ui_component: "select",
    is_filterable: true,
    is_required: false,
    possible_values: [
      { value: "Cotton", rank: 1 },
      { value: "Polyester", rank: 2 },
    ],
  },
])

Parameters

data

CreateAttributeDTO[]

required

The attributes to be created.

Show properties

name

string

required

The name of the attribute.

description

string

The description of the attribute.

handle

string

The unique handle of the attribute.

is_filterable

boolean

Whether the attribute is filterable.

is_required

boolean

Whether the attribute is required.

ui_component

required

The UI component type for rendering the attribute.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

possible_values

CreateAttributeValueDTO[]

The predefined possible values for the attribute.

Show properties

value

string

required

The value of the attribute possible value.

rank

number

required

The rank of the attribute possible value.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

product_category_ids

string[]

The IDs of product categories to associate with this attribute.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributeDTO[]>

The created attributes.

createAttributes(data, sharedContext?): Promise<AttributeDTO>

This method creates an attribute.

Example

const attribute = await attributeModuleService.createAttributes({
  name: "Size",
  handle: "size",
  ui_component: "select",
  is_filterable: true,
})

Parameters

data

CreateAttributeDTO

required

The attribute to be created.

Show properties

name

string

required

The name of the attribute.

description

string

The description of the attribute.

handle

string

The unique handle of the attribute.

is_filterable

boolean

Whether the attribute is filterable.

is_required

boolean

Whether the attribute is required.

ui_component

required

The UI component type for rendering the attribute.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

possible_values

CreateAttributeValueDTO[]

The predefined possible values for the attribute.

Show properties

value

string

required

The value of the attribute possible value.

rank

number

required

The rank of the attribute possible value.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

product_category_ids

string[]

The IDs of product categories to associate with this attribute.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributeDTO>

The created attribute.

updateAttributeWithUpsertOrReplacePossibleValues

This section provides a reference to the updateAttributeWithUpsertOrReplacePossibleValues method. This belongs to the Attribute Module.

updateAttributeWithUpsertOrReplacePossibleValues(input, sharedContext?): Promise<void>

This method updates an attribute and upserts or replaces its possible values in a single operation. If id is not provided for possible_values entries, it will lookup the database by attributePossibleValue.value to update or create accordingly.

Example

await attributeModuleService.updateAttributeWithUpsertOrReplacePossibleValues({
  id: "attr_123",
  name: "Updated Material",
  possible_values: [
    { id: "attr_pos_val_1", value: "Cotton", rank: 1 },
    { value: "Silk", rank: 3 }, // Will be created
  ],
})

Parameters

input

UpdateAttributeDTO | UpdateAttributeDTO[]

required

The attribute(s) to update with possible values to upsert.

Show properties

string

required

The ID of the attribute to update.

name

string

The name of the attribute.

description

string

The description of the attribute.

handle

string

The unique handle of the attribute.

is_filterable

boolean

Whether the attribute is filterable.

is_required

boolean

Whether the attribute is required.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

possible_values

UpsertAttributeValueDTO[]

The possible values to upsert.

Show properties

string

The ID of the existing possible value (for updates).

value

string

The value of the attribute possible value.

rank

number

The rank of the attribute possible value.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

attribute_id

string

The ID of the attribute this value belongs to.

product_category_ids

{ id: string }[]

The product categories to associate with this attribute.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void>

Resolves when the attribute and its possible values are updated successfully.

listAttributes

This section provides a reference to the listAttributes method. This belongs to the Attribute Module. This method retrieves a paginated list of attributes based on optional filters and configuration.

Example

To retrieve a list of attributes using their IDs:

const attributes = await attributeModuleService.listAttributes({
  id: ["attr_123", "attr_321"],
})

To retrieve filterable attributes:

const attributes = await attributeModuleService.listAttributes({
  is_filterable: true,
})

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const attributes = await attributeModuleService.listAttributes(
  {
    id: ["attr_123", "attr_321"],
  },
  {
    take: 20,
    skip: 2,
  }
)

Parameters

filters

FilterableAttributeProps

The filters to apply on the retrieved attributes.

Show properties

string | string[]

The IDs to filter the attributes by.

name

string | string[]

Filter attributes by their names.

handle

string | string[]

Filter attributes by their handles.

is_filterable

boolean

Filter by whether attributes are filterable.

is_required

boolean

Filter by whether attributes are required.

ui_component

string | string[]

Filter attributes by their UI component type.

config

FindConfig<AttributeDTO>

The configurations determining how the attribute is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with an attribute.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

skip

number

A number indicating the number of records to skip before retrieving the results.

take

number

A number indicating the number of records to return in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result. For example, ["possible_values", "values"].

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key’s value can either be ASC to sort retrieved records in an ascending order, or DESC to sort retrieved records in a descending order.

withDeleted

boolean

A boolean indicating whether deleted records should also be retrieved as part of the result.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributeDTO[]>

The list of attributes.

retrieveAttribute

This section provides a reference to the retrieveAttribute method. This belongs to the Attribute Module. This method retrieves an attribute by its ID.

Example

const attribute = await attributeModuleService.retrieveAttribute("attr_123")

To retrieve relationships:

const attribute = await attributeModuleService.retrieveAttribute(
  "attr_123",
  {
    relations: ["possible_values", "values"],
  }
)

Parameters

string

required

The ID of the attribute.

config

FindConfig<AttributeDTO>

The configurations determining how the attribute is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with an attribute.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

skip

number

A number indicating the number of records to skip before retrieving the results.

take

number

A number indicating the number of records to return in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result. For example, ["possible_values", "values"].

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

withDeleted

boolean

A boolean indicating whether deleted records should also be retrieved as part of the result.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributeDTO>

The retrieved attribute.

Show properties

string

The ID of the attribute.

name

string

The name of the attribute.

description

string

The description of the attribute.

handle

string

The unique handle of the attribute.

is_filterable

boolean

Whether the attribute is filterable.

is_required

boolean

Whether the attribute is required.

ui_component

string

The UI component type for rendering the attribute.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

created_at

string

The created date of the attribute.

updated_at

string

The updated date of the attribute.

possible_values

AttributePossibleValueDTO[]

The associated possible values (if included in relations).

Show properties

string

The ID of the attribute possible value.

value

string

The value of the attribute possible value.

rank

number

The rank of the attribute possible value.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

created_at

string

The created date of the possible value.

values

AttributeValueDTO[]

The associated attribute values (if included in relations).

Show properties

string

The ID of the attribute value.

value

string

The value of the attribute value.

rank

number

The rank of the attribute value.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

updateAttributes

This section provides a reference to the updateAttributes method. This belongs to the Attribute Module.

updateAttributes(id, data, sharedContext?): Promise<AttributeDTO>

This method updates an existing attribute.

Example

const attribute = await attributeModuleService.updateAttributes("attr_123", {
  name: "Updated Material",
  is_filterable: false,
})

Parameters

string

required

The ID of the attribute.

data

UpdateAttributeDTO

required

The attributes to update in the attribute.

Show properties

name

string

The name of the attribute.

description

string

The description of the attribute.

handle

string

The unique handle of the attribute.

is_filterable

boolean

Whether the attribute is filterable.

is_required

boolean

Whether the attribute is required.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributeDTO>

The updated attribute.

Show properties

string

The ID of the attribute.

name

string

The name of the attribute.

description

string

The description of the attribute.

handle

string

The unique handle of the attribute.

is_filterable

boolean

Whether the attribute is filterable.

is_required

boolean

Whether the attribute is required.

ui_component

string

The UI component type for rendering the attribute.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

created_at

string

The created date of the attribute.

updated_at

string

The updated date of the attribute.

deleteAttributes

This section provides a reference to the deleteAttributes method. This belongs to the Attribute Module.

deleteAttributes(ids, sharedContext?): Promise<void>

This method deletes attributes by their IDs.

Example

await attributeModuleService.deleteAttributes(["attr_123", "attr_321"])

Parameters

ids

string[]

required

The IDs of the attributes.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void>

Resolves when the attributes are deleted successfully.

deleteAttributes(id, sharedContext?): Promise<void>

This method deletes an attribute by its ID.

Example

await attributeModuleService.deleteAttributes("attr_123")

Parameters

string

required

The ID of the attribute.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void>

Resolves when the attribute is deleted successfully.

listAndCountAttributes

This section provides a reference to the listAndCountAttributes method. This belongs to the Attribute Module. This method retrieves a paginated list of attributes along with the total count of available attributes satisfying the provided filters.

Example

To retrieve a list of attributes using their IDs:

const [attributes, count] = await attributeModuleService.listAndCountAttributes({
  id: ["attr_123", "attr_321"],
})

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const [attributes, count] = await attributeModuleService.listAndCountAttributes(
  {
    id: ["attr_123", "attr_321"],
  },
  {
    take: 20,
    skip: 2,
  }
)

Parameters

filters

FilterableAttributeProps

The filters to apply on the retrieved attributes.

Show properties

string | string[]

The IDs to filter the attributes by.

name

string | string[]

Filter attributes by their names.

handle

string | string[]

Filter attributes by their handles.

is_filterable

boolean

Filter by whether attributes are filterable.

is_required

boolean

Filter by whether attributes are required.

ui_component

string | string[]

Filter attributes by their UI component type.

config

FindConfig<AttributeDTO>

The configurations determining how the attribute is retrieved.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

skip

number

A number indicating the number of records to skip before retrieving the results.

take

number

A number indicating the number of records to return in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result.

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

withDeleted

boolean

A boolean indicating whether deleted records should also be retrieved as part of the result.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<[AttributeDTO[], number]>

The list of attributes along with their total count.

softDeleteAttributes

This section provides a reference to the softDeleteAttributes method. This belongs to the Attribute Module. This method soft deletes attributes by their IDs.

Example

await attributeModuleService.softDeleteAttributes([
  "attr_123",
  "attr_321",
])

Parameters

attributeIds

string[]

required

The IDs of the attributes.

config

SoftDeleteReturn<TReturnableLinkableKeys>

An object that is used to specify an entity’s related entities that should be soft-deleted when the main entity is soft-deleted.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void | Record<string, string[]>>

An object that includes the IDs of related records that were also soft deleted. If there are no related records, the promise resolves to void.

restoreAttributes

This section provides a reference to the restoreAttributes method. This belongs to the Attribute Module. This method restores soft deleted attributes by their IDs.

Example

await attributeModuleService.restoreAttributes(["attr_123", "attr_321"])

Parameters

attributeIds

string[]

required

The IDs of the attributes.

config

RestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the attribute.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void | Record<string, string[]>>

An object that includes the IDs of related records that were restored. If there are no related records restored, the promise resolves to void.

createAttributeValues

This section provides a reference to the createAttributeValues method. This belongs to the Attribute Module. This method creates attribute values.

Example

const attributeValues = await attributeModuleService.createAttributeValues([
  {
    attribute_id: "attr_123",
    value: "Large",
    rank: 1,
  },
])

Parameters

data

CreateAttributeValueDTO[]

required

The attribute values to be created.

Show properties

value

string

required

The value of the attribute value.

rank

number

required

The rank of the attribute value.

attribute_id

string

required

The ID of the attribute this value belongs to.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributeValueDTO[]>

The created attribute values.

updateAttributeValues

This section provides a reference to the updateAttributeValues method. This belongs to the Attribute Module. This method updates existing attribute values.

Example

const attributeValues = await attributeModuleService.updateAttributeValues([
  {
    id: "attr_val_123",
    value: "Extra Large",
    rank: 4,
  },
])

Parameters

data

UpdateAttributeValueDTO[]

required

The attribute values to update.

Show properties

string

required

The ID of the attribute value.

value

string

The value of the attribute value.

rank

number

The rank of the attribute value.

metadata

Record<string, unknown> | null

Holds custom data in key-value pairs.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributeValueDTO[]>

The updated attribute values.

deleteAttributeValues

This section provides a reference to the deleteAttributeValues method. This belongs to the Attribute Module. This method deletes attribute values by their IDs.

Example

await attributeModuleService.deleteAttributeValues(["attr_val_123", "attr_val_321"])

Parameters

ids

string[]

required

The IDs of the attribute values.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void>

Resolves when the attribute values are deleted successfully.

listAttributeValues

This section provides a reference to the listAttributeValues method. This belongs to the Attribute Module. This method retrieves a paginated list of attribute values based on optional filters and configuration.

Example

const attributeValues = await attributeModuleService.listAttributeValues({
  attribute_id: "attr_123",
})

Parameters

filters

FilterableAttributeValueProps

The filters to apply on the retrieved attribute values.

Show properties

string | string[]

The IDs to filter the attribute values by.

attribute_id

string | string[]

Filter attribute values by their attribute IDs.

value

string | string[]

Filter attribute values by their values.

config

FindConfig<AttributeValueDTO>

The configurations determining how the attribute value is retrieved.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

skip

number

A number indicating the number of records to skip before retrieving the results.

take

number

A number indicating the number of records to return in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result.

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributeValueDTO[]>

The list of attribute values.

retrieveAttributeValue

This section provides a reference to the retrieveAttributeValue method. This belongs to the Attribute Module. This method retrieves an attribute value by its ID.

Example

const attributeValue = await attributeModuleService.retrieveAttributeValue("attr_val_123")

Parameters

string

required

The ID of the attribute value.

config

FindConfig<AttributeValueDTO>

The configurations determining how the attribute value is retrieved.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result.

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributeValueDTO>

The retrieved attribute value.

Show properties

string

The ID of the attribute value.

value

string

The value of the attribute value.

rank

number

The rank of the attribute value.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

listAndCountAttributeValues

This section provides a reference to the listAndCountAttributeValues method. This belongs to the Attribute Module. This method retrieves a paginated list of attribute values along with the total count of available attribute values satisfying the provided filters.

Example

const [attributeValues, count] = await attributeModuleService.listAndCountAttributeValues({
  attribute_id: "attr_123",
})

Parameters

filters

FilterableAttributeValueProps

The filters to apply on the retrieved attribute values.

Show properties

string | string[]

The IDs to filter the attribute values by.

attribute_id

string | string[]

Filter attribute values by their attribute IDs.

value

string | string[]

Filter attribute values by their values.

config

FindConfig<AttributeValueDTO>

The configurations determining how the attribute value is retrieved.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

skip

number

A number indicating the number of records to skip before retrieving the results.

take

number

A number indicating the number of records to return in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result.

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<[AttributeValueDTO[], number]>

The list of attribute values along with their total count.

softDeleteAttributeValues

This section provides a reference to the softDeleteAttributeValues method. This belongs to the Attribute Module. This method soft deletes attribute values by their IDs.

Example

await attributeModuleService.softDeleteAttributeValues([
  "attr_val_123",
  "attr_val_321",
])

Parameters

attributeValueIds

string[]

required

The IDs of the attribute values.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void | Record<string, string[]>>

An object that includes the IDs of related records that were also soft deleted. If there are no related records, the promise resolves to void.

restoreAttributeValues

This section provides a reference to the restoreAttributeValues method. This belongs to the Attribute Module. This method restores soft deleted attribute values by their IDs.

Example

await attributeModuleService.restoreAttributeValues(["attr_val_123", "attr_val_321"])

Parameters

attributeValueIds

string[]

required

The IDs of the attribute values.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void | Record<string, string[]>>

An object that includes the IDs of related records that were restored. If there are no related records restored, the promise resolves to void.

createAttributePossibleValues

This section provides a reference to the createAttributePossibleValues method. This belongs to the Attribute Module. This method creates attribute possible values.

Example

const possibleValues = await attributeModuleService.createAttributePossibleValues([
  {
    attribute_id: "attr_123",
    value: "Small",
    rank: 1,
  },
])

Parameters

data

CreateAttributePossibleValueDTO[]

required

The attribute possible values to be created.

Show properties

attribute_id

string

required

The ID of the attribute this possible value belongs to.

value

string

required

The value of the attribute possible value.

rank

number

required

The rank of the attribute possible value.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributePossibleValueDTO[]>

The created attribute possible values.

updateAttributePossibleValues

This section provides a reference to the updateAttributePossibleValues method. This belongs to the Attribute Module. This method updates existing attribute possible values.

Example

const possibleValues = await attributeModuleService.updateAttributePossibleValues([
  {
    id: "attr_pos_val_123",
    value: "Extra Small",
    rank: 0,
  },
])

Parameters

data

UpdateAttributePossibleValueDTO[]

required

The attribute possible values to update.

Show properties

string

required

The ID of the attribute possible value.

value

string

The value of the attribute possible value.

rank

number

The rank of the attribute possible value.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributePossibleValueDTO[]>

The updated attribute possible values.

deleteAttributePossibleValues

This section provides a reference to the deleteAttributePossibleValues method. This belongs to the Attribute Module. This method deletes attribute possible values by their IDs.

Example

await attributeModuleService.deleteAttributePossibleValues([
  "attr_pos_val_123",
  "attr_pos_val_321",
])

Parameters

ids

string[]

required

The IDs of the attribute possible values.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void>

Resolves when the attribute possible values are deleted successfully.

listAttributePossibleValues

This section provides a reference to the listAttributePossibleValues method. This belongs to the Attribute Module. This method retrieves a paginated list of attribute possible values based on optional filters and configuration.

Example

const possibleValues = await attributeModuleService.listAttributePossibleValues({
  attribute_id: "attr_123",
})

Parameters

filters

FilterableAttributePossibleValueProps

The filters to apply on the retrieved attribute possible values.

Show properties

string | string[]

The IDs to filter the attribute possible values by.

attribute_id

string | string[]

Filter attribute possible values by their attribute IDs.

value

string | string[]

Filter attribute possible values by their values.

config

FindConfig<AttributePossibleValueDTO>

The configurations determining how the attribute possible value is retrieved.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

skip

number

A number indicating the number of records to skip before retrieving the results.

take

number

A number indicating the number of records to return in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result.

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributePossibleValueDTO[]>

The list of attribute possible values.

retrieveAttributePossibleValue

This section provides a reference to the retrieveAttributePossibleValue method. This belongs to the Attribute Module. This method retrieves an attribute possible value by its ID.

Example

const possibleValue = await attributeModuleService.retrieveAttributePossibleValue(
  "attr_pos_val_123"
)

Parameters

string

required

The ID of the attribute possible value.

config

FindConfig<AttributePossibleValueDTO>

The configurations determining how the attribute possible value is retrieved.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result.

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<AttributePossibleValueDTO>

The retrieved attribute possible value.

Show properties

string

The ID of the attribute possible value.

value

string

The value of the attribute possible value.

rank

number

The rank of the attribute possible value.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

created_at

string

The created date of the possible value.

listAndCountAttributePossibleValues

This section provides a reference to the listAndCountAttributePossibleValues method. This belongs to the Attribute Module. This method retrieves a paginated list of attribute possible values along with the total count of available attribute possible values satisfying the provided filters.

Example

const [possibleValues, count] = await attributeModuleService.listAndCountAttributePossibleValues({
  attribute_id: "attr_123",
})

Parameters

filters

FilterableAttributePossibleValueProps

The filters to apply on the retrieved attribute possible values.

Show properties

string | string[]

The IDs to filter the attribute possible values by.

attribute_id

string | string[]

Filter attribute possible values by their attribute IDs.

value

string | string[]

Filter attribute possible values by their values.

config

FindConfig<AttributePossibleValueDTO>

The configurations determining how the attribute possible value is retrieved.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

skip

number

A number indicating the number of records to skip before retrieving the results.

take

number

A number indicating the number of records to return in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result.

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<[AttributePossibleValueDTO[], number]>

The list of attribute possible values along with their total count.

softDeleteAttributePossibleValues

This section provides a reference to the softDeleteAttributePossibleValues method. This belongs to the Attribute Module. This method soft deletes attribute possible values by their IDs.

Example

await attributeModuleService.softDeleteAttributePossibleValues([
  "attr_pos_val_123",
  "attr_pos_val_321",
])

Parameters

attributePossibleValueIds

string[]

required

The IDs of the attribute possible values.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void | Record<string, string[]>>

An object that includes the IDs of related records that were also soft deleted. If there are no related records, the promise resolves to void.

restoreAttributePossibleValues

This section provides a reference to the restoreAttributePossibleValues method. This belongs to the Attribute Module. This method restores soft deleted attribute possible values by their IDs.

Example

await attributeModuleService.restoreAttributePossibleValues([
  "attr_pos_val_123",
  "attr_pos_val_321",
])

Parameters

attributePossibleValueIds

string[]

required

The IDs of the attribute possible values.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void | Record<string, string[]>>

An object that includes the IDs of related records that were restored. If there are no related records restored, the promise resolves to void.

Quick start

Components

Core Concepts

Product

Integrations

Deployment

Help

​IAttributeModuleService Reference

​Methods

​createAttributes

​createAttributes(data, sharedContext?): Promise<AttributeDTO[]>

​Example

​Parameters

​Returns

​createAttributes(data, sharedContext?): Promise<AttributeDTO>

​Example

​Parameters

​Returns

​updateAttributeWithUpsertOrReplacePossibleValues

​updateAttributeWithUpsertOrReplacePossibleValues(input, sharedContext?): Promise<void>

​Example

​Parameters

​Returns

​listAttributes

​Example

​Parameters

​Returns

​retrieveAttribute

​Example

​Parameters

​Returns

​updateAttributes

​updateAttributes(id, data, sharedContext?): Promise<AttributeDTO>

​Example

​Parameters

​Returns

​deleteAttributes

​deleteAttributes(ids, sharedContext?): Promise<void>

​Example

​Parameters

​Returns

​deleteAttributes(id, sharedContext?): Promise<void>

​Example

​Parameters

​Returns

​listAndCountAttributes

​Example

​Parameters

​Returns

​softDeleteAttributes

​Example

​Parameters

​Returns

​restoreAttributes

​Example

​Parameters

​Returns

​createAttributeValues

​Example

​Parameters

​Returns

​updateAttributeValues

​Example

​Parameters

​Returns

​deleteAttributeValues

​Example

​Parameters

​Returns

​listAttributeValues

​Example

​Parameters

​Returns

​retrieveAttributeValue

​Example

​Parameters

​Returns

​listAndCountAttributeValues

​Example

​Parameters

IAttributeModuleService Reference

Methods

createAttributes

createAttributes(data, sharedContext?): Promise<AttributeDTO[]>

Example

Parameters

Returns

createAttributes(data, sharedContext?): Promise<AttributeDTO>

Example

Parameters

Returns

updateAttributeWithUpsertOrReplacePossibleValues

updateAttributeWithUpsertOrReplacePossibleValues(input, sharedContext?): Promise<void>

Example

Parameters

Returns

listAttributes

Example

Parameters

Returns

retrieveAttribute

Example

Parameters

Returns

updateAttributes

updateAttributes(id, data, sharedContext?): Promise<AttributeDTO>

Example

Parameters

Returns

deleteAttributes

deleteAttributes(ids, sharedContext?): Promise<void>

Example

Parameters

Returns

deleteAttributes(id, sharedContext?): Promise<void>

Example

Parameters

Returns

listAndCountAttributes

Example

Parameters

Returns

softDeleteAttributes

Example

Parameters

Returns

restoreAttributes

Example

Parameters

Returns

createAttributeValues

Example

Parameters

Returns

updateAttributeValues

Example

Parameters

Returns

deleteAttributeValues

Example

Parameters

Returns

listAttributeValues

Example

Parameters

Returns

retrieveAttributeValue

Example

Parameters

Returns

listAndCountAttributeValues

Example

Parameters

Returns

softDeleteAttributeValues

Example

Parameters

Returns

restoreAttributeValues

Example