GitHub

MagentoProductRoute

import { MagentoProductRoute } from '@daffodil/external-router/driver/magento'

interface MagentoProductRoute {
  relative_url: string
  type: "PRODUCT"
  redirect_code: number
  uid: string
  canonical_url: string
  meta_description: string
  name: string
  meta_title: string
  sku: string
  review_count: number
  rating_summary: number
  image: { url: string; }
  __typename: string
  price_range: { maximum_price: { final_price: { currency: string; value: number; }; regular_price: { currency: string; value: number; }; }; minimum_price: { final_price: { currency: string; value: number; }; regular_price: { ...; }; }; }
  stock_status: "IN_STOCK" | "OUT_OF_STOCK"
}

Properties

relative_url
string

The relative path for the route.

type
"PRODUCT"

The type of route, typically PRODUCT, CATEGORY or CMS_PAGE

redirect_code
number

The HTTP code for the page.

uid
string

In v2.4.3 this became the standard field across types

canonical_url
string

The canonical url of the route.

meta_description
string

The meta description of the route

name
string

The name of the route

meta_title
string

The title of the route

sku
string

The sku of a product.

review_count
number

The number of reviews of a product.

rating_summary
number

The rating of a product.

image
{ url: string; }

The images of a product.

__typename
string

The type of route.

price_range
{ maximum_price: { final_price: { currency: string; value: number; }; regular_price: { currency: string; value: number; }; }; minimum_price: { final_price: { currency: string; value: number; }; regular_price: { ...; }; }; }

The price of the item.

stock_status
"IN_STOCK" | "OUT_OF_STOCK"

The stock status of a product.