Sitemap Entries

Manage XML sitemap entries for SEO optimization. Control URL indexing, priority, and change frequency to help search engines discover and crawl your content effectively.

Basic CRUD Actions

Get Sitemap Entries listing

View on Postman

Get a list of all sitemap entries.

JavaScript

let sitemapEntries = await Client.API.Core.SitemapEntries.all();

TypeScript

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

Client.API.Core.SitemapEntries.all().then((response:Response<SitemapEntries>) => {
    response.resource.forEach((entry) => {
        console.log(entry.id, entry.loc, entry.priority);
    });
});

PHP

$sitemapEntries = $client->API->Core->SitemapEntries->all();

Create new Sitemap Entry

View on Postman

Create a new sitemap URL entry.

JavaScript

const payload = {
    loc: 'https://example.com/products/special-offers',
    priority: 0.8,
    changefreq: 'weekly'
};
let sitemapEntry = await Client.API.Core.SitemapEntries.create(payload);

TypeScript

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

const payload:CreateSitemapEntryPayload = {
    loc: 'https://example.com/products/special-offers',
    priority: 0.8,
    changefreq: 'weekly'
};

Client.API.Core.SitemapEntries.create(payload).then((response:Response<SitemapEntry>) => {
    console.log('Created sitemap entry:', response.resource);
});

PHP

$payload = [
    'loc' => 'https://example.com/products/special-offers',
    'priority' => 0.8,
    'changefreq' => 'weekly'
];
$sitemapEntry = $client->API->Core->SitemapEntries->create($payload);

Get Sitemap Entry

View on Postman

Get an existing sitemap entry by ID.

JavaScript

const sitemapEntryId = 123;
let sitemapEntry = await Client.API.Core.SitemapEntries.read(sitemapEntryId);

TypeScript

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

const sitemapEntryId:SitemapEntry['id'] = 123;
Client.API.Core.SitemapEntries.read(sitemapEntryId).then((response:Response<SitemapEntry>) => {
    console.log('Sitemap entry:', response.resource);
});

PHP

$sitemapEntryId = 123;
$sitemapEntry = $client->API->Core->SitemapEntries->read($sitemapEntryId);

Update Sitemap Entry

View on Postman

Update an existing sitemap entry.

JavaScript

const sitemapEntryId = 123;
const payload = {
    priority: 0.9,
    changefreq: 'daily'
};
let sitemapEntry = await Client.API.Core.SitemapEntries.update(sitemapEntryId, payload);

TypeScript

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

const sitemapEntryId:SitemapEntry['id'] = 123;
const payload:UpdateSitemapEntryPayload = {
    priority: 0.9,
    changefreq: 'daily'
};

Client.API.Core.SitemapEntries.update(sitemapEntryId, payload).then((response:Response<SitemapEntry>) => {
    console.log('Updated sitemap entry:', response.resource);
});

PHP

$sitemapEntryId = 123;
$payload = ['priority' => 0.9, 'changefreq' => 'daily'];
$sitemapEntry = $client->API->Core->SitemapEntries->update($sitemapEntryId, $payload);

Delete Sitemap Entry

View on Postman

Delete a sitemap entry.

JavaScript

const sitemapEntryId = 123;
Client.API.Core.SitemapEntries.delete(sitemapEntryId);

TypeScript

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

const sitemapEntryId:SitemapEntry['id'] = 123;
Client.API.Core.SitemapEntries.delete(sitemapEntryId).then((response:Response) => {
    console.log('Sitemap entry deleted successfully');
});

PHP

$sitemapEntryId = 123;
$client->API->Core->SitemapEntries->delete($sitemapEntryId);

Duplication

Duplicate Sitemap Entry

View on Postman

Create a copy of an existing sitemap entry.

JavaScript

const sitemapEntryId = 123;
let duplicate = await Client.API.Core.SitemapEntries.duplicate(sitemapEntryId);

TypeScript

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

const sitemapEntryId:SitemapEntry['id'] = 123;
Client.API.Core.SitemapEntries.duplicate(sitemapEntryId).then((response:Response<SitemapEntry>) => {
    console.log('Duplicated sitemap entry ID:', response.resource.id);
});

PHP

$sitemapEntryId = 123;
$duplicate = $client->API->Core->SitemapEntries->duplicate($sitemapEntryId);

Bulk Actions

Bulk delete Sitemap Entries

View on Postman

Delete multiple sitemap entries at once.

JavaScript

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

TypeScript

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

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

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

PHP

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

Search

Search Sitemap Entries

View on Postman

Search sitemap entries by URL or content.

JavaScript

const query = 'products';
let results = await Client.API.Core.SitemapEntries.search({ query });

TypeScript

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

const payload:SearchSitemapEntriesPayload = {
    query: 'products'
};

Client.API.Core.SitemapEntries.search(payload).then((response:Response<SitemapEntries>) => {
    response.resource.forEach((entry) => {
        console.log(entry.loc);
    });
});

PHP

$payload = ['query' => 'products'];
$results = $client->API->Core->SitemapEntries->search($payload);