Mobile app

Mobile app: Sub campaign
Mobile app: Carousel
Mobile app

Mobile app: Sub campaign

Getting started

In this article, you can find information about the mobile app: sub campaign sub-category. Sub campaigns are blocks of desired content like products, promotion pages, or opensets that will be visible in the mobile app directly below the carousel. Customers are able to select these blocks in order to be redirected to the desired page.

RememberYou can find more information about the mobile app and other sub-categories in the Mobile app article.

Visualization of the sub campaign on the mobile app

To open the sub campaign view, in the admin panel, navigate to:
Mobile app > sub campaign

All possible operations to perform on the sub campaign view can be done in the Filters (1), and Sub campaigns (2) tabs.

Visualization of the sub campaign sub-category

Table of contents:

Filters section
Sub campaign
Creating a sub campaign

Filters section

The Filters section allows sorting of the sub campaigns in the mobile app module, based on the available filters. Below you will find a description of available filters

Visualization of the filters section

Is active? - Sub campaign activity status.
Date start - A range of dates that indicate the start date of the sub campaign.
Date end - A range of dates that indicate the end date of the sub campaign.

After defining the above filters, select the Apply Filters button to get a list of sites according to the applied filters.

Sub campaign

The Sub campaign section allows organizing the filtered featured sub campaigns, edit them and create new ones and delete them.

Below you will find a description of all possible actions you can perform in the sub campaign section in the admin panel.

Visualization of the sub campaign section

Select the Show X entries(1) field to set the number of sub campaigns, displayed on one page (min 10 / max 100).
The names of the columns (2) that contain information about a target sub campaign. Each column is susceptible to sorting.
To sort the records, click on the title of the column in question.
- ID - An internal ID of the sub campaign.
- Internal name - Internal name of the sub campaign.
- Place - Place identification: homepage / boutique. Field is used by mobile application to distinguish which banners should go to home view and which to boutique view.
- Sort order - Sort order of the sub campaign.
- Date start - Start date when the sub campaign will be visible to the customers.
- Date End - End date when the sub campaign will be hidden from the customers.
- Is active? - Activity status of the sub campaign.
- Actions - List of buttons with possible actions that can be done to the sub campaign.
  - Edit - Edit desired sub campaign. As editing contains exactly the same fields and actions as creating a new sub campaign you can read more about it in the Creating a sub campaign chapter.
  - Delete - Deletes the selected sub campaign without the ability to restore it.
Select the Add (3) button to go to the adding the new sub campaign. You can learn more about adding of the sub campaign in the Creating a sub campaign chapter.
Search box (4) where you can search for sub campaigns by their system name.
Page buttons(5), which allow users to change the page of the currently viewed content.

Creating a sub campaign

Add button allows users to create a new sub campaign.

Below, you will find a description of all possible fields that can be edited while creating a new sub campaign in the admin panel.

Visualization of the creating the sub campaign

Internal name (mandatory) - Internal name of the sub campaign.
Place (mandatory) - Place identification: homepage / boutique. Field is used by mobile application to distinguish which banners should go to home view and which to boutique view.
Link type (mandatory) - Type of a link available in the sub campaign. Depending on the selected type the Object ID field will require different input. There are 5 types of links:
- Product - Product available on the website.
- Category (tag) - Category tag available on the website.
- Promotion page - The promotion page available on the website.
- Openset page - Openset page available on the website.
- Custom view - Custom object programmed by the mobile app developers.
Object ID (mandatory) - ID of an object selected in Link type section.
- Product - Product SKU i.e. J12345
- Category (tag) -Tag ID i.e. 76938
- Promotion page - Promotion page internal ID i.e. 1234
- Openset page - Openset internal ID i.e. 765
- Custom view - Custom field that doesn't have any validation. Custom values configured and programmed by mobile app developers can be put here.
Small image (mandatory) - Small image of the sub campaign. Recommended image size is 200x400px. This image will be visible to the customers.
Medium image (mandatory) - Medium image of the sub campaign. Recommended image size is 400x600px. This image will be visible to the customers.
Large image (mandatory) - Large image of the sub campaign. Recommended image size is 800x1000px. This image will be visible to the customers.
Start date - Start date when the sub campaign will be visible to the customers.
End date - End date when the sub campaign will be hidden from the customers.
Sort order (mandatory) - Sort order of the sub campaign. The lower the sort order the earlier in the order selected sub campaign will be visible to the customer.
Is active? - Switch, which defines if the selected sub campaign is visible in the mobile app.

