CTAs (Call-to-Actions)

Manage call-to-action elements and marketing banners for your storefront. CTAs are promotional elements used to drive customer engagement and conversions through targeted messaging and visuals.

Basic CRUD Actions

Get CTAs listing

View on Postman

Get a list of all call-to-action elements.

JavaScript

let ctas = await Client.API.Core.Ctas.all();

TypeScript

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

Client.API.Core.Ctas.all().then((response:Response<Ctas>) => {
    response.resource.forEach((cta) => {
        console.log(cta.id, cta.title);
    });
});

PHP

$ctas = $client->API->Core->Ctas->all();

Create new CTA

View on Postman

Create a brand new call-to-action element.

JavaScript

const payload = {
    title: 'Summer Sale',
    subtitle: 'Up to 50% off',
    link: '/sales/summer',
    image_url: '/images/summer-banner.jpg'
};
let cta = await Client.API.Core.Ctas.create(payload);

TypeScript

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

const payload:CreateCtaPayload = {
    title: 'Summer Sale',
    subtitle: 'Up to 50% off',
    link: '/sales/summer',
    image_url: '/images/summer-banner.jpg'
};

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

PHP

$payload = [
    'title' => 'Summer Sale',
    'subtitle' => 'Up to 50% off',
    'link' => '/sales/summer',
    'image_url' => '/images/summer-banner.jpg'
];
$cta = $client->API->Core->Ctas->create($payload);

Get CTA

View on Postman

Get an existing CTA by ID.

JavaScript

const ctaId = 123;
let cta = await Client.API.Core.Ctas.read(ctaId);

TypeScript

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

const ctaId:Cta['id'] = 123;
Client.API.Core.Ctas.read(ctaId).then((response:Response<Cta>) => {
    console.log('CTA:', response.resource);
});

PHP

$ctaId = 123;
$cta = $client->API->Core->Ctas->read($ctaId);

Update CTA

View on Postman

Update an existing call-to-action element.

JavaScript

const ctaId = 123;
const payload = {
    title: 'Updated Summer Sale'
};
let cta = await Client.API.Core.Ctas.update(ctaId, payload);

TypeScript

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

const ctaId:Cta['id'] = 123;
const payload:UpdateCtaPayload = {
    title: 'Updated Summer Sale'
};

Client.API.Core.Ctas.update(ctaId, payload).then((response:Response<Cta>) => {
    console.log('Updated CTA:', response.resource);
});

PHP

$ctaId = 123;
$payload = ['title' => 'Updated Summer Sale'];
$cta = $client->API->Core->Ctas->update($ctaId, $payload);

Bulk Actions

Bulk delete CTAs

View on Postman

Delete multiple CTAs at once.

JavaScript

const ctaIds = [123, 456, 789];
Client.API.Core.Ctas.bulkDelete({ ids: ctaIds });

TypeScript

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

const payload:BulkDeleteCtaPayload = {
    ids: [123, 456, 789]
};

Client.API.Core.Ctas.bulkDelete(payload).then((response:Response) => {
    console.log('CTAs deleted successfully');
});

PHP

$payload = ['ids' => [123, 456, 789]];
$client->API->Core->Ctas->bulkDelete($payload);