Attributes

Manage product attributes and specifications. Define custom fields, technical specifications, and filterable characteristics for your catalog products with flexible data types and validation rules.

Basic CRUD Actions

Get Attributes listing

View on Postman

Get a list of all product attributes.

JavaScript

const attributes = await $SDK.API.Core.Attributes.getAll();

TypeScript

import type { Attributes } from '@tscommerce/sdk-typescript/resources/Core';

const attributes: Attributes[] = await $SDK.API.Core.Attributes.getAll();

PHP

$attributes = $sdk->core->attributes->getAll();

Create new Attribute

View on Postman

Create a new product attribute with custom specifications.

JavaScript

const newAttribute = await $SDK.API.Core.Attributes.create({
  name: 'Material',
  slug: 'material',
  type: 'select',
  values: ['Cotton', 'Polyester', 'Wool']
});

TypeScript

import type { Attribute, Attributes } from '@tscommerce/sdk-typescript/resources/Core';

const newAttribute: Attribute = await $SDK.API.Core.Attributes.create({
  name: 'Material',
  slug: 'material',
  type: 'select',
  values: ['Cotton', 'Polyester', 'Wool']
});

PHP

$newAttribute = $sdk->core->attributes->create([
  'name' => 'Material',
  'slug' => 'material',
  'type' => 'select',
  'values' => ['Cotton', 'Polyester', 'Wool']
]);

Get Attribute

View on Postman

Get an existing attribute by ID.

JavaScript

const attribute = await $SDK.API.Core.Attributes.get(1);

TypeScript

import type { Attribute, Attributes } from '@tscommerce/sdk-typescript/resources/Core';

const attribute: Attribute = await $SDK.API.Core.Attributes.get(1);

PHP

$attribute = $sdk->core->attributes->get(1);

Update Attribute

View on Postman

Update an existing product attribute.

JavaScript

const updated = await $SDK.API.Core.Attributes.update(1, {
  name: 'Updated Material',
  values: ['Cotton', 'Polyester', 'Wool', 'Silk']
});

TypeScript

import type { Attribute, Attributes } from '@tscommerce/sdk-typescript/resources/Core';

const updated: Attribute = await $SDK.API.Core.Attributes.update(1, {
  name: 'Updated Material',
  values: ['Cotton', 'Polyester', 'Wool', 'Silk']
});

PHP

$updated = $sdk->core->attributes->update(1, [
  'name' => 'Updated Material',
  'values' => ['Cotton', 'Polyester', 'Wool', 'Silk']
]);

Partial Update Attribute

View on Postman

Partially update specific fields of an attribute.

JavaScript

const updated = await $SDK.API.Core.Attributes.partialUpdate(1, {
  name: 'New Name'
});

TypeScript

import type { Attribute, Attributes } from '@tscommerce/sdk-typescript/resources/Core';

const updated: Attribute = await $SDK.API.Core.Attributes.partialUpdate(1, {
  name: 'New Name'
});

PHP

$updated = $sdk->core->attributes->partialUpdate(1, [
  'name' => 'New Name'
]);

Delete Attribute

View on Postman

Delete a product attribute.

JavaScript

await $SDK.API.Core.Attributes.delete(1);

TypeScript

await $SDK.API.Core.Attributes.delete(1);

PHP

$sdk->core->attributes->delete(1);

Search

Search Attributes

View on Postman

Search attributes by name, type or other criteria.

JavaScript

const results = await $SDK.API.Core.Attributes.search({
  name: 'material',
  type: 'select'
});

TypeScript

import type { Attributes } from '@tscommerce/sdk-typescript/resources/Core';

const results: Attributes[] = await $SDK.API.Core.Attributes.search({
  name: 'material',
  type: 'select'
});

PHP

$results = $sdk->core->attributes->search([
  'name' => 'material',
  'type' => 'select'
]);