Rewrite Rules

Manage SEO-friendly URL rewrites and redirects. Create custom URL patterns, handle 301/302 redirects, and optimize URL structure for search engines.

Basic CRUD Actions

Get Rewrite Rules listing

View on Postman

Get a list of all rewrite rules.

JavaScript

let rules = await Client.API.Core.RewriteRules.all();

TypeScript

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

Client.API.Core.RewriteRules.all().then((response:Response<RewriteRules>) => {
    response.resource.forEach((rule) => {
        console.log(rule.id, rule.from, rule.to);
    });
});

PHP

$rules = $client->API->Core->RewriteRules->all();

Create new Rewrite Rule

View on Postman

Create a new URL rewrite rule.

JavaScript

const payload = {
    from: '/old-page',
    to: '/new-page',
    type: 301
};
let rule = await Client.API.Core.RewriteRules.create(payload);

TypeScript

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

const payload:CreateRewriteRulePayload = {
    from: '/old-page',
    to: '/new-page',
    type: 301
};

Client.API.Core.RewriteRules.create(payload).then((response:Response<RewriteRule>) => {
    console.log('Created rewrite rule:', response.resource);
});

PHP

$payload = [
    'from' => '/old-page',
    'to' => '/new-page',
    'type' => 301
];
$rule = $client->API->Core->RewriteRules->create($payload);

Get Rewrite Rule

View on Postman

Get an existing rewrite rule by ID.

JavaScript

const ruleId = 123;
let rule = await Client.API.Core.RewriteRules.read(ruleId);

TypeScript

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

const ruleId:RewriteRule['id'] = 123;
Client.API.Core.RewriteRules.read(ruleId).then((response:Response<RewriteRule>) => {
    console.log('Rewrite rule:', response.resource);
});

PHP

$ruleId = 123;
$rule = $client->API->Core->RewriteRules->read($ruleId);

Update Rewrite Rule

View on Postman

Update an existing rewrite rule.

JavaScript

const ruleId = 123;
const payload = {
    to: '/updated-page'
};
let rule = await Client.API.Core.RewriteRules.update(ruleId, payload);

TypeScript

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

const ruleId:RewriteRule['id'] = 123;
const payload:UpdateRewriteRulePayload = {
    to: '/updated-page'
};

Client.API.Core.RewriteRules.update(ruleId, payload).then((response:Response<RewriteRule>) => {
    console.log('Updated rewrite rule:', response.resource);
});

PHP

$ruleId = 123;
$payload = ['to' => '/updated-page'];
$rule = $client->API->Core->RewriteRules->update($ruleId, $payload);

Delete Rewrite Rule

View on Postman

Delete a rewrite rule.

JavaScript

const ruleId = 123;
Client.API.Core.RewriteRules.delete(ruleId);

TypeScript

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

const ruleId:RewriteRule['id'] = 123;
Client.API.Core.RewriteRules.delete(ruleId).then((response:Response) => {
    console.log('Rewrite rule deleted successfully');
});

PHP

$ruleId = 123;
$client->API->Core->RewriteRules->delete($ruleId);

Bulk Actions

Bulk delete Rewrite Rules

View on Postman

Delete multiple rewrite rules at once.

JavaScript

const ruleIds = [123, 456, 789];
Client.API.Core.RewriteRules.bulkDelete(ruleIds);

TypeScript

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

const ruleIds:Array<RewriteRule['id']> = [123, 456, 789];
Client.API.Core.RewriteRules.bulkDelete(ruleIds).then((response:Response) => {
    console.log('Rewrite rules deleted successfully');
});

PHP

$ruleIds = [123, 456, 789];
$client->API->Core->RewriteRules->bulkDelete($ruleIds);

Search

Search Rewrite Rules

View on Postman

Search rewrite rules by pattern or target.

JavaScript

const searchCriteria = {
    from: '/old'
};
let results = await Client.API.Core.RewriteRules.search(searchCriteria);

TypeScript

import { PaginatedResponse, RewriteRules } from "@tscommerce/sdk-typescript"

const searchCriteria = {
    from: '/old'
};

Client.API.Core.RewriteRules.search(searchCriteria).then((response:PaginatedResponse<RewriteRules>) => {
    response.resource.data.forEach((rule) => {
        console.log(rule.from, rule.to);
    });
});

PHP

$searchCriteria = ['from' => '/old'];
$results = $client->API->Core->RewriteRules->search($searchCriteria);