Special Website Pages: Overview of Methods

In Bitrix24, a website page can be assigned a special type. For example, it can be designated as the main page, a catalog page, a cart page, or an order page.

This is necessary for Bitrix24 to know which page to use in each scenario. For instance, if a page is assigned the type cart, Bitrix24 will use it as the website's cart page.

The pages remain ordinary: they can be created, edited, and configured. Only their role in the website's operation changes.

Methods help assign a special type to a page, retrieve current bindings and addresses of special pages, and delete bindings.

Quick Navigation: All Methods

How to Assign and Retrieve Special PagesHow to Assign and Retrieve Special Pages

1. Obtain the site ID using the methods landing.site.getList or landing.site.add.
2. Get the page ID using the methods landing.landing.getList, landing.landing.add, landing.landing.addByTemplate, or landing.landing.copy.
3. Assign the page as special using the method landing.syspage.set. For this, specify the type of special page in the type parameter and the ID of the page to be bound.
4. Check current bindings using the method landing.syspage.get or retrieve the URL of a special page using the method landing.syspage.getSpecialPage.
5. If you need to remove bindings, use landing.syspage.deleteForLanding or landing.syspage.deleteForSite. The first method removes all bindings for a specific page, while the second clears all special pages for the site.

Codes of Special PagesCodes of Special Pages

The type parameter is used for the special page type. It defines what role the page will play on the site.

Type Code	Purpose	Marker in Page Body
mainpage	Main Page	#system_mainpage
catalog	Main Catalog Page	#system_catalog
personal	Personal Section	#system_personal
cart	Cart	#system_cart
order	Order Processing	#system_order
payment	Payment Page	#system_payment
compare	Comparison Page	#system_compare
feedback	Feedback Page	#system_feedback

If a page is assigned for the code on the current site, Bitrix24 will substitute its address instead of the marker. If there is no such binding, the marker will not work.

For example, if the cart page is assigned the type cart, then at the location of the marker #system_cart, Bitrix24 will substitute the address of that page. If the binding is removed, the address will no longer be substituted.

Relation to Other ObjectsRelation to Other Objects

Special pages are configured for a specific site. Each binding indicates which page Bitrix24 will use for the required scenario.

Site. The methods landing.syspage.set, landing.syspage.get, landing.syspage.getSpecialPage, and landing.syspage.deleteForSite operate in the context of the site. Therefore, siteId is always required for operation. It can be obtained using the methods landing.site.getList or landing.site.add.

Page. An ordinary page can be assigned as special. The page ID can be obtained using the methods landing.landing.getList, landing.landing.add, landing.landing.addByTemplate, or landing.landing.copy. If the page should no longer be used as special, all its bindings can be removed using the method landing.syspage.deleteForLanding.

Overview of MethodsOverview of Methods

Scope: landing

Who can execute the method: depending on the method

Assigning and RetrievingAssigning and Retrieving

Method	Description
landing.syspage.set	Assigns a special page for the site
landing.syspage.get	Retrieves the list of special pages for the site
landing.syspage.getSpecialPage	Retrieves the URL of a special page for the site

Removing BindingsRemoving Bindings

Method	Description
landing.syspage.deleteForLanding	Removes all bindings of the page as special
landing.syspage.deleteForSite	Removes all bindings of special pages for the site