Instructions for setting up the Y.CMS module for WebAsyst

Download the instructions in PDF format

Y.CMS is the module for integrating your online store with Yandex's business services.

Yandex.Checkout: accept payments to settlement account and conduct refunds (by contract, for legal entities and private entrepreneurs).

Yandex.Money: accept payments to Yandex.Money wallet (without a contract, for everyone).

Yandex.Billing: accept payments to company's account (without a contract, for legal entities and private entrepreneurs).

Yandex.Metrica: collect user clicks and user behavior data.

Yandex.Market: post products at Yandex.Market.

Technical support and updates are provided by Yandex.Money.

Installing the module

Yandex.Checkout

Yandex.Money

Yandex.Billing

Yandex.Metrica

Yandex.Market

Installing the module

1. Download the archive (.ZIP, 424 KB).

2. Copy the contents of the archive to the root folder of the website on your server.

3. Add the 'yamodule_api' => true line to the /wa-config/apps/shop/plugins.php file.

4. Make sure the module is installed by checking the Plugins tab in the Store section of the dashboard. See the Y. CMS Shop-Script 2.0 line in the left column.

If everything is correct, you can proceed with the configuration.

Yandex.Checkout

How to set up payment acceptance

To set up payment acceptance using this manual, you need to sign up for Yandex.Checkout and get the shopId and Secret key parameters.

  • shopId will appear in your Merchant Profile by itself when you sign up for the service,
  • Secret key is issued independently and requires activation in Merchant Profile. More in Yandex.Checkout's help guide

Once you get both parameters, you can proceed with the configuration.

1. Select Store — Plugins — Y.CMS Shop-Script (2.0) in the website's dashboard.

2. Open the Yandex.Checkout tab and check the Enable payment acceptance via Yandex.Checkout box.

3. Fill out the shopId and Secret key fields: you can get both parameters in your Yandex.Checkout Merchant Profile.

4. Indicate the preferable scenario of selecting a payment method:

  • On Yandex.Checkout's side (you can view an example in Demo Store),
  • On the store's side.
The option of selecting the payment method on the store's side looks like this

5. If you selected the first scenario, you can name the pay button "Pay via Yandex.Checkout" by checking the corresponding box.

If you selected the payment scenario to be played out on the store's side, check the boxes corresponding to payment methods indicated in your contract with Yandex.Money.

6. Enable the transmission of receipt data if required. This configuration is for those who use the Yandex.Checkout solution for Federal Law No. 54-FZ.

Receipts require the VAT rate: if you have enabled the transmission of receipt data, the module will offer you to compare rates in your store against the Yandex.Checkout's rates.

7. Click Save at the bottom of the page. Open the Settings tab and view the Payment section.