With all necessary fields filled, you can save the changes using the save button.

Mobile app: Carousel

Getting started

In this article, you can find information about the mobile app: Carousel sub-category. Carousel is equivalent to sliders on the e-commerce platform, except it shows only the first carousel depending on their sort order and after selecting it customer will see a story (similar to Instagrams stories), where every available carousel is visible for a short time.

RememberYou can find more information about the mobile app and other sub-categories in the Mobile app article.

Visualization of the carousel story on the mobile app

To open the Carousel view, in the admin panel, navigate to:
Mobile app > Carousel

All possible operations to perform on the Carousel view can be done in the Filters (1), and Carousel (2) tabs.

Visualization of the carousel sub-category

Table of contents:

Filters section
Carousel
Creating a carousel
Application view

Filters section

The Filters section allows sorting of the carousel in the mobile app module, based on the available filters. Below you will find a description of available filters

Visualization of the filters section

Is active? - Carousel activity status.
Date start - A range of dates that indicate the start date of the carousel.
Date end - A range of dates that indicate the end date of the carousel.

After defining the above filters, select the Apply Filters button to get a list of sites according to the applied filters.

Carousel

The Carousel section allows organizing the filtered featured carousels, edit them and create new ones and delete them.

Below you will find a description of all possible actions you can perform in the Carousel section.

Visualization of the carousel section

Select the Show X entries(1) field to set the number of carousels, displayed on one page (min 10 / max 100).
The names of the columns (2) that contain information about a target carousel. Each column is susceptible to sorting.
To sort the records, click on the title of the column in question.
- ID - An internal ID of the carousel.
- Title - Internal title of the carousel. This field is not visible to the customers
- Story title - Story, public title of the carousel. This field is visible to the customers.
- Date start - Start date when the carousel will be visible to the customers.
- Date End - End date when the carousel will be hidden from the customers.
- Is active? - Activity status of the carousel.
- Actions - List of buttons with possible actions that can be done to the desired carousel.
  - Edit - Edit desired carousel. As editing contains exactly the same fields and actions as creating a new carousel you can read more about it in the Creating a carousel chapter.
  - Delete - Deletes the selected carousel without the ability to restore it.
Select the Add (3) button to go to the adding the new carousel. You can learn more about adding of the carousel in the Creating a carousel chapter.
Search box (4) where you can search for carousels by their system name.
Page buttons(5), which allow users to change the page of the currently viewed carousel.

Creating a carousel

Add button allows users to create a new carousel.

Below, you will find a description of all possible fields that can be edited while creating a new carousel.

Visualization of the creating the carousel

Title (mandatory) - Internal carousel name. This field is not visible to the customers.
Story title (mandatory) - Public carousel name. This field is visible to the customers.
Description (mandatory) - Description of the carousel. This field is visible to the customers.
Link type (mandatory) - Type of a link available in the carousel. Depending on the selected type the Object ID field will require different input. There are 5 types of links:
- Product - Product available on the website.
- Category (tag) - Category tag available on the website.
- Promotion page - Promotion page available on the website.
- Openset page - Openset page available on the website.
- Custom view - Custom object programmed by the mobile app developers.
Object ID (mandatory) - ID of an object selected in Link type section.
- Product - Product SKU i.e. J12345
- Category (tag) -Tag ID i.e. 76938
- Promotion page - Promotion page internal ID i.e. 1234
- Openset page - Openset internal ID i.e. 765
- Custom view - Custom field that doesn't have any validation. Custom values configured and programmed by mobile app developers can be put here.
Small image (mandatory) - Small image of the carousel. Recommended image size: 200x400.
Medium image (mandatory) - Medium image of the carousel. Recommended image size: 400x600.
Large image (mandatory) - Large image of the carousel. Recommended image size: 800x1000.
Start date - Start date when the carousel will be visible to the customers.
End date - End date when the carousel will be hidden from the customers.
Sort order (mandatory) - Sort order of the carousel. The lower the sort order the earlier in the order selected carousel will be visible to the customer.
Is active? - Switch, which defines if the selected carousel is visible in the mobile app.

