### XML Schema for Product Variants Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed Defines the structure for product variants, including essential information like GUID, TITLE, and URL. It also supports multiple images for each variant, with a dedicated section for a list of image URLs. ```xml ``` -------------------------------- ### XSD Schema for Product Data Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed Defines the structure of the product data feed, including elements for product information such as GUID, TITLE, URL, images, content, descriptions, keywords, and pricing. It specifies data types and constraints for each element. ```xml ``` -------------------------------- ### Product Data Structure Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed Defines the overall structure for product information, including core attributes and nested elements for variants and categories. ```APIDOC ## Product Data Structure ### Description This section describes the fundamental elements and their relationships within the product data model. ### Parameters #### Complex Type: PARAMS - **PARAM** (Complex Type) - 1 or more (unbounded) - A key-value pair representing a product attribute. - **NAME** (String) - 1 - The name of the parameter (e.g., "Color", "Size"). - **VAL** (String) - 1 - The value of the parameter (e.g., "Red", "Large"). #### Simple Types: - **STOCK_AVAILABILITY** (unsignedByte) - 0 or 1 (optional) - Indicates stock availability (e.g., 1 for in stock, 0 for out of stock). - **IN_STOCK** (decimal) - 0 or 1 (optional) - The number of units currently in stock. - **IS_ACCESSORY** (unsignedByte) - 0 or 1 (optional) - Indicates whether the product is an accessory (1 for yes, 0 for no). - **MAIN_CATEGORY** (String) - 0 or 1 (optional) - The main category to which the product belongs. #### Complex Type: CATEGORIES - **CATEGORY** (Complex Type) - 1 or more (unbounded) - A category to which the product belongs. - **(attribute main_category)** (unsignedByte) - 0 or 1 (optional) - Flag, that this category is main. - **(attribute id)** (String) - 0 or 1 (optional) - Identifier of category. - **(attribute parentId)** (String) - 0 or 1 (optional) - Identifier of parent category. #### Complex Type: VARIANTS - **VARIANT** (Complex Type) - 1 or more (unbounded) - Represents a specific variant of the product. - **GUID** (String) - 0 or 1 (optional) - Globally Unique Identifier for the variant. Used to uniquely identify this variant. - **TITLE** (String) - 1 - The title of the variant. - **URL** (String) - 1 - The URL of the variant. - **IMAGE** (String) - 0 or 1 (optional) - The URL of the image for the variant. - **IMAGES** (Complex Type) - 0 or 1 (optional) - Container for multiple image urls for a variant. - **IMAGE** (String) - 1 or more (unbounded) - Image url for a variant. - **CONTENT** (String) - 0 or 1 (optional) - The content for the variant. - **SHORT_DESCRIPTION** (String) - 0 or 1 (optional) - The short description for this variant. - **KEYWORDS** (Complex Type) - 0 or 1 (optional) - Container for keywords associated with the variant. - **KEYWORD** (String) - 1 or more (unbounded) - Keyword describing the variant. - **PRICES** (Complex Type) - 0 or 1 (optional) - Container for multiple prices of the variant. - **PRICE** (Complex Type) - 1 or more (unbounded) - Represents a specific price for the product variant, potentially based on a price group. - **PRICE_GROUP** (String) - 1 - The name of the price group for the variant (e.g., "Default", "Wholesale"). - **CURRENCY_CODE** (String) - 0 or 1 (optional) - The currency code for the variant price (e.g., "USD", "EUR"). - **PRICE** (Decimal) - 1 - The actual (sell) price of the product variant. - **PRICE_WITHOUT_VAT** (Decimal) - 0 or 1 (optional) - The price of the product variant excluding VAT. - **VAT** (Decimal) - 0 or 1 (optional) - The amount of VAT (Value Added Tax) included in the variant price. - **ORIGINAL_PRICE** (Decimal) - 0 or 1 (optional) - The original price of the product variant before any discounts. - **MARGIN** (Integer) - 0 or 1 (optional) - The margin for this variant price expressed as a percentage. - **DISCOUNT** (Decimal) - 0 or 1 (optional) - The amount of discount applied to the variant. - **PURCHASE_PRICE** (Decimal) - 0 or 1 (optional) - The price at which the variant was purchased by the seller. - **UNIT** (String) - 0 or 1 (optional) - The unit of measure for the variant (e.g., "pcs", "kg"). - **SALES** (Integer) - 0 or 1 (optional) - The number of units sold for the product variant. The sales period to which the data refers is optional. - **START_OF_SALES** (DateTime) - 0 or 1 (optional) - The date and time when the product variant went on sale. - **IS_VISIBLE** (unsignedByte) - 0 or 1 (optional) - Indicates whether the product variant is visible on the website (1 for visible, 0 for hidden). - **VISIBILITY** (String) - 0 or 1 (optional) - Specifies the product variant's visibility setting (e.g., "public", "private"). ### Request Example ```json { "product": { "params": [ { "name": "Color", "val": "Blue" }, { "name": "Size", "val": "M" } ], "stock_availability": 1, "in_stock": 150.5, "is_accessory": 0, "main_category": "Apparel", "categories": [ { "id": "cat123", "main_category": 1, "$main_category": "Clothing" }, { "id": "cat456", "parentId": "cat123", "$main_category": "T-Shirts" } ], "variants": [ { "guid": "var-guid-1", "title": "Blue T-Shirt - Medium", "url": "/products/tshirt-blue-m", "image": "/images/tshirt-blue.jpg", "prices": [ { "price_group": "Default", "currency_code": "USD", "price": 29.99, "price_without_vat": 27.26, "vat": 2.73, "original_price": 35.00, "discount": 5.01 } ], "purchase_price": 15.00, "unit": "pcs", "sales": 100, "start_of_sales": "2023-10-26T10:00:00Z", "is_visible": 1, "visibility": "public" } ] } } ``` ### Response #### Success Response (200) - **product** (Complex Type) - The processed product data. #### Response Example ```json { "product": { "params": [ { "name": "Color", "val": "Blue" }, { "name": "Size", "val": "M" } ], "stock_availability": 1, "in_stock": 150.5, "is_accessory": 0, "main_category": "Apparel", "categories": [ { "id": "cat123", "main_category": 1, "$main_category": "Clothing" }, { "id": "cat456", "parentId": "cat123", "$main_category": "T-Shirts" } ], "variants": [ { "guid": "var-guid-1", "title": "Blue T-Shirt - Medium", "url": "/products/tshirt-blue-m", "image": "/images/tshirt-blue.jpg", "prices": [ { "price_group": "Default", "currency_code": "USD", "price": 29.99, "price_without_vat": 27.26, "vat": 2.73, "original_price": 35.00, "discount": 5.01 } ], "purchase_price": 15.00, "unit": "pcs", "sales": 100, "start_of_sales": "2023-10-26T10:00:00Z", "is_visible": 1, "visibility": "public" } ] } } ``` ``` -------------------------------- ### XML Example for Category Data Source: https://mediafactory.stoplight.io/docs/searchready/s9o0qtgnbdmk9-category-xml-feed This XML snippet demonstrates the structure for representing product categories. It includes fields like TITLE, URL, DESCRIPTION, IMAGE, PATH, PRODUCTS count, ID, and PARENT category ID. ```xml Children's Socks https://www.yourdomain.com/clothing/childrens-clothing/childrens-socks Children's socks not only for cycling, but also for any other sport. https://www.yourdomain.com/img/childrens-socks-cat.jpg Clothing | Children's Clothing | Children's Socks 20 2c12dd8b-b6dd-4eee-9b44-188bf09bea17 ecd713d8-c6c6-44e7-a9c9-ad812f3f1537 Clothing https://www.yourdomain.com/clothing Clothing 5a01e1af-dc48-4308-8f6d-f78ffb43f490 ``` -------------------------------- ### Define XML Schema for Product Content and Keywords Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed This snippet defines the XML schema elements for product content and a list of keywords. It specifies that CONTENT and SHORT_DESCRIPTION are optional strings, while KEYWORDS is an optional element that can contain multiple KEYWORD string elements. ```xml ``` -------------------------------- ### XML Schema for Product Identification and Attributes Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed Defines core product identification elements like SKU and ISBN, along with descriptive attributes such as LABELS, DELIVERY, and BRAND. It also includes definitions for dynamic PARAMS and stock-related information. ```xml ``` -------------------------------- ### XML Product Data Structure Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed This XML structure defines a single product with its core details, pricing information, categories, and available variants. It includes product identifiers, descriptions, media URLs, pricing tiers, and specifications. ```xml a1b2c3d4-e5f6-7890-1234-567890abcdef StellarPhone Z2000 https://example.com/stellarphone-z2000 https://example.com/images/stellarphone-z2000-main.jpg https://example.com/images/stellarphone-z2000-side.jpg https://example.com/images/stellarphone-z2000-back.jpg Introducing the StellarPhone Z2000!

