Collect and retrieve the list of product render info

GET /V1/products-render-info

Collect and retrieve the list of product render info. This info contains raw prices and formatted prices, product name, stock status, store_id, etc.

Query parameters

searchCriteria[filterGroups][0][filters][0][field] string

Field
searchCriteria[filterGroups][0][filters][0][value] string

Value
searchCriteria[filterGroups][0][filters][0][conditionType] string

Condition type
searchCriteria[sortOrders][0][field] string

Sorting field.
searchCriteria[sortOrders][0][direction] string

Sorting direction.
searchCriteria[pageSize] integer

Page size.
searchCriteria[currentPage] integer

Current page.
storeId integer Required
currencyCode string Required

Responses

200

200 Success.
Hide response attribute Show response attribute object
- items array[object] Required
  
  Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data
  
  Hide items attributes Show items attributes object
  
  add_to_cart_button object Required
  
  Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend
  
  Hide add_to_cart_button attributes Show add_to_cart_button attributes object
  
  post_data string Required
  
  Post data
  
  url string Required
  
  Url, needed to add product to cart
  
  required_options boolean Required
  
  Flag whether a product has options or not
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface
  
  add_to_compare_button object Required
  
  Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend
  
  Hide add_to_compare_button attributes Show add_to_compare_button attributes object
  
  post_data string Required
  
  Post data
  
  url string Required
  
  Url, needed to add product to cart
  
  required_options boolean Required
  
  Flag whether a product has options or not
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface
  
  price_info object Required
  
  Price interface.
  
  Hide price_info attributes Show price_info attributes object
  
  final_price number Required
  
  Final price
  
  max_price number Required
  
  Max price of a product
  
  max_regular_price number Required
  
  Max regular price
  
  minimal_regular_price number Required
  
  Minimal regular price
  
  special_price number Required
  
  Special price
  
  minimal_price number Required
  
  Minimal price
  
  regular_price number Required
  
  Regular price
  
  formatted_prices object Required
  
  Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html
  
  Hide formatted_prices attributes Show formatted_prices attributes object
  
  final_price string Required
  
  Html with final price
  
  max_price string Required
  
  Max price of a product
  
  minimal_price string Required
  
  The minimal price of the product or variation
  
  max_regular_price string Required
  
  Max regular price
  
  minimal_regular_price string Required
  
  Minimal regular price
  
  special_price string Required
  
  Special price
  
  regular_price string Required
  
  Price - is price of product without discounts and special price with taxes and fixed product tax
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  msrp object
  
  Price interface.
  
  Hide msrp attributes Show msrp attributes object
  
  msrp_price string Required
  
  is_applicable string Required
  
  is_shown_price_on_gesture string Required
  
  msrp_message string Required
  
  explanation_message string Required
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface
  
  tax_adjustments object
  
  Price interface.
  
  weee_attributes array[object]
  
  List of all weee attributes, their amounts, etc.., that product has
  
  Hide weee_attributes attributes Show weee_attributes attributes object
  
  amount string Required
  
  Weee attribute amount
  
  tax_amount string Required
  
  Tax which is calculated to fixed product tax attribute
  
  tax_amount_incl_tax string Required
  
  Tax amount of weee attribute
  
  amount_excl_tax string Required
  
  Product amount exclude tax
  
  attribute_code string Required
  
  Weee attribute code
  
  extension_attributes object Required
  
  ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface
  
  weee_adjustment string
  
  images array[object] Required
  
  Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view
  
  Hide images attributes Show images attributes object
  
  url string Required
  
  Image url
  
  code string Required
  
  Image code
  
  height number Required
  
  Image height
  
  width number Required
  
  Image width in px
  
  label string Required
  
  Image label
  
  resized_width number Required
  
  Resize width
  
  resized_height number Required
  
  Resize height
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface
  
  url string Required
  
  Product url
  
  id integer Required
  
  Product identifier
  
  name string Required
  
  Product name
  
  type string Required
  
  Product type. Such as bundle, grouped, simple, etc...
  
  is_salable string Required
  
  Information about product saleability (In Stock)
  
  store_id integer Required
  
  Information about current store id or requested store id
  
  currency_code string Required
  
  Current or desired currency code to product
  
  extension_attributes object Required
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  wishlist_button object
  
  Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend
  
  Hide wishlist_button attributes Show wishlist_button attributes object
  
  post_data string Required
  
  Post data
  
  url string Required
  
  Url, needed to add product to cart
  
  required_options boolean Required
  
  Flag whether a product has options or not
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface
  
  review_html string
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/products-render-info

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/products-render-info?storeId=42&currencyCode=string

Response examples (200)

{
  "items": [
    {
      "add_to_cart_button": {
        "post_data": "string",
        "url": "string",
        "required_options": true,
        "extension_attributes": {}
      },
      "add_to_compare_button": {
        "post_data": "string",
        "url": "string",
        "required_options": true,
        "extension_attributes": {}
      },
      "price_info": {
        "final_price": 42.0,
        "max_price": 42.0,
        "max_regular_price": 42.0,
        "minimal_regular_price": 42.0,
        "special_price": 42.0,
        "minimal_price": 42.0,
        "regular_price": 42.0,
        "formatted_prices": {
          "final_price": "string",
          "max_price": "string",
          "minimal_price": "string",
          "max_regular_price": "string",
          "minimal_regular_price": "string",
          "special_price": "string",
          "regular_price": "string",
          "extension_attributes": {}
        },
        "extension_attributes": {
          "msrp": {
            "msrp_price": "string",
            "is_applicable": "string",
            "is_shown_price_on_gesture": "string",
            "msrp_message": "string",
            "explanation_message": "string",
            "extension_attributes": {}
          },
          "tax_adjustments": {},
          "weee_attributes": [
            {
              "amount": "string",
              "tax_amount": "string",
              "tax_amount_incl_tax": "string",
              "amount_excl_tax": "string",
              "attribute_code": "string",
              "extension_attributes": {}
            }
          ],
          "weee_adjustment": "string"
        }
      },
      "images": [
        {
          "url": "string",
          "code": "string",
          "height": 42.0,
          "width": 42.0,
          "label": "string",
          "resized_width": 42.0,
          "resized_height": 42.0,
          "extension_attributes": {}
        }
      ],
      "url": "string",
      "id": 42,
      "name": "string",
      "type": "string",
      "is_salable": "string",
      "store_id": 42,
      "currency_code": "string",
      "extension_attributes": {
        "wishlist_button": {
          "post_data": "string",
          "url": "string",
          "required_options": true,
          "extension_attributes": {}
        },
        "review_html": "string"
      }
    }
  ]
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}