Albums

Manage photo and media albums for organizing visual content in your e-commerce system. Albums are collections that can contain multiple images or media files, useful for product galleries, promotional content, or brand storytelling.

Get albums listing

View on Postman

Get a list of all albums.

JavaScript

let albums = await Client.API.Core.Albums.all();

TypeScript

import { Response, Albums } from "@tscommerce/sdk-typescript"

Client.API.Core.Albums.all().then((response:Response<Albums>) => {
    response.resource.forEach((album) => {
        console.log(album.id, album.name);
    });
});

PHP

$albums = $client->API->Core->Albums->all();

Basic CRUD Actions

Create new Album

View on Postman

Create a brand new album.

JavaScript

const payload = {
    name: 'Summer Collection',
    slug: 'summer-collection',
    description: 'Photos from summer events'
};
let album = await Client.API.Core.Albums.create(payload);

TypeScript

import { Response, Album, CreateAlbumPayload } from "@tscommerce/sdk-typescript"

const payload:CreateAlbumPayload = {
    name: 'Summer Collection',
    slug: 'summer-collection',
    description: 'Photos from summer events'
};

Client.API.Core.Albums.create(payload).then((response:Response<Album>) => {
    console.log('Created album:', response.resource);
});

PHP

$payload = [
    'name' => 'Summer Collection',
    'slug' => 'summer-collection',
    'description' => 'Photos from summer events'
];
$album = $client->API->Core->Albums->create($payload);

Get Album

View on Postman

Get an existing album by ID.

JavaScript

const albumId = 123;
let album = await Client.API.Core.Albums.read(albumId);

TypeScript

import { Response, Album } from "@tscommerce/sdk-typescript"

const albumId:Album['id'] = 123;
Client.API.Core.Albums.read(albumId).then((response:Response<Album>) => {
    console.log('Album:', response.resource);
});

PHP

$albumId = 123;
$album = $client->API->Core->Albums->read($albumId);

Update Album

View on Postman

Update an existing album.

JavaScript

const albumId = 123;
const payload = {
    name: 'Updated Summer Collection',
    description: 'New description'
};
let album = await Client.API.Core.Albums.update(albumId, payload);

TypeScript

import { Response, Album, UpdateAlbumPayload } from "@tscommerce/sdk-typescript"

const albumId:Album['id'] = 123;
const payload:UpdateAlbumPayload = {
    name: 'Updated Summer Collection',
    description: 'New description'
};

Client.API.Core.Albums.update(albumId, payload).then((response:Response<Album>) => {
    console.log('Updated album:', response.resource);
});

PHP

$albumId = 123;
$payload = [
    'name' => 'Updated Summer Collection',
    'description' => 'New description'
];
$album = $client->API->Core->Albums->update($albumId, $payload);

Partially update Album

View on Postman

Partially update an existing album.

JavaScript

const albumId = 123;
const payload = {
    name: 'Partially Updated Name'
};
let album = await Client.API.Core.Albums.patch(albumId, payload);

TypeScript

import { Response, Album, PatchAlbumPayload } from "@tscommerce/sdk-typescript"

const albumId:Album['id'] = 123;
const payload:PatchAlbumPayload = {
    name: 'Partially Updated Name'
};

Client.API.Core.Albums.patch(albumId, payload).then((response:Response<Album>) => {
    console.log('Patched album:', response.resource);
});

PHP

$albumId = 123;
$payload = ['name' => 'Partially Updated Name'];
$album = $client->API->Core->Albums->patch($albumId, $payload);

Delete Album

View on Postman

Delete an existing album.

JavaScript

const albumId = 123;
Client.API.Core.Albums.delete(albumId);

TypeScript

import { Response, Album } from "@tscommerce/sdk-typescript"

const albumId:Album['id'] = 123;
Client.API.Core.Albums.delete(albumId).then((response:Response) => {
    console.log('Album deleted successfully');
});

PHP

$albumId = 123;
$client->API->Core->Albums->delete($albumId);