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 | null
  meta_description: string | null
  name: string
  meta_title: string | null
  sku: string
  review_count: number | null
  rating_summary: number | null
  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: {
            currency: string;
            value: number;
        };
    };
}
  stock_status: 'IN_STOCK' | 'OUT_OF_STOCK'
}

Properties

Name Type Description
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 | null

The canonical url of the route.

meta_description string | null

The meta description of the route

name string

The name of the route

meta_title string | null

The title of the route

sku string

The sku of a product.

review_count number | null

The number of reviews of a product.

rating_summary number | null

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: { currency: string; value: number; }; }; }

The price of the item.

stock_status 'IN_STOCK' | 'OUT_OF_STOCK'

The stock status of a product.