Maginium
Admin Api
Admin Api
  • About
  • API reference
    • CustomerGroups
      • Permissions
      • Default
      • Search
    • Customers
      • Confirm
      • BillingAddress
      • ShippingAddress
      • Carts
      • Me
        • Activate
        • Password
        • BillingAddress
        • ShippingAddress
      • Search
      • Activate
      • Password
        • ResetLinkToken
      • ResetPassword
      • Validate
      • IsEmailAvailable
      • Addresses
      • Permissions
        • Readonly
    • CmsPage
      • Search
    • CmsBlock
      • Search
    • Products
      • Media
        • Types
      • Options
        • Types
      • Links
        • Types
        • Attributes
      • Websites
      • Downloadable links
        • Samples
      • Attributes
        • Options
        • Types
      • Attribute sets
        • Attributes
        • Groups
          • List
        • Sets
          • List
      • Tier prices
      • Types
      • Tier prices information
      • Tier prices delete
      • Base prices information
      • Base prices
      • Cost information
      • Cost
      • Cost delete
      • Special price information
      • Special price
      • Special price delete
      • StockItems
      • Group prices
        • Tiers
          • Price
    • Categories
      • Attributes
        • Options
      • Products
      • Move
      • List
    • StockItems
      • LowStock
        • /
    • Carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods by address id
      • Estimate shipping methods
      • Payment methods
      • Totals
      • Shipping information
      • Totals information
      • Mine
        • Items
        • Selected payment method
        • Billing address
        • Coupons
        • Payment information
        • Gift message
        • Order
        • Shipping methods
        • Estimate shipping methods by address id
        • Estimate shipping methods
        • Payment methods
        • Totals
        • Collect totals
        • Shipping information
        • Totals information
        • Set payment information
      • Licence
        • List
      • /
      • Search
    • Guest carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Payment information
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods
      • Payment methods
      • Collect totals
      • Totals
      • Shipping information
      • Totals information
      • Set payment information
    • Orders
      • Comments
      • Statuses
      • Cancel
      • Emails
      • Hold
      • Unhold
      • Items
      • Create
    • Invoices
      • Comments
      • Emails
      • Void
      • Capture
      • /
    • Creditmemo
      • Comments
      • Emails
      • Refund
    • Shipment
      • Comments
      • Emails
      • Label
      • Track
      • /
    • Transactions
    • TaxRates
      • Search
    • TaxRules
      • Search
    • TaxClasses
      • Search
    • SalesRules
      • Search
    • Coupons
      • Search
      • Generate
      • DeleteByIds
      • DeleteByCodes
    • Bulk
      • Detailed status
      • Status
      • Operation status
    • Modules
    • Search
    • Addresses
    • Products render info
    • StockStatuses
    • Creditmemos
    • Shipments
    • Amazon shipping address
    • Amazon billing address
    • Store
      • StoreViews
      • StoreGroups
      • Websites
      • StoreConfigs
    • Adobestock
      • Asset
        • Search
        • List
      • Search
    • Directory
      • Countries
      • Currency
    • Eav
      • Attribute sets
        • List
    • AttributeMetadata
      • Customer
        • Attribute
        • Form
        • Custom
      • CustomerAddress
        • Attribute
        • Form
        • Custom
    • Bundle products
      • Links
      • Options
        • Children
        • All
        • Types
        • Add
      • Children
    • Order
      • Refund
      • Ship
      • Invoice
      • Notify orders are ready for pickup
    • Configurable products
      • Children
      • Options
        • All
      • Child
      • Variation
    • Inventory
      • Sources
      • Stocks
      • Stock source links
      • Source items
      • Low quantity notification
      • Get sources assigned to stock ordered by priority
      • Stock source links delete
      • Source items delete
      • Bulk product source assign
      • Bulk product source unassign
      • Bulk product source transfer
      • Bulk partial source transfer
      • Get distance provider code
      • Get distance
      • Get latlng from address
      • Get latslngs from address
      • Export stock salable qty
      • Dump stock index data
      • Get product salable quantity
      • Is product salable
      • Are products salable
      • Is product salable for requested qty
      • Stock resolver
      • Source selection algorithm list
      • Source selection algorithm result
      • Low quantity notifications delete
      • Are product salable for requested qty
        • /
      • In store pickup
        • Pickup locations
          • /
    • Invoice
      • Refund
    • Analytics
      • Link
    • Amazon
      • Order ref
    • Applepay
      • Auth
    • Address
      • Cleanse
    • Guest address
      • Cleanse
    • Vertex address validation
      • Vertex address
    • Integration
      • Admin
        • Token
      • Customer
        • Token
Powered by GitBook
On this page
  1. API reference

Products render info

PreviousAddressesNextStockStatuses

catalog Product Render List V1Get List Get

get

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]stringOptional

Field

Example: <string>
searchCriteria[filterGroups][0][filters][0][value]stringOptional

Value

Example: <string>
searchCriteria[filterGroups][0][filters][0][conditionType]stringOptional

Condition type

Example: <string>
searchCriteria[sortOrders][0][field]stringOptional

Sorting field.

Example: <string>
searchCriteria[sortOrders][0][direction]stringOptional

Sorting direction.

Example: <string>
searchCriteria[pageSize]stringOptional

Page size.

Example: <integer>
searchCriteria[currentPage]stringOptional

Current page.

Example: <integer>
storeIdstringOptional

(Required)

Example: <integer>
currencyCodestringOptional

(Required)