8. Click Add a payment method and select Yandex.Money 2.0 (Y.CMS in the opened list.

9. Enter Yandex.Checkout in the Payment method name field and list the available payment methods in the Description field (for example, as shown in the screenshot below). This text will be displayed to your customers.

10. Click Save at the bottom of the page. That's it: you can test payment acceptance on the website.

Returning Money

You can refund money to the buyer if the order was paid for via Yandex.Checkout using one of the following payment methods: bank cards, Yandex.Money, WebMoney, Alfa-Click, MasterPass,QIWI Wallet, Kupivkredit.

To make a full refund:

1. Click Orders in the website's dashboard and select the required order.

2. View the Refund tab on the orders page and enter the reason behind the refund (this message will be sent to the buyer), then click Make refund.

Partial refunds can only be made from your Yandex.Checkout Merchant Profile. Instructions on the Yandex.Checkout website

Yandex.Money

How to set up payment acceptance to a Yandex.Money wallet

Using this module, you can accept payments to your Yandex.Money wallet without a contract.

1. li Select Store — Plugins — Y.CMS Shop-Script (2.0) in the website's dashboard.

2. Open the "Yandex.Money" tab and check the "Enable payment acceptance to the Yandex.Money wallet" box.

3. Enter the number of the wallet for accepting the money in the "Wallet number" field.

4. You can get the "App ID" and "Code word" values on the Yandex.Money website

by following this link and filling out the fields:

  • "Name" is the name of your store, it will be shown to the user.
  • "URL" is the website where you will accept payments.
  • "Email address for contact" is your email address.
  • "Redirect URL" is RedirectURL in the module's settings (simply copy this link).
  • "Logo" is not required but it helps users to recognize your service.
  • Be sure to check the "Use app authentication" box.

5. When you fill out all the fields on the registration page, click "Confirm". The website will generate ID and the "Code word": copy them to the module settings.

6. Click Save at the bottom of the page. Open the Settings tab and view the Payment section.

7. Click Add a payment method and select Yandex.Money 2.0 (Y.CMS) in the opened list.

9. Enter "Yandex.Checkout" in the Payment method name field and list the available payment methods in the Description field (for example, as shown in the screenshot below). This text will be displayed to your customers.

9. Click Save at the bottom of the page. That's it, now you can test payment acceptance.

Yandex.Billing

The configuration of payment acceptance via Yandex.Billing consists of three steps:

  1. Get the payment form settings at the Yandex.Billing website.
  2. Indicate these settings in the website's dashboard.
  3. Pay the fee for using the form.

How to get the payment form settings

1. Fill out the form template at the Yandex.Billing website: indicate "Payment for order" in the Name of product or service field. You don't need to fill out the Amount field, add other products, or additional fields, as this information is already included in your CMS.

What the form template looks like

2. Click Next and fill out the company questionnaire on the next page. You will need to indicate:

  • your company's legal name and INN (TIN),
  • account's banking details,
  • ​email address where you'd like to receive payment notifications,
  • URL of the website where you're going to accept payments via Yandex.Billing.​
What the company questionnaire looks like

3. Click Create form. Banking details, URL, and other provided information will be sent for verification. It will take a couple of minutes.

​4. If everything's in order, you will receive an email containing the form's parameters and banking details for paying the fee.​

Body of the email

How to configure settings in the dashboard

1. Select Store — Plugins — Y.CMS Shop-Script (2.0) in the website's dashboard.

2. View the Yandex.Billing tab and check the Enable payment acceptance box.

3. Yandex.Billing's identifier is the Form ID, copy it from the Yandex.Billing email (you received one after setting up the form).

4. In the Payment purpose field, indicate everything that will help distinguish the payment made via Yandex.Billing. This parameter will be included in the payment order.

5. In the Order status field, select the status that will be assigned to the order that was paid via Yandex.Billing. The status should indicate that the payment result is unknown: you can only find out whether the customer paid or not from the email notification.

6. Click Save at the bottom of the page. Open the Settings tab and select the Payment section.

7. Click Add a payment method and select Yandex.Money 2.0 (Y.CMS) in the opened list.

9. Enter "Yandex.Checkout" in the Payment method name field and list the available payment methods in the Description field (for example, as shown in the screenshot below). This text will be displayed to your customers.

9. Click Save at the bottom of the page. That's it, now you can test payment acceptance.

How to pay for the form

1. Open the email containing the form's code and the banking details for paying a fee.

2. Pay 3,000 rubles using the banking details from the settlement account that you will use ofr accepting payments (otherwise, the fee will not be considered as paid).

3. As soon as we receive the funds, we will activate the form and send you an email. The duration depends on your bank, but it shouldn't take more than 3 days.

4. Make a test payment for a small amount: check that the form works properly, and the money can reach your account.

That's it, you can accept payments now.

Внимание. One paid fee covers all the forms that you select for your company (we check by INN (TIN) indicated during the creation of the form). Limitations on quantity and amount of payments also apply to all forms at the same time.

Yandex.Metrica

How to get the parameters for setting up Yandex.Metrica

To set up the module to collect stats, you need to create an app to access Yandex.Metrica and get its ID and password. The new app is needed even if you've already created one for interacting with any other Yandex service.

1. Open the app creation page.

2. Fill out the form:

Name — the name that will be shown to the user.

Description — the text that will be shown in the list of apps allowed by the user to have access to their account.

Link to logo — the link to your website's logo. Optional.

Link to website — the link to your website.

Rights — select "Yandex.Metrica" and check these boxes:

  • "Receiving stats, reading parameters from your own and trusted counters",
  • "Creating counters, changing parameters of your own and trusted counters".

Callback URL — copy the URL from the Link for app field in the Yandex.Metrica tab (Y.CMS Shop-Script settings).

Внимание. Don't click "Set the development URL", as the module will not work with it.

3. Click Save. Yandex will issue ID and password for the app: use them to set up the module for interacting with Yandex.Metrica.

How to set up the module to interact with Yandex.Metrica

1. Click Store in the website's dashboard, select the Plugins tab (in the upper right corner), and click Y.CMS Shop-Script in the left-hand menu.

2. View the Yandex.Metrica tab. Set Activity to "Enabled".

3. Specify the store's details:

  • Counter number that you received during creation of the counter at the Yandex.Metrica website.
  • App ID and App password are issued on the app creation page. Instructions
  • QAuth Token will be filled automatically after you click the "Get token" link.

4. Check the boxes with the Yandex.Metrica parameters that you require (Settings section)

5. Click Save. That's it: the module will collect the stats for your website.

Yandex.Market

How to upload products to Yandex.Market

Before setting up the module, you need to register your store at Yandex.Market. After you've registered the store:

1. Click Store in the website's dashboard, open the Plugins tab. Select Y. CMS Shop-Script 2 from the list of installed modules.

2. View the Yandex.Market tab to open the module settings.

3. Indicate your store's name in the top field and the full name of the company below it.

4. Select the main and additional currencies for your price list in the Currency section.

Yandex.Market accepts information about the prices in rubles (RUR, RUB), hrivnas (UAH), Belarusian rubles (BYN), tenge (KZT), dollars (USD), and euros (EUR) If any of the currencies are not available here, it means they are not included in your CMS.

You can only use the rubles (RUR, RUB), Belarusian rubles (BYN), hryvnias (UAH), and Kazakhstani tenge (KZT) as the main currency.

Learn more about currencies.

You can also configure the Rates and Surcharge for additional currencies by hovering over the currency name and clicking the pencil icon.

Indicate the required parameters in the settings and click OK.

Rates

Determine the exchange rates in relation to the rate of the main currency taken as a unit.

  • By the rate of the Central Bank of Russia.
  • By the rate of the National Bank of Ukraine.
  • By the rate of the National Bank of Kazakhstan.
  • By the rate of the bank of the country where the store belongs by region (set in your Merchant Profile).
Surcharge The percentage you want to add to the value you set for the rate.

5. Select the categories of products to upload to the price list.

Set All if you want to upload all categories.

If you want to upload only few of the categories, set Selected to open an additional field with a list of categories. Check the boxes next to the ones you want to upload.

6. If you offer courier delivery within your home region, add the delivery conditions in the next section.

You can configure several conditions for different cases by hovering over the condition and clicking the pencil icon.

Specify the delivery parameters in the settings and click OK:

Price Price of delivery within the home region. Main currency that you selected in section 5 will be added automatically.
Delivery time Period required for courier delivery within your home region.
For orders before... If the delivery time depends on when the order was placed, specify it here. For example, "12:00" if the specified delivery time is relevant for orders placed before noon. By default, Yandex.Market is set to "before 13: 00"

After you complete the configuration, the condition might look like this:

Check the box next to it to upload it to the price list.

More about delivery conditions.

7. Select the offer format in the next section, Arbitrary or Simplified with offer name template.

Learn more about offer formats.

8. In Product status and delivery methods, set the statuses and delivery methods of products that are in and out of stock.

Hover over the required option and click the pencil icon.

Indicate the required parameters Indicate the status and check the boxes corresponding with the delivery methods in the drop-down menu, then click OK. If you do not want to upload these products to the price list, use the Don't upload status.

The settings might look something like this:

Check the box for the corresponding condition to make it work.

9. The VAT rate may differ for individual products in the general taxation system. If you would like to set non-standard taxation rates and display them in your offers at Yandex.Market, indicate these settings in the Tax rates settings.

All rates available in your CMS are displayed in the drop-down menu. Set the desired VAT rate here, then specify the corresponding rates in the product description.

Check the Add tax rates to offers box to upload the tax rates.

More about tax rates.

10. Check the box in this block to upload offers with options to the price list.

11. In the next block, you can apply additional conditions to product categories. Click Add a condition to view settings.

Condition name Indicate the name of this condition (not uploaded to Yandex.Market).
Tag The YML element to set the condition for.
Permanent value or Value from product description The value to be set for this element. You can select an existing one from the product description or use a new one.
Identical tags in offers How to upload identical tags in a sentence to a price list.
For categories Apply this condition to all or selected categories.

Enter all parameters and click OK.

Check the box for the corresponding condition to make it work. To edit or delete a condition, hover over it and click the pencil icon on the right.

After you complete the configuration, the additional condition might look like this.

12. After configuring the module, click Save at the bottom of the page to save changes.

13. After saving, scroll down and copy the link from the Link for uploading products to Yandex.Market field.

14. View settings of your store at partner.market.yandex.ru, click Assortment, then Price list and Enter a link. Paste the copied link to the field and click Import.

If Y.CMS settings are filled correctly, the price list will be sent to the Yandex.Market specialists for verification. If there are any errors, the Yandex.Market team will help you fix them.