Appearance
Manufacturers
Manage product manufacturers and brands for your catalog. Track manufacturer information, relationships with products, and enable brand-based filtering and navigation.
Basic CRUD Actions
Get Manufacturers listing
View on PostmanGet a list of all manufacturers.
JS
let manufacturers = await Client.API.Core.Manufacturers.all();TS
import { Response, Manufacturers } from "@tscommerce/sdk-typescript"
Client.API.Core.Manufacturers.all().then((response:Response<Manufacturers>) => {
response.resource.forEach((manufacturer) => {
console.log(manufacturer.id, manufacturer.name);
});
});PHP
$manufacturers = $client->API->Core->Manufacturers->all();Create new Manufacturer
View on PostmanCreate a brand new manufacturer.
JS
const payload = {
name: 'Samsung Electronics',
slug: 'samsung',
description: 'Leading electronics manufacturer'
};
let manufacturer = await Client.API.Core.Manufacturers.create(payload);TS
import { Response, Manufacturer, CreateManufacturerPayload } from "@tscommerce/sdk-typescript"
const payload:CreateManufacturerPayload = {
name: 'Samsung Electronics',
slug: 'samsung',
description: 'Leading electronics manufacturer'
};
Client.API.Core.Manufacturers.create(payload).then((response:Response<Manufacturer>) => {
console.log('Created manufacturer:', response.resource);
});PHP
$payload = [
'name' => 'Samsung Electronics',
'slug' => 'samsung',
'description' => 'Leading electronics manufacturer'
];
$manufacturer = $client->API->Core->Manufacturers->create($payload);Get Manufacturer
View on PostmanGet an existing manufacturer by ID.
JS
const manufacturerId = 123;
let manufacturer = await Client.API.Core.Manufacturers.read(manufacturerId);TS
import { Response, Manufacturer } from "@tscommerce/sdk-typescript"
const manufacturerId:Manufacturer['id'] = 123;
Client.API.Core.Manufacturers.read(manufacturerId).then((response:Response<Manufacturer>) => {
console.log('Manufacturer:', response.resource);
});PHP
$manufacturerId = 123;
$manufacturer = $client->API->Core->Manufacturers->read($manufacturerId);Update Manufacturer
View on PostmanUpdate an existing manufacturer.
JS
const manufacturerId = 123;
const payload = {
name: 'Samsung Electronics Co.',
description: 'Updated description'
};
let manufacturer = await Client.API.Core.Manufacturers.update(manufacturerId, payload);TS
import { Response, Manufacturer, UpdateManufacturerPayload } from "@tscommerce/sdk-typescript"
const manufacturerId:Manufacturer['id'] = 123;
const payload:UpdateManufacturerPayload = {
name: 'Samsung Electronics Co.',
description: 'Updated description'
};
Client.API.Core.Manufacturers.update(manufacturerId, payload).then((response:Response<Manufacturer>) => {
console.log('Updated manufacturer:', response.resource);
});PHP
$manufacturerId = 123;
$payload = [
'name' => 'Samsung Electronics Co.',
'description' => 'Updated description'
];
$manufacturer = $client->API->Core->Manufacturers->update($manufacturerId, $payload);Delete Manufacturer
View on PostmanDelete an existing manufacturer.
JS
const manufacturerId = 123;
Client.API.Core.Manufacturers.delete(manufacturerId);TS
import { Response, Manufacturer } from "@tscommerce/sdk-typescript"
const manufacturerId:Manufacturer['id'] = 123;
Client.API.Core.Manufacturers.delete(manufacturerId).then((response:Response) => {
console.log('Manufacturer deleted successfully');
});PHP
$manufacturerId = 123;
$client->API->Core->Manufacturers->delete($manufacturerId);Duplication
Duplicate Manufacturer
View on PostmanCreate a duplicate of an existing manufacturer.
JS
const manufacturerId = 123;
let duplicated = await Client.API.Core.Manufacturers.duplicate(manufacturerId);TS
import { Response, Manufacturer } from "@tscommerce/sdk-typescript"
const manufacturerId:Manufacturer['id'] = 123;
Client.API.Core.Manufacturers.duplicate(manufacturerId).then((response:Response<Manufacturer>) => {
console.log('Duplicated manufacturer:', response.resource);
});PHP
$manufacturerId = 123;
$duplicated = $client->API->Core->Manufacturers->duplicate($manufacturerId);Bulk Actions
Bulk delete Manufacturers
View on PostmanDelete multiple manufacturers at once.
JS
const manufacturerIds = [123, 456, 789];
Client.API.Core.Manufacturers.bulkDelete(manufacturerIds);TS
import { Response, Manufacturer } from "@tscommerce/sdk-typescript"
const manufacturerIds:Array<Manufacturer['id']> = [123, 456, 789];
Client.API.Core.Manufacturers.bulkDelete(manufacturerIds).then((response:Response) => {
console.log('Manufacturers deleted successfully');
});PHP
$manufacturerIds = [123, 456, 789];
$client->API->Core->Manufacturers->bulkDelete($manufacturerIds);Search
Search Manufacturers
View on PostmanSearch manufacturers by name or attributes.
JS
const searchCriteria = {
name: 'Samsung'
};
let results = await Client.API.Core.Manufacturers.search(searchCriteria);TS
import { PaginatedResponse, Manufacturers } from "@tscommerce/sdk-typescript"
const searchCriteria = {
name: 'Samsung'
};
Client.API.Core.Manufacturers.search(searchCriteria).then((response:PaginatedResponse<Manufacturers>) => {
response.resource.data.forEach((manufacturer) => {
console.log(manufacturer.id, manufacturer.name);
});
});PHP
$searchCriteria = [
'name' => 'Samsung'
];
$results = $client->API->Core->Manufacturers->search($searchCriteria);Manufacturer Products
Get Manufacturer Products
View on PostmanGet all products associated with a specific manufacturer.
JS
const manufacturerId = 123;
let products = await Client.API.Core.Manufacturers.getProducts(manufacturerId);TS
import { PaginatedResponse, Manufacturer, ManufacturerProducts } from "@tscommerce/sdk-typescript"
const manufacturerId:Manufacturer['id'] = 123;
Client.API.Core.Manufacturers.getProducts(manufacturerId).then((response:PaginatedResponse<ManufacturerProducts[]>) => {
response.resource.data.forEach((product) => {
console.log(product.id, product.name);
});
});PHP
$manufacturerId = 123;
$products = $client->API->Core->Manufacturers->getProducts($manufacturerId);Assign Products to Manufacturer
View on PostmanAssociate products with a manufacturer.
JS
const manufacturerId = 123;
const productIds = [456, 789, 101];
Client.API.Core.Manufacturers.assignProducts(manufacturerId, productIds);TS
import { Response, Manufacturer, Product } from "@tscommerce/sdk-typescript"
const manufacturerId:Manufacturer['id'] = 123;
const productIds:Array<Product['id']> = [456, 789, 101];
Client.API.Core.Manufacturers.assignProducts(manufacturerId, productIds).then((response:Response) => {
console.log('Products assigned successfully');
});PHP
$manufacturerId = 123;
$productIds = [456, 789, 101];
$client->API->Core->Manufacturers->assignProducts($manufacturerId, $productIds);