Example: <string>
Responses
200
OK
application/json
Responseobject
500
Internal Server Error
application/json
get
GET /V1/products-render-info HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "items": [
    {
      "add_to_cart_button": {
        "post_data": "voluptate",
        "url": "sunt qui incididun",
        "required_options": true,
        "extension_attributes": {}
      },
      "add_to_compare_button": {
        "post_data": "in in",
        "url": "nostrud eu",
        "required_options": true,
        "extension_attributes": {}
      },
      "price_info": {
        "final_price": 49816158.86704892,
        "max_price": -19140328.48415439,
        "max_regular_price": -19197023.951550916,
        "minimal_regular_price": -38799864.92163297,
        "special_price": -9065906.522823438,
        "minimal_price": 31930627.398446187,
        "regular_price": -32223205.996452004,
        "formatted_prices": {
          "final_price": "esse nulla in",
          "max_price": "ad et aliqua Lorem",
          "minimal_price": "ut ex",
          "max_regular_price": "labore sit",
          "minimal_regular_price": "irure ex officia dolor",
          "special_price": "aliqua enim",
          "regular_price": "dolore dolor irure lab",
          "extension_attributes": {}
        },
        "extension_attributes": {
          "msrp": {
            "msrp_price": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "is_applicable": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "is_shown_price_on_gesture": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "msrp_message": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "explanation_message": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          "tax_adjustments": {
            "value": "<Circular reference to #/components/schemas/catalog-data-product-render-price-info-interface detected>"
          },
          "weee_attributes": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "weee_adjustment": "deserunt inci"
        }
      },
      "images": [
        {
          "url": "nisi eu cupidatat",
          "code": "reprehenderit",
          "height": -11849120.747301534,
          "width": 3871411.237667516,
          "label": "exercitation aliqua cillum dolor",
          "resized_width": 41451761.963478655,
          "resized_height": 54466437.537554264,
          "extension_attributes": {}
        },
        {
          "url": "deserunt proident anim",
          "code": "nostrud irure tempor",
          "height": -56730788.02418079,
          "width": -3959511.0286418945,
          "label": "elit",
          "resized_width": -50237383.28701164,
          "resized_height": -15524996.77319111,
          "extension_attributes": {}
        }
      ],
      "url": "quis se",
      "id": 48959434,
      "name": "enim ea voluptate est",
      "type": "fugiat ut dolore",
      "is_salable": "ut ea consequat minim",
      "store_id": -87915831,
      "currency_code": "consect",
      "extension_attributes": {
        "review_html": "ut aliquip",
        "wishlist_button": {
          "post_data": "laboris Ut occaecat",
          "url": "irure sed",
          "required_options": false,
          "extension_attributes": {}
        },
        "ddg_brand": "aute Duis in consequat",
        "ddg_description": "fugiat sit ex ad",
        "ddg_sku": "nulla dolore officia",
        "ddg_image": "se",
        "ddg_categories": [
          "pariatur officia eiusmod aute adipisicing",
          "non eiusmod mollit voluptate"
        ]
      }
    },
    {
      "add_to_cart_button": {
        "post_data": "dolor",
        "url": "ea amet",
        "required_options": true,
        "extension_attributes": {}
      },
      "add_to_compare_button": {
        "post_data": "amet minim cupidatat",
        "url": "qui enim",
        "required_options": false,
        "extension_attributes": {}
      },
      "price_info": {
        "final_price": -92588845.47683941,
        "max_price": 45360617.654212564,
        "max_regular_price": 61695893.423603386,
        "minimal_regular_price": -48403924.34389322,
        "special_price": -60578083.81727239,
        "minimal_price": 65467362.56213942,
        "regular_price": -61744.02085208893,
        "formatted_prices": {
          "final_price": "irure ut",
          "max_price": "nulla aliquip ullamco",
          "minimal_price": "aliquip aute non si",
          "max_regular_price": "nostrud fugiat pariatur",
          "minimal_regular_price": "ut est ex of",
          "special_price": "ex lab",
          "regular_price": "laboris officia occaecat elit ipsum",
          "extension_attributes": {}
        },
        "extension_attributes": {
          "msrp": {
            "msrp_price": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "is_applicable": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "is_shown_price_on_gesture": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "msrp_message": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "explanation_message": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          "tax_adjustments": {
            "value": "<Circular reference to #/components/schemas/catalog-data-product-render-price-info-interface detected>"
          },
          "weee_attributes": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "weee_adjustment": "qui in ullamco irure"
        }
      },
      "images": [
        {
          "url": "adipisicing",
          "code": "officia cupidatat l",
          "height": -42303409.9344211,
          "width": 93278978.01086721,
          "label": "labore ut sunt",
          "resized_width": 52636497.290858656,
          "resized_height": -75773105.41072224,
          "extension_attributes": {}
        },
        {
          "url": "Ut enim ipsum dolor laborum",
          "code": "sit deserunt ea",
          "height": 81228495.56974798,
          "width": -69466211.22040519,
          "label": "mollit m",
          "resized_width": 56421668.79012987,
          "resized_height": -97724647.41361322,
          "extension_attributes": {}
        }
      ],
      "url": "mollit do exercitation",
      "id": 4316921,
      "name": "exercitation fugiat amet",
      "type": "cupidatat",
      "is_salable": "magna culpa nulla",
      "store_id": -92237784,
      "currency_code": "ea consectetur",
      "extension_attributes": {
        "review_html": "dolore enim culpa eu",
        "wishlist_button": {
          "post_data": "m",
          "url": "in cupidatat aute adipis",
          "required_options": true,
          "extension_attributes": {}
        },
        "ddg_brand": "do et ullamco",
        "ddg_description": "anim consequat",
        "ddg_sku": "commodo",
        "ddg_image": "labore ni",
        "ddg_categories": [
          "id l",
          "tempor"
        ]
      }
    }
  ]
}