With all necessary fields filled, you can save the changes using the save button.

Application view

Customers accessing the Yves Rocher application will view the carousel with the lowest sort order a the top of the page.

Visualization of the carousel on the mobile app

When selecting the carousel it will open carousel story where the carousel will change the slide every 10 seconds.

Visualization of the carousel story on the mobile app

Selecting the discover more button will redirect the user to the desired page set in the "link type" and "object id" part of the carousel.

Visualization of the promotional page

Mobile app

Getting started

Mobile API is an interface that allows Yves Rocher Mobile application for android and iOS to get content from Yves-Rocher website. The mobile app should get configured in the Yves Rocher admin panel in order to work properly. The mobile app has its own category in the administrator panel called "Mobile app" where content for the mobile app can be configured. Detailed information about each sub-category can be found in the separate articles listed in the Mobile app sub-categories section.

RememberYves Rocher API documentation for developer use can be accessed under URL
https://yr-api-doc.netlify.app/

Table of contents:

Enabling the Mobile app
Mobile app sub-categories

Enabling the Mobile app

Mobile app by default is disabled on the selected environment. In order to enable or disable it you have to navigate to:

System > System / Settings > Integrations > Mobile App

Visualization of the mobile app system settings

In the mobile app menu you can find three options:

Enable - A switch that enables or disables the mobile application integration. This switch should be always turned on if the selected country is using the mobile app, as turning it off will cause an issue with API communication between Yves Rocher mobile application and Yves Rocher admin panel.
Gifts of choice - An JSON of gifts of choices, which shows up in the mobile application. The JSON has to be set between two square brackets ( [ ] ) and must include two parameters:
ExampleBelow you can find an example JSON of gifts of choice.
[
{"name": "Gifts from 100 EUR", "min_cart_value": 100, "products": ["P12345", "P12346"]},
{"name": "Gifts from 150 EUR", "min_cart_value": 150, "products": ["P92345", "P92346"]}
]
Paper Mailing - An JSON of paper mailing products that show up in the mobile application. The JSON has to be set between two curly brackets ( { } ) and must include the following parameters:
ExampleBelow you can find an example JSON of gifts of paper mailing.
{
"ver1": {
"discount_code": "ABCDEFG",
"products": [
{"skus": ["P12345", "P12346"]},
{"skus": ["P12345", "P12346"]}
]
},
"ver2": {
"offer_id": "offer_id_1",
"discount_code": "ABCDEFG",
"discount_percentage": 10,
"products": [
{"skus": ["12345","12346","12347"]}
],
"additional": {
"validity": "2024-12-31",
"ean_image": "https://example.com/image.jpg",
"image_small": "https://example.com/image-sm.jpg",
"image_medium": "https://example.com/image-md.jpg",
"image_large": "https://example.com/image-lg.jpg"
}
}
}

RememberYou can find more about paper mailing api calls in
https://yr-api-doc-staging-v6.netlify.app/api-raml/#mobile_app_paper_mailing_get
https://yr-api-doc-staging-v6.netlify.app/api-raml/#mobile_app_paper_mailing_list_get

With an enabled mobile app all the categories described in the Mobile app sub-categories can be used in the mobile application.

Mobile app sub-categories

The mobile app content can be managed using the "Mobile app" category in the admin panel. In this category, you will find many different subcategories that will be read by the mobile app and shown on the application.

Visualization of the mobile app sub-categories

Below you will find URLs to the articles of the currently available sub-categories

Carousel
Sub Campaign
Boxes
Homepage products
Articles
Current offers
Cms elements
Cms categories
Catalog
Customer private offers