{page.title}
++ {`This document was last updated on ${new Intl.DateTimeFormat(undefined, { + year: 'numeric', + month: 'long', + day: 'numeric' + }).format(new Date(page.updatedAt))}.`} +
+ + ); +} diff --git a/app/api/revalidate/route.ts b/app/api/revalidate/route.ts new file mode 100644 index 000000000..94ddfff9b --- /dev/null +++ b/app/api/revalidate/route.ts @@ -0,0 +1,37 @@ +import { TAGS } from 'lib/constants'; +import { revalidateTag } from 'next/cache'; +import { headers } from 'next/headers'; +import { NextRequest, NextResponse } from 'next/server'; + +export const runtime = 'edge'; + +// We always need to respond with a 200 status code to Shopify, +// otherwise it will continue to retry the request. +export async function POST(req: NextRequest): Promise
+
+ );
+}
diff --git a/public/favicon.ico b/app/favicon.ico
similarity index 100%
rename from public/favicon.ico
rename to app/favicon.ico
diff --git a/app/globals.css b/app/globals.css
new file mode 100644
index 000000000..0a6d36768
--- /dev/null
+++ b/app/globals.css
@@ -0,0 +1,21 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+@media (prefers-color-scheme: dark) {
+ html {
+ color-scheme: dark;
+ }
+}
+
+@supports (font: -apple-system-body) and (-webkit-appearance: none) {
+ img[loading='lazy'] {
+ clip-path: inset(0.6px);
+ }
+}
+
+a,
+input,
+button {
+ @apply focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-neutral-400 focus-visible:ring-offset-2 focus-visible:ring-offset-neutral-50 dark:focus-visible:ring-neutral-600 dark:focus-visible:ring-offset-neutral-900;
+}
diff --git a/app/layout.tsx b/app/layout.tsx
new file mode 100644
index 000000000..2674f79fc
--- /dev/null
+++ b/app/layout.tsx
@@ -0,0 +1,44 @@
+import Navbar from 'components/layout/navbar';
+import { Inter } from 'next/font/google';
+import { ReactNode, Suspense } from 'react';
+import './globals.css';
+
+const { TWITTER_CREATOR, TWITTER_SITE, SITE_NAME } = process.env;
+
+export const metadata = {
+ title: {
+ default: SITE_NAME,
+ template: `%s | ${SITE_NAME}`
+ },
+ robots: {
+ follow: true,
+ index: true
+ },
+ ...(TWITTER_CREATOR &&
+ TWITTER_SITE && {
+ twitter: {
+ card: 'summary_large_image',
+ creator: TWITTER_CREATOR,
+ site: TWITTER_SITE
+ }
+ })
+};
+
+const inter = Inter({
+ subsets: ['latin'],
+ display: 'swap',
+ variable: '--font-inter'
+});
+
+export default async function RootLayout({ children }: { children: ReactNode }) {
+ return (
+
+
+ Something went wrong.
+ +
+
+
+
+
+
+
+ ({
+ src: image.url,
+ altText: image.altText
+ }))}
+ />
+
+
+
+
+
+
+ );
+}
diff --git a/app/robots.ts b/app/robots.ts
new file mode 100644
index 000000000..c9849a276
--- /dev/null
+++ b/app/robots.ts
@@ -0,0 +1,15 @@
+const baseUrl = process.env.NEXT_PUBLIC_VERCEL_URL
+ ? `https://${process.env.NEXT_PUBLIC_VERCEL_URL}`
+ : 'http://localhost:3000';
+
+export default function robots() {
+ return {
+ rules: [
+ {
+ userAgent: '*'
+ }
+ ],
+ sitemap: `${baseUrl}/sitemap.xml`,
+ host: baseUrl
+ };
+}
diff --git a/app/search/[collection]/opengraph-image.tsx b/app/search/[collection]/opengraph-image.tsx
new file mode 100644
index 000000000..9eb9c47f7
--- /dev/null
+++ b/app/search/[collection]/opengraph-image.tsx
@@ -0,0 +1,11 @@
+import OpengraphImage from 'components/opengraph-image';
+import { getCollection } from 'lib/shopify';
+
+export const runtime = 'edge';
+
+export default async function Image({ params }: { params: { collection: string } }) {
+ const collection = await getCollection(params.collection);
+ const title = collection?.seo?.title || collection?.title;
+
+ return await OpengraphImage({ title });
+}
diff --git a/app/search/[collection]/page.tsx b/app/search/[collection]/page.tsx
new file mode 100644
index 000000000..25416d544
--- /dev/null
+++ b/app/search/[collection]/page.tsx
@@ -0,0 +1,49 @@
+import { getCollection, getCollectionProducts } from 'lib/shopify';
+import { Metadata } from 'next';
+import { notFound } from 'next/navigation';
+
+import Grid from 'components/grid';
+import ProductGridItems from 'components/layout/product-grid-items';
+import { defaultSort, sorting } from 'lib/constants';
+
+export const runtime = 'edge';
+
+export async function generateMetadata({
+ params
+}: {
+ params: { collection: string };
+}): PromiseRelated Products
+
+ {relatedProducts.map((product, i) => {
+ return (
+
+
+ {`No products found in this collection`}
+ ) : ( +
+
+
+
+
+ {children}
+
+
+ + {products.length === 0 + ? 'There are no products that match ' + : `Showing ${products.length} ${resultsText} for `} + "{searchValue}" +
+ ) : null} + {products.length > 0 ? ( +
+
+ );
+}
diff --git a/components/cart/CartItem/CartItem.module.css b/components/cart/CartItem/CartItem.module.css
deleted file mode 100644
index dd43314fb..000000000
--- a/components/cart/CartItem/CartItem.module.css
+++ /dev/null
@@ -1,32 +0,0 @@
-.root {
- @apply flex flex-col py-4;
-}
-
-.root:first-child {
- padding-top: 0;
-}
-
-.quantity {
- appearance: textfield;
- @apply w-8 border-accent-2 border mx-3 rounded text-center text-sm text-black;
-}
-
-.quantity::-webkit-outer-spin-button,
-.quantity::-webkit-inner-spin-button {
- @apply appearance-none m-0;
-}
-
-.productImage {
- position: absolute;
- transform: scale(1.9);
- width: 100%;
- height: 100%;
- left: 30% !important;
- top: 30% !important;
- z-index: 1;
-}
-
-.productName {
- @apply font-medium cursor-pointer pb-1;
- margin-top: -4px;
-}
diff --git a/components/cart/CartItem/CartItem.tsx b/components/cart/CartItem/CartItem.tsx
deleted file mode 100644
index a59024e06..000000000
--- a/components/cart/CartItem/CartItem.tsx
+++ /dev/null
@@ -1,151 +0,0 @@
-import { ChangeEvent, FocusEventHandler, useEffect, useState } from 'react'
-import cn from 'classnames'
-import Image from 'next/image'
-import Link from 'next/link'
-import s from './CartItem.module.css'
-import { Trash, Plus, Minus, Cross } from '@components/icons'
-import { useUI } from '@components/ui/context'
-import type { LineItem } from '@commerce/types/cart'
-import usePrice from '@framework/product/use-price'
-import useUpdateItem from '@framework/cart/use-update-item'
-import useRemoveItem from '@framework/cart/use-remove-item'
-import Quantity from '@components/ui/Quantity'
-
-type ItemOption = {
- name: string
- nameId: number
- value: string
- valueId: number
-}
-
-const CartItem = ({
- item,
- variant = 'default',
- currencyCode,
- ...rest
-}: {
- variant?: 'default' | 'display'
- item: LineItem
- currencyCode: string
-}) => {
- const { closeSidebarIfPresent } = useUI()
- const [removing, setRemoving] = useState(false)
- const [quantity, setQuantity] = useState
+ {[...products, ...products].map((product, i) => (
+
+
+
-
- {variant === 'default' && (
-
-
- closeSidebarIfPresent()}
- className={s.productImage}
- width={150}
- height={150}
- src={item.variant.image!.url}
- alt={item.variant.image!.altText}
- unoptimized
- />
-
-
-
-
- closeSidebarIfPresent()}
- >
- {item.name}
-
-
- {options && options.length > 0 && (
-
-
- {options.map((option: ItemOption, i: number) => (
-
- )}
- {variant === 'display' && (
-
- {option.name}
- {option.name === 'Color' ? (
-
- ) : (
-
- {option.value}
-
- )}
- {i === options.length - 1 ? '' : }
-
- ))}
- {quantity}x
- )}
-
- {price}
-
-
-
-
- ) : error ? (
- - Your cart is empty -
-- Biscuit oat cake wafer icing ice cream tiramisu pudding cupcake. -
-
-
-
- ) : success ? (
- - We couldn’t process the purchase. Please check your card information - and try again. -
-
-
-
- ) : (
- <>
- - Thank you for your order. -
-
-
-
- My Cart
-
-
-
-
- -
- {data!.lineItems.map((item: any) => (
-
-
-
- )}
- -
-
- - Subtotal - {subTotal} - -
- - Taxes - Calculated at checkout - -
- - Shipping - FREE - -
- Total
- {total}
-
-
- {process.env.COMMERCE_CUSTOMCHECKOUT_ENABLED ? (
-
- ) : (
-
- )}
-
-
+
+ );
+}
diff --git a/components/cart/delete-item-button.tsx b/components/cart/delete-item-button.tsx
new file mode 100644
index 000000000..f279f178d
--- /dev/null
+++ b/components/cart/delete-item-button.tsx
@@ -0,0 +1,44 @@
+import { XMarkIcon } from '@heroicons/react/24/outline';
+import LoadingDots from 'components/loading-dots';
+import { useRouter } from 'next/navigation';
+
+import clsx from 'clsx';
+import { removeItem } from 'components/cart/actions';
+import type { CartItem } from 'lib/shopify/types';
+import { useTransition } from 'react';
+
+export default function DeleteItemButton({ item }: { item: CartItem }) {
+ const router = useRouter();
+ const [isPending, startTransition] = useTransition();
+
+ return (
+
+ );
+}
diff --git a/components/cart/edit-item-quantity-button.tsx b/components/cart/edit-item-quantity-button.tsx
new file mode 100644
index 000000000..8b1553f73
--- /dev/null
+++ b/components/cart/edit-item-quantity-button.tsx
@@ -0,0 +1,60 @@
+import { useRouter } from 'next/navigation';
+import { useTransition } from 'react';
+
+import { MinusIcon, PlusIcon } from '@heroicons/react/24/outline';
+import clsx from 'clsx';
+import { removeItem, updateItemQuantity } from 'components/cart/actions';
+import LoadingDots from 'components/loading-dots';
+import type { CartItem } from 'lib/shopify/types';
+
+export default function EditItemQuantityButton({
+ item,
+ type
+}: {
+ item: CartItem;
+ type: 'plus' | 'minus';
+}) {
+ const router = useRouter();
+ const [isPending, startTransition] = useTransition();
+
+ return (
+
+ );
+}
diff --git a/components/cart/index.ts b/components/cart/index.ts
deleted file mode 100644
index 3e53fa34a..000000000
--- a/components/cart/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export { default as CartSidebarView } from './CartSidebarView'
-export { default as CartItem } from './CartItem'
diff --git a/components/cart/index.tsx b/components/cart/index.tsx
new file mode 100644
index 000000000..3e250ba93
--- /dev/null
+++ b/components/cart/index.tsx
@@ -0,0 +1,14 @@
+import { getCart } from 'lib/shopify';
+import { cookies } from 'next/headers';
+import CartModal from './modal';
+
+export default async function Cart() {
+ const cartId = cookies().get('cartId')?.value;
+ let cart;
+
+ if (cartId) {
+ cart = await getCart(cartId);
+ }
+
+ return
+
+ );
+}
diff --git a/components/checkout/CheckoutSidebarView/CheckoutSidebarView.module.css b/components/checkout/CheckoutSidebarView/CheckoutSidebarView.module.css
deleted file mode 100644
index 34c1b487c..000000000
--- a/components/checkout/CheckoutSidebarView/CheckoutSidebarView.module.css
+++ /dev/null
@@ -1,7 +0,0 @@
-.root {
- min-height: calc(100vh - 322px);
-}
-
-.lineItemsList {
- @apply py-4 space-y-6 sm:py-0 sm:space-y-0 sm:divide-y sm:divide-accent-2 border-accent-2;
-}
diff --git a/components/checkout/CheckoutSidebarView/CheckoutSidebarView.tsx b/components/checkout/CheckoutSidebarView/CheckoutSidebarView.tsx
deleted file mode 100644
index fb562e7af..000000000
--- a/components/checkout/CheckoutSidebarView/CheckoutSidebarView.tsx
+++ /dev/null
@@ -1,89 +0,0 @@
-import cn from 'classnames'
-import Link from 'next/link'
-import { FC } from 'react'
-import CartItem from '@components/cart/CartItem'
-import { Button, Text } from '@components/ui'
-import { useUI } from '@components/ui/context'
-import useCart from '@framework/cart/use-cart'
-import usePrice from '@framework/product/use-price'
-import ShippingWidget from '../ShippingWidget'
-import PaymentWidget from '../PaymentWidget'
-import SidebarLayout from '@components/common/SidebarLayout'
-import s from './CheckoutSidebarView.module.css'
-
-const CheckoutSidebarView: FC = () => {
- const { setSidebarView } = useUI()
- const { data } = useCart()
-
- const { price: subTotal } = usePrice(
- data && {
- amount: Number(data.subtotalPrice),
- currencyCode: data.currency.code,
- }
- )
- const { price: total } = usePrice(
- data && {
- amount: Number(data.totalPrice),
- currencyCode: data.currency.code,
- }
- )
-
- return (
-
+ {quantity}
+
+ ) : null}
+
-
- Checkout
-
-
- setSidebarView('PAYMENT_VIEW')} />
- setSidebarView('SHIPPING_VIEW')} />
-
-
-
- -
- {data!.lineItems.map((item: any) => (
-
-
- -
-
- - Subtotal - {subTotal} - -
- - Taxes - Calculated at checkout - -
- - Shipping - FREE - -
- Total
- {total}
-
-
- {/* Once data is correcly filled */}
- {/* */}
-
-
-
- Payment Method
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- )
-}
-
-export default PaymentWidget
diff --git a/components/checkout/PaymentWidget/index.ts b/components/checkout/PaymentWidget/index.ts
deleted file mode 100644
index 18cadea57..000000000
--- a/components/checkout/PaymentWidget/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './PaymentWidget'
diff --git a/components/checkout/ShippingView/ShippingView.module.css b/components/checkout/ShippingView/ShippingView.module.css
deleted file mode 100644
index 157d3174e..000000000
--- a/components/checkout/ShippingView/ShippingView.module.css
+++ /dev/null
@@ -1,21 +0,0 @@
-.fieldset {
- @apply flex flex-col my-3;
-}
-
-.fieldset .label {
- @apply text-accent-7 uppercase text-xs font-medium mb-2;
-}
-
-.fieldset .input,
-.fieldset .select {
- @apply p-2 border border-accent-2 w-full text-sm font-normal;
-}
-
-.fieldset .input:focus,
-.fieldset .select:focus {
- @apply outline-none shadow-outline-normal;
-}
-
-.radio {
- @apply bg-black;
-}
diff --git a/components/checkout/ShippingView/ShippingView.tsx b/components/checkout/ShippingView/ShippingView.tsx
deleted file mode 100644
index 1d03a2aac..000000000
--- a/components/checkout/ShippingView/ShippingView.tsx
+++ /dev/null
@@ -1,78 +0,0 @@
-import { FC } from 'react'
-import cn from 'classnames'
-import s from './ShippingView.module.css'
-import Button from '@components/ui/Button'
-import { useUI } from '@components/ui/context'
-import SidebarLayout from '@components/common/SidebarLayout'
-
-const PaymentMethodView: FC = () => {
- const { setSidebarView } = useUI()
-
- return (
-
-
-
-
-
-
- - Shipping -
-
-
-
-
-
- Same as billing address
-
-
-
-
- Use a different shipping address
-
-
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- )
-}
-
-export default ShippingWidget
diff --git a/components/checkout/ShippingWidget/index.ts b/components/checkout/ShippingWidget/index.ts
deleted file mode 100644
index 88e6dca4b..000000000
--- a/components/checkout/ShippingWidget/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './ShippingWidget'
diff --git a/components/common/Avatar/Avatar.tsx b/components/common/Avatar/Avatar.tsx
deleted file mode 100644
index 663538450..000000000
--- a/components/common/Avatar/Avatar.tsx
+++ /dev/null
@@ -1,24 +0,0 @@
-import { FC, useRef, useEffect } from 'react'
-import { useUserAvatar } from '@lib/hooks/useUserAvatar'
-
-interface Props {
- className?: string
- children?: any
-}
-
-const Avatar: FC
-
- San Franssisco, California - */} -
- - San Franssisco, California - */} -
-
-
- {/* Add an image - We're generating a gradient as placeholder ![]()
*/}
-
- )
-}
-
-export default Avatar
diff --git a/components/common/Avatar/index.ts b/components/common/Avatar/index.ts
deleted file mode 100644
index a4600ec77..000000000
--- a/components/common/Avatar/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './Avatar'
diff --git a/components/common/FeatureBar/FeatureBar.module.css b/components/common/FeatureBar/FeatureBar.module.css
deleted file mode 100644
index a3cb61cd2..000000000
--- a/components/common/FeatureBar/FeatureBar.module.css
+++ /dev/null
@@ -1,7 +0,0 @@
-.root {
- @apply text-center p-6 bg-primary text-sm flex-row justify-center items-center font-medium fixed bottom-0 w-full z-30 transition-all duration-300 ease-out;
-
- @screen md {
- @apply flex text-left;
- }
-}
diff --git a/components/common/FeatureBar/FeatureBar.tsx b/components/common/FeatureBar/FeatureBar.tsx
deleted file mode 100644
index 8923a721e..000000000
--- a/components/common/FeatureBar/FeatureBar.tsx
+++ /dev/null
@@ -1,39 +0,0 @@
-import cn from 'classnames'
-import s from './FeatureBar.module.css'
-
-interface FeatureBarProps {
- className?: string
- title: string
- description?: string
- hide?: boolean
- action?: React.ReactNode
-}
-
-const FeatureBar: React.FC
- {title}
-
- {description}
-
- {action && action}
-
- )
-}
-
-export default FeatureBar
diff --git a/components/common/FeatureBar/index.ts b/components/common/FeatureBar/index.ts
deleted file mode 100644
index d78bc9d20..000000000
--- a/components/common/FeatureBar/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './FeatureBar'
diff --git a/components/common/Footer/Footer.module.css b/components/common/Footer/Footer.module.css
deleted file mode 100644
index 2ba492086..000000000
--- a/components/common/Footer/Footer.module.css
+++ /dev/null
@@ -1,13 +0,0 @@
-.root {
- @apply border-t border-accent-2;
-}
-
-.link {
- & > svg {
- @apply transform duration-75 ease-linear;
- }
-
- &:hover > svg {
- @apply scale-110;
- }
-}
diff --git a/components/common/Footer/Footer.tsx b/components/common/Footer/Footer.tsx
deleted file mode 100644
index 04b80404e..000000000
--- a/components/common/Footer/Footer.tsx
+++ /dev/null
@@ -1,117 +0,0 @@
-import { FC } from 'react'
-import cn from 'classnames'
-import Link from 'next/link'
-import { useRouter } from 'next/router'
-import type { Page } from '@commerce/types/page'
-import getSlug from '@lib/get-slug'
-import { Github, Vercel } from '@components/icons'
-import { Logo, Container } from '@components/ui'
-import { I18nWidget } from '@components/common'
-import s from './Footer.module.css'
-
-interface Props {
- className?: string
- children?: any
- pages?: Page[]
-}
-
-const links = [
- {
- name: 'Home',
- url: '/',
- },
-]
-
-const Footer: FC
-
- )
-}
-
-export default HomeAllProductsGrid
diff --git a/components/common/HomeAllProductsGrid/index.ts b/components/common/HomeAllProductsGrid/index.ts
deleted file mode 100644
index 31d313d16..000000000
--- a/components/common/HomeAllProductsGrid/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './HomeAllProductsGrid'
diff --git a/components/common/I18nWidget/I18nWidget.module.css b/components/common/I18nWidget/I18nWidget.module.css
deleted file mode 100644
index 269aa5f61..000000000
--- a/components/common/I18nWidget/I18nWidget.module.css
+++ /dev/null
@@ -1,46 +0,0 @@
-.root {
- @apply relative;
-}
-
-.button {
- @apply h-10 px-2 rounded-md border border-accent-2 flex items-center justify-center transition-colors ease-linear;
-}
-
-.button:hover {
- @apply border-accent-3 shadow-sm;
-}
-
-.button:focus {
- @apply outline-none;
-}
-
-.dropdownMenu {
- @apply fixed right-0 top-12 mt-2 origin-top-right outline-none bg-primary z-40 w-full h-full;
-
- @screen lg {
- @apply absolute border border-accent-1 shadow-lg w-56 h-auto;
- }
-}
-
-.closeButton {
- @screen md {
- @apply hidden;
- }
-}
-
-.item {
- @apply flex cursor-pointer px-6 py-3 transition ease-in-out duration-150 text-primary leading-6 font-medium items-center;
- text-transform: capitalize;
-}
-
-.item:hover {
- @apply bg-accent-1;
-}
-
-.icon {
- transition: transform 0.2s ease;
-}
-
-.icon.active {
- transform: rotate(180deg);
-}
diff --git a/components/common/I18nWidget/I18nWidget.tsx b/components/common/I18nWidget/I18nWidget.tsx
deleted file mode 100644
index 58135f12a..000000000
--- a/components/common/I18nWidget/I18nWidget.tsx
+++ /dev/null
@@ -1,101 +0,0 @@
-import cn from 'classnames'
-import Link from 'next/link'
-import { FC, useState } from 'react'
-import { useRouter } from 'next/router'
-import s from './I18nWidget.module.css'
-import { Cross, ChevronUp } from '@components/icons'
-import ClickOutside from '@lib/click-outside'
-interface LOCALE_DATA {
- name: string
- img: {
- filename: string
- alt: string
- }
-}
-
-const LOCALES_MAP: Record
-
-
-
- -
-
- - - All Categories - - - {categories.map((cat: any) => ( -
- - - {cat.name} - - - ))} -
-
-
- - - All Designers - - - {brands.flatMap(({ node }: any) => ( -
- - - {node.name} - - - ))} -
-
- {products.map((product) => (
-
-
-
-
-)
-
-const dynamicProps = {
- loading: () =>
- {children}
-
- onAcceptCookies()}>
- Accept cookies
-
- }
- />
-
-
-
-
- {children}
-
- )
-}
-
-export default NavbarRoot
diff --git a/components/common/Navbar/index.ts b/components/common/Navbar/index.ts
deleted file mode 100644
index e6400ae40..000000000
--- a/components/common/Navbar/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './Navbar'
diff --git a/components/common/Searchbar/Searchbar.module.css b/components/common/Searchbar/Searchbar.module.css
deleted file mode 100644
index 7f20ed973..000000000
--- a/components/common/Searchbar/Searchbar.module.css
+++ /dev/null
@@ -1,29 +0,0 @@
-.root {
- @apply relative text-sm bg-accent-0 text-base w-full transition-colors duration-150 border border-accent-2;
-}
-
-.input {
- @apply bg-transparent px-3 py-2 appearance-none w-full transition duration-150 ease-in-out pr-10;
-}
-
-.input::placeholder {
- @apply text-accent-3;
-}
-
-.input:focus {
- @apply outline-none shadow-outline-normal;
-}
-
-.iconContainer {
- @apply absolute inset-y-0 right-0 pr-3 flex items-center pointer-events-none;
-}
-
-.icon {
- @apply h-5 w-5;
-}
-
-@screen sm {
- .input {
- min-width: 300px;
- }
-}
diff --git a/components/common/Searchbar/Searchbar.tsx b/components/common/Searchbar/Searchbar.tsx
deleted file mode 100644
index 0fc276d02..000000000
--- a/components/common/Searchbar/Searchbar.tsx
+++ /dev/null
@@ -1,63 +0,0 @@
-import { FC, InputHTMLAttributes, useEffect, useMemo } from 'react'
-import cn from 'classnames'
-import s from './Searchbar.module.css'
-import { useRouter } from 'next/router'
-
-interface Props {
- className?: string
- id?: string
-}
-
-const Searchbar: FC
-
-
-
- ),
- []
- )
-}
-
-export default Searchbar
diff --git a/components/common/Searchbar/index.ts b/components/common/Searchbar/index.ts
deleted file mode 100644
index e6c0e36c8..000000000
--- a/components/common/Searchbar/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './Searchbar'
diff --git a/components/common/SidebarLayout/SidebarLayout.module.css b/components/common/SidebarLayout/SidebarLayout.module.css
deleted file mode 100644
index a8940dc52..000000000
--- a/components/common/SidebarLayout/SidebarLayout.module.css
+++ /dev/null
@@ -1,20 +0,0 @@
-.root {
- @apply relative h-full flex flex-col;
-}
-
-.header {
- @apply sticky top-0 pl-4 py-4 pr-6
- flex items-center justify-between
- bg-accent-0 box-border w-full z-10;
- min-height: 66px;
-}
-
-.container {
- @apply flex flex-col flex-1 box-border;
-}
-
-@screen lg {
- .header {
- min-height: 74px;
- }
-}
diff --git a/components/common/SidebarLayout/SidebarLayout.tsx b/components/common/SidebarLayout/SidebarLayout.tsx
deleted file mode 100644
index a4e60a758..000000000
--- a/components/common/SidebarLayout/SidebarLayout.tsx
+++ /dev/null
@@ -1,50 +0,0 @@
-import React, { FC } from 'react'
-import { Cross, ChevronLeft } from '@components/icons'
-import { UserNav } from '@components/common'
-import cn from 'classnames'
-import s from './SidebarLayout.module.css'
-
-type ComponentProps = { className?: string } & (
- | { handleClose: () => any; handleBack?: never }
- | { handleBack: () => any; handleClose?: never }
-)
-
-const SidebarLayout: FC
-
-
-
-
- {handleClose && (
-
- )}
- {handleBack && (
-
- )}
-
-
-
- )
-}
-
-export default SidebarLayout
diff --git a/components/common/SidebarLayout/index.ts b/components/common/SidebarLayout/index.ts
deleted file mode 100644
index 45ded0cf0..000000000
--- a/components/common/SidebarLayout/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './SidebarLayout'
diff --git a/components/common/UserNav/DropdownMenu.module.css b/components/common/UserNav/DropdownMenu.module.css
deleted file mode 100644
index d6b13ecb5..000000000
--- a/components/common/UserNav/DropdownMenu.module.css
+++ /dev/null
@@ -1,24 +0,0 @@
-.dropdownMenu {
- @apply fixed right-0 mt-2 origin-top-right outline-none bg-primary z-40 w-full h-full;
-
- @screen lg {
- @apply absolute top-10 border border-accent-1 shadow-lg w-56 h-auto;
- }
-}
-
-.link {
- @apply text-primary flex cursor-pointer px-6 py-3 flex transition ease-in-out duration-150 leading-6 font-medium items-center;
- text-transform: capitalize;
-}
-
-.link:hover {
- @apply bg-accent-1;
-}
-
-.link.active {
- @apply font-bold bg-accent-2;
-}
-
-.off {
- @apply hidden;
-}
diff --git a/components/common/UserNav/DropdownMenu.tsx b/components/common/UserNav/DropdownMenu.tsx
deleted file mode 100644
index f79fd5821..000000000
--- a/components/common/UserNav/DropdownMenu.tsx
+++ /dev/null
@@ -1,125 +0,0 @@
-import cn from 'classnames'
-import Link from 'next/link'
-import { FC, useRef, useState, useEffect } from 'react'
-import { useTheme } from 'next-themes'
-import { useRouter } from 'next/router'
-import s from './DropdownMenu.module.css'
-import { Avatar } from '@components/common'
-import { Moon, Sun } from '@components/icons'
-import { useUI } from '@components/ui/context'
-import ClickOutside from '@lib/click-outside'
-import useLogout from '@framework/auth/use-logout'
-
-import {
- disableBodyScroll,
- enableBodyScroll,
- clearAllBodyScrollLocks,
-} from 'body-scroll-lock'
-
-interface DropdownMenuProps {
- open?: boolean
-}
-
-const LINKS = [
- {
- name: 'My Orders',
- href: '/orders',
- },
- {
- name: 'My Profile',
- href: '/profile',
- },
- {
- name: 'My Cart',
- href: '/cart',
- },
-]
-
-const DropdownMenu: FC{children}
-
-
- {display && (
-
- -
- {LINKS.map(({ name, href }) => (
-
- - - - ))} -
-
- {
- theme === 'dark' ? setTheme('light') : setTheme('dark')
- setDisplay(false)
- }}
- >
- - Theme: {theme}{' '} --- {theme == 'dark' ? ( -- -
- ) : ( - - )} -
- - - logout()} - > - Logout - - -
-
+ {props.children}
+
+
+
+ );
+}
+
+export async function ThreeItemGrid() {
+ // Collections that start with `hidden-*` are hidden from the search page.
+ const homepageItems = await getCollectionProducts({
+ collection: 'hidden-homepage-featured-items'
+ });
+
+ if (!homepageItems[0] || !homepageItems[1] || !homepageItems[2]) return null;
+
+ const [firstProduct, secondProduct, thirdProduct] = homepageItems;
+
+ return (
+
+ {props.src ? (
+ // eslint-disable-next-line jsx-a11y/alt-text -- `alt` is inherited from `props`, which is being enforced with TypeScript
+
+ );
+}
diff --git a/components/icons/ArrowLeft.tsx b/components/icons/ArrowLeft.tsx
deleted file mode 100644
index 8cc1e1294..000000000
--- a/components/icons/ArrowLeft.tsx
+++ /dev/null
@@ -1,27 +0,0 @@
-const ArrowLeft = ({ ...props }) => {
- return (
-
- )
-}
-
-export default ArrowLeft
diff --git a/components/icons/ArrowRight.tsx b/components/icons/ArrowRight.tsx
deleted file mode 100644
index e644951d9..000000000
--- a/components/icons/ArrowRight.tsx
+++ /dev/null
@@ -1,28 +0,0 @@
-const ArrowRight = ({ ...props }) => {
- return (
-
- )
-}
-
-export default ArrowRight
diff --git a/components/icons/Bag.tsx b/components/icons/Bag.tsx
deleted file mode 100644
index de2cde0d1..000000000
--- a/components/icons/Bag.tsx
+++ /dev/null
@@ -1,33 +0,0 @@
-const Bag = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Bag
diff --git a/components/icons/Check.tsx b/components/icons/Check.tsx
deleted file mode 100644
index 89c91a1e3..000000000
--- a/components/icons/Check.tsx
+++ /dev/null
@@ -1,21 +0,0 @@
-const Check = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Check
diff --git a/components/icons/ChevronDown.tsx b/components/icons/ChevronDown.tsx
deleted file mode 100644
index 542e8056d..000000000
--- a/components/icons/ChevronDown.tsx
+++ /dev/null
@@ -1,20 +0,0 @@
-const ChevronDown = ({ ...props }) => {
- return (
-
- )
-}
-
-export default ChevronDown
diff --git a/components/icons/ChevronLeft.tsx b/components/icons/ChevronLeft.tsx
deleted file mode 100644
index 4efb6a522..000000000
--- a/components/icons/ChevronLeft.tsx
+++ /dev/null
@@ -1,20 +0,0 @@
-const ChevronLeft = ({ ...props }) => {
- return (
-
- )
-}
-
-export default ChevronLeft
diff --git a/components/icons/ChevronRight.tsx b/components/icons/ChevronRight.tsx
deleted file mode 100644
index d72b77a32..000000000
--- a/components/icons/ChevronRight.tsx
+++ /dev/null
@@ -1,20 +0,0 @@
-const ChevronUp = ({ ...props }) => {
- return (
-
- )
-}
-
-export default ChevronUp
diff --git a/components/icons/ChevronUp.tsx b/components/icons/ChevronUp.tsx
deleted file mode 100644
index 69b9959b8..000000000
--- a/components/icons/ChevronUp.tsx
+++ /dev/null
@@ -1,20 +0,0 @@
-const ChevronUp = ({ ...props }) => {
- return (
-
- )
-}
-
-export default ChevronUp
diff --git a/components/icons/CreditCard.tsx b/components/icons/CreditCard.tsx
deleted file mode 100644
index 958c31193..000000000
--- a/components/icons/CreditCard.tsx
+++ /dev/null
@@ -1,21 +0,0 @@
-const CreditCard = ({ ...props }) => {
- return (
-
- )
-}
-
-export default CreditCard
diff --git a/components/icons/Cross.tsx b/components/icons/Cross.tsx
deleted file mode 100644
index 12e115ac9..000000000
--- a/components/icons/Cross.tsx
+++ /dev/null
@@ -1,21 +0,0 @@
-const Cross = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Cross
diff --git a/components/icons/DoubleChevron.tsx b/components/icons/DoubleChevron.tsx
deleted file mode 100644
index 198c30464..000000000
--- a/components/icons/DoubleChevron.tsx
+++ /dev/null
@@ -1,22 +0,0 @@
-const DoubleChevron = ({ ...props }) => {
- return (
-
- )
-}
-
-export default DoubleChevron
diff --git a/components/icons/Github.tsx b/components/icons/Github.tsx
deleted file mode 100644
index 1195a3c3a..000000000
--- a/components/icons/Github.tsx
+++ /dev/null
@@ -1,20 +0,0 @@
-const Github = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Github
diff --git a/components/icons/Heart.tsx b/components/icons/Heart.tsx
deleted file mode 100644
index afa2f6aaa..000000000
--- a/components/icons/Heart.tsx
+++ /dev/null
@@ -1,22 +0,0 @@
-const Heart = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Heart
diff --git a/components/icons/Info.tsx b/components/icons/Info.tsx
deleted file mode 100644
index 67c79cf27..000000000
--- a/components/icons/Info.tsx
+++ /dev/null
@@ -1,22 +0,0 @@
-const Info = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Info
diff --git a/components/icons/MapPin.tsx b/components/icons/MapPin.tsx
deleted file mode 100644
index 6323b9c1c..000000000
--- a/components/icons/MapPin.tsx
+++ /dev/null
@@ -1,20 +0,0 @@
-const MapPin = ({ ...props }) => {
- return (
-
- )
-}
-
-export default MapPin
diff --git a/components/icons/Minus.tsx b/components/icons/Minus.tsx
deleted file mode 100644
index 1e9411dda..000000000
--- a/components/icons/Minus.tsx
+++ /dev/null
@@ -1,15 +0,0 @@
-const Minus = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Minus
diff --git a/components/icons/Moon.tsx b/components/icons/Moon.tsx
deleted file mode 100644
index e02f2a30d..000000000
--- a/components/icons/Moon.tsx
+++ /dev/null
@@ -1,20 +0,0 @@
-const Moon = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Moon
diff --git a/components/icons/Plus.tsx b/components/icons/Plus.tsx
deleted file mode 100644
index ad030b92e..000000000
--- a/components/icons/Plus.tsx
+++ /dev/null
@@ -1,22 +0,0 @@
-const Plus = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Plus
diff --git a/components/icons/Star.tsx b/components/icons/Star.tsx
deleted file mode 100644
index d98f55e1d..000000000
--- a/components/icons/Star.tsx
+++ /dev/null
@@ -1,16 +0,0 @@
-const Star = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Star
diff --git a/components/icons/Sun.tsx b/components/icons/Sun.tsx
deleted file mode 100644
index d3684bcb9..000000000
--- a/components/icons/Sun.tsx
+++ /dev/null
@@ -1,28 +0,0 @@
-const Sun = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Sun
diff --git a/components/icons/Trash.tsx b/components/icons/Trash.tsx
deleted file mode 100644
index b005ea892..000000000
--- a/components/icons/Trash.tsx
+++ /dev/null
@@ -1,43 +0,0 @@
-const Trash = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Trash
diff --git a/components/icons/Vercel.tsx b/components/icons/Vercel.tsx
deleted file mode 100644
index 96e619fdf..000000000
--- a/components/icons/Vercel.tsx
+++ /dev/null
@@ -1,40 +0,0 @@
-const Vercel = ({ ...props }) => {
- return (
-
- )
-}
-
-export default Vercel
diff --git a/components/icons/github.tsx b/components/icons/github.tsx
new file mode 100644
index 000000000..e74d90722
--- /dev/null
+++ b/components/icons/github.tsx
@@ -0,0 +1,13 @@
+export default function GitHubIcon({ className }: { className?: string }) {
+ return (
+
+ );
+}
diff --git a/components/icons/index.ts b/components/icons/index.ts
deleted file mode 100644
index 97eef6d58..000000000
--- a/components/icons/index.ts
+++ /dev/null
@@ -1,22 +0,0 @@
-export { default as Bag } from './Bag'
-export { default as Heart } from './Heart'
-export { default as Trash } from './Trash'
-export { default as Cross } from './Cross'
-export { default as Plus } from './Plus'
-export { default as Minus } from './Minus'
-export { default as Check } from './Check'
-export { default as Sun } from './Sun'
-export { default as Moon } from './Moon'
-export { default as Github } from './Github'
-export { default as Info } from './Info'
-export { default as Vercel } from './Vercel'
-export { default as MapPin } from './MapPin'
-export { default as Star } from './Star'
-export { default as ArrowLeft } from './ArrowLeft'
-export { default as ArrowRight } from './ArrowRight'
-export { default as CreditCard } from './CreditCard'
-export { default as ChevronUp } from './ChevronUp'
-export { default as ChevronLeft } from './ChevronLeft'
-export { default as ChevronDown } from './ChevronDown'
-export { default as ChevronRight } from './ChevronRight'
-export { default as DoubleChevron } from './DoubleChevron'
diff --git a/components/icons/logo.tsx b/components/icons/logo.tsx
new file mode 100644
index 000000000..46fa02464
--- /dev/null
+++ b/components/icons/logo.tsx
@@ -0,0 +1,16 @@
+import clsx from 'clsx';
+
+export default function LogoIcon(props: React.ComponentProps<'svg'>) {
+ return (
+
+ );
+}
diff --git a/components/label.tsx b/components/label.tsx
new file mode 100644
index 000000000..e49efce40
--- /dev/null
+++ b/components/label.tsx
@@ -0,0 +1,34 @@
+import clsx from 'clsx';
+import Price from './price';
+
+const Label = ({
+ title,
+ amount,
+ currencyCode,
+ position = 'bottom'
+}: {
+ title: string;
+ amount: string;
+ currencyCode: string;
+ position?: 'bottom' | 'center';
+}) => {
+ return (
+
+
+ );
+};
+
+export default Label;
diff --git a/components/layout/footer-menu.tsx b/components/layout/footer-menu.tsx
new file mode 100644
index 000000000..696f61fc0
--- /dev/null
+++ b/components/layout/footer-menu.tsx
@@ -0,0 +1,46 @@
+'use client';
+
+import clsx from 'clsx';
+import { Menu } from 'lib/shopify/types';
+import Link from 'next/link';
+import { usePathname } from 'next/navigation';
+import { useEffect, useState } from 'react';
+
+const FooterMenuItem = ({ item }: { item: Menu }) => {
+ const pathname = usePathname();
+ const [active, setActive] = useState(pathname === item.path);
+
+ useEffect(() => {
+ setActive(pathname === item.path);
+ }, [pathname, item.path]);
+
+ return (
+
+
+ {title}
+
+
+ );
+}
diff --git a/components/layout/search/filter/index.tsx b/components/layout/search/filter/index.tsx
new file mode 100644
index 000000000..ac5002d68
--- /dev/null
+++ b/components/layout/search/filter/index.tsx
@@ -0,0 +1,32 @@
+import { SortFilterItem } from 'lib/constants';
+import FilterItemDropdown from './dropdown';
+import { FilterItem } from './item';
+
+export type ListItem = SortFilterItem | PathFilterItem;
+export type PathFilterItem = { title: string; path: string };
+
+function FilterItemList({ list }: { list: ListItem[] }) {
+ return (
+ <>
+ {list.map((item: ListItem, i) => (
+ {
+ setOpenSelect(!openSelect);
+ }}
+ className="flex w-full items-center justify-between rounded border border-black/30 px-4 py-2 text-sm dark:border-white/30"
+ >
+
+ {openSelect && (
+ {active}
+ {
+ setOpenSelect(false);
+ }}
+ className="absolute z-40 w-full rounded-b-md bg-white p-4 shadow-md dark:bg-black"
+ >
+ {list.map((item: ListItem, i) => (
+
+ )}
+
+
+ );
+}
diff --git a/components/opengraph-image.tsx b/components/opengraph-image.tsx
new file mode 100644
index 000000000..17592bca8
--- /dev/null
+++ b/components/opengraph-image.tsx
@@ -0,0 +1,40 @@
+import { ImageResponse } from 'next/server';
+import LogoIcon from './icons/logo';
+
+export type Props = {
+ title?: string;
+};
+
+export default async function OpengraphImage(props?: Props): Promise
+
+ ),
+ {
+ width: 1200,
+ height: 630,
+ fonts: [
+ {
+ name: 'Inter',
+ data: await fetch(new URL('../fonts/Inter-Bold.ttf', import.meta.url)).then((res) =>
+ res.arrayBuffer()
+ ),
+ style: 'normal',
+ weight: 700
+ }
+ ]
+ }
+ );
+}
diff --git a/components/price.tsx b/components/price.tsx
new file mode 100644
index 000000000..e7090148d
--- /dev/null
+++ b/components/price.tsx
@@ -0,0 +1,24 @@
+import clsx from 'clsx';
+
+const Price = ({
+ amount,
+ className,
+ currencyCode = 'USD',
+ currencyCodeClassName
+}: {
+ amount: string;
+ className?: string;
+ currencyCode: string;
+ currencyCodeClassName?: string;
+} & React.ComponentProps<'p'>) => (
+
+
+ {title}
++ {`${new Intl.NumberFormat(undefined, { + style: 'currency', + currency: currencyCode, + currencyDisplay: 'narrowSymbol' + }).format(parseFloat(amount))}`} + {`${currencyCode}`} +
+); + +export default Price; diff --git a/components/product/ProductCard/ProductCard.module.css b/components/product/ProductCard/ProductCard.module.css deleted file mode 100644 index d5d441fea..000000000 --- a/components/product/ProductCard/ProductCard.module.css +++ /dev/null @@ -1,114 +0,0 @@ -.root { - @apply relative max-h-full w-full box-border overflow-hidden - bg-no-repeat bg-center bg-cover transition-transform - ease-linear cursor-pointer inline-block bg-accent-1; - height: 100% !important; -} - -.root:hover { - & .productImage { - transform: scale(1.2625); - } - - & .header .name span, - & .header .price, - & .wishlistButton { - @apply bg-secondary text-secondary; - } - - &:nth-child(6n + 1) .header .name span, - &:nth-child(6n + 1) .header .price, - &:nth-child(6n + 1) .wishlistButton { - @apply bg-violet text-white; - } - - &:nth-child(6n + 5) .header .name span, - &:nth-child(6n + 5) .header .price, - &:nth-child(6n + 5) .wishlistButton { - @apply bg-blue text-white; - } - - &:nth-child(6n + 3) .header .name span, - &:nth-child(6n + 3) .header .price, - &:nth-child(6n + 3) .wishlistButton { - @apply bg-pink text-white; - } - - &:nth-child(6n + 6) .header .name span, - &:nth-child(6n + 6) .header .price, - &:nth-child(6n + 6) .wishlistButton { - @apply bg-cyan text-white; - } -} - -.header { - @apply transition-colors ease-in-out duration-500 - absolute top-0 left-0 z-20 pr-16; -} - -.header .name { - @apply pt-0 max-w-full w-full leading-extra-loose - transition-colors ease-in-out duration-500; - font-size: 2rem; - letter-spacing: 0.4px; -} - -.header .name span { - @apply py-4 px-6 bg-primary text-primary font-bold - transition-colors ease-in-out duration-500; - font-size: inherit; - letter-spacing: inherit; - box-decoration-break: clone; - -webkit-box-decoration-break: clone; -} - -.header .price { - @apply pt-2 px-6 pb-4 text-sm bg-primary text-accent-9 - font-semibold inline-block tracking-wide - transition-colors ease-in-out duration-500; -} - -.imageContainer { - @apply flex items-center justify-center overflow-hidden; -} - -.imageContainer > div { - min-width: 100%; -} - -.imageContainer .productImage { - @apply transform transition-transform duration-500 - object-cover scale-120; -} - -.root .wishlistButton { - @apply top-0 right-0 z-30 absolute; -} - -/* Variant Simple */ -.simple .header .name { - @apply pt-2 text-lg leading-10 -mt-1; -} - -.simple .header .price { - @apply text-sm; -} - -/* Variant Slim */ -.slim { - @apply bg-transparent relative overflow-hidden - box-border; -} - -.slim .header { - @apply absolute inset-0 flex items-center justify-end mr-8 z-20; -} - -.slim span { - @apply bg-accent-9 text-accent-0 inline-block p-3 - font-bold text-xl break-words; -} - -.root:global(.secondary) .header span { - @apply bg-accent-0 text-accent-9; -} diff --git a/components/product/ProductCard/ProductCard.tsx b/components/product/ProductCard/ProductCard.tsx deleted file mode 100644 index 39c19db00..000000000 --- a/components/product/ProductCard/ProductCard.tsx +++ /dev/null @@ -1,132 +0,0 @@ -import { FC } from 'react' -import cn from 'classnames' -import Link from 'next/link' -import type { Product } from '@commerce/types/product' -import s from './ProductCard.module.css' -import Image, { ImageProps } from 'next/image' -import WishlistButton from '@components/wishlist/WishlistButton' -import usePrice from '@framework/product/use-price' -import ProductTag from '../ProductTag' -interface Props { - className?: string - product: Product - noNameTag?: boolean - imgProps?: Omit
- {product.name}
-
- {product?.images && (
-
-
- )}
- - {product.name} -
-
- {`${price} ${product.price?.currencyCode}`}
-
-
- {product?.images && (
-
-
- )}
-
- {variant === 'default' && (
- <>
- {process.env.COMMERCE_WISHLIST_ENABLED && (
-
- {product?.images && (
-
-
- )}
-
-
- )
-}
-
-export default ProductCard
diff --git a/components/product/ProductCard/index.ts b/components/product/ProductCard/index.ts
deleted file mode 100644
index 4559faa14..000000000
--- a/components/product/ProductCard/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './ProductCard'
diff --git a/components/product/ProductOptions/ProductOptions.tsx b/components/product/ProductOptions/ProductOptions.tsx
deleted file mode 100644
index 9261406bc..000000000
--- a/components/product/ProductOptions/ProductOptions.tsx
+++ /dev/null
@@ -1,50 +0,0 @@
-import { Swatch } from '@components/product'
-import type { ProductOption } from '@commerce/types/product'
-import { SelectedOptions } from '../helpers'
-import React from 'react'
-interface ProductOptionsProps {
- options: ProductOption[]
- selectedOptions: SelectedOptions
- setSelectedOptions: React.Dispatch
- {options.map((opt) => (
-
- )
- }
-)
-
-export default ProductOptions
diff --git a/components/product/ProductOptions/index.ts b/components/product/ProductOptions/index.ts
deleted file mode 100644
index 252415ab7..000000000
--- a/components/product/ProductOptions/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './ProductOptions'
diff --git a/components/product/ProductSidebar/ProductSidebar.module.css b/components/product/ProductSidebar/ProductSidebar.module.css
deleted file mode 100644
index b6ecc2b77..000000000
--- a/components/product/ProductSidebar/ProductSidebar.module.css
+++ /dev/null
@@ -1,84 +0,0 @@
-.root {
- @apply relative grid items-start gap-1 grid-cols-1 overflow-x-hidden;
- min-height: auto;
-}
-
-.main {
- @apply relative px-0 pb-0 box-border flex flex-col col-span-1;
- min-height: 500px;
-}
-
-.header {
- @apply transition-colors ease-in-out duration-500
- absolute top-0 left-0 z-20 pr-16;
-}
-
-.header .name {
- @apply pt-0 max-w-full w-full leading-extra-loose;
- font-size: 2rem;
- letter-spacing: 0.4px;
-}
-
-.header .name span {
- @apply py-4 px-6 bg-primary text-primary font-bold;
- font-size: inherit;
- letter-spacing: inherit;
- box-decoration-break: clone;
- -webkit-box-decoration-break: clone;
-}
-
-.header .price {
- @apply pt-2 px-6 pb-4 text-sm bg-primary text-accent-9
- font-semibold inline-block tracking-wide;
-}
-
-.sidebar {
- @apply flex flex-col col-span-1 mx-auto max-w-8xl px-6 py-6 w-full h-full;
-}
-
-.sliderContainer {
- @apply flex items-center justify-center overflow-x-hidden bg-violet;
-}
-
-.imageContainer {
- @apply text-center;
-}
-
-.imageContainer > div,
-.imageContainer > div > div {
- @apply h-full;
-}
-
-.sliderContainer .img {
- @apply w-full h-auto max-h-full object-cover;
-}
-
-.button {
- width: 100%;
-}
-
-.wishlistButton {
- @apply absolute z-30 top-0 right-0;
-}
-
-.relatedProductsGrid {
- @apply grid grid-cols-2 py-2 gap-2 md:grid-cols-4 md:gap-7;
-}
-
-@screen lg {
- .root {
- @apply grid-cols-12;
- }
-
- .main {
- @apply mx-0 col-span-8;
- }
-
- .sidebar {
- @apply col-span-4 py-6;
- }
-
- .imageContainer {
- max-height: 600px;
- }
-}
diff --git a/components/product/ProductSidebar/ProductSidebar.tsx b/components/product/ProductSidebar/ProductSidebar.tsx
deleted file mode 100644
index fe8a71aa5..000000000
--- a/components/product/ProductSidebar/ProductSidebar.tsx
+++ /dev/null
@@ -1,89 +0,0 @@
-import s from './ProductSidebar.module.css'
-import { useAddItem } from '@framework/cart'
-import { FC, useEffect, useState } from 'react'
-import { ProductOptions } from '@components/product'
-import type { Product } from '@commerce/types/product'
-import { Button, Text, Rating, Collapse, useUI } from '@components/ui'
-import {
- getProductVariant,
- selectDefaultOptionFromProduct,
- SelectedOptions,
-} from '../helpers'
-
-interface ProductSidebarProps {
- product: Product
- className?: string
-}
-
-const ProductSidebar: FC
-
- ))}
- - {opt.displayName} -
-
- {opt.values.map((v, i: number) => {
- const active = selectedOptions[opt.displayName.toLowerCase()]
- return (
- {
- setSelectedOptions((selectedOptions) => {
- return {
- ...selectedOptions,
- [opt.displayName.toLowerCase()]:
- v.label.toLowerCase(),
- }
- })
- }}
- />
- )
- })}
-
-
-
- )
-}
-
-export default ProductSidebar
diff --git a/components/product/ProductSidebar/index.ts b/components/product/ProductSidebar/index.ts
deleted file mode 100644
index 7e00359c4..000000000
--- a/components/product/ProductSidebar/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './ProductSidebar'
diff --git a/components/product/ProductSlider/ProductSlider.module.css b/components/product/ProductSlider/ProductSlider.module.css
deleted file mode 100644
index 8d7265eb8..000000000
--- a/components/product/ProductSlider/ProductSlider.module.css
+++ /dev/null
@@ -1,64 +0,0 @@
-.root {
- @apply relative w-full h-full select-none;
- overflow: hidden;
-}
-
-.slider {
- @apply relative h-full transition-opacity duration-150;
- opacity: 0;
-}
-
-.slider.show {
- opacity: 1;
-}
-
-.thumb {
- @apply transition-transform transition-colors
- ease-linear duration-75 overflow-hidden inline-block
- cursor-pointer h-full;
- width: 125px;
- width: calc(100% / 3);
-}
-
-.thumb.selected {
- @apply bg-white;
-}
-
-.thumb img {
- height: 85% !important;
-}
-
-.album {
- width: 100%;
- height: 100%;
- @apply bg-violet-dark;
- box-sizing: content-box;
- overflow-y: hidden;
- overflow-x: auto;
- white-space: nowrap;
- height: 125px;
- scrollbar-width: none;
-}
-
-/* Hide scrollbar for Chrome, Safari and Opera */
-.album::-webkit-scrollbar {
- display: none;
-}
-
-@screen md {
- .thumb:hover {
- transform: scale(1.02);
- background-color: rgba(255, 255, 255, 0.08);
- }
-
- .thumb.selected {
- @apply bg-white;
- }
-
- .album {
- height: 182px;
- }
- .thumb {
- width: 235px;
- }
-}
diff --git a/components/product/ProductSlider/ProductSlider.tsx b/components/product/ProductSlider/ProductSlider.tsx
deleted file mode 100644
index 8c3441906..000000000
--- a/components/product/ProductSlider/ProductSlider.tsx
+++ /dev/null
@@ -1,136 +0,0 @@
-import { useKeenSlider } from 'keen-slider/react'
-import React, {
- Children,
- FC,
- isValidElement,
- useState,
- useRef,
- useEffect,
-} from 'react'
-import cn from 'classnames'
-import { a } from '@react-spring/web'
-import s from './ProductSlider.module.css'
-import ProductSliderControl from '../ProductSliderControl'
-
-interface ProductSliderProps {
- children: React.ReactNode[]
- className?: string
-}
-
-const ProductSlider: React.FC
-
- 36 reviews
-
- {process.env.COMMERCE_CART_ENABLED && (
-
- )}
-
-
-
- This is a limited edition production run. Printing starts when the
- drop ends.
-
-
- This is a limited edition production run. Printing starts when the
- drop ends. Reminder: Bad Boys For Life. Shipping may take 10+ days due
- to COVID-19.
-
-
-
-
- {slider &&
- Children.map(children, (child, idx) => {
- if (isValidElement(child)) {
- return {
- ...child,
- props: {
- ...child.props,
- className: cn(child.props.className, s.thumb, {
- [s.selected]: currentSlide === idx,
- }),
- id: `thumb-${idx}`,
- onClick: () => {
- slider.moveToSlideRelative(idx)
- },
- },
- }
- }
- return child
- })}
-
-
- )
-}
-
-export default ProductSlider
diff --git a/components/product/ProductSlider/index.ts b/components/product/ProductSlider/index.ts
deleted file mode 100644
index 504440410..000000000
--- a/components/product/ProductSlider/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './ProductSlider'
diff --git a/components/product/ProductSliderControl/ProductSliderControl.module.css b/components/product/ProductSliderControl/ProductSliderControl.module.css
deleted file mode 100644
index c744e7598..000000000
--- a/components/product/ProductSliderControl/ProductSliderControl.module.css
+++ /dev/null
@@ -1,29 +0,0 @@
-.control {
- @apply bg-violet absolute bottom-10 right-10 flex flex-row
- border-accent-0 border text-accent-0 z-30 shadow-xl select-none;
- height: 48px;
-}
-
-.leftControl,
-.rightControl {
- @apply px-9 cursor-pointer;
- transition: background-color 0.2s ease;
-}
-
-.leftControl:hover,
-.rightControl:hover {
- background-color: var(--violet-dark);
-}
-
-.leftControl:focus,
-.rightControl:focus {
- @apply outline-none;
-}
-
-.rightControl {
- @apply border-l border-accent-0;
-}
-
-.leftControl {
- margin-right: -1px;
-}
diff --git a/components/product/ProductSliderControl/ProductSliderControl.tsx b/components/product/ProductSliderControl/ProductSliderControl.tsx
deleted file mode 100644
index 4e767b5db..000000000
--- a/components/product/ProductSliderControl/ProductSliderControl.tsx
+++ /dev/null
@@ -1,31 +0,0 @@
-import cn from 'classnames'
-import React from 'react'
-import s from './ProductSliderControl.module.css'
-import { ArrowLeft, ArrowRight } from '@components/icons'
-
-interface ProductSliderControl {
- onPrev: React.MouseEventHandler
- {slider &&
-
-
-
-
-
- )
-)
-export default ProductSliderControl
diff --git a/components/product/ProductSliderControl/index.ts b/components/product/ProductSliderControl/index.ts
deleted file mode 100644
index 5b63c466f..000000000
--- a/components/product/ProductSliderControl/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './ProductSliderControl'
diff --git a/components/product/ProductTag/ProductTag.module.css b/components/product/ProductTag/ProductTag.module.css
deleted file mode 100644
index faf2fd97f..000000000
--- a/components/product/ProductTag/ProductTag.module.css
+++ /dev/null
@@ -1,30 +0,0 @@
-.root {
- @apply transition-colors ease-in-out duration-500
- absolute top-0 left-0 z-20 pr-16;
-}
-
-.root .name {
- @apply pt-0 max-w-full w-full leading-extra-loose;
- font-size: 2rem;
- letter-spacing: 0.4px;
- line-height: 2.2em;
-}
-
-.root .name span {
- @apply py-4 px-6 bg-primary text-primary font-bold;
- min-height: 70px;
- font-size: inherit;
- letter-spacing: inherit;
- box-decoration-break: clone;
- -webkit-box-decoration-break: clone;
-}
-
-.root .name span.fontsizing {
- display: flex;
- padding-top: 1.5rem;
-}
-
-.root .price {
- @apply pt-2 px-6 pb-4 text-sm bg-primary text-accent-9
- font-semibold inline-block tracking-wide;
-}
diff --git a/components/product/ProductTag/ProductTag.tsx b/components/product/ProductTag/ProductTag.tsx
deleted file mode 100644
index 2bc80b878..000000000
--- a/components/product/ProductTag/ProductTag.tsx
+++ /dev/null
@@ -1,36 +0,0 @@
-import cn from 'classnames'
-import { inherits } from 'util'
-import s from './ProductTag.module.css'
-
-interface ProductTagProps {
- className?: string
- name: string
- price: string
- fontSize?: number
-}
-
-const ProductTag: React.FC
-
- )
-}
-
-export default ProductTag
diff --git a/components/product/ProductTag/index.ts b/components/product/ProductTag/index.ts
deleted file mode 100644
index cb345e8bd..000000000
--- a/components/product/ProductTag/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './ProductTag'
diff --git a/components/product/ProductView/ProductView.module.css b/components/product/ProductView/ProductView.module.css
deleted file mode 100644
index 0b3ebf564..000000000
--- a/components/product/ProductView/ProductView.module.css
+++ /dev/null
@@ -1,60 +0,0 @@
-.root {
- @apply relative grid items-start gap-1 grid-cols-1 overflow-x-hidden;
- min-height: auto;
-}
-
-.main {
- @apply relative px-0 pb-0 box-border flex flex-col col-span-1;
- min-height: 500px;
-}
-
-.sidebar {
- @apply flex flex-col col-span-1 mx-auto max-w-8xl px-6 py-6 w-full h-full;
-}
-
-.sliderContainer {
- @apply flex items-center justify-center overflow-x-hidden bg-violet;
-}
-
-.imageContainer {
- @apply text-center;
-}
-
-.imageContainer > div,
-.imageContainer > div > div {
- @apply h-full;
-}
-
-.sliderContainer .img {
- @apply w-full h-auto max-h-full object-cover;
-}
-
-.button {
- width: 100%;
-}
-
-.wishlistButton {
- @apply absolute z-30 top-0 right-0;
-}
-
-.relatedProductsGrid {
- @apply grid grid-cols-2 py-2 gap-2 md:grid-cols-4 md:gap-7;
-}
-
-@screen lg {
- .root {
- @apply grid-cols-12;
- }
-
- .main {
- @apply mx-0 col-span-8;
- }
-
- .sidebar {
- @apply col-span-4 py-6;
- }
-
- .imageContainer {
- max-height: 600px;
- }
-}
diff --git a/components/product/ProductView/ProductView.tsx b/components/product/ProductView/ProductView.tsx
deleted file mode 100644
index f689030d6..000000000
--- a/components/product/ProductView/ProductView.tsx
+++ /dev/null
@@ -1,109 +0,0 @@
-import cn from 'classnames'
-import Image from 'next/image'
-import { NextSeo } from 'next-seo'
-import s from './ProductView.module.css'
-import { FC } from 'react'
-import type { Product } from '@commerce/types/product'
-import usePrice from '@framework/product/use-price'
-import { WishlistButton } from '@components/wishlist'
-import { ProductSlider, ProductCard } from '@components/product'
-import { Container, Text } from '@components/ui'
-import ProductSidebar from '../ProductSidebar'
-import ProductTag from '../ProductTag'
-interface ProductViewProps {
- product: Product
- relatedProducts: Product[]
-}
-
-const ProductView: FC- - {name} - -
-{price}
-
-
-
-
-
-
-
- {product.images.map((image, i) => (
-
-
- {process.env.COMMERCE_WISHLIST_ENABLED && (
-
-
- ))}
- -
- {relatedProducts.map((p) => (
-
-
-
- ))}
-
+
+ );
+}
diff --git a/components/product/helpers.ts b/components/product/helpers.ts
deleted file mode 100644
index d3fbd5ef5..000000000
--- a/components/product/helpers.ts
+++ /dev/null
@@ -1,32 +0,0 @@
-import type { Product } from '@commerce/types/product'
-export type SelectedOptions = Record
+ {images[currentImageIndex] && (
+
+
+ {images.length > 1 ? (
+
+
+ ) : null}
+
+
+
+
+
+
+ {images.map((image, index) => {
+ const isActive = index === currentImageIndex;
+ return (
+
+ );
+ })}
+
+ ) : null}
+
+
+ {product.title}
+
+
+ -
+
- {option.name} +
-
+ {option.values.map((value) => {
+ const optionNameLowerCase = option.name.toLowerCase();
+
+ // Base option params on current params so we can preserve any other param state in the url.
+ const optionSearchParams = new URLSearchParams(searchParams.toString());
+
+ // Update the option params using the current option to reflect how the url *would* change,
+ // if the option was clicked.
+ optionSearchParams.set(optionNameLowerCase, value);
+ const optionUrl = createUrl(pathname, optionSearchParams);
+
+ // In order to determine if an option is available for sale, we need to:
+ //
+ // 1. Filter out all other param state
+ // 2. Filter out invalid options
+ // 3. Check if the option combination is available for sale
+ //
+ // This is the "magic" that will cross check possible variant combinations and preemptively
+ // disable combinations that are not available. For example, if the color gray is only available in size medium,
+ // then all other sizes should be disabled.
+ const filtered = Array.from(optionSearchParams.entries()).filter(([key, value]) =>
+ options.find(
+ (option) => option.name.toLowerCase() === key && option.values.includes(value)
+ )
+ );
+ const isAvailableForSale = combinations.find((combination) =>
+ filtered.every(
+ ([key, value]) => combination[key] === value && combination.availableForSale
+ )
+ );
+
+ // The option is active if it's in the url params.
+ const isActive = searchParams.get(optionNameLowerCase) === value;
+
+ // You can't disable a link, so we need to render something that isn't clickable.
+ const DynamicTag = isAvailableForSale ? Link : 'p';
+ const dynamicProps = {
+ ...(isAvailableForSale && { scroll: false })
+ };
+
+ return (
+
+ {value} + + ); + })} +
+
-
-
- {/* Categories */}
-
- {/* Products */}
-
-
-
- {/* Designs */}
-
-
-
-
-
-
-
-
-
-
-
- -
-
- - - handleClick(e, 'categories')} - className={ - 'block lg:inline-block px-4 py-2 lg:p-0 lg:my-2 lg:mx-4' - } - > - All Categories - - - - {categories.map((cat: any) => ( -
- - - handleClick(e, 'categories')} - className={ - 'block lg:inline-block px-4 py-2 lg:p-0 lg:my-2 lg:mx-4' - } - > - {cat.name} - - - - ))} -
-
-
-
-
-
-
-
-
-
-
-
-
- -
-
- - - handleClick(e, 'brands')} - className={ - 'block lg:inline-block px-4 py-2 lg:p-0 lg:my-2 lg:mx-4' - } - > - All Designers - - - - {brands.flatMap(({ node }: { node: any }) => ( -
- - - handleClick(e, 'brands')} - className={ - 'block lg:inline-block px-4 py-2 lg:p-0 lg:my-2 lg:mx-4' - } - > - {node.name} - - - - ))} -
- {(q || activeCategory || activeBrand) && (
-
-
- {/* Sort */}
-
- {data ? (
- <>
-
- Showing {data.products.length} results{' '}
- {q && (
- <>
- for "{q}"
-
- )}
-
-
- {q ? (
- <>
- There are no products that match "{q}"
-
- ) : (
- <>
- There are no products that match the selected category.
-
- )}
-
-
- ) : q ? (
- <>
- Searching for: "{q}"
-
- ) : (
- <>Searching...
- )}
-
- )}
- {data ? (
-
- {data.products.map((product: Product) => (
-
- ) : (
-
- {rangeMap(12, (i) => (
-
-
-
- ))}
-
- )}{' '}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
-
- - - handleClick(e, 'sort')} - className={ - 'block lg:inline-block px-4 py-2 lg:p-0 lg:my-2 lg:mx-4' - } - > - Relevance - - - - {SORT.map(([key, text]) => ( -
- - - handleClick(e, 'sort')} - className={ - 'block lg:inline-block px-4 py-2 lg:p-0 lg:my-2 lg:mx-4' - } - > - {text} - - - - ))} -
-
-
-
- )
-})
-
-export default Collapse
diff --git a/components/ui/Collapse/index.ts b/components/ui/Collapse/index.ts
deleted file mode 100644
index 1e584a53b..000000000
--- a/components/ui/Collapse/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export { default } from './Collapse'
-export * from './Collapse'
diff --git a/components/ui/Container/Container.tsx b/components/ui/Container/Container.tsx
deleted file mode 100644
index 538b1cac7..000000000
--- a/components/ui/Container/Container.tsx
+++ /dev/null
@@ -1,27 +0,0 @@
-import cn from 'classnames'
-import React, { FC } from 'react'
-
-interface ContainerProps {
- className?: string
- children?: any
- el?: HTMLElement
- clean?: boolean
-}
-
-const Container: FC
-
-
- {children}
-
- {children}
-}
-
-export default Grid
diff --git a/components/ui/Grid/index.ts b/components/ui/Grid/index.ts
deleted file mode 100644
index ddb51299b..000000000
--- a/components/ui/Grid/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './Grid'
diff --git a/components/ui/Hero/Hero.module.css b/components/ui/Hero/Hero.module.css
deleted file mode 100644
index a0f1798f5..000000000
--- a/components/ui/Hero/Hero.module.css
+++ /dev/null
@@ -1,30 +0,0 @@
-.root {
- @apply flex flex-col py-16 mx-auto;
-}
-
-.title {
- @apply text-accent-0 font-extrabold text-4xl leading-none tracking-tight;
-}
-
-.description {
- @apply mt-4 text-xl leading-8 text-accent-2 mb-1 lg:max-w-4xl;
-}
-
-@screen lg {
- .root {
- @apply flex-row items-start justify-center py-32;
- }
- .title {
- @apply text-5xl max-w-xl text-right leading-10 -mt-3;
- line-height: 3.5rem;
- }
- .description {
- @apply mt-0 ml-6;
- }
-}
-
-@screen xl {
- .title {
- @apply text-6xl;
- }
-}
diff --git a/components/ui/Hero/Hero.tsx b/components/ui/Hero/Hero.tsx
deleted file mode 100644
index 58d13e5de..000000000
--- a/components/ui/Hero/Hero.tsx
+++ /dev/null
@@ -1,33 +0,0 @@
-import React, { FC } from 'react'
-import { Container } from '@components/ui'
-import { ArrowRight } from '@components/icons'
-import s from './Hero.module.css'
-import Link from 'next/link'
-interface HeroProps {
- className?: string
- headline: string
- description: string
-}
-
-const Hero: FC
-
-
-
- )
-}
-
-export default Hero
diff --git a/components/ui/Hero/index.ts b/components/ui/Hero/index.ts
deleted file mode 100644
index b08fa5ac8..000000000
--- a/components/ui/Hero/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './Hero'
diff --git a/components/ui/Input/Input.module.css b/components/ui/Input/Input.module.css
deleted file mode 100644
index 34507f445..000000000
--- a/components/ui/Input/Input.module.css
+++ /dev/null
@@ -1,7 +0,0 @@
-.root {
- @apply bg-primary py-2 px-6 w-full appearance-none transition duration-150 ease-in-out pr-10 border border-accent-3 text-accent-6;
-}
-
-.root:focus {
- @apply outline-none shadow-outline-normal;
-}
diff --git a/components/ui/Input/Input.tsx b/components/ui/Input/Input.tsx
deleted file mode 100644
index e630728b2..000000000
--- a/components/ui/Input/Input.tsx
+++ /dev/null
@@ -1,37 +0,0 @@
-import cn from 'classnames'
-import s from './Input.module.css'
-import React, { InputHTMLAttributes } from 'react'
-
-export interface InputProps extends InputHTMLAttributes
-
- {headline}
-
-
- {description}
- - - Read it here -
-
- )
-}
-
-export default Modal
diff --git a/components/ui/Modal/index.ts b/components/ui/Modal/index.ts
deleted file mode 100644
index e24753a1e..000000000
--- a/components/ui/Modal/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './Modal'
diff --git a/components/ui/Quantity/Quantity.module.css b/components/ui/Quantity/Quantity.module.css
deleted file mode 100644
index fa60cc56e..000000000
--- a/components/ui/Quantity/Quantity.module.css
+++ /dev/null
@@ -1,27 +0,0 @@
-.actions {
- @apply flex p-1 border-accent-2 border items-center justify-center
- w-12 text-accent-7;
- transition-property: border-color, background, color, transform, box-shadow;
-
- transition-duration: 0.15s;
- transition-timing-function: ease;
- user-select: none;
-}
-
-.actions:hover {
- @apply border bg-accent-1 border-accent-3 text-accent-9;
- transition: border-color;
- z-index: 10;
-}
-
-.actions:focus {
- @apply outline-none;
-}
-
-.actions:disabled {
- @apply cursor-not-allowed;
-}
-
-.input {
- @apply bg-transparent px-4 w-full h-full focus:outline-none select-none pointer-events-auto;
-}
diff --git a/components/ui/Quantity/Quantity.tsx b/components/ui/Quantity/Quantity.tsx
deleted file mode 100644
index abde145aa..000000000
--- a/components/ui/Quantity/Quantity.tsx
+++ /dev/null
@@ -1,62 +0,0 @@
-import React, { FC } from 'react'
-import s from './Quantity.module.css'
-import { Cross, Plus, Minus } from '@components/icons'
-import cn from 'classnames'
-export interface QuantityProps {
- value: number
- increase: () => any
- decrease: () => any
- handleRemove: React.MouseEventHandler
-
- {children}
-
-
-
-
-
-
-
- )
-}
-
-export default Quantity
diff --git a/components/ui/Quantity/index.ts b/components/ui/Quantity/index.ts
deleted file mode 100644
index 5ee880cc9..000000000
--- a/components/ui/Quantity/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export { default } from './Quantity'
-export * from './Quantity'
diff --git a/components/ui/README.md b/components/ui/README.md
deleted file mode 100644
index 5bf4fe510..000000000
--- a/components/ui/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# UI
-
-Building blocks to build a rich graphical interfaces. Components should be atomic and pure. Serve one purpose.
diff --git a/components/ui/Rating/Rating.module.css b/components/ui/Rating/Rating.module.css
deleted file mode 100644
index e69de29bb..000000000
diff --git a/components/ui/Rating/Rating.tsx b/components/ui/Rating/Rating.tsx
deleted file mode 100644
index 259e642ea..000000000
--- a/components/ui/Rating/Rating.tsx
+++ /dev/null
@@ -1,27 +0,0 @@
-import React, { FC } from 'react'
-import rangeMap from '@lib/range-map'
-import { Star } from '@components/icons'
-import cn from 'classnames'
-
-export interface RatingProps {
- value: number
-}
-
-const Quantity: React.FC
- {rangeMap(5, (i) => (
- = Math.floor(value),
- })}
- >
-
- )
-})
-
-export default Quantity
diff --git a/components/ui/Rating/index.ts b/components/ui/Rating/index.ts
deleted file mode 100644
index 1354efb25..000000000
--- a/components/ui/Rating/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export { default } from './Rating'
-export * from './Rating'
diff --git a/components/ui/Sidebar/Sidebar.module.css b/components/ui/Sidebar/Sidebar.module.css
deleted file mode 100644
index f6a49387f..000000000
--- a/components/ui/Sidebar/Sidebar.module.css
+++ /dev/null
@@ -1,14 +0,0 @@
-.root {
- @apply fixed inset-0 h-full z-50 box-border;
-}
-
-.sidebar {
- @apply h-full flex flex-col text-base bg-accent-0 shadow-xl overflow-y-auto overflow-x-hidden;
- -webkit-overflow-scrolling: touch !important;
-}
-
-.backdrop {
- @apply absolute inset-0 bg-black bg-opacity-40 duration-100 ease-linear;
- backdrop-filter: blur(0.8px);
- -webkit-backdrop-filter: blur(0.8px);
-}
diff --git a/components/ui/Sidebar/Sidebar.tsx b/components/ui/Sidebar/Sidebar.tsx
deleted file mode 100644
index ce0eeefe2..000000000
--- a/components/ui/Sidebar/Sidebar.tsx
+++ /dev/null
@@ -1,46 +0,0 @@
-import { FC, useEffect, useRef } from 'react'
-import s from './Sidebar.module.css'
-import cn from 'classnames'
-import {
- disableBodyScroll,
- enableBodyScroll,
- clearAllBodyScrollLocks,
-} from 'body-scroll-lock'
-
-interface SidebarProps {
- children: any
- onClose: () => void
-}
-
-const Sidebar: FC
-
- )
-}
-
-export default Sidebar
diff --git a/components/ui/Sidebar/index.ts b/components/ui/Sidebar/index.ts
deleted file mode 100644
index 877187ca3..000000000
--- a/components/ui/Sidebar/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { default } from './Sidebar'
diff --git a/components/ui/Skeleton/Skeleton.module.css b/components/ui/Skeleton/Skeleton.module.css
deleted file mode 100644
index 37c164de7..000000000
--- a/components/ui/Skeleton/Skeleton.module.css
+++ /dev/null
@@ -1,48 +0,0 @@
-.skeleton {
- @apply block;
- background-image: linear-gradient(
- 270deg,
- var(--accent-0),
- var(--accent-2),
- var(--accent-0),
- var(--accent-1)
- );
- background-size: 400% 100%;
- animation: loading 8s ease-in-out infinite;
-}
-
-.wrapper {
- @apply block relative;
-
- &:not(.show)::before {
- content: none;
- }
-
- &::before {
- content: '';
- position: absolute;
- top: 0;
- left: 0;
- right: 0;
- bottom: 0;
- z-index: 100;
- background-image: linear-gradient(
- 270deg,
- var(--accent-0),
- var(--accent-2),
- var(--accent-0),
- var(--accent-1)
- );
- background-size: 400% 100%;
- animation: loading 8s ease-in-out infinite;
- }
-}
-
-@keyframes loading {
- 0% {
- background-position: 200% 0;
- }
- 100% {
- background-position: -200% 0;
- }
-}
diff --git a/components/ui/Skeleton/Skeleton.tsx b/components/ui/Skeleton/Skeleton.tsx
deleted file mode 100644
index 9cef2c1ac..000000000
--- a/components/ui/Skeleton/Skeleton.tsx
+++ /dev/null
@@ -1,57 +0,0 @@
-import React, { CSSProperties } from 'react'
-import cn from 'classnames'
-import px from '@lib/to-pixels'
-import s from './Skeleton.module.css'
-
-interface SkeletonProps {
- show?: boolean
- block?: boolean
- className?: string
- style?: CSSProperties
- width?: string | number
- height?: string | number
- boxHeight?: string | number
-}
-
-const Skeleton: React.FC
-
-
-
-
-
-
-
- {children}
-
-
-
-First thing you do is: set your environment variables -
-
-.env.local - -```sh -BIGCOMMERCE_STOREFRONT_API_URL=<> -BIGCOMMERCE_STOREFRONT_API_TOKEN=<> -BIGCOMMERCE_STORE_API_URL=<> -BIGCOMMERCE_STORE_API_TOKEN=<> -BIGCOMMERCE_STORE_API_CLIENT_ID=<> -BIGCOMMERCE_CHANNEL_ID=<> -``` - -If your project was started with a "Deploy with Vercel" button, you can use Vercel's CLI to retrieve these credentials. - -1. Install Vercel CLI: `npm i -g vercel` -2. Link local instance with Vercel and Github accounts (creates .vercel file): `vercel link` -3. Download your environment variables: `vercel env pull .env.local` - -Next, you're free to customize the starter. More updates coming soon. Stay tuned. - -
-
-I already own a BigCommerce store. What should I do?
--First thing you do is: set your environment variables -
-
-.env.local - -```sh -BIGCOMMERCE_STOREFRONT_API_URL=<> -BIGCOMMERCE_STOREFRONT_API_TOKEN=<> -BIGCOMMERCE_STORE_API_URL=<> -BIGCOMMERCE_STORE_API_TOKEN=<> -BIGCOMMERCE_STORE_API_CLIENT_ID=<> -BIGCOMMERCE_CHANNEL_ID=<> -``` - -If your project was started with a "Deploy with Vercel" button, you can use Vercel's CLI to retrieve these credentials. - -1. Install Vercel CLI: `npm i -g vercel` -2. Link local instance with Vercel and Github accounts (creates .vercel file): `vercel link` -3. Download your environment variables: `vercel env pull .env.local` - -Next, you're free to customize the starter. More updates coming soon. Stay tuned. - -
-
-After Email confirmation, Checkout should be manually enabled through BigCommerce platform. Look for "Review & test your store" section through BigCommerce's dashboard. -
-
-BigCommerce team has been notified and they plan to add more detailed about this subject. -
diff --git a/framework/bigcommerce/api/definitions/catalog.ts b/framework/bigcommerce/api/definitions/catalog.ts
deleted file mode 100644
index 2c483f781..000000000
--- a/framework/bigcommerce/api/definitions/catalog.ts
+++ /dev/null
@@ -1,2993 +0,0 @@
-/**
- * This file was auto-generated by swagger-to-ts.
- * Do not make direct changes to the file.
- */
-
-export interface definitions {
- /**
- * Common Modifier properties.
- */
- productModifier_Base: {
- /**
- * BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST.
- */
- type:
- | 'date'
- | 'checkbox'
- | 'file'
- | 'text'
- | 'multi_line_text'
- | 'numbers_only_text'
- | 'radio_buttons'
- | 'rectangles'
- | 'dropdown'
- | 'product_list'
- | 'product_list_with_images'
- | 'swatch'
- /**
- * Whether or not this modifer is required or not at checkout. Required in a /POST.
- */
- required: boolean
- /**
- * The order the modifiers display on the product detail page.
- */
- sort_order?: number
- config?: definitions['config_Full']
- /**
- * The name of the option shown on the storefront.
- */
- display_name?: string
- }
- /**
- * Product Modifier
- */
- productModifier_Full: definitions['productModifier_Base'] & {
- /**
- * The unique numeric ID of the modifier; increments sequentially.
- */
- id?: number
- /**
- * The unique numeric ID of the product to which the option belongs.
- */
- product_id?: number
- /**
- * The unique option name. Auto-generated from the display name, a timestamp, and the product ID.
- */
- name?: string
- option_values?: definitions['productModifierOptionValue_Full'][]
- }
- /**
- * The model for a POST to create a modifier on a product.
- */
- productModifier_Post: {
- /**
- * BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST.
- */
- type:
- | 'date'
- | 'checkbox'
- | 'file'
- | 'text'
- | 'multi_line_text'
- | 'numbers_only_text'
- | 'radio_buttons'
- | 'rectangles'
- | 'dropdown'
- | 'product_list'
- | 'product_list_with_images'
- | 'swatch'
- /**
- * Whether or not this modifer is required or not at checkout. Required in a /POST.
- */
- required: boolean
- /**
- * The order the modifiers display on the product detail page.
- */
- sort_order?: number
- /**
- * The values for option config can vary based on the Modifier created.
- */
- config?: {
- /**
- * (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
- */
- default_value?: string
- /**
- * (checkbox) Flag for setting the checkbox to be checked by default.
- */
- checked_by_default?: boolean
- /**
- * (checkbox) Label displayed for the checkbox option.
- */
- checkbox_label?: string
- /**
- * (date) Flag to limit the dates allowed to be entered on a date option.
- */
- date_limited?: boolean
- /**
- * (date) The type of limit that is allowed to be entered on a date option.
- */
- date_limit_mode?: 'earliest' | 'range' | 'latest'
- /**
- * (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_earliest_value?: string
- /**
- * (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_latest_value?: string
- /**
- * (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types.
- */
- file_types_mode?: 'specific' | 'all'
- /**
- * (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values:
- * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`).
- * `other` - Allows file types defined in the `file_types_other` array.
- */
- file_types_supported?: string[]
- /**
- * (file) A list of other file types allowed with the file upload option.
- */
- file_types_other?: string[]
- /**
- * (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server.
- */
- file_max_size?: number
- /**
- * (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
- */
- text_characters_limited?: boolean
- /**
- * (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
- */
- text_min_length?: number
- /**
- * (text, multi_line_text) The maximum length allowed for a text or multi line text option.
- */
- text_max_length?: number
- /**
- * (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
- */
- text_lines_limited?: boolean
- /**
- * (multi_line_text) The maximum number of lines allowed on a multi-line text input.
- */
- text_max_lines?: number
- /**
- * (numbers_only_text) Flag to limit the value of a number option.
- */
- number_limited?: boolean
- /**
- * (numbers_only_text) The type of limit on values entered for a number option.
- */
- number_limit_mode?: 'lowest' | 'highest' | 'range'
- /**
- * (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true.
- */
- number_lowest_value?: number
- /**
- * (numbers_only_text) The highest allowed value for a number option if `number_limited` is true.
- */
- number_highest_value?: number
- /**
- * (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
- */
- number_integers_only?: boolean
- /**
- * (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
- */
- product_list_adjusts_inventory?: boolean
- /**
- * (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
- */
- product_list_adjusts_pricing?: boolean
- /**
- * (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions.
- */
- product_list_shipping_calc?: 'none' | 'weight' | 'package'
- }
- option_values?: (({
- /**
- * The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
- */
- is_default?: boolean
- /**
- * The text display identifying the value on the storefront. Required in a /POST.
- */
- label: string
- /**
- * The order in which the value will be displayed on the product page. Required in a /POST.
- */
- sort_order: number
- /**
- * Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.
- */
- value_data?: { [key: string]: any }
- } & {
- adjusters?: {
- /**
- * Adjuster for Complex Rules.
- */
- price?: {
- /**
- * The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster?: 'relative' | 'percentage'
- /**
- * The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster_value?: number
- }
- /**
- * Adjuster for Complex Rules.
- */
- weight?: {
- /**
- * The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster?: 'relative' | 'percentage'
- /**
- * The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster_value?: number
- }
- /**
- * The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file.
- */
- image_url?: string
- purchasing_disabled?: {
- /**
- * Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value.
- */
- status?: boolean
- /**
- * The message displayed on the storefront when the purchasing disabled status is `true`.
- */
- message?: string
- }
- }
- }) & {
- /**
- * The unique numeric ID of the value; increments sequentially.
- */
- id?: number
- })[]
- } & {
- /**
- * The name of the option shown on the storefront.
- */
- display_name: string
- }
- /**
- * The model for a PUT to update a modifier on a product.
- */
- productModifier_Put: {
- /**
- * BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST.
- */
- type:
- | 'date'
- | 'checkbox'
- | 'file'
- | 'text'
- | 'multi_line_text'
- | 'numbers_only_text'
- | 'radio_buttons'
- | 'rectangles'
- | 'dropdown'
- | 'product_list'
- | 'product_list_with_images'
- | 'swatch'
- /**
- * Whether or not this modifer is required or not at checkout. Required in a /POST.
- */
- required: boolean
- /**
- * The order the modifiers display on the product detail page.
- */
- sort_order?: number
- /**
- * The values for option config can vary based on the Modifier created.
- */
- config?: {
- /**
- * (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
- */
- default_value?: string
- /**
- * (checkbox) Flag for setting the checkbox to be checked by default.
- */
- checked_by_default?: boolean
- /**
- * (checkbox) Label displayed for the checkbox option.
- */
- checkbox_label?: string
- /**
- * (date) Flag to limit the dates allowed to be entered on a date option.
- */
- date_limited?: boolean
- /**
- * (date) The type of limit that is allowed to be entered on a date option.
- */
- date_limit_mode?: 'earliest' | 'range' | 'latest'
- /**
- * (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_earliest_value?: string
- /**
- * (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_latest_value?: string
- /**
- * (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types.
- */
- file_types_mode?: 'specific' | 'all'
- /**
- * (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values:
- * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`).
- * `other` - Allows file types defined in the `file_types_other` array.
- */
- file_types_supported?: string[]
- /**
- * (file) A list of other file types allowed with the file upload option.
- */
- file_types_other?: string[]
- /**
- * (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server.
- */
- file_max_size?: number
- /**
- * (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
- */
- text_characters_limited?: boolean
- /**
- * (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
- */
- text_min_length?: number
- /**
- * (text, multi_line_text) The maximum length allowed for a text or multi line text option.
- */
- text_max_length?: number
- /**
- * (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
- */
- text_lines_limited?: boolean
- /**
- * (multi_line_text) The maximum number of lines allowed on a multi-line text input.
- */
- text_max_lines?: number
- /**
- * (numbers_only_text) Flag to limit the value of a number option.
- */
- number_limited?: boolean
- /**
- * (numbers_only_text) The type of limit on values entered for a number option.
- */
- number_limit_mode?: 'lowest' | 'highest' | 'range'
- /**
- * (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true.
- */
- number_lowest_value?: number
- /**
- * (numbers_only_text) The highest allowed value for a number option if `number_limited` is true.
- */
- number_highest_value?: number
- /**
- * (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
- */
- number_integers_only?: boolean
- /**
- * (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
- */
- product_list_adjusts_inventory?: boolean
- /**
- * (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
- */
- product_list_adjusts_pricing?: boolean
- /**
- * (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions.
- */
- product_list_shipping_calc?: 'none' | 'weight' | 'package'
- }
- option_values?: (({
- /**
- * The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
- */
- is_default?: boolean
- /**
- * The text display identifying the value on the storefront. Required in a /POST.
- */
- label: string
- /**
- * The order in which the value will be displayed on the product page. Required in a /POST.
- */
- sort_order: number
- /**
- * Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.
- */
- value_data?: { [key: string]: any }
- } & {
- adjusters?: {
- /**
- * Adjuster for Complex Rules.
- */
- price?: {
- /**
- * The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster?: 'relative' | 'percentage'
- /**
- * The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster_value?: number
- }
- /**
- * Adjuster for Complex Rules.
- */
- weight?: {
- /**
- * The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster?: 'relative' | 'percentage'
- /**
- * The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster_value?: number
- }
- /**
- * The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file.
- */
- image_url?: string
- purchasing_disabled?: {
- /**
- * Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value.
- */
- status?: boolean
- /**
- * The message displayed on the storefront when the purchasing disabled status is `true`.
- */
- message?: string
- }
- }
- }) & {
- /**
- * The unique numeric ID of the value; increments sequentially.
- */
- id?: number
- })[]
- }
- /**
- * Common Product Modifer `option_value` properties.
- */
- productModifierOptionValue_Base: {
- /**
- * The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
- */
- is_default?: boolean
- /**
- * The text display identifying the value on the storefront. Required in a /POST.
- */
- label: string
- /**
- * The order in which the value will be displayed on the product page. Required in a /POST.
- */
- sort_order: number
- /**
- * Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. If no data is available, returns `null`.
- */
- value_data?: { [key: string]: any }
- adjusters?: definitions['adjusters_Full']
- }
- /**
- * Product Modifer `option_value`.
- */
- productModifierOptionValue_Full: definitions['productModifierOptionValue_Base'] & {
- /**
- * The unique numeric ID of the value; increments sequentially.
- */
- id?: number
- option_id?: number
- }
- /**
- * The model for a POST to create a modifier value on a product.
- */
- productModifierOptionValue_Post: {
- /**
- * The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
- */
- is_default?: boolean
- /**
- * The text display identifying the value on the storefront. Required in a /POST.
- */
- label: string
- /**
- * The order in which the value will be displayed on the product page. Required in a /POST.
- */
- sort_order: number
- /**
- * Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.
- */
- value_data?: { [key: string]: any }
- } & {
- adjusters?: {
- /**
- * Adjuster for Complex Rules.
- */
- price?: {
- /**
- * The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster?: 'relative' | 'percentage'
- /**
- * The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster_value?: number
- }
- /**
- * Adjuster for Complex Rules.
- */
- weight?: {
- /**
- * The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster?: 'relative' | 'percentage'
- /**
- * The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster_value?: number
- }
- /**
- * The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file.
- */
- image_url?: string
- purchasing_disabled?: {
- /**
- * Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value.
- */
- status?: boolean
- /**
- * The message displayed on the storefront when the purchasing disabled status is `true`.
- */
- message?: string
- }
- }
- }
- /**
- * The model for a PUT to update a modifier value on a product.
- */
- productModifierOptionValue_Put: ({
- /**
- * The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
- */
- is_default?: boolean
- /**
- * The text display identifying the value on the storefront. Required in a /POST.
- */
- label: string
- /**
- * The order in which the value will be displayed on the product page. Required in a /POST.
- */
- sort_order: number
- /**
- * Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.
- */
- value_data?: { [key: string]: any }
- } & {
- adjusters?: {
- /**
- * Adjuster for Complex Rules.
- */
- price?: {
- /**
- * The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster?: 'relative' | 'percentage'
- /**
- * The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster_value?: number
- }
- /**
- * Adjuster for Complex Rules.
- */
- weight?: {
- /**
- * The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster?: 'relative' | 'percentage'
- /**
- * The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster_value?: number
- }
- /**
- * The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file.
- */
- image_url?: string
- purchasing_disabled?: {
- /**
- * Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value.
- */
- status?: boolean
- /**
- * The message displayed on the storefront when the purchasing disabled status is `true`.
- */
- message?: string
- }
- }
- }) & {
- /**
- * The unique numeric ID of the value; increments sequentially.
- */
- id?: number
- }
- resp_productionOption: {
- data?: definitions['productOption_Full']
- /**
- * Empty meta object; may be used later.
- */
- meta?: { ''?: string }
- }
- /**
- * Common Option properties.
- */
- productOption_Base: {
- /**
- * The unique numerical ID of the option, increments sequentially.
- */
- id?: number
- /**
- * The unique numerical ID of the product to which the option belongs.
- */
- product_id?: number
- /**
- * The name of the option shown on the storefront.
- */
- display_name?: string
- /**
- * The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
- */
- type?:
- | 'radio_buttons'
- | 'rectangles'
- | 'dropdown'
- | 'product_list'
- | 'product_list_with_images'
- | 'swatch'
- config?: definitions['productOptionConfig_Full']
- /**
- * Order in which the option is displayed on the storefront.
- */
- sort_order?: number
- option_values?: definitions['productOptionOptionValue_Full']
- }
- productOption_Full: definitions['productOption_Base'] & {
- /**
- * The unique option name, auto-generated from the display name, a timestamp, and the product ID.
- */
- name?: string
- }
- /**
- * The model for a POST to create options on a product.
- */
- productOption_Post: {
- /**
- * The unique numerical ID of the option, increments sequentially.
- */
- id?: number
- /**
- * The unique numerical ID of the product to which the option belongs.
- */
- product_id?: number
- /**
- * The name of the option shown on the storefront.
- */
- display_name?: string
- /**
- * The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
- */
- type?:
- | 'radio_buttons'
- | 'rectangles'
- | 'dropdown'
- | 'product_list'
- | 'product_list_with_images'
- | 'swatch'
- /**
- * The values for option config can vary based on the Modifier created.
- */
- config?: {
- /**
- * (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
- */
- default_value?: string
- /**
- * (checkbox) Flag for setting the checkbox to be checked by default.
- */
- checked_by_default?: boolean
- /**
- * (checkbox) Label displayed for the checkbox option.
- */
- checkbox_label?: string
- /**
- * (date) Flag to limit the dates allowed to be entered on a date option.
- */
- date_limited?: boolean
- /**
- * (date) The type of limit that is allowed to be entered on a date option.
- */
- date_limit_mode?: 'earliest' | 'range' | 'latest'
- /**
- * (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_earliest_value?: string
- /**
- * (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_latest_value?: string
- /**
- * (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types.
- */
- file_types_mode?: 'specific' | 'all'
- /**
- * (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values:
- * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`).
- * `other` - Allows file types defined in the `file_types_other` array.
- */
- file_types_supported?: string[]
- /**
- * (file) A list of other file types allowed with the file upload option.
- */
- file_types_other?: string[]
- /**
- * (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server.
- */
- file_max_size?: number
- /**
- * (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
- */
- text_characters_limited?: boolean
- /**
- * (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
- */
- text_min_length?: number
- /**
- * (text, multi_line_text) The maximum length allowed for a text or multi line text option.
- */
- text_max_length?: number
- /**
- * (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
- */
- text_lines_limited?: boolean
- /**
- * (multi_line_text) The maximum number of lines allowed on a multi-line text input.
- */
- text_max_lines?: number
- /**
- * (numbers_only_text) Flag to limit the value of a number option.
- */
- number_limited?: boolean
- /**
- * (numbers_only_text) The type of limit on values entered for a number option.
- */
- number_limit_mode?: 'lowest' | 'highest' | 'range'
- /**
- * (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true.
- */
- number_lowest_value?: number
- /**
- * (numbers_only_text) The highest allowed value for a number option if `number_limited` is true.
- */
- number_highest_value?: number
- /**
- * (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
- */
- number_integers_only?: boolean
- /**
- * (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
- */
- product_list_adjusts_inventory?: boolean
- /**
- * (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
- */
- product_list_adjusts_pricing?: boolean
- /**
- * (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions.
- */
- product_list_shipping_calc?: 'none' | 'weight' | 'package'
- }
- /**
- * Order in which the option is displayed on the storefront.
- */
- sort_order?: number
- option_values?: ({
- /**
- * The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
- */
- is_default?: boolean
- /**
- * The text display identifying the value on the storefront. Required in a /POST.
- */
- label: string
- /**
- * The order in which the value will be displayed on the product page. Required in a /POST.
- */
- sort_order: number
- /**
- * Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.
- */
- value_data?: { [key: string]: any }
- } & {
- /**
- * The unique numeric ID of the value; increments sequentially.
- */
- id?: number
- })[]
- /**
- * Publicly available image url
- */
- image_url?: string
- }
- /**
- * The model for a PUT to update options on a product.
- */
- productOption_Put: {
- /**
- * The unique numerical ID of the option, increments sequentially.
- */
- id?: number
- /**
- * The unique numerical ID of the product to which the option belongs.
- */
- product_id?: number
- /**
- * The name of the option shown on the storefront.
- */
- display_name?: string
- /**
- * The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
- */
- type?:
- | 'radio_buttons'
- | 'rectangles'
- | 'dropdown'
- | 'product_list'
- | 'product_list_with_images'
- | 'swatch'
- /**
- * The values for option config can vary based on the Modifier created.
- */
- config?: {
- /**
- * (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
- */
- default_value?: string
- /**
- * (checkbox) Flag for setting the checkbox to be checked by default.
- */
- checked_by_default?: boolean
- /**
- * (checkbox) Label displayed for the checkbox option.
- */
- checkbox_label?: string
- /**
- * (date) Flag to limit the dates allowed to be entered on a date option.
- */
- date_limited?: boolean
- /**
- * (date) The type of limit that is allowed to be entered on a date option.
- */
- date_limit_mode?: 'earliest' | 'range' | 'latest'
- /**
- * (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_earliest_value?: string
- /**
- * (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_latest_value?: string
- /**
- * (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types.
- */
- file_types_mode?: 'specific' | 'all'
- /**
- * (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values:
- * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`).
- * `other` - Allows file types defined in the `file_types_other` array.
- */
- file_types_supported?: string[]
- /**
- * (file) A list of other file types allowed with the file upload option.
- */
- file_types_other?: string[]
- /**
- * (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server.
- */
- file_max_size?: number
- /**
- * (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
- */
- text_characters_limited?: boolean
- /**
- * (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
- */
- text_min_length?: number
- /**
- * (text, multi_line_text) The maximum length allowed for a text or multi line text option.
- */
- text_max_length?: number
- /**
- * (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
- */
- text_lines_limited?: boolean
- /**
- * (multi_line_text) The maximum number of lines allowed on a multi-line text input.
- */
- text_max_lines?: number
- /**
- * (numbers_only_text) Flag to limit the value of a number option.
- */
- number_limited?: boolean
- /**
- * (numbers_only_text) The type of limit on values entered for a number option.
- */
- number_limit_mode?: 'lowest' | 'highest' | 'range'
- /**
- * (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true.
- */
- number_lowest_value?: number
- /**
- * (numbers_only_text) The highest allowed value for a number option if `number_limited` is true.
- */
- number_highest_value?: number
- /**
- * (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
- */
- number_integers_only?: boolean
- /**
- * (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
- */
- product_list_adjusts_inventory?: boolean
- /**
- * (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
- */
- product_list_adjusts_pricing?: boolean
- /**
- * (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions.
- */
- product_list_shipping_calc?: 'none' | 'weight' | 'package'
- }
- /**
- * Order in which the option is displayed on the storefront.
- */
- sort_order?: number
- option_values?: ({
- /**
- * The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
- */
- is_default?: boolean
- /**
- * The text display identifying the value on the storefront. Required in a /POST.
- */
- label: string
- /**
- * The order in which the value will be displayed on the product page. Required in a /POST.
- */
- sort_order: number
- /**
- * Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.
- */
- value_data?: { [key: string]: any }
- } & {
- /**
- * The unique numeric ID of the value; increments sequentially.
- */
- id?: number
- })[]
- /**
- * Publicly available image url
- */
- image_url?: string
- }
- /**
- * Returns the categories tree, a nested lineage of the categories with parent->child relationship. The Category objects returned are simplified versions of the category objects returned in the rest of this API.
- */
- categoriesTree_Resp: {
- data?: definitions['categoriesTreeNode_Full'][]
- meta?: definitions['metaEmpty_Full']
- }
- /**
- * Used to reflect parent <> child category relationships. Used by Category Tree.
- */
- categoriesTreeNode_Full: {
- /**
- * The unique numeric ID of the category; increments sequentially.
- */
- id?: number
- /**
- * The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
- */
- parent_id?: number
- /**
- * The name displayed for the category. Name is unique with respect to the category's siblings.
- */
- name?: string
- /**
- * Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view.
- */
- is_visible?: boolean
- /**
- * The custom URL for the category on the storefront.
- */
- url?: string
- /**
- * The list of children of the category.
- */
- children?: definitions['categoriesTreeNode_Full'][]
- }
- /**
- * Common Category object properties.
- */
- category_Full: {
- /**
- * Unique ID of the *Category*. Increments sequentially.
- * Read-Only.
- */
- id?: number
- /**
- * The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog.
- * Required in a POST if creating a child category.
- */
- parent_id: number
- /**
- * The name displayed for the category. Name is unique with respect to the category's siblings.
- * Required in a POST.
- */
- name: string
- /**
- * The product description, which can include HTML formatting.
- */
- description?: string
- /**
- * Number of views the category has on the storefront.
- */
- views?: number
- /**
- * Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
- */
- sort_order?: number
- /**
- * Custom title for the category page. If not defined, the category name will be used as the meta title.
- */
- page_title?: string
- /**
- * A comma-separated list of keywords that can be used to locate the category when searching the store.
- */
- search_keywords?: string
- /**
- * Custom meta keywords for the category page. If not defined, the store's default keywords will be used. Must post as an array like: ["awesome","sauce"].
- */
- meta_keywords?: string[]
- /**
- * Custom meta description for the category page. If not defined, the store's default meta description will be used.
- */
- meta_description?: string
- /**
- * A valid layout file. (Please refer to [this article](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/) on creating category files.) This field is writable only for stores with a Blueprint theme applied.
- */
- layout_file?: string
- /**
- * Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view.
- */
- is_visible?: boolean
- /**
- * Determines how the products are sorted on category page load.
- */
- default_product_sort?:
- | 'use_store_settings'
- | 'featured'
- | 'newest'
- | 'best_selling'
- | 'alpha_asc'
- | 'alpha_desc'
- | 'avg_customer_review'
- | 'price_asc'
- | 'price_desc'
- /**
- * Image URL used for this category on the storefront. Images can be uploaded via form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field.
- */
- image_url?: string
- custom_url?: definitions['customUrl_Full']
- }
- /**
- * Common Brand properties.
- */
- brand_Full: {
- /**
- * Unique ID of the *Brand*. Read-Only.
- */
- id?: number
- /**
- * The name of the brand. Must be unique.
- * Required in POST.
- */
- name: string
- /**
- * The title shown in the browser while viewing the brand.
- */
- page_title?: string
- /**
- * Comma-separated list of meta keywords to include in the HTML.
- */
- meta_keywords?: string[]
- /**
- * A meta description to include.
- */
- meta_description?: string
- /**
- * A comma-separated list of keywords that can be used to locate this brand.
- */
- search_keywords?: string
- /**
- * Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field.
- */
- image_url?: string
- custom_url?: definitions['customUrl_Full']
- }
- /**
- * Common Variant properties.
- */
- productVariant_Base: {
- /**
- * The cost price of the variant. Not affected by Price List prices.
- */
- cost_price?: number
- /**
- * This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is `null`, the product's default price (set in the Product resource's `price` field) will be used as the base price.
- */
- price?: number
- /**
- * This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's `price` field) will be used as the sale price.
- */
- sale_price?: number
- /**
- * This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's `price` field) will be used as the retail price.
- */
- retail_price?: number
- /**
- * This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
- */
- weight?: number
- /**
- * Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width.
- */
- width?: number
- /**
- * Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height.
- */
- height?: number
- /**
- * Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth.
- */
- depth?: number
- /**
- * Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero.
- */
- is_free_shipping?: boolean
- /**
- * A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
- */
- fixed_cost_shipping_price?: number
- /**
- * If `true`, this variant will not be purchasable on the storefront.
- */
- purchasing_disabled?: boolean
- /**
- * If `purchasing_disabled` is `true`, this message should show on the storefront when the variant is selected.
- */
- purchasing_disabled_message?: string
- /**
- * The UPC code used in feeds for shopping comparison sites and external channel integrations.
- */
- upc?: string
- /**
- * Inventory level for the variant, which is used when the product's inventory_tracking is set to `variant`.
- */
- inventory_level?: number
- /**
- * When the variant hits this inventory level, it is considered low stock.
- */
- inventory_warning_level?: number
- /**
- * Identifies where in a warehouse the variant is located.
- */
- bin_picking_number?: string
- }
- productVariant_Full: definitions['productVariant_Base'] & {
- id?: number
- product_id?: number
- sku?: string
- /**
- * Read-only reference to v2 API's SKU ID. Null if it is a base variant.
- */
- sku_id?: number
- /**
- * Array of option and option values IDs that make up this variant. Will be empty if the variant is the product's base variant.
- */
- option_values?: definitions['productVariantOptionValue_Base'][]
- /**
- * The price of the variant as seen on the storefront. This price takes into account `sale_price` and any price adjustment rules that are applicable to this variant.
- */
- calculated_price?: number
- }
- /**
- * The model for a POST to create variants on a product.
- */
- productVariant_Post: {
- /**
- * The cost price of the variant. Not affected by Price List prices.
- */
- cost_price?: number
- /**
- * This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is `null`, the product's default price (set in the Product resource's `price` field) will be used as the base price.
- */
- price?: number
- /**
- * This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's `price` field) will be used as the sale price.
- */
- sale_price?: number
- /**
- * This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's `price` field) will be used as the retail price.
- */
- retail_price?: number
- /**
- * This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
- */
- weight?: number
- /**
- * Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width.
- */
- width?: number
- /**
- * Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height.
- */
- height?: number
- /**
- * Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth.
- */
- depth?: number
- /**
- * Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero.
- */
- is_free_shipping?: boolean
- /**
- * A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
- */
- fixed_cost_shipping_price?: number
- /**
- * If `true`, this variant will not be purchasable on the storefront.
- */
- purchasing_disabled?: boolean
- /**
- * If `purchasing_disabled` is `true`, this message should show on the storefront when the variant is selected.
- */
- purchasing_disabled_message?: string
- /**
- * The UPC code used in feeds for shopping comparison sites and external channel integrations.
- */
- upc?: string
- /**
- * Inventory level for the variant, which is used when the product's inventory_tracking is set to `variant`.
- */
- inventory_level?: number
- /**
- * When the variant hits this inventory level, it is considered low stock.
- */
- inventory_warning_level?: number
- /**
- * Identifies where in a warehouse the variant is located.
- */
- bin_picking_number?: string
- } & {
- product_id?: number
- sku?: string
- /**
- * Array of option and option values IDs that make up this variant. Will be empty if the variant is the product's base variant.
- */
- option_values?: { id?: number; option_id?: number }[]
- }
- variantCollection_Put: definitions['productVariant_Full'][]
- /**
- * The model for a PUT to update variants on a product.
- */
- variant_Put: {
- /**
- * The cost price of the variant. Not affected by Price List prices.
- */
- cost_price?: number
- /**
- * This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is `null`, the product's default price (set in the Product resource's `price` field) will be used as the base price.
- */
- price?: number
- /**
- * This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's `price` field) will be used as the sale price.
- */
- sale_price?: number
- /**
- * This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's `price` field) will be used as the retail price.
- */
- retail_price?: number
- /**
- * This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
- */
- weight?: number
- /**
- * Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width.
- */
- width?: number
- /**
- * Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height.
- */
- height?: number
- /**
- * Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth.
- */
- depth?: number
- /**
- * Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero.
- */
- is_free_shipping?: boolean
- /**
- * A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
- */
- fixed_cost_shipping_price?: number
- /**
- * If `true`, this variant will not be purchasable on the storefront.
- */
- purchasing_disabled?: boolean
- /**
- * If `purchasing_disabled` is `true`, this message should show on the storefront when the variant is selected.
- */
- purchasing_disabled_message?: string
- /**
- * The UPC code used in feeds for shopping comparison sites and external channel integrations.
- */
- upc?: string
- /**
- * Inventory level for the variant, which is used when the product's inventory_tracking is set to `variant`.
- */
- inventory_level?: number
- /**
- * When the variant hits this inventory level, it is considered low stock.
- */
- inventory_warning_level?: number
- /**
- * Identifies where in a warehouse the variant is located.
- */
- bin_picking_number?: string
- } & { id?: number }
- /**
- * The model for a POST to create variants on a product.
- */
- productVariant_Post_Product: definitions['productVariant_Base'] & {
- sku?: string
- option_values?: {
- /**
- * The name of the option.
- */
- option_display_name?: string
- /**
- * The label of the option value.
- */
- label?: string
- }[]
- }
- /**
- * The model for a PUT to update variants on a product.
- */
- productVariant_Put_Product: {
- /**
- * The cost price of the variant. Not affected by Price List prices.
- */
- cost_price?: number
- /**
- * This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is `null`, the product's default price (set in the Product resource's `price` field) will be used as the base price.
- */
- price?: number
- /**
- * This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's `price` field) will be used as the sale price.
- */
- sale_price?: number
- /**
- * This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's `price` field) will be used as the retail price.
- */
- retail_price?: number
- /**
- * This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
- */
- weight?: number
- /**
- * Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width.
- */
- width?: number
- /**
- * Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height.
- */
- height?: number
- /**
- * Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth.
- */
- depth?: number
- /**
- * Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero.
- */
- is_free_shipping?: boolean
- /**
- * A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
- */
- fixed_cost_shipping_price?: number
- /**
- * If `true`, this variant will not be purchasable on the storefront.
- */
- purchasing_disabled?: boolean
- /**
- * If `purchasing_disabled` is `true`, this message should show on the storefront when the variant is selected.
- */
- purchasing_disabled_message?: string
- /**
- * The UPC code used in feeds for shopping comparison sites and external channel integrations.
- */
- upc?: string
- /**
- * Inventory level for the variant, which is used when the product's inventory_tracking is set to `variant`.
- */
- inventory_level?: number
- /**
- * When the variant hits this inventory level, it is considered low stock.
- */
- inventory_warning_level?: number
- /**
- * Identifies where in a warehouse the variant is located.
- */
- bin_picking_number?: string
- product_id?: number
- sku?: string
- }
- productVariantOptionValue_Full: {
- /**
- * The name of the option.
- */
- option_display_name?: string
- /**
- * The label of the option value.
- */
- label?: string
- } & definitions['productVariantOptionValue_Base']
- /**
- * The model for a POST to create option values on a product.
- */
- productOptionValue_Post_Product: {
- /**
- * The name of the option.
- */
- option_display_name?: string
- /**
- * The label of the option value.
- */
- label?: string
- }
- /**
- * Common Product Variant Option properties.
- */
- productVariantOptionValue_Base: { id?: number; option_id?: number }
- /**
- * The model for a POST to create option values on a variant.
- */
- productVariantOptionValue_Post: { id?: number; option_id?: number }
- resp_productOptionValue: {
- data?: definitions['productOptionOptionValue_Full']
- /**
- * Empty meta object; may be used later.
- */
- meta?: { ''?: string }
- }
- /**
- * Common Product Option `option_value` properties.
- */
- productOptionOptionValue_Base: {
- /**
- * The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
- */
- is_default?: boolean
- /**
- * The text display identifying the value on the storefront. Required in a /POST.
- */
- label: string
- /**
- * The order in which the value will be displayed on the product page. Required in a /POST.
- */
- sort_order: number
- /**
- * Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. If no data is available, returns `null`.
- */
- value_data?: { [key: string]: any }
- }
- /**
- * Product Option `option_value`.
- */
- productOptionOptionValue_Full: definitions['productOptionOptionValue_Base'] & {
- /**
- * The unique numeric ID of the value; increments sequentially.
- */
- id?: number
- }
- /**
- * The model for a POST to create option values on a product.
- */
- productOptionValue_Post: {
- /**
- * The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
- */
- is_default?: boolean
- /**
- * The text display identifying the value on the storefront. Required in a /POST.
- */
- label: string
- /**
- * The order in which the value will be displayed on the product page. Required in a /POST.
- */
- sort_order: number
- /**
- * Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.
- */
- value_data?: { [key: string]: any }
- }
- /**
- * The model for a PUT to update option values on a product.
- */
- productOptionValue_Put: {
- /**
- * The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
- */
- is_default?: boolean
- /**
- * The text display identifying the value on the storefront. Required in a /POST.
- */
- label: string
- /**
- * The order in which the value will be displayed on the product page. Required in a /POST.
- */
- sort_order: number
- /**
- * Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.
- */
- value_data?: { [key: string]: any }
- } & {
- /**
- * The unique numeric ID of the value; increments sequentially.
- */
- id?: number
- }
- /**
- * Common ProductImage properties.
- */
- productImage_Base: {
- /**
- * The local path to the original image file uploaded to BigCommerce.
- */
- image_file?: string
- /**
- * Flag for identifying whether the image is used as the product's thumbnail.
- */
- is_thumbnail?: boolean
- /**
- * The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the image's new `sort_order` value will have their `sort_order`s reordered.
- */
- sort_order?: number
- /**
- * The description for the image.
- */
- description?: string
- /**
- * Must be a fully qualified URL path, including protocol. Limit of 8MB per file.
- */
- image_url?: string
- }
- /**
- * The model for a POST to create an image on a product.
- */
- productImage_Post: {
- /**
- * The unique numeric ID of the image; increments sequentially.
- */
- id?: number
- /**
- * The unique numeric identifier for the product with which the image is associated.
- */
- product_id?: number
- /**
- * The local path to the original image file uploaded to BigCommerce.
- */
- image_file?: string
- /**
- * The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
- */
- url_zoom?: string
- /**
- * The standard URL for this image. By default, this is used for product-page images.
- */
- url_standard?: string
- /**
- * The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
- */
- url_thumbnail?: string
- /**
- * The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
- */
- url_tiny?: string
- /**
- * The date on which the product image was modified.
- */
- date_modified?: string
- /**
- * Flag for identifying whether the image is used as the product's thumbnail.
- */
- is_thumbnail?: boolean
- /**
- * The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the image's new `sort_order` value will have their `sort_order`s reordered.
- */
- sort_order?: number
- /**
- * The description for the image.
- */
- description?: string
- } & {
- /**
- * Must be a fully qualified URL path, including protocol. Limit of 8MB per file.
- */
- image_url?: string
- /**
- * Must be sent as a multipart/form-data field in the request body.
- */
- image_file?: string
- }
- /**
- * The model for a PUT to update applicable Product Image fields.
- */
- productImage_Put: {
- /**
- * The unique numeric ID of the image; increments sequentially.
- */
- id?: number
- /**
- * The unique numeric identifier for the product with which the image is associated.
- */
- product_id?: number
- /**
- * The local path to the original image file uploaded to BigCommerce.
- */
- image_file?: string
- /**
- * The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
- */
- url_zoom?: string
- /**
- * The standard URL for this image. By default, this is used for product-page images.
- */
- url_standard?: string
- /**
- * The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
- */
- url_thumbnail?: string
- /**
- * The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
- */
- url_tiny?: string
- /**
- * The date on which the product image was modified.
- */
- date_modified?: string
- /**
- * Flag for identifying whether the image is used as the product's thumbnail.
- */
- is_thumbnail?: boolean
- /**
- * The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the image's new `sort_order` value will have their `sort_order`s reordered.
- */
- sort_order?: number
- /**
- * The description for the image.
- */
- description?: string
- }
- /**
- * The model for a POST to create a video on a product.
- */
- productVideo_Base: {
- /**
- * The title for the video. If left blank, this will be filled in according to data on a host site.
- */
- title?: string
- /**
- * The description for the video. If left blank, this will be filled in according to data on a host site.
- */
- description?: string
- /**
- * The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the video's new `sort_order` value will have their `sort_order`s reordered.
- */
- sort_order?: number
- /**
- * The video type (a short name of a host site).
- */
- type?: 'youtube'
- /**
- * The ID of the video on a host site.
- */
- video_id?: string
- }
- /**
- * A product video model.
- */
- productVideo_Full: definitions['productVideo_Base'] & {
- /**
- * The unique numeric ID of the product video; increments sequentially.
- */
- id?: number
- /**
- * The unique numeric identifier for the product with which the image is associated.
- */
- product_id?: number
- /**
- * Length of the video. This will be filled in according to data on a host site.
- */
- length?: string
- }
- /**
- * The model for a POST to create a video on a product.
- */
- productVideo_Post: definitions['productVideo_Base']
- /**
- * The model for a PUT to update a video on a product.
- */
- productVideo_Put: definitions['productVideo_Base'] & {
- /**
- * The unique numeric ID of the product video; increments sequentially.
- */
- id?: number
- }
- productReview_Base: {
- /**
- * The title for the product review.
- * Required in /POST.
- */
- title: string
- /**
- * The text for the product review.
- */
- text?: string
- /**
- * The status of the product review. Must be one of `approved`, `disapproved` or `pending`.
- */
- status?: string
- /**
- * The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
- */
- rating?: number
- /**
- * The email of the reviewer. Must be a valid email, or an empty string.
- */
- email?: string
- /**
- * The name of the reviewer.
- */
- name?: string
- /**
- * Date the product was reviewed. Required in /POST.
- */
- date_reviewed: string
- }
- /**
- * A product review model.
- */
- productReview_Full: definitions['productReview_Base'] & {
- /**
- * The unique numeric ID of the product review; increments sequentially.
- */
- id?: number
- /**
- * The unique numeric identifier for the product with which the review is associated.
- */
- product_id?: number
- /**
- * Date the product review was created.
- */
- date_created?: string
- /**
- * Date the product review was modified.
- */
- date_modified?: string
- }
- /**
- * The model for a POST to create a product review.
- */
- productReview_Post: {
- /**
- * The title for the product review.
- * Required in /POST.
- */
- title: string
- /**
- * The text for the product review.
- */
- text?: string
- /**
- * The status of the product review. Must be one of `approved`, `disapproved` or `pending`.
- */
- status?: string
- /**
- * The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
- */
- rating?: number
- /**
- * The email of the reviewer. Must be a valid email, or an empty string.
- */
- email?: string
- /**
- * The name of the reviewer.
- */
- name?: string
- /**
- * Date the product was reviewed. Required in /POST.
- */
- date_reviewed: string
- }
- /**
- * The model for a PUT to update a product review.
- */
- productReview_Put: {
- /**
- * The title for the product review.
- * Required in /POST.
- */
- title: string
- /**
- * The text for the product review.
- */
- text?: string
- /**
- * The status of the product review. Must be one of `approved`, `disapproved` or `pending`.
- */
- status?: string
- /**
- * The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
- */
- rating?: number
- /**
- * The email of the reviewer. Must be a valid email, or an empty string.
- */
- email?: string
- /**
- * The name of the reviewer.
- */
- name?: string
- /**
- * Date the product was reviewed. Required in /POST.
- */
- date_reviewed: string
- }
- /**
- * Image Response returns for:
- * * Create Variant Image
- * * Create Modifier Image
- * * Create Category Image
- * * Create Brand Image
- */
- resp_productImage: {
- data?: definitions['productImage_Full']
- /**
- * Empty meta object; may be used later.
- */
- meta?: { [key: string]: any }
- }
- /**
- * An object containing a publicly accessible image URL, or a form post that contains an image file.
- */
- resourceImage_Full: {
- /**
- * A public URL for a GIF, JPEG, or PNG image. Limit of 8MB per file.
- */
- image_url?: string
- }
- product_Post: definitions['product_Base'] & {
- variants?: definitions['productVariant_Post_Product']
- }
- /**
- * The model for a PUT to update a product.
- */
- product_Put: {
- /**
- * The unique numerical ID of the product; increments sequentially.
- */
- id?: number
- } & definitions['product_Base'] & {
- variants?: definitions['productVariant_Put_Product']
- }
- /**
- * Catalog Summary object describes a lightweight summary of the catalog.
- */
- catalogSummary_Full: {
- /**
- * A count of all inventory items in the catalog.
- */
- inventory_count?: number
- /**
- * Total value of store's inventory.
- */
- inventory_value?: number
- /**
- * ID of the category containing the most products.
- */
- primary_category_id?: number
- /**
- * Name of the category containing the most products.
- */
- primary_category_name?: string
- /**
- * Total number of variants
- */
- variant_count?: number
- /**
- * Highest priced variant
- */
- highest_variant_price?: number
- /**
- * Average price of all variants
- */
- average_variant_price?: number
- /**
- * Lowest priced variant in the store
- */
- lowest_variant_price?: string
- oldest_variant_date?: string
- newest_variant_date?: string
- }
- /**
- * Metafield for products, categories, variants, and brands. The max number of metafields allowed on each product, category, variant, or brand is fifty. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center.
- */
- metafield_Base: {
- /**
- * Unique ID of the *Metafield*. Read-Only.
- */
- id?: number
- /**
- * Determines the visibility and writeability of the field by other API consumers.
- *
- * |Value|Description
- * |-|-|
- * |`app_only`|Private to the app that owns the field|
- * |`read`|Visible to other API consumers|
- * |`write`|Open for reading and writing by other API consumers|
- * |`read_and_sf_access`|Visible to other API consumers, including on storefront|
- * |`write_and_sf_access`|Open for reading and writing by other API consumers, including on storefront|
- */
- permission_set:
- | 'app_only'
- | 'read'
- | 'write'
- | 'read_and_sf_access'
- | 'write_and_sf_access'
- /**
- * Namespace for the metafield, for organizational purposes. This is set set by the developer. Required for POST.
- */
- namespace: string
- /**
- * The name of the field, for example: `location_id`, `color`. Required for POST.
- */
- key: string
- /**
- * The value of the field, for example: `1`, `blue`. Required for POST.
- */
- value: string
- /**
- * Description for the metafields.
- */
- description?: string
- /**
- * The type of resource with which the metafield is associated.
- */
- resource_type?: 'category' | 'brand' | 'product' | 'variant'
- /**
- * The ID for the resource with which the metafield is associated.
- */
- resource_id?: number
- /**
- * Date and time of the metafield's creation. Read-Only.
- */
- date_created?: string
- /**
- * Date and time when the metafield was last updated. Read-Only.
- */
- date_modified?: string
- }
- /**
- * Common ComplexRule properties.
- */
- complexRule_Base: {
- /**
- * The unique numeric ID of the rule; increments sequentially.
- * Read-Only
- */
- id?: number
- /**
- * The unique numeric ID of the product with which the rule is associated; increments sequentially.
- */
- product_id?: number
- /**
- * The priority to give this rule when making adjustments to the product properties.
- */
- sort_order?: number
- /**
- * Flag for determining whether the rule is to be used when adjusting a product's price, weight, image, or availabilty.
- */
- enabled?: boolean
- /**
- * Flag for determining whether other rules should not be applied after this rule has been applied.
- */
- stop?: boolean
- /**
- * Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.
- */
- purchasing_disabled?: boolean
- /**
- * Message displayed on the storefront when a rule disables the purchasing of a product.
- */
- purchasing_disabled_message?: string
- /**
- * Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.
- */
- purchasing_hidden?: boolean
- /**
- * The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file.
- */
- image_url?: string
- price_adjuster?: definitions['adjuster_Full']
- weight_adjuster?: definitions['adjuster_Full']
- conditions?: definitions['complexRuleConditionBase'][]
- }
- /**
- * Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product's page, such as a book's ISBN or a DVD's release date.
- */
- productCustomField_Base: {
- /**
- * The unique numeric ID of the custom field; increments sequentially.
- * Read-Only
- */
- id?: number
- /**
- * The name of the field, shown on the storefront, orders, etc. Required for /POST
- */
- name: string
- /**
- * The name of the field, shown on the storefront, orders, etc. Required for /POST
- */
- value: string
- }
- /**
- * The model for a POST to create a custom field on a product.
- */
- productCustomField_Post: {
- /**
- * The unique numeric ID of the custom field; increments sequentially.
- * Read-Only
- */
- id?: number
- /**
- * The name of the field, shown on the storefront, orders, etc. Required for /POST
- */
- name: string
- /**
- * The name of the field, shown on the storefront, orders, etc. Required for /POST
- */
- value: string
- }
- /**
- * The model for a PUT to update a custom field on a product.
- */
- productCustomField_Put: {
- /**
- * The unique numeric ID of the custom field; increments sequentially.
- * Read-Only
- */
- id?: number
- /**
- * The name of the field, shown on the storefront, orders, etc. Required for /POST
- */
- name: string
- /**
- * The name of the field, shown on the storefront, orders, etc. Required for /POST
- */
- value: string
- }
- /**
- * Complex rules may return with conditions that apply to one or more variants, or with a single modifier value (if the rules were created using the v2 API or the control panel). Complex rules created or updated in the v3 API must have conditions that either reference multiple `modifier_value_id`'s, or else reference a `modifier_value_id` and a `variant_id`.
- */
- complexRuleConditionBase: {
- /**
- * The unique numeric ID of the rule condition; increments sequentially. Read-Only
- */
- id?: number
- /**
- * The unique numeric ID of the rule with which the condition is associated.
- * Read-Only
- */
- rule_id?: number
- /**
- * The unique numeric ID of the modifier with which the rule condition is associated.
- * Required in /POST.
- */
- modifier_id: number
- /**
- * The unique numeric ID of the modifier value with which the rule condition is associated.
- * Required in /POST.
- */
- modifier_value_id: number
- /**
- * The unique numeric ID of the variant with which the rule condition is associated.
- * Required in /POST.
- */
- variant_id: number
- /**
- * (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3.
- */
- combination_id?: number
- }
- /**
- * The custom URL for the category on the storefront.
- */
- customUrl_Full: {
- /**
- * Category URL on the storefront.
- */
- url?: string
- /**
- * Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
- */
- is_customized?: boolean
- }
- /**
- * Common Bulk Pricing Rule properties
- */
- bulkPricingRule_Full: {
- /**
- * Unique ID of the *Bulk Pricing Rule*. Read-Only.
- */
- id?: number
- /**
- * The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
- * Required in /POST.
- */
- quantity_min: number
- /**
- * The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the `quantity_min` value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.
- * Required in /POST.
- */
- quantity_max: number
- /**
- * The type of adjustment that is made. Values: `price` - the adjustment amount per product; `percent` - the adjustment as a percentage of the original price; `fixed` - the adjusted absolute price of the product.
- * Required in /POST.
- */
- type: 'price' | 'percent' | 'fixed'
- /**
- * The discount can be a fixed dollar amount or a percentage. For a fixed dollar amount enter it as an integer and the response will return as an integer. For percentage enter the amount as the percentage divided by 100 using string format. For example 10% percent would be “.10”. The response will return as an integer.
- * Required in /POST.
- */
- amount: number
- }
- /**
- * The values for option config can vary based on the Modifier created.
- */
- productOptionConfig_Full: {
- /**
- * (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
- */
- default_value?: string
- /**
- * (checkbox) Flag for setting the checkbox to be checked by default.
- */
- checked_by_default?: boolean
- /**
- * (checkbox) Label displayed for the checkbox option.
- */
- checkbox_label?: string
- /**
- * (date) Flag to limit the dates allowed to be entered on a date option.
- */
- date_limited?: boolean
- /**
- * (date) The type of limit that is allowed to be entered on a date option.
- */
- date_limit_mode?: 'earliest' | 'range' | 'latest'
- /**
- * (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_earliest_value?: string
- /**
- * (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_latest_value?: string
- /**
- * (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types.
- */
- file_types_mode?: 'specific' | 'all'
- /**
- * (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values:
- * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`).
- * `other` - Allows file types defined in the `file_types_other` array.
- */
- file_types_supported?: string[]
- /**
- * (file) A list of other file types allowed with the file upload option.
- */
- file_types_other?: string[]
- /**
- * (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server.
- */
- file_max_size?: number
- /**
- * (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
- */
- text_characters_limited?: boolean
- /**
- * (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
- */
- text_min_length?: number
- /**
- * (text, multi_line_text) The maximum length allowed for a text or multi line text option.
- */
- text_max_length?: number
- /**
- * (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
- */
- text_lines_limited?: boolean
- /**
- * (multi_line_text) The maximum number of lines allowed on a multi-line text input.
- */
- text_max_lines?: number
- /**
- * (numbers_only_text) Flag to limit the value of a number option.
- */
- number_limited?: boolean
- /**
- * (numbers_only_text) The type of limit on values entered for a number option.
- */
- number_limit_mode?: 'lowest' | 'highest' | 'range'
- /**
- * (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true.
- */
- number_lowest_value?: number
- /**
- * (numbers_only_text) The highest allowed value for a number option if `number_limited` is true.
- */
- number_highest_value?: number
- /**
- * (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
- */
- number_integers_only?: boolean
- /**
- * (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
- */
- product_list_adjusts_inventory?: boolean
- /**
- * (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
- */
- product_list_adjusts_pricing?: boolean
- /**
- * (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions.
- */
- product_list_shipping_calc?: 'none' | 'weight' | 'package'
- }
- /**
- * Adjuster for Complex Rules.
- */
- adjuster_Full: {
- /**
- * The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster?: 'relative' | 'percentage'
- /**
- * The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.
- */
- adjuster_value?: number
- }
- /**
- * Errors during batch usage for the BigCommerce API.
- */
- resp_variantBatchError: {
- batch_errors?: (definitions['error_Base'] & {
- errors?: { additionalProperties?: string }
- })[]
- }
- /**
- * Data about the response, including pagination and collection totals.
- */
- metaCollection_Full: { pagination?: definitions['pagination_Full'] }
- /**
- * Data about the response, including pagination and collection totals.
- */
- pagination_Full: {
- /**
- * Total number of items in the result set.
- */
- total?: number
- /**
- * Total number of items in the collection response.
- */
- count?: number
- /**
- * The amount of items returned in the collection per page, controlled by the limit parameter.
- */
- per_page?: number
- /**
- * The page you are currently on within the collection.
- */
- current_page?: number
- /**
- * The total number of pages in the collection.
- */
- total_pages?: number
- /**
- * Pagination links for the previous and next parts of the whole collection.
- */
- links?: {
- /**
- * Link to the previous page returned in the response.
- */
- previous?: string
- /**
- * Link to the current page returned in the response.
- */
- current?: string
- /**
- * Link to the next page returned in the response.
- */
- next?: string
- }
- }
- /**
- * Empty meta object; may be used later.
- */
- metaEmpty_Full: { [key: string]: any }
- errorResponse_Full: definitions['error_Base'] & {
- errors?: definitions['detailedErrors']
- }
- /**
- * Error payload for the BigCommerce API.
- */
- error_Base: {
- /**
- * The HTTP status code.
- */
- status?: number
- /**
- * The error title describing the particular error.
- */
- title?: string
- type?: string
- instance?: string
- }
- /**
- * Error payload for the BigCommerce API.
- */
- errorNotFound: {
- /**
- * 404 HTTP status code.
- */
- status?: number
- /**
- * The error title describing the particular error.
- */
- title?: string
- type?: string
- instance?: string
- }
- /**
- * A gift-certificate model.
- */
- giftCertificate_Full: {
- /**
- * The gift-certificate code.
- */
- code?: string
- /**
- * The balance on a gift certificate when it was purchased.
- */
- original_balance?: number
- /**
- * The balance on a gift certificate at the time of this purchase.
- */
- starting_balance?: number
- /**
- * The remaining balance on a gift certificate.
- */
- remaining_balance?: number
- /**
- * The status of a gift certificate: `active` - gift certificate is active; `pending` - gift certificate purchase is pending; `disabled` - gift certificate is disabled; `expired` - gift certificate is expired.
- */
- status?: 'active' | 'pending' | 'disabled' | 'expired'
- }
- /**
- * No-content response for the BigCommerce API.
- */
- errorNoContent: {
- /**
- * 204 HTTP status code.
- */
- status?: number
- /**
- * The error title describing the situation.
- */
- title?: string
- type?: string
- instance?: string
- }
- detailedErrors: { additionalProperties?: string }
- product_Full: definitions['product_Base'] & {
- /**
- * The date on which the product was created.
- */
- date_created?: string
- /**
- * The date on which the product was modified.
- */
- date_modified?: string
- /**
- * ID of the product. Read Only.
- */
- id?: number
- /**
- * The unique identifier of the base variant associated with a simple product. This value is `null` for complex products.
- */
- base_variant_id?: number
- /**
- * The price of the product as seen on the storefront. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`.
- */
- calculated_price?: number
- options?: definitions['productOption_Base'][]
- modifiers?: definitions['productModifier_Full'][]
- /**
- * Minimum Advertised Price.
- */
- map_price?: number
- /**
- * Indicates that the product is in an Option Set (legacy V2 concept).
- */
- option_set_id?: number
- /**
- * Legacy template setting which controls if the option set shows up to the side of or below the product image and description.
- */
- option_set_display?: string
- } & { variants?: definitions['productVariant_Full'] }
- /**
- * Common ProductImage properties.
- */
- productImage_Full: definitions['productImage_Base'] & {
- /**
- * The unique numeric ID of the image; increments sequentially.
- */
- id?: number
- /**
- * The unique numeric identifier for the product with which the image is associated.
- */
- product_id?: number
- /**
- * The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.
- */
- url_zoom?: string
- /**
- * The standard URL for this image. By default, this is used for product-page images.
- */
- url_standard?: string
- /**
- * The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
- */
- url_thumbnail?: string
- /**
- * The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.
- */
- url_tiny?: string
- /**
- * The date on which the product image was modified.
- */
- date_modified?: string
- }
- metafield_Post: definitions['metafield_Base']
- /**
- * The model for batch updating products.
- */
- product_Put_Collection: ({
- /**
- * The unique numerical ID of the product; increments sequentially. Required on batch product `PUT` requests.
- */
- id: number
- } & definitions['product_Base'])[]
- /**
- * The values for option config can vary based on the Modifier created.
- */
- config_Full: {
- /**
- * (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.
- */
- default_value?: string
- /**
- * (checkbox) Flag for setting the checkbox to be checked by default.
- */
- checked_by_default?: boolean
- /**
- * (checkbox) Label displayed for the checkbox option.
- */
- checkbox_label?: string
- /**
- * (date) Flag to limit the dates allowed to be entered on a date option.
- */
- date_limited?: boolean
- /**
- * (date) The type of limit that is allowed to be entered on a date option.
- */
- date_limit_mode?: 'earliest' | 'range' | 'latest'
- /**
- * (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_earliest_value?: string
- /**
- * (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
- */
- date_latest_value?: string
- /**
- * (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types.
- */
- file_types_mode?: 'specific' | 'all'
- /**
- * (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values:
- * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`).
- * `other` - Allows file types defined in the `file_types_other` array.
- */
- file_types_supported?: string[]
- /**
- * (file) A list of other file types allowed with the file upload option.
- */
- file_types_other?: string[]
- /**
- * (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server.
- */
- file_max_size?: number
- /**
- * (text, multi_line_text) Flag to validate the length of a text or multi-line text input.
- */
- text_characters_limited?: boolean
- /**
- * (text, multi_line_text) The minimum length allowed for a text or multi-line text option.
- */
- text_min_length?: number
- /**
- * (text, multi_line_text) The maximum length allowed for a text or multi line text option.
- */
- text_max_length?: number
- /**
- * (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.
- */
- text_lines_limited?: boolean
- /**
- * (multi_line_text) The maximum number of lines allowed on a multi-line text input.
- */
- text_max_lines?: number
- /**
- * (numbers_only_text) Flag to limit the value of a number option.
- */
- number_limited?: boolean
- /**
- * (numbers_only_text) The type of limit on values entered for a number option.
- */
- number_limit_mode?: 'lowest' | 'highest' | 'range'
- /**
- * (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true.
- */
- number_lowest_value?: number
- /**
- * (numbers_only_text) The highest allowed value for a number option if `number_limited` is true.
- */
- number_highest_value?: number
- /**
- * (numbers_only_text) Flag to limit the input on a number option to whole numbers only.
- */
- number_integers_only?: boolean
- /**
- * (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.
- */
- product_list_adjusts_inventory?: boolean
- /**
- * (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.
- */
- product_list_adjusts_pricing?: boolean
- /**
- * (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions.
- */
- product_list_shipping_calc?: 'none' | 'weight' | 'package'
- }
- adjusters_Full: {
- price?: definitions['adjuster_Full']
- weight?: definitions['adjuster_Full']
- /**
- * The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file.
- */
- image_url?: string
- purchasing_disabled?: {
- /**
- * Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value.
- */
- status?: boolean
- /**
- * The message displayed on the storefront when the purchasing disabled status is `true`.
- */
- message?: string
- }
- }
- /**
- * Variant properties used on:
- * * `/catalog/products/variants`
- * * `/catalog/variants`
- */
- variant_Base: {
- /**
- * The cost price of the variant. Not affected by Price List prices.
- */
- cost_price?: number
- /**
- * This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is `null`, the product's default price (set in the Product resource's `price` field) will be used as the base price.
- */
- price?: number
- /**
- * This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's `price` field) will be used as the sale price.
- */
- sale_price?: number
- /**
- * This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's `price` field) will be used as the retail price.
- */
- retail_price?: number
- /**
- * This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.
- */
- weight?: number
- /**
- * Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width.
- */
- width?: number
- /**
- * Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height.
- */
- height?: number
- /**
- * Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth.
- */
- depth?: number
- /**
- * Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero.
- */
- is_free_shipping?: boolean
- /**
- * A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
- */
- fixed_cost_shipping_price?: number
- /**
- * If `true`, this variant will not be purchasable on the storefront.
- */
- purchasing_disabled?: boolean
- /**
- * If `purchasing_disabled` is `true`, this message should show on the storefront when the variant is selected.
- */
- purchasing_disabled_message?: string
- /**
- * The UPC code used in feeds for shopping comparison sites and external channel integrations.
- */
- upc?: string
- /**
- * Inventory level for the variant, which is used when the product's inventory_tracking is set to `variant`.
- */
- inventory_level?: number
- /**
- * When the variant hits this inventory level, it is considered low stock.
- */
- inventory_warning_level?: number
- /**
- * Identifies where in a warehouse the variant is located.
- */
- bin_picking_number?: string
- }
- /**
- * Shared `Product` properties used in:
- * * `POST`
- * * `PUT`
- * * `GET`
- */
- product_Base: {
- /**
- * The product name.
- */
- name?: string
- /**
- * The product type. One of: `physical` - a physical stock unit, `digital` - a digital download.
- */
- type?: 'physical' | 'digital'
- /**
- * User defined product code/stock keeping unit (SKU).
- */
- sku?: string
- /**
- * The product description, which can include HTML formatting.
- */
- description?: string
- /**
- * Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store
- */
- weight?: number
- /**
- * Width of the product, which can be used when calculating shipping costs.
- */
- width?: number
- /**
- * Depth of the product, which can be used when calculating shipping costs.
- */
- depth?: number
- /**
- * Height of the product, which can be used when calculating shipping costs.
- */
- height?: number
- /**
- * The price of the product. The price should include or exclude tax, based on the store settings.
- */
- price?: number
- /**
- * The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.
- */
- cost_price?: number
- /**
- * The retail cost of the product. If entered, the retail cost price will be shown on the product page.
- */
- retail_price?: number
- /**
- * If entered, the sale price will be used instead of value in the price field when calculating the product's cost.
- */
- sale_price?: number
- /**
- * The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
- */
- tax_class_id?: number
- /**
- * Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation.
- */
- product_tax_code?: string
- /**
- * An array of IDs for the categories to which this product belongs. When updating a product, if an array of categories is supplied, all product categories will be overwritten. Does not accept more than 1,000 ID values.
- */
- categories?: number[]
- /**
- * A product can be added to an existing brand during a product /PUT or /POST.
- */
- brand_id?: number
- /**
- * Current inventory level of the product. Simple inventory tracking must be enabled (See the `inventory_tracking` field) for this to take any effect.
- */
- inventory_level?: number
- /**
- * Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the `inventory_tracking` field) for this to take any effect.
- */
- inventory_warning_level?: number
- /**
- * The type of inventory tracking for the product. Values are: `none` - inventory levels will not be tracked; `product` - inventory levels will be tracked using the `inventory_level` and `inventory_warning_level` fields; `variant` - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels.
- */
- inventory_tracking?: 'none' | 'product' | 'variant'
- /**
- * A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
- */
- fixed_cost_shipping_price?: number
- /**
- * Flag used to indicate whether the product has free shipping. If `true`, the shipping cost for the product will be zero.
- */
- is_free_shipping?: boolean
- /**
- * Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the product will be displayed. If `false`, the product will be hidden from view.
- */
- is_visible?: boolean
- /**
- * Flag to determine whether the product should be included in the `featured products` panel when viewing the store.
- */
- is_featured?: boolean
- /**
- * An array of IDs for the related products.
- */
- related_products?: number[]
- /**
- * Warranty information displayed on the product page. Can include HTML formatting.
- */
- warranty?: string
- /**
- * The BIN picking number for the product.
- */
- bin_picking_number?: string
- /**
- * The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied.
- */
- layout_file?: string
- /**
- * The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.
- */
- upc?: string
- /**
- * A comma-separated list of keywords that can be used to locate the product when searching the store.
- */
- search_keywords?: string
- /**
- * Availability of the product. Availability options are: `available` - the product can be purchased on the storefront; `disabled` - the product is listed in the storefront, but cannot be purchased; `preorder` - the product is listed for pre-orders.
- */
- availability?: 'available' | 'disabled' | 'preorder'
- /**
- * Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.'
- */
- availability_description?: string
- /**
- * Type of gift-wrapping options. Values: `any` - allow any gift-wrapping options in the store; `none` - disallow gift-wrapping on the product; `list` – provide a list of IDs in the `gift_wrapping_options_list` field.
- */
- gift_wrapping_options_type?: 'any' | 'none' | 'list'
- /**
- * A list of gift-wrapping option IDs.
- */
- gift_wrapping_options_list?: number[]
- /**
- * Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
- */
- sort_order?: number
- /**
- * The product condition. Will be shown on the product page if the `is_condition_shown` field's value is `true`. Possible values: `New`, `Used`, `Refurbished`.
- */
- condition?: 'New' | 'Used' | 'Refurbished'
- /**
- * Flag used to determine whether the product condition is shown to the customer on the product page.
- */
- is_condition_shown?: boolean
- /**
- * The minimum quantity an order must contain, to be eligible to purchase this product.
- */
- order_quantity_minimum?: number
- /**
- * The maximum quantity an order can contain when purchasing the product.
- */
- order_quantity_maximum?: number
- /**
- * Custom title for the product page. If not defined, the product name will be used as the meta title.
- */
- page_title?: string
- /**
- * Custom meta keywords for the product page. If not defined, the store's default keywords will be used.
- */
- meta_keywords?: string[]
- /**
- * Custom meta description for the product page. If not defined, the store's default meta description will be used.
- */
- meta_description?: string
- /**
- * The number of times the product has been viewed.
- */
- view_count?: number
- /**
- * Pre-order release date. See the `availability` field for details on setting a product's availability to accept pre-orders.
- */
- preorder_release_date?: string
- /**
- * Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the `%%DATE%%` placeholder, which will be substituted for the release date.
- */
- preorder_message?: string
- /**
- * If set to true then on the preorder release date the preorder status will automatically be removed.
- * If set to false, then on the release date the preorder status **will not** be removed. It will need to be changed manually either in the
- * control panel or using the API. Using the API set `availability` to `available`.
- */
- is_preorder_only?: boolean
- /**
- * False by default, indicating that this product's price should be shown on the product page. If set to `true`, the price is hidden. (NOTE: To successfully set `is_price_hidden` to `true`, the `availability` value must be `disabled`.)
- */
- is_price_hidden?: boolean
- /**
- * By default, an empty string. If `is_price_hidden` is `true`, the value of `price_hidden_label` is displayed instead of the price. (NOTE: To successfully set a non-empty string value with `is_price_hidden` set to `true`, the `availability` value must be `disabled`.)
- */
- price_hidden_label?: string
- custom_url?: definitions['customUrl_Full']
- /**
- * Type of product, defaults to `product`.
- */
- open_graph_type?:
- | 'product'
- | 'album'
- | 'book'
- | 'drink'
- | 'food'
- | 'game'
- | 'movie'
- | 'song'
- | 'tv_show'
- /**
- * Title of the product, if not specified the product name will be used instead.
- */
- open_graph_title?: string
- /**
- * Description to use for the product, if not specified then the meta_description will be used instead.
- */
- open_graph_description?: string
- /**
- * Flag to determine if product description or open graph description is used.
- */
- open_graph_use_meta_description?: boolean
- /**
- * Flag to determine if product name or open graph name is used.
- */
- open_graph_use_product_name?: boolean
- /**
- * Flag to determine if product image or open graph image is used.
- */
- open_graph_use_image?: boolean
- /**
- * The brand can be created during a product PUT or POST request. If the brand already exists then the product will be added. If not the brand will be created and the product added. If using `brand_name` it performs a fuzzy match and adds the brand. eg. "Common Good" and "Common good" are the same. Brand name does not return as part of a product response. Only the `brand_id`.
- */
- 'brand_name or brand_id'?: string
- /**
- * Global Trade Item Number
- */
- gtin?: string
- /**
- * Manufacturer Part Number
- */
- mpn?: string
- /**
- * The total rating for the product.
- */
- reviews_rating_sum?: number
- /**
- * The number of times the product has been rated.
- */
- reviews_count?: number
- /**
- * The total quantity of this product sold.
- */
- total_sold?: number
- custom_fields?: definitions['productCustomField_Put'][]
- bulk_pricing_rules?: definitions['bulkPricingRule_Full'][]
- images?: definitions['productImage_Full'][]
- primary_image?: definitions['productImage_Full']
- videos?: definitions['productVideo_Full'][]
- }
- /**
- * Properties for updating metafields.
- */
- metafield_Put: {
- /**
- * Unique ID of the *Metafield*. Read-Only.
- */
- id?: number
- } & definitions['metafield_Base']
- metafield_Full: definitions['metafield_Put'] & {
- /**
- * Date and time of the metafield's creation. Read-Only.
- */
- date_created?: string
- /**
- * Date and time when the metafield was last updated. Read-Only.
- */
- date_modified?: string
- }
- /**
- * The model for a PUT to update variants on a product.
- */
- productVariant_Put: definitions['productVariant_Base'] & {
- product_id?: number
- sku?: string
- }
-}
diff --git a/framework/bigcommerce/api/definitions/store-content.ts b/framework/bigcommerce/api/definitions/store-content.ts
deleted file mode 100644
index f00c28844..000000000
--- a/framework/bigcommerce/api/definitions/store-content.ts
+++ /dev/null
@@ -1,329 +0,0 @@
-/**
- * This file was auto-generated by swagger-to-ts.
- * Do not make direct changes to the file.
- */
-
-export interface definitions {
- blogPost_Full: {
- /**
- * ID of this blog post. (READ-ONLY)
- */
- id?: number
- } & definitions['blogPost_Base']
- addresses: {
- /**
- * Full URL of where the resource is located.
- */
- url?: string
- /**
- * Resource being accessed.
- */
- resource?: string
- }
- formField: {
- /**
- * Name of the form field
- */
- name?: string
- /**
- * Value of the form field
- */
- value?: string
- }
- page_Full: {
- /**
- * ID of the page.
- */
- id?: number
- } & definitions['page_Base']
- redirect: {
- /**
- * Numeric ID of the redirect.
- */
- id?: number
- /**
- * The path from which to redirect.
- */
- path: string
- forward: definitions['forward']
- /**
- * URL of the redirect. READ-ONLY
- */
- url?: string
- }
- forward: {
- /**
- * The type of redirect. If it is a `manual` redirect then type will always be manual. Dynamic redirects will have the type of the page. Such as product or category.
- */
- type?: string
- /**
- * Reference of the redirect. Dynamic redirects will have the category or product number. Manual redirects will have the url that is being directed to.
- */
- ref?: number
- }
- customer_Full: {
- /**
- * Unique numeric ID of this customer. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
- */
- id?: number
- /**
- * Not returned in any responses, but accepts up to two fields allowing you to set the customer’s password. If a password is not supplied, it is generated automatically. For further information about using this object, please see the Customers resource documentation.
- */
- _authentication?: {
- force_reset?: string
- password?: string
- password_confirmation?: string
- }
- /**
- * The name of the company for which the customer works.
- */
- company?: string
- /**
- * First name of the customer.
- */
- first_name: string
- /**
- * Last name of the customer.
- */
- last_name: string
- /**
- * Email address of the customer.
- */
- email: string
- /**
- * Phone number of the customer.
- */
- phone?: string
- /**
- * Date on which the customer registered from the storefront or was created in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
- */
- date_created?: string
- /**
- * Date on which the customer updated their details in the storefront or was updated in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
- */
- date_modified?: string
- /**
- * The amount of credit the customer has. (Float, Float as String, Integer)
- */
- store_credit?: string
- /**
- * The customer’s IP address when they signed up.
- */
- registration_ip_address?: string
- /**
- * The group to which the customer belongs.
- */
- customer_group_id?: number
- /**
- * Store-owner notes on the customer.
- */
- notes?: string
- /**
- * Used to identify customers who fall into special sales-tax categories – in particular, those who are fully or partially exempt from paying sales tax. Can be blank, or can contain a single AvaTax code. (The codes are case-sensitive.) Stores that subscribe to BigCommerce’s Avalara Premium integration will use this code to determine how/whether to apply sales tax. Does not affect sales-tax calculations for stores that do not subscribe to Avalara Premium.
- */
- tax_exempt_category?: string
- /**
- * Records whether the customer would like to receive marketing content from this store. READ-ONLY.This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
- */
- accepts_marketing?: boolean
- addresses?: definitions['addresses']
- /**
- * Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
- */
- form_fields?: definitions['formField'][]
- /**
- * Force a password change on next login.
- */
- reset_pass_on_login?: boolean
- }
- categoryAccessLevel: {
- /**
- * + `all` - Customers can access all categories
- * + `specific` - Customers can access a specific list of categories
- * + `none` - Customers are prevented from viewing any of the categories in this group.
- */
- type?: 'all' | 'specific' | 'none'
- /**
- * Is an array of category IDs and should be supplied only if `type` is specific.
- */
- categories?: string[]
- }
- timeZone: {
- /**
- * a string identifying the time zone, in the format: BigCommerce shows a Coming Soon page and requests a Preview Code
--After Email confirmation, Checkout should be manually enabled through BigCommerce platform. Look for "Review & test your store" section through BigCommerce's dashboard. -
-
-BigCommerce team has been notified and they plan to add more detailed about this subject. -