The StellarPhone Z2000 is the pinnacle of mobile technology from FutureTech. Experience unparalleled performance, a stunning display, and revolutionary features.

  • 7.0" Super Retina XDR Display
  • 200MP HyperZoom Camera
  • Next-Gen Quantum Processor
  • 6G Connectivity
  • All-Day Battery Life
]]> The StellarPhone Z2000: The Future is in Your Hands. StellarPhone Z2000 Smartphone 6G Retina Quantum Default EUR 1200 991.74 21.00 1500 20.00 0 1 20 Registered EUR 1190 983.47 21.00 1400 20.00 0 1 20 950.00 pcs 2200 2024-02-01T00:00:00 1 public Free Wireless Charging Pad + Premium Case 4.9 SPZ2000 1234567890123 Z2000-BLK-256 965-3-14-148210-0 In stock FutureTech Color Midnight Black Storage 256GB RAM 16GB 1 750.00 0 Smartphones Smartphones Mobile Phones Electronics f7g8h9i0-j1k2-3456-7890-1234567890abc StellarPhone Z2000 - Lunar Silver - 512GB https://example.com/stellarphone-z2000-silver-512gb https://example.com/images/stellarphone-z2000-silver.jpg StellarPhone Z2000 - Lunar Silver - 512GB StellarPhone Lunar Silver 512GB Default ``` -------------------------------- ### Products XML Feed Structure Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed This section outlines the structure of the Products XML Feed, detailing various fields and their types related to product variants. ```APIDOC ## Products XML Feed Structure ### Description This feed provides detailed information about products, including their variants, attributes, and availability. ### Method N/A (XML Feed) ### Endpoint N/A (XML Feed) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example ```xml 123 Electronics 2023-01-01T10:00:00Z 2023-01-01T10:00:00Z Limited Edition Bonus 4.5 VAR-ELEC-001 1234567890123 SKU-ELEC-001-RED N/A In stock Color Red Size Large 1 50 ``` ### Response #### Success Response (200) N/A (XML Feed) #### Response Example N/A (XML Feed) ### Fields **VARIANTS/VARIANT/GIFT** * **Description**: A description of any gift associated with the product variant. * **Type**: String * **Optional**: 0 or 1 (optional) **VARIANTS/VARIANT/RATING** * **Description**: The average rating of the product variant, on a scale of 0 to 5. * **Type**: Decimal * **Optional**: 0 or 1 (optional) **VARIANTS/VARIANT/PRODUCT_CODE** * **Description**: A unique code assigned to the product variant. * **Type**: String * **Optional**: 0 or 1 (optional) **VARIANTS/VARIANT/EAN** * **Description**: European Article Number (barcode) for the product variant. * **Type**: String * **Optional**: 0 or 1 (optional) **VARIANTS/VARIANT/SKU** * **Description**: Stock Keeping Unit – a unique identifier for inventory management of variant. * **Type**: String * **Optional**: 0 or 1 (optional) **VARIANTS/VARIANT/ISBN** * **Description**: International Standard Book Number (if applicable). * **Type**: String * **Optional**: 0 or 1 (optional) **VARIANTS/VARIANT/LABELS** * **Description**: A container for labels applied to the product variant. * **Type**: Complex Type (Sequence of LABEL elements) * **Optional**: 0 or 1 (optional) **VARIANTS/VARIANT/LABELS/LABEL** * **Description**: A label assigned to the product variant (e.g., "New", "Sale"). * **Type**: String * **Cardinality**: 1 or more (unbounded) **VARIANTS/VARIANT/DELIVERY** * **Description**: Delivery information for the variant (e.g., "In stock", "Out of stock"). * **Type**: String * **Optional**: 0 or 1 (optional) **VARIANTS/VARIANT/PARAMS** * **Description**: A container for product variant parameters (attributes). * **Type**: Complex Type (Sequence of PARAM elements) * **Optional**: 0 or 1 (optional) **VARIANTS/VARIANT/PARAMS/PARAM** * **Description**: A key-value pair representing a product variant attribute. * **Type**: Complex Type (All - elements in any order) * **Cardinality**: 1 or more (unbounded) **VARIANTS/VARIANT/PARAMS/PARAM/NAME** * **Description**: The name of the parameter for variant (e.g., "Color", "Size"). * **Type**: String * **Cardinality**: 1 **VARIANTS/VARIANT/PARAMS/PARAM/VAL** * **Description**: The value of the parameter for variant (e.g., "Red", "Large"). * **Type**: String * **Cardinality**: 1 **VARIANTS/VARIANT/STOCK_AVAILABILITY** * **Description**: Indicates stock availability of variant (e.g., 1 for in stock, 0 for out of stock). * **Type**: unsignedByte * **Optional**: 0 or 1 (optional) **VARIANTS/VARIANT/IN_STOCK** * **Description**: The number of units currently in stock for this variant. * **Type**: decimal * **Optional**: 0 or 1 (optional) **PRODUCT_TYPE** * **Description**: Type of product. * **Type**: String * **Optional**: 0 or 1 (optional) **CREATION_TIME** * **Description**: Time, when this product was created. * **Type**: DateTime * **Optional**: 0 or 1 (optional) **CHANGE_TIME** * **Description**: Time, when this product was changed. * **Type**: DateTime * **Optional**: 0 or 1 (optional) ``` -------------------------------- ### XML Schema for Product Data Structure Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed Defines the structure of product data, including elements like PRODUCT_ID, PRICE, DELIVER, PARAMS, and STOCK_AVAILABILITY. It specifies data types and occurrence constraints for each element. ```xml ``` -------------------------------- ### XML Schema for Product Categories Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed Defines the structure for product categorization, allowing for multiple categories per product. Each category can have attributes like 'main_category', 'id', and 'parentId' for hierarchical organization. ```xml ``` -------------------------------- ### Articles XML Feed Example Source: https://mediafactory.stoplight.io/docs/searchready/sxhodz2suwimk-articles-xml-feed This XML snippet demonstrates the structure of the Articles feed. It includes sample data for an article with its title, URL, content, image, keywords, and perex. This format is used for disseminating article information. ```xml
Helping E-shops Increase Revenue and Customer Satisfaction https://blog.mfgroup.cz/article/advanced-search-and-its-optimization-increases-ecommerce-revenue-and-customer-satisfaction Search Ready, we discovered and multiplied this potential in the development of the Search Ready search platform. We now advise e-shops on how they can be one step ahead of the competition and use advanced search to benefit their business goals.....]]> https://blog.mfgroup.cz/storage/app/media/Blog%20images/intro.png search, fulltext, e-shop, faceted search, filtering Advanced search and its regular optimization bring customer satisfaction and more orders. We'll advise you on how to do it.
``` -------------------------------- ### Categories XML Feed Source: https://mediafactory.stoplight.io/docs/searchready/s9o0qtgnbdmk9-category-xml-feed This section details the XML feed for product categories, including an example and XSD schema. ```APIDOC ## Categories XML Feed ### Description Provides an XML feed containing information about product categories. ### XML Example ```xml Children's Socks https://www.yourdomain.com/clothing/childrens-clothing/childrens-socks Children's socks not only for cycling, but also for any other sport. https://www.yourdomain.com/img/childrens-socks-cat.jpg Clothing | Children's Clothing | Children's Socks 20 2c12dd8b-b6dd-4eee-9b44-188bf09bea17 ecd713d8-c6c6-44e7-a9c9-ad812f3f1537 Clothing https://www.yourdomain.com/clothing Clothing 5a01e1af-dc48-4308-8f6d-f78ffb43f490 ``` ### XSD Schema ```xml ``` ### XML Element Descriptions | Element | Description | Data Type | Occurrences | |-------------|-----------------------------------------------------------------|-------------------|--------------------| | CATEGORIES | The root element containing a list of product categories. | Complex Type | 1 | | CATEGORY | Represents a single product category. | Complex Type | 1 or more (unbounded) | | TITLE | The name or title of the product category. | String | 1 | | URL | The URL of the product category page on the website. | String | 1 | | DESCRIPTION | A description of the product category. | String | 0 or 1 (optional) | | IMAGE | The URL of an image representing the product category. | String | 0 or 1 (optional) | | PATH | The hierarchical path of the category within the website's structure. | String | 0 or 1 (optional) | | PRODUCTS | The number of products belonging to this category. | Integer | 0 or 1 (optional) | | ID | Category identifier. | String | 0 or 1 (optional) | | PARENT | Parent category identifier. | String | 0 or 1 (optional) | ``` -------------------------------- ### Articles XML Feed Source: https://mediafactory.stoplight.io/docs/searchready/sxhodz2suwimk-articles-xml-feed This section details the structure and content of the Articles XML feed, including an example and XSD schema. ```APIDOC ## Articles XML Feed ### Description Provides an XML feed containing a list of articles, including their title, URL, content, image, keywords, and a short summary (perex). ### XML Structure ```xml
Helping E-shops Increase Revenue and Customer Satisfaction https://blog.mfgroup.cz/article/advanced-search-and-its-optimization-increases-ecommerce-revenue-and-customer-satisfaction Search Ready, we discovered and multiplied this potential in the development of the Search Ready search platform. We now advise e-shops on how they can be one step ahead of the competition and use advanced search to benefit their business goals.....]]> https://blog.mfgroup.cz/storage/app/media/Blog%20images/intro.png search, fulltext, e-shop, faceted search, filtering Advanced search and its regular optimization bring customer satisfaction and more orders. We'll advise you on how to do it.
``` ### XSD Schema ```xml ``` ### XML Element Descriptions | Element | Description | Data Type | Occurrences | |----------|--------------------------------------------------------------------------------------------------------------|-----------|-------------------| | ARTICLES | The root element containing a list of articles. | Complex Type | 1 | | ARTICLE | Represents a single article. | Complex Type | 1 or more | | TITLE | The title of the article. | String | 1 | | URL | The URL of the article. | String | 1 | | CONTENT | The main content of the article, potentially containing HTML markup (within a CDATA section). | String | 0 or 1 (optional) | | IMAGE | The URL of an image associated with the article. | String | 0 or 1 (optional) | | KEYWORDS | A comma-separated list of keywords associated with the article. | String | 0 or 1 (optional) | | PEREX | A short summary or introductory paragraph for the article (often used as a teaser). | String | 0 or 1 (optional) | ``` -------------------------------- ### Define XML Schema for Product Labels Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed This snippet defines the XML schema for product labels. The LABELS element is optional and can contain multiple LABEL elements, each of which is an optional string. ```xml ``` -------------------------------- ### Define XML Schema for Product Identification and Metadata Source: https://mediafactory.stoplight.io/docs/searchready/htg9s0d7jmohc-product-xml-feed This snippet defines various product identification and metadata elements within an XML schema. It includes optional elements for purchase price, unit, sales figures, visibility status, gift information, rating, and specific product codes like PRODUCT_CODE, EAN, SKU, and ISBN. ```xml ```