Documentation

RedirectsApi extends V3ApiBase
in package
Uses GetAllResources, DeleteInIdList, BatchUpdateResource

Redirects API

For management of storefront redirects.

Example for adding a generated list of nonsense redirects. All urls of the format /old-url/[1-50] will be redirected to product 1, at url /new-url/1.

$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);

$range = range(1, 50);
$redirects = [];

$redirectTo = new RedirectTo();
$redirectTo->type      = RedirectTo::TYPE__PRODUCT;
$redirectTo->entity_id = 1;
$redirectTo->url       = '/new-url/1'

foreach ($range as $i) {
  $redirect = new Redirect();
  $redirect->from_path = "/old-url/$i";
  $redirect->site_id   = 0;

  $redirects[] = $redirect;
}

$api->redirects()->upsert($redirects);
Tags

Table of Contents

__construct()  : mixed
batchUpdate()  : RedirectsResponse
delete()  : bool
getAll()  : RedirectsResponse
getClient()  : Client
getMaxRetries()  : int
getParentResourceId()  : int|null
getResourceId()  : int|null
multipleResourceUrl()  : string
setMaxRetries()  : void
upsert()  : RedirectsResponse

Methods

__construct()

public __construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
$client : Client
$resourceId : int|null = null
$parentResourceId : int|null = null
Tags
Return values
mixed —

delete()

public delete([array<string|int, mixed> $ids = [] ]) : bool
Parameters
$ids : array<string|int, mixed> = []
Tags
Return values
bool —

getAll()

public getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : RedirectsResponse
Parameters
$filters : array<string|int, mixed> = []
$page : int = 1
$limit : int = 250
Tags
Return values
RedirectsResponse —

getParentResourceId()

public getParentResourceId() : int|null
Tags
Return values
int|null —

getResourceId()

public getResourceId() : int|null
Tags
Return values
int|null —

multipleResourceUrl()

public multipleResourceUrl() : string
Tags
Return values
string —

setMaxRetries()

public setMaxRetries(int $maxRetries) : void
Parameters
$maxRetries : int
Tags
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results