diff --git a/.editorconfig b/.editorconfig
deleted file mode 100644
index 11ebf4e4e..000000000
--- a/.editorconfig
+++ /dev/null
@@ -1,23 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-tab_width = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
-
-[*.js]
-quote_type = single
-
-[{*.c,*.cc,*.h,*.hh,*.cpp,*.hpp,*.m,*.mm,*.mpp,*.js,*.java,*.go,*.rs,*.php,*.ng,*.jsx,*.ts,*.d,*.cs,*.swift}]
-curly_bracket_next_line = false
-spaces_around_operators = true
-spaces_around_brackets = outside
-# close enough to 1TB
-indent_brace_style = K&R
diff --git a/.env.example b/.env.example
new file mode 100644
index 000000000..73342135c
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,6 @@
+# !STARTERCONF Duplicate this to .env.local
+
+# DEVELOPMENT TOOLS
+# Ideally, don't add them to production deployment envs
+# !STARTERCONF Change to true if you want to log data
+NEXT_PUBLIC_SHOW_LOGGER="false"
\ No newline at end of file
diff --git a/.eslintrc.js b/.eslintrc.js
new file mode 100644
index 000000000..c4e9194de
--- /dev/null
+++ b/.eslintrc.js
@@ -0,0 +1,81 @@
+module.exports = {
+ env: {
+ browser: true,
+ es2021: true,
+ node: true,
+ },
+ plugins: ['@typescript-eslint', 'simple-import-sort', 'unused-imports'],
+ extends: [
+ 'eslint:recommended',
+ 'next',
+ 'next/core-web-vitals',
+ 'plugin:@typescript-eslint/recommended',
+ 'prettier',
+ ],
+ rules: {
+ 'no-unused-vars': 'off',
+ 'no-console': 'warn',
+ '@typescript-eslint/explicit-module-boundary-types': 'off',
+
+ 'react/display-name': 'off',
+ 'react/jsx-curly-brace-presence': ['warn', { props: 'never', children: 'never' }],
+
+ //#region //*=========== Unused Import ===========
+ '@typescript-eslint/no-unused-vars': 'off',
+ '@next/next/no-img-element': 'off',
+ 'unused-imports/no-unused-imports': 'warn',
+ 'unused-imports/no-unused-vars': [
+ 'warn',
+ {
+ vars: 'all',
+ varsIgnorePattern: '^_',
+ args: 'after-used',
+ argsIgnorePattern: '^_',
+ },
+ ],
+ //#endregion //*======== Unused Import ===========
+
+ //#region //*=========== Import Sort ===========
+ 'simple-import-sort/exports': 'warn',
+ 'simple-import-sort/imports': [
+ 'warn',
+ {
+ groups: [
+ // ext library & side effect imports
+ ['^@?\\w', '^\\u0000'],
+ // {s}css files
+ ['^.+\\.s?css$'],
+ // Lib and hooks
+ ['^@/lib', '^@/hooks'],
+ // static data
+ ['^@/data'],
+ // components
+ ['^@/components', '^@/container'],
+ // zustand store
+ ['^@/store'],
+ // Other imports
+ ['^@/'],
+ // relative paths up until 3 level
+ [
+ '^\\./?$',
+ '^\\.(?!/?$)',
+ '^\\.\\./?$',
+ '^\\.\\.(?!/?$)',
+ '^\\.\\./\\.\\./?$',
+ '^\\.\\./\\.\\.(?!/?$)',
+ '^\\.\\./\\.\\./\\.\\./?$',
+ '^\\.\\./\\.\\./\\.\\.(?!/?$)',
+ ],
+ ['^@/types'],
+ // other that didnt fit in
+ ['^'],
+ ],
+ },
+ ],
+ //#endregion //*======== Import Sort ===========
+ },
+ globals: {
+ React: true,
+ JSX: true,
+ },
+};
diff --git a/.github/ISSUE_TEMPLATE/1.core_bug_report.yml b/.github/ISSUE_TEMPLATE/1.core_bug_report.yml
deleted file mode 100644
index 6d3848884..000000000
--- a/.github/ISSUE_TEMPLATE/1.core_bug_report.yml
+++ /dev/null
@@ -1,55 +0,0 @@
-name: Core package Bug Report
-description: Create a bug report for the Next.js commerce core package
-labels: 'template: core bug'
-body:
- - type: markdown
- attributes:
- value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
- - type: checkboxes
- attributes:
- label: Verify latest commit
- description: `main` is the latest version of Next.js Commerce.
- options:
- - label: I verified that the issue exists on `main`
- required: true
- - type: textarea
- attributes:
- label: Provide environment information
- description: Please run `npx --no-install next info` in the root directory of your project and paste the results.
- validations:
- required: true
- - type: input
- attributes:
- label: What browser are you using? (if relevant)
- description: 'Please specify the exact version. For example: Chrome 100.0.4878.0'
- - type: input
- attributes:
- label: How are you deploying your application? (if relevant)
- description: 'For example: next start, next export, Vercel, Other platform'
- - type: textarea
- attributes:
- label: Describe the Bug
- description: A clear and concise description of what the bug is.
- validations:
- required: true
- - type: textarea
- attributes:
- label: Expected Behavior
- description: A clear and concise description of what you expected to happen.
- validations:
- required: true
- - type: textarea
- attributes:
- label: To Reproduce
- description: Steps to reproduce the behavior, please provide a clear code snippets that always reproduces the issue or a GitHub repository. Screenshots can be provided in the issue body below.
- validations:
- required: true
- - type: markdown
- attributes:
- value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
- - type: markdown
- attributes:
- value: Contributors should be able to follow the steps provided in order to reproduce the bug.
- - type: markdown
- attributes:
- value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!
diff --git a/.github/ISSUE_TEMPLATE/2.provider_bug_report.yml b/.github/ISSUE_TEMPLATE/2.provider_bug_report.yml
deleted file mode 100644
index a600c3781..000000000
--- a/.github/ISSUE_TEMPLATE/2.provider_bug_report.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-name: Provider package Bug Report
-description: Create a bug report for the Next.js commerce core package
-labels: 'template: provider bug'
-body:
- - type: markdown
- attributes:
- value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
- - type: checkboxes
- attributes:
- label: Verify latest commit
- description: `main` is the latest version of Next.js Commerce.
- options:
- - label: I verified that the issue exists on `main`
- required: true
- - type: textarea
- attributes:
- label: Provide environment information
- description: Please run `npx --no-install next info` in the root directory of your project and paste the results.
- validations:
- required: true
- - type: input
- attributes:
- label: What Provider are you using?
- description: 'Please specify the provider package name. For example: `bigcommerce`'
- - type: input
- attributes:
- label: What browser are you using? (if relevant)
- description: 'Please specify the exact version. For example: Chrome 100.0.4878.0'
- - type: input
- attributes:
- label: How are you deploying your application? (if relevant)
- description: 'For example: next start, next export, Vercel, Other platform'
- - type: textarea
- attributes:
- label: Describe the Bug
- description: A clear and concise description of what the bug is.
- validations:
- required: true
- - type: textarea
- attributes:
- label: Expected Behavior
- description: A clear and concise description of what you expected to happen.
- validations:
- required: true
- - type: textarea
- attributes:
- label: To Reproduce
- description: Steps to reproduce the behavior, please provide a clear code snippets that always reproduces the issue or a GitHub repository. Screenshots can be provided in the issue body below.
- validations:
- required: true
- - type: markdown
- attributes:
- value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
- - type: markdown
- attributes:
- value: Contributors should be able to follow the steps provided in order to reproduce the bug.
- - type: markdown
- attributes:
- value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!
diff --git a/.github/ISSUE_TEMPLATE/3.feature_request.yml b/.github/ISSUE_TEMPLATE/3.feature_request.yml
deleted file mode 100644
index 2655aff44..000000000
--- a/.github/ISSUE_TEMPLATE/3.feature_request.yml
+++ /dev/null
@@ -1,28 +0,0 @@
-name: Feature Request
-description: Create a feature request for the Next.js core
-labels: 'template: story'
-body:
- - type: markdown
- attributes:
- value: Thanks for taking the time to file a feature request! Please fill out this form as completely as possible.
- - type: markdown
- attributes:
- value: 'Feature requests will be converted to the GitHub Discussions "Ideas" section.'
- - type: textarea
- attributes:
- label: Describe the feature you'd like to request
- description: A clear and concise description of what you want and what your use case is.
- validations:
- required: true
- - type: textarea
- attributes:
- label: Describe the solution you'd like
- description: A clear and concise description of what you want to happen.
- validations:
- required: true
- - type: textarea
- attributes:
- label: Describe alternatives you've considered
- description: A clear and concise description of any alternative solutions or features you've considered.
- validations:
- required: true
diff --git a/.github/ISSUE_TEMPLATE/4.docs_request.yml b/.github/ISSUE_TEMPLATE/4.docs_request.yml
deleted file mode 100644
index 72acd89ac..000000000
--- a/.github/ISSUE_TEMPLATE/4.docs_request.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-name: 'Docs Request for an Update or Improvement'
-description: A request to update or improve Next.js Commerce documentation
-title: 'Docs: '
-labels:
- - 'template: documentation'
-body:
- - type: textarea
- attributes:
- label: What is the improvement or update you wish to see?
- description: 'Example: I would like to see more examples of how to use hooks.'
- validations:
- required: true
- - type: textarea
- attributes:
- label: Is there any context that might help us understand?
- description: A clear description of any added context that might help us understand.
- validations:
- required: true
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
deleted file mode 100644
index dcefd31c5..000000000
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ /dev/null
@@ -1,5 +0,0 @@
-blank_issues_enabled: false
-contact_links:
- - name: Ask a question
- url: https://github.com/vercel/commerce/discussions
- about: Ask questions and discuss with other community members
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
new file mode 100644
index 000000000..14d6c6758
--- /dev/null
+++ b/.github/workflows/lint.yml
@@ -0,0 +1,71 @@
+# https://github.com/kentcdodds/kentcdodds.com/blob/main/.github/workflows/deployment.yml
+name: Code Check
+on:
+ push:
+ branches:
+ - main
+ pull_request: {}
+
+jobs:
+ lint:
+ name: ⏣ ESLint
+ runs-on: ubuntu-latest
+ steps:
+ - name: đ Cancel Previous Runs
+ uses: styfle/cancel-workflow-action@0.9.1
+
+ - name: âŹď¸ Checkout repo
+ uses: actions/checkout@v2
+
+ - name: â Setup node
+ uses: actions/setup-node@v2
+ with:
+ node-version: 16
+
+ - name: đĽ Download deps
+ uses: bahmutov/npm-install@v1
+
+ - name: đŹ Lint
+ run: yarn lint:strict
+
+ typecheck:
+ name: ĘŚ TypeScript
+ runs-on: ubuntu-latest
+ steps:
+ - name: đ Cancel Previous Runs
+ uses: styfle/cancel-workflow-action@0.9.1
+
+ - name: âŹď¸ Checkout repo
+ uses: actions/checkout@v2
+
+ - name: â Setup node
+ uses: actions/setup-node@v2
+ with:
+ node-version: 16
+
+ - name: đĽ Download deps
+ uses: bahmutov/npm-install@v1
+
+ - name: đ Type check
+ run: yarn typecheck
+
+ test:
+ name: đ Test
+ runs-on: ubuntu-latest
+ steps:
+ - name: đ Cancel Previous Runs
+ uses: styfle/cancel-workflow-action@0.9.1
+
+ - name: âŹď¸ Checkout repo
+ uses: actions/checkout@v2
+
+ - name: â Setup node
+ uses: actions/setup-node@v2
+ with:
+ node-version: 16
+
+ - name: đĽ Download deps
+ uses: bahmutov/npm-install@v1
+
+ - name: đ Run jest
+ run: yarn test
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
new file mode 100644
index 000000000..a4df08251
--- /dev/null
+++ b/.github/workflows/release-please.yml
@@ -0,0 +1,14 @@
+name: release-please
+on:
+ workflow_dispatch:
+ push:
+ branches:
+ - main
+jobs:
+ release-please:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: google-github-actions/release-please-action@v3
+ with:
+ release-type: node
+ package-name: release-please-action
diff --git a/.gitignore b/.gitignore
index b7301fe56..cb1f55c9e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,25 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies
-node_modules
-.pnp
+/node_modules
+/.pnp
.pnp.js
# testing
-coverage
+/coverage
# next.js
-.next
-out
+/.next/
+/out/
# production
-build
-dist
+/build
# misc
.DS_Store
*.pem
-.idea
# debug
npm-debug.log*
@@ -27,7 +25,6 @@ yarn-debug.log*
yarn-error.log*
# local env files
-.env
.env.local
.env.development.local
.env.test.local
@@ -36,5 +33,7 @@ yarn-error.log*
# vercel
.vercel
-# Turborepo
-.turbo
+# next-sitemap
+robots.txt
+sitemap.xml
+sitemap-*.xml
\ No newline at end of file
diff --git a/.husky/commit-msg b/.husky/commit-msg
new file mode 100755
index 000000000..0bd658f49
--- /dev/null
+++ b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit "$1"
diff --git a/.husky/post-merge b/.husky/post-merge
new file mode 100755
index 000000000..f53e03ad8
--- /dev/null
+++ b/.husky/post-merge
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn
diff --git a/.husky/pre-commit b/.husky/pre-commit
new file mode 100755
index 000000000..c37466e2b
--- /dev/null
+++ b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged
\ No newline at end of file
diff --git a/.npmrc b/.npmrc
new file mode 100644
index 000000000..bf79505bb
--- /dev/null
+++ b/.npmrc
@@ -0,0 +1 @@
+v16.14.0
diff --git a/.prettierignore b/.prettierignore
index 1c8b279ce..ed96aec55 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -1,5 +1,38 @@
-# Every package defines its prettier config
-node_modules
-dist
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
.next
-public
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel
+
+# changelog
+CHANGELOG.md
diff --git a/.prettierrc b/.prettierrc
index e1076edfa..a57b82594 100644
--- a/.prettierrc
+++ b/.prettierrc
@@ -1,6 +1,8 @@
{
- "semi": false,
+ "arrowParens": "always",
"singleQuote": true,
+ "jsxSingleQuote": true,
"tabWidth": 2,
- "useTabs": false
-}
+ "semi": true,
+ "printWidth": 90
+}
\ No newline at end of file
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
index 60907f7fd..44bf29839 100644
--- a/.vscode/extensions.json
+++ b/.vscode/extensions.json
@@ -1,8 +1,9 @@
{
"recommendations": [
- "esbenp.prettier-vscode",
- "csstools.postcss",
+ // Tailwind CSS Intellisense
"bradlc.vscode-tailwindcss",
- "ms-vscode.vscode-typescript-next"
+ "esbenp.prettier-vscode",
+ "dbaeumer.vscode-eslint",
+ "aaron-bond.better-comments"
]
}
diff --git a/.vscode/settings.json b/.vscode/settings.json
deleted file mode 100644
index 9bf4d12b5..000000000
--- a/.vscode/settings.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "editor.defaultFormatter": "esbenp.prettier-vscode",
- "editor.formatOnSave": true
-}
diff --git a/README.md b/README.md
index 10502012a..b257a99b9 100644
--- a/README.md
+++ b/README.md
@@ -1,198 +1 @@
-[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fcommerce&project-name=commerce&repo-name=commerce&demo-title=Next.js%20Commerce&demo-description=An%20all-in-one%20starter%20kit%20for%20high-performance%20e-commerce%20sites.&demo-url=https%3A%2F%2Fdemo.vercel.store&demo-image=https%3A%2F%2Fbigcommerce-demo-asset-ksvtgfvnd.vercel.app%2Fbigcommerce.png&integration-ids=oac_MuWZiE4jtmQ2ejZQaQ7ncuDT,oac_9HSKtXld74NG0srzdxSiBGty&skippable-integrations=1&root-directory=site&build-command=cd%20..%20%26%26%20yarn%20build)
-
-# Next.js Commerce
-
-The all-in-one starter kit for high-performance e-commerce sites. With a few clicks, Next.js developers can clone, deploy and fully customize their own store.
-Start right now at [nextjs.org/commerce](https://nextjs.org/commerce)
-
-Demo live at: [demo.vercel.store](https://demo.vercel.store/)
-
-- Shopify Demo: https://shopify.vercel.store/
-- Swell Demo: https://swell.vercel.store/
-- BigCommerce Demo: https://bigcommerce.vercel.store/
-- Vendure Demo: https://vendure.vercel.store
-- Saleor Demo: https://saleor.vercel.store/
-- Ordercloud Demo: https://ordercloud.vercel.store/
-- Spree Demo: https://spree.vercel.store/
-- Kibo Commerce Demo: https://kibocommerce.vercel.store/
-- Commerce.js Demo: https://commercejs.vercel.store/
-- SalesForce Cloud Commerce Demo: https://salesforce-cloud-commerce.vercel.store/
-
-## Run minimal version locally
-
-> To run a minimal version of Next.js Commerce you can start with the default local provider `@vercel/commerce-local` that has disabled all features (cart, auth) and use static files for the backend
-
-```bash
-yarn # run this command in root folder of the mono repo
-yarn dev
-```
-
-> If you encounter any problems while installing and running for the first time, please see the Troubleshoot section
-
-## Features
-
-- Performant by default
-- SEO Ready
-- Internationalization
-- Responsive
-- UI Components
-- Theming
-- Standardized Data Hooks
-- Integrations - Integrate seamlessly with the most common ecommerce platforms.
-- Dark Mode Support
-
-## Integrations
-
-Next.js Commerce integrates out-of-the-box with BigCommerce, Shopify, Swell, Saleor, Vendure, Spree and Commerce.js. We plan to support all major ecommerce backends.
-
-## Considerations
-
-- `packages/commerce` contains all types, helpers and functions to be used as base to build a new **provider**.
-- **Providers** live under `packages`'s root folder and they will extend Next.js Commerce types and functionality (`packages/commerce`).
-- We have a **Features API** to ensure feature parity between the UI and the Provider. The UI should update accordingly and no extra code should be bundled. All extra configuration for features will live under `features` in `commerce.config.json` and if needed it can also be accessed programatically.
-- Each **provider** should add its corresponding `next.config.js` and `commerce.config.json` adding specific data related to the provider. For example in case of BigCommerce, the images CDN and additional API routes.
-
-## Configuration
-
-### How to change providers
-
-Open `site/.env.local` and change the value of `COMMERCE_PROVIDER` to the provider you would like to use, then set the environment variables for that provider (use `site/.env.template` as the base).
-
-The setup for Shopify would look like this for example:
-
-```
-COMMERCE_PROVIDER=@vercel/commerce-shopify
-NEXT_PUBLIC_SHOPIFY_STOREFRONT_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxx
-NEXT_PUBLIC_SHOPIFY_STORE_DOMAIN=xxxxxxx.myshopify.com
-```
-
-### Features
-
-Every provider defines the features that it supports under `packages/{provider}/src/commerce.config.json`
-
-#### Features Available
-
-The following features can be enabled or disabled. This means that the UI will remove all code related to the feature.
-For example: Turning `cart` off will disable Cart capabilities.
-
-- cart
-- search
-- wishlist
-- customerAuth
-- customCheckout
-
-#### How to turn Features on and off
-
-> NOTE: The selected provider should support the feature that you are toggling. (This means that you can't turn wishlist on if the provider doesn't support this functionality out the box)
-
-- Open `site/commerce.config.json`
-- You'll see a config file like this:
- ```json
- {
- "features": {
- "wishlist": false,
- "customCheckout": true
- }
- }
- ```
-- Turn `wishlist` on by setting `wishlist` to `true`.
-- Run the app and the wishlist functionality should be back on.
-
-### How to create a new provider
-
-Follow our docs for [Adding a new Commerce Provider](packages/commerce/new-provider.md).
-
-If you succeeded building a provider, submit a PR with a valid demo and we'll review it asap.
-
-## Contribute
-
-Our commitment to Open Source can be found [here](https://vercel.com/oss).
-
-1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
-2. Create a new branch `git checkout -b MY_BRANCH_NAME`
-3. Install the dependencies: `yarn`
-4. Duplicate `site/.env.template` and rename it to `site/.env.local`
-5. Add proper store values to `site/.env.local`
-6. Run `cd site` and `yarn dev` to build and watch for code changes
-7. Run `yarn turbo run build` to check the build after your changes
-
-## Work in progress
-
-We're using Github Projects to keep track of issues in progress and todo's. Here is our [Board](https://github.com/vercel/commerce/projects/1)
-
-People actively working on this project: @okbel, @lfades, @dominiksipowicz, @gbibeaul.
-
-## Troubleshoot
-
-
-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..
-
-
-
-
-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 details about this subject.
-
-
-
-When run locally I get `Error: Cannot find module '...@vercel/commerce/dist/config'`
-
-```bash
-commerce/site
-⯠yarn dev
-yarn run v1.22.17
-$ next dev
-ready - started server on 0.0.0.0:3000, url: http://localhost:3000
-info - Loaded env from /commerce/site/.env.local
-error - Failed to load next.config.js, see more info here https://nextjs.org/docs/messages/next-config-error
-Error: Cannot find module '/Users/dom/work/vercel/commerce/node_modules/@vercel/commerce/dist/config.cjs'
- at createEsmNotFoundErr (node:internal/modules/cjs/loader:960:15)
- at finalizeEsmResolution (node:internal/modules/cjs/loader:953:15)
- at resolveExports (node:internal/modules/cjs/loader:482:14)
- at Function.Module._findPath (node:internal/modules/cjs/loader:522:31)
- at Function.Module._resolveFilename (node:internal/modules/cjs/loader:919:27)
- at Function.mod._resolveFilename (/Users/dom/work/vercel/commerce/node_modules/next/dist/build/webpack/require-hook.js:179:28)
- at Function.Module._load (node:internal/modules/cjs/loader:778:27)
- at Module.require (node:internal/modules/cjs/loader:1005:19)
- at require (node:internal/modules/cjs/helpers:102:18)
- at Object. (/Users/dom/work/vercel/commerce/site/commerce-config.js:9:14) {
- code: 'MODULE_NOT_FOUND',
- path: '/Users/dom/work/vercel/commerce/node_modules/@vercel/commerce/package.json'
-}
-error Command failed with exit code 1.
-info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
-```
-
-The error usually occurs when running yarn dev inside of the `/site/` folder after installing a fresh repository.
-
-In order to fix this, run `yarn dev` in the monorepo root folder first.
-
-> Using `yarn dev` from the root is recommended for developing, which will run watch mode on all packages.
-
-
+Developer DAO Merch Store
diff --git a/commitlint.config.js b/commitlint.config.js
new file mode 100644
index 000000000..3bf488d0b
--- /dev/null
+++ b/commitlint.config.js
@@ -0,0 +1,24 @@
+module.exports = {
+ extends: ['@commitlint/config-conventional'],
+ rules: {
+ // TODO Add Scope Enum Here
+ // 'scope-enum': [2, 'always', ['yourscope', 'yourscope']],
+ 'type-enum': [
+ 2,
+ 'always',
+ [
+ 'feat',
+ 'fix',
+ 'docs',
+ 'chore',
+ 'style',
+ 'refactor',
+ 'ci',
+ 'test',
+ 'perf',
+ 'revert',
+ 'vercel',
+ ],
+ ],
+ },
+};
diff --git a/jest.config.js b/jest.config.js
new file mode 100644
index 000000000..05e36dfd4
--- /dev/null
+++ b/jest.config.js
@@ -0,0 +1,29 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const nextJest = require('next/jest');
+
+const createJestConfig = nextJest({
+ // Provide the path to your Next.js app to load next.config.js and .env files in your test environment
+ dir: './',
+});
+
+// Add any custom config to be passed to Jest
+const customJestConfig = {
+ // Add more setup options before each test is run
+ setupFilesAfterEnv: ['/jest.setup.js'],
+
+ // if using TypeScript with a baseUrl set to the root directory then you need the below for alias' to work
+ moduleDirectories: ['node_modules', '/'],
+
+ testEnvironment: 'jest-environment-jsdom',
+
+ /**
+ * Absolute imports and Module Path Aliases
+ */
+ moduleNameMapper: {
+ '^@/(.*)$': '/src/$1',
+ '^~/(.*)$': '/public/$1',
+ },
+};
+
+// createJestConfig is exported this way to ensure that next/jest can load the Next.js config which is async
+module.exports = createJestConfig(customJestConfig);
diff --git a/jest.setup.js b/jest.setup.js
new file mode 100644
index 000000000..666127af3
--- /dev/null
+++ b/jest.setup.js
@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';
diff --git a/license.md b/license.md
deleted file mode 100644
index fa5d39b62..000000000
--- a/license.md
+++ /dev/null
@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Vercel, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
diff --git a/site/next-env.d.ts b/next-env.d.ts
similarity index 100%
rename from site/next-env.d.ts
rename to next-env.d.ts
diff --git a/next-sitemap.config.js b/next-sitemap.config.js
new file mode 100644
index 000000000..f7f4005fe
--- /dev/null
+++ b/next-sitemap.config.js
@@ -0,0 +1,13 @@
+/**
+ * @type {import('next-sitemap').IConfig}
+ * @see https://github.com/iamvishnusankar/next-sitemap#readme
+ */
+module.exports = {
+ // !STARTERCONF Change the siteUrl
+ /** Without additional '/' on the end, e.g. https://developerdao.com */
+ siteUrl: 'https://merch.developerdao.com',
+ generateRobotsTxt: true,
+ robotsTxtOptions: {
+ policies: [{ userAgent: '*', allow: '/' }],
+ },
+};
diff --git a/next.config.js b/next.config.js
new file mode 100644
index 000000000..211d0cdd8
--- /dev/null
+++ b/next.config.js
@@ -0,0 +1,8 @@
+/** @type {import('next').NextConfig} */
+module.exports = {
+ eslint: {
+ dirs: ['src'],
+ },
+
+ reactStrictMode: true,
+};
diff --git a/package.json b/package.json
index a17fc5fbe..1fab0d7a8 100644
--- a/package.json
+++ b/package.json
@@ -1,27 +1,66 @@
{
- "name": "commerce",
- "license": "MIT",
+ "name": "ts-nextjs-tailwind-starter",
+ "version": "0.1.0",
"private": true,
- "workspaces": [
- "site",
- "packages/*"
- ],
"scripts": {
- "build": "turbo run build --filter=next-commerce...",
- "dev": "turbo run dev",
- "start": "turbo run start",
- "types": "turbo run types",
- "prettier-fix": "prettier --write ."
+ "dev": "next dev",
+ "build": "next build",
+ "start": "next start",
+ "lint": "next lint",
+ "lint:fix": "eslint src --fix && yarn format",
+ "lint:strict": "eslint --max-warnings=0 src",
+ "typecheck": "tsc --noEmit --incremental false",
+ "test:watch": "jest --watch",
+ "test": "jest",
+ "format": "prettier -w .",
+ "format:check": "prettier -c .",
+ "postbuild": "next-sitemap --config next-sitemap.config.js",
+ "prepare": "husky install"
+ },
+ "dependencies": {
+ "@headlessui/react": "^1.7.0",
+ "@heroicons/react": "^2.0.10",
+ "@tailwindcss/aspect-ratio": "^0.4.2",
+ "clsx": "^1.2.1",
+ "next": "^12.2.5",
+ "react": "^18.2.0",
+ "react-dom": "^18.2.0",
+ "react-icons": "^4.4.0",
+ "tailwind-merge": "^1.6.0"
},
"devDependencies": {
+ "@commitlint/cli": "^16.3.0",
+ "@commitlint/config-conventional": "^16.2.4",
+ "@svgr/webpack": "^6.3.1",
+ "@tailwindcss/forms": "^0.5.3",
+ "@testing-library/jest-dom": "^5.16.5",
+ "@testing-library/react": "^13.3.0",
+ "@types/react": "^18.0.18",
+ "@typescript-eslint/eslint-plugin": "^5.36.1",
+ "@typescript-eslint/parser": "^5.36.1",
+ "autoprefixer": "^10.4.8",
+ "eslint": "^8.23.0",
+ "eslint-config-next": "^12.2.5",
+ "eslint-config-prettier": "^8.5.0",
+ "eslint-plugin-simple-import-sort": "^7.0.0",
+ "eslint-plugin-unused-imports": "^2.0.0",
"husky": "^7.0.4",
- "prettier": "^2.5.1",
- "turbo": "^1.2.16"
+ "jest": "^27.5.1",
+ "lint-staged": "^12.5.0",
+ "next-sitemap": "^2.5.28",
+ "postcss": "^8.4.16",
+ "prettier": "^2.7.1",
+ "prettier-plugin-tailwindcss": "^0.1.13",
+ "tailwindcss": "^3.1.8",
+ "typescript": "^4.8.2"
},
- "husky": {
- "hooks": {
- "pre-commit": "turbo run lint"
- }
- },
- "packageManager": "yarn@1.22.17"
+ "lint-staged": {
+ "**/*.{js,jsx,ts,tsx}": [
+ "eslint --max-warnings=0",
+ "prettier -w"
+ ],
+ "**/*.{json,css,scss,md}": [
+ "prettier -w"
+ ]
+ }
}
diff --git a/packages/bigcommerce/.env.template b/packages/bigcommerce/.env.template
deleted file mode 100644
index b5d12f570..000000000
--- a/packages/bigcommerce/.env.template
+++ /dev/null
@@ -1,8 +0,0 @@
-COMMERCE_PROVIDER=@vercel/commerce-bigcommerce
-
-BIGCOMMERCE_STOREFRONT_API_URL=
-BIGCOMMERCE_STOREFRONT_API_TOKEN=
-BIGCOMMERCE_STORE_API_URL=
-BIGCOMMERCE_STORE_API_TOKEN=
-BIGCOMMERCE_STORE_API_CLIENT_ID=
-BIGCOMMERCE_CHANNEL_ID=
diff --git a/packages/bigcommerce/.prettierignore b/packages/bigcommerce/.prettierignore
deleted file mode 100644
index f06235c46..000000000
--- a/packages/bigcommerce/.prettierignore
+++ /dev/null
@@ -1,2 +0,0 @@
-node_modules
-dist
diff --git a/packages/bigcommerce/.prettierrc b/packages/bigcommerce/.prettierrc
deleted file mode 100644
index e1076edfa..000000000
--- a/packages/bigcommerce/.prettierrc
+++ /dev/null
@@ -1,6 +0,0 @@
-{
- "semi": false,
- "singleQuote": true,
- "tabWidth": 2,
- "useTabs": false
-}
diff --git a/packages/bigcommerce/README.md b/packages/bigcommerce/README.md
deleted file mode 100644
index 1e8c6cb08..000000000
--- a/packages/bigcommerce/README.md
+++ /dev/null
@@ -1,59 +0,0 @@
-# Bigcommerce Provider
-
-**Demo:** https://bigcommerce.demo.vercel.store/
-
-With the deploy button below you'll be able to have a [BigCommerce](https://www.bigcommerce.com/) account and a store that works with this starter:
-
-[](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fcommerce&project-name=commerce&repo-name=commerce&demo-title=Next.js%20Commerce&demo-description=An%20all-in-one%20starter%20kit%20for%20high-performance%20e-commerce%20sites.&demo-url=https%3A%2F%2Fdemo.vercel.store&demo-image=https%3A%2F%2Fbigcommerce-demo-asset-ksvtgfvnd.vercel.app%2Fbigcommerce.png&integration-ids=oac_MuWZiE4jtmQ2ejZQaQ7ncuDT)
-
-If you already have a BigCommerce account and want to use your current store, then copy the `.env.template` file in this directory to `.env.local` in the main directory (which will be ignored by Git):
-
-```bash
-cp packages/bigcommerce/.env.template .env.local
-```
-
-Then, set the environment variables in `.env.local` to match the ones from your store.
-
-## Contribute
-
-Our commitment to Open Source can be found [here](https://vercel.com/oss).
-
-If you find an issue with the provider or want a new feature, feel free to open a PR or [create a new issue](https://github.com/vercel/commerce/issues).
-
-## Troubleshoot
-
-
-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.
-
-
-
-
-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.
-
diff --git a/packages/bigcommerce/codegen.json b/packages/bigcommerce/codegen.json
deleted file mode 100644
index 7346508f7..000000000
--- a/packages/bigcommerce/codegen.json
+++ /dev/null
@@ -1,27 +0,0 @@
-{
- "schema": {
- "https://buybutton.store/graphql": {
- "headers": {
- "Authorization": "Bearer xzy"
- }
- }
- },
- "documents": [
- {
- "./src/api/**/*.ts": {
- "noRequire": true
- }
- }
- ],
- "generates": {
- "./schema.d.ts": {
- "plugins": ["typescript", "typescript-operations"]
- },
- "./schema.graphql": {
- "plugins": ["schema-ast"]
- }
- },
- "hooks": {
- "afterAllFileWrite": ["prettier --write"]
- }
-}
diff --git a/packages/bigcommerce/package.json b/packages/bigcommerce/package.json
deleted file mode 100644
index 34b8ac614..000000000
--- a/packages/bigcommerce/package.json
+++ /dev/null
@@ -1,86 +0,0 @@
-{
- "name": "@vercel/commerce-bigcommerce",
- "version": "0.0.1",
- "license": "MIT",
- "scripts": {
- "release": "taskr release",
- "build": "taskr build",
- "dev": "taskr",
- "types": "tsc --emitDeclarationOnly",
- "generate:definitions": "node scripts/generate-definitions.js"
- },
- "sideEffects": false,
- "type": "module",
- "exports": {
- ".": "./dist/index.js",
- "./*": [
- "./dist/*.js",
- "./dist/*/index.js"
- ],
- "./next.config": "./dist/next.config.cjs"
- },
- "typesVersions": {
- "*": {
- "*": [
- "src/*",
- "src/*/index"
- ],
- "next.config": [
- "dist/next.config.d.cts"
- ]
- }
- },
- "files": [
- "dist"
- ],
- "publishConfig": {
- "typesVersions": {
- "*": {
- "*": [
- "dist/*.d.ts",
- "dist/*/index.d.ts"
- ],
- "config": [
- "dist/next.config.d.cts"
- ]
- }
- }
- },
- "dependencies": {
- "@vercel/fetch": "^6.1.1",
- "cookie": "^0.4.1",
- "immutability-helper": "^3.1.1",
- "jsonwebtoken": "^8.5.1",
- "lodash.debounce": "^4.0.8",
- "uuidv4": "^6.2.12"
- },
- "peerDependencies": {
- "next": "^12",
- "react": "^17",
- "react-dom": "^17"
- },
- "devDependencies": {
- "@taskr/clear": "^1.1.0",
- "@taskr/esnext": "^1.1.0",
- "@taskr/watch": "^1.1.0",
- "@types/cookie": "^0.4.1",
- "@types/jsonwebtoken": "^8.5.7",
- "@types/lodash.debounce": "^4.0.6",
- "@types/node": "^17.0.8",
- "@types/react": "^17.0.38",
- "lint-staged": "^12.1.7",
- "next": "^12.0.8",
- "prettier": "^2.5.1",
- "react": "^17.0.2",
- "react-dom": "^17.0.2",
- "taskr": "^1.1.0",
- "taskr-swc": "^0.0.1",
- "typescript": "^4.5.4"
- },
- "lint-staged": {
- "**/*.{js,jsx,ts,tsx,json}": [
- "prettier --write",
- "git add"
- ]
- }
-}
diff --git a/packages/bigcommerce/schema.d.ts b/packages/bigcommerce/schema.d.ts
deleted file mode 100644
index 04824e263..000000000
--- a/packages/bigcommerce/schema.d.ts
+++ /dev/null
@@ -1,2064 +0,0 @@
-export type Maybe = T | null
-export type Exact = {
- [K in keyof T]: T[K]
-}
-/** All built-in and custom scalars, mapped to their actual values */
-export type Scalars = {
- ID: string
- String: string
- Boolean: boolean
- Int: number
- Float: number
- DateTime: any
- /** The `BigDecimal` scalar type represents signed fractional values with arbitrary precision. */
- BigDecimal: any
- /** The `Long` scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1. */
- Long: any
-}
-
-/** Login result */
-export type LoginResult = {
- __typename?: 'LoginResult'
- /** The result of a login */
- result: Scalars['String']
-}
-
-/** Logout result */
-export type LogoutResult = {
- __typename?: 'LogoutResult'
- /** The result of a logout */
- result: Scalars['String']
-}
-
-export type Mutation = {
- __typename?: 'Mutation'
- login: LoginResult
- logout: LogoutResult
-}
-
-export type MutationLoginArgs = {
- email: Scalars['String']
- password: Scalars['String']
-}
-
-/** Aggregated */
-export type Aggregated = {
- __typename?: 'Aggregated'
- /** Number of available products in stock. This can be 'null' if inventory is not set orif the store's Inventory Settings disable displaying stock levels on the storefront. */
- availableToSell: Scalars['Long']
- /** Indicates a threshold low-stock level. This can be 'null' if the inventory warning level is not set or if the store's Inventory Settings disable displaying stock levels on the storefront. */
- warningLevel: Scalars['Int']
-}
-
-/** Aggregated Product Inventory */
-export type AggregatedInventory = {
- __typename?: 'AggregatedInventory'
- /** Number of available products in stock. This can be 'null' if inventory is not set orif the store's Inventory Settings disable displaying stock levels on the storefront. */
- availableToSell: Scalars['Int']
- /** Indicates a threshold low-stock level. This can be 'null' if the inventory warning level is not set or if the store's Inventory Settings disable displaying stock levels on the storefront. */
- warningLevel: Scalars['Int']
-}
-
-/** Brand */
-export type Brand = Node & {
- __typename?: 'Brand'
- /** The ID of an object */
- id: Scalars['ID']
- /** Id of the brand. */
- entityId: Scalars['Int']
- /** Name of the brand. */
- name: Scalars['String']
- /** Default image for brand. */
- defaultImage?: Maybe
- /** Page title for the brand. */
- pageTitle: Scalars['String']
- /** Meta description for the brand. */
- metaDesc: Scalars['String']
- /** Meta keywords for the brand. */
- metaKeywords: Array
- /** Search keywords for the brand. */
- searchKeywords: Array
- /** Path for the brand page. */
- path: Scalars['String']
- products: ProductConnection
- /** Metafield data related to a brand. */
- metafields: MetafieldConnection
-}
-
-/** Brand */
-export type BrandProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Brand */
-export type BrandMetafieldsArgs = {
- namespace: Scalars['String']
- keys?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A connection to a list of items. */
-export type BrandConnection = {
- __typename?: 'BrandConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type BrandEdge = {
- __typename?: 'BrandEdge'
- /** The item at the end of the edge. */
- node: Brand
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Breadcrumb */
-export type Breadcrumb = {
- __typename?: 'Breadcrumb'
- /** Category id. */
- entityId: Scalars['Int']
- /** Name of the category. */
- name: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type BreadcrumbConnection = {
- __typename?: 'BreadcrumbConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type BreadcrumbEdge = {
- __typename?: 'BreadcrumbEdge'
- /** The item at the end of the edge. */
- node: Breadcrumb
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Bulk pricing tier that sets a fixed price for the product or variant. */
-export type BulkPricingFixedPriceDiscount = BulkPricingTier & {
- __typename?: 'BulkPricingFixedPriceDiscount'
- /** This price will override the current product price. */
- price: Scalars['BigDecimal']
- /** Minimum item quantity that applies to this bulk pricing tier. */
- minimumQuantity: Scalars['Int']
- /** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
- maximumQuantity?: Maybe
-}
-
-/** Bulk pricing tier that reduces the price of the product or variant by a percentage. */
-export type BulkPricingPercentageDiscount = BulkPricingTier & {
- __typename?: 'BulkPricingPercentageDiscount'
- /** The percentage that will be removed from the product price. */
- percentOff: Scalars['BigDecimal']
- /** Minimum item quantity that applies to this bulk pricing tier. */
- minimumQuantity: Scalars['Int']
- /** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
- maximumQuantity?: Maybe
-}
-
-/** Bulk pricing tier that will subtract an amount from the price of the product or variant. */
-export type BulkPricingRelativePriceDiscount = BulkPricingTier & {
- __typename?: 'BulkPricingRelativePriceDiscount'
- /** The price of the product/variant will be reduced by this priceAdjustment. */
- priceAdjustment: Scalars['BigDecimal']
- /** Minimum item quantity that applies to this bulk pricing tier. */
- minimumQuantity: Scalars['Int']
- /** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
- maximumQuantity?: Maybe
-}
-
-/** A set of bulk pricing tiers that define price discounts which apply when purchasing specified quantities of a product or variant. */
-export type BulkPricingTier = {
- /** Minimum item quantity that applies to this bulk pricing tier. */
- minimumQuantity: Scalars['Int']
- /** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
- maximumQuantity?: Maybe
-}
-
-/** Product Option */
-export type CatalogProductOption = {
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** Product Option Value */
-export type CatalogProductOptionValue = {
- /** Unique ID for the option value. */
- entityId: Scalars['Int']
- /** Label for the option value. */
- label: Scalars['String']
- /** Indicates whether this value is the chosen default selected value. */
- isDefault: Scalars['Boolean']
-}
-
-/** Category */
-export type Category = Node & {
- __typename?: 'Category'
- /** The ID of an object */
- id: Scalars['ID']
- /** Unique ID for the category. */
- entityId: Scalars['Int']
- /** Category name. */
- name: Scalars['String']
- /** Category path. */
- path: Scalars['String']
- /** Default image for the category. */
- defaultImage?: Maybe
- /** Category description. */
- description: Scalars['String']
- /** Category breadcrumbs. */
- breadcrumbs: BreadcrumbConnection
- products: ProductConnection
- /** Metafield data related to a category. */
- metafields: MetafieldConnection
-}
-
-/** Category */
-export type CategoryBreadcrumbsArgs = {
- depth: Scalars['Int']
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Category */
-export type CategoryProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Category */
-export type CategoryMetafieldsArgs = {
- namespace: Scalars['String']
- keys?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A connection to a list of items. */
-export type CategoryConnection = {
- __typename?: 'CategoryConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type CategoryEdge = {
- __typename?: 'CategoryEdge'
- /** The item at the end of the edge. */
- node: Category
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** An item in a tree of categories. */
-export type CategoryTreeItem = {
- __typename?: 'CategoryTreeItem'
- /** The id category. */
- entityId: Scalars['Int']
- /** The name of category. */
- name: Scalars['String']
- /** Path assigned to this category */
- path: Scalars['String']
- /** The description of this category. */
- description: Scalars['String']
- /** The number of products in this category. */
- productCount: Scalars['Int']
- /** Subcategories of this category */
- children: Array
-}
-
-/** A simple yes/no question represented by a checkbox. */
-export type CheckboxOption = CatalogProductOption & {
- __typename?: 'CheckboxOption'
- /** Indicates the default checked status. */
- checkedByDefault: Scalars['Boolean']
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** Contact field */
-export type ContactField = {
- __typename?: 'ContactField'
- /** Store address line. */
- address: Scalars['String']
- /** Store country. */
- country: Scalars['String']
- /** Store address type. */
- addressType: Scalars['String']
- /** Store email. */
- email: Scalars['String']
- /** Store phone number. */
- phone: Scalars['String']
-}
-
-/** Custom field */
-export type CustomField = {
- __typename?: 'CustomField'
- /** Custom field id. */
- entityId: Scalars['Int']
- /** Name of the custom field. */
- name: Scalars['String']
- /** Value of the custom field. */
- value: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type CustomFieldConnection = {
- __typename?: 'CustomFieldConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type CustomFieldEdge = {
- __typename?: 'CustomFieldEdge'
- /** The item at the end of the edge. */
- node: CustomField
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** A customer that shops on a store */
-export type Customer = {
- __typename?: 'Customer'
- /** The ID of the customer. */
- entityId: Scalars['Int']
- /** The company name of the customer. */
- company: Scalars['String']
- /** The customer group id of the customer. */
- customerGroupId: Scalars['Int']
- /** The email address of the customer. */
- email: Scalars['String']
- /** The first name of the customer. */
- firstName: Scalars['String']
- /** The last name of the customer. */
- lastName: Scalars['String']
- /** The notes of the customer. */
- notes: Scalars['String']
- /** The phone number of the customer. */
- phone: Scalars['String']
- /** The tax exempt category of the customer. */
- taxExemptCategory: Scalars['String']
- /** Customer addresses count. */
- addressCount: Scalars['Int']
- /** Customer attributes count. */
- attributeCount: Scalars['Int']
- /** Customer store credit. */
- storeCredit: Array
- /** Customer attributes. */
- attributes: CustomerAttributes
-}
-
-/** A custom, store-specific attribute for a customer */
-export type CustomerAttribute = {
- __typename?: 'CustomerAttribute'
- /** The ID of the custom customer attribute */
- entityId: Scalars['Int']
- /** The value of the custom customer attribute */
- value?: Maybe
- /** The name of the custom customer attribute */
- name: Scalars['String']
-}
-
-/** Custom, store-specific customer attributes */
-export type CustomerAttributes = {
- __typename?: 'CustomerAttributes'
- attribute: CustomerAttribute
-}
-
-/** Custom, store-specific customer attributes */
-export type CustomerAttributesAttributeArgs = {
- entityId: Scalars['Int']
-}
-
-/** A calendar for allowing selection of a date. */
-export type DateFieldOption = CatalogProductOption & {
- __typename?: 'DateFieldOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** Date Time Extended */
-export type DateTimeExtended = {
- __typename?: 'DateTimeExtended'
- /** ISO-8601 formatted date in UTC */
- utc: Scalars['DateTime']
-}
-
-/** Display field */
-export type DisplayField = {
- __typename?: 'DisplayField'
- /** Short date format. */
- shortDateFormat: Scalars['String']
- /** Extended date format. */
- extendedDateFormat: Scalars['String']
-}
-
-/** A form allowing selection and uploading of a file from the user's local computer. */
-export type FileUploadFieldOption = CatalogProductOption & {
- __typename?: 'FileUploadFieldOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** Image */
-export type Image = {
- __typename?: 'Image'
- /** Absolute path to image using store CDN. */
- url: Scalars['String']
- /** Absolute path to original image using store CDN. */
- urlOriginal: Scalars['String']
- /** Text description of an image that can be used for SEO and/or accessibility purposes. */
- altText: Scalars['String']
- /** Indicates whether this is the primary image. */
- isDefault: Scalars['Boolean']
-}
-
-/** Image */
-export type ImageUrlArgs = {
- width: Scalars['Int']
- height?: Maybe
-}
-
-/** A connection to a list of items. */
-export type ImageConnection = {
- __typename?: 'ImageConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type ImageEdge = {
- __typename?: 'ImageEdge'
- /** The item at the end of the edge. */
- node: Image
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** An inventory */
-export type Inventory = {
- __typename?: 'Inventory'
- /** Locations */
- locations: LocationConnection
-}
-
-/** An inventory */
-export type InventoryLocationsArgs = {
- entityIds?: Maybe>
- codes?: Maybe>
- typeIds?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Inventory By Locations */
-export type InventoryByLocations = {
- __typename?: 'InventoryByLocations'
- /** Location id. */
- locationEntityId: Scalars['Long']
- /** Number of available products in stock. */
- availableToSell: Scalars['Long']
- /** Indicates a threshold low-stock level. */
- warningLevel: Scalars['Int']
- /** Indicates whether this product is in stock. */
- isInStock: Scalars['Boolean']
-}
-
-/** A connection to a list of items. */
-export type LocationConnection = {
- __typename?: 'LocationConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type LocationEdge = {
- __typename?: 'LocationEdge'
- /** The item at the end of the edge. */
- node: InventoryByLocations
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Logo field */
-export type LogoField = {
- __typename?: 'LogoField'
- /** Logo title. */
- title: Scalars['String']
- /** Store logo image. */
- image: Image
-}
-
-/** Measurement */
-export type Measurement = {
- __typename?: 'Measurement'
- /** Unformatted weight measurement value. */
- value: Scalars['Float']
- /** Unit of measurement. */
- unit: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type MetafieldConnection = {
- __typename?: 'MetafieldConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type MetafieldEdge = {
- __typename?: 'MetafieldEdge'
- /** The item at the end of the edge. */
- node: Metafields
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Key/Value pairs of data attached tied to a resource entity (product, brand, category, etc.) */
-export type Metafields = {
- __typename?: 'Metafields'
- /** The ID of an object */
- id: Scalars['ID']
- /** The ID of the metafield when referencing via our backend API. */
- entityId: Scalars['Int']
- /** A label for identifying a metafield data value. */
- key: Scalars['String']
- /** A metafield value. */
- value: Scalars['String']
-}
-
-/** A money object - includes currency code and a money amount */
-export type Money = {
- __typename?: 'Money'
- /** Currency code of the current money. */
- currencyCode: Scalars['String']
- /** The amount of money. */
- value: Scalars['BigDecimal']
-}
-
-/** A min and max pair of money objects */
-export type MoneyRange = {
- __typename?: 'MoneyRange'
- /** Minimum money object. */
- min: Money
- /** Maximum money object. */
- max: Money
-}
-
-/** A multi-line text input field, aka a text box. */
-export type MultiLineTextFieldOption = CatalogProductOption & {
- __typename?: 'MultiLineTextFieldOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** An option type that has a fixed list of values. */
-export type MultipleChoiceOption = CatalogProductOption & {
- __typename?: 'MultipleChoiceOption'
- /** The chosen display style for this multiple choice option. */
- displayStyle: Scalars['String']
- /** List of option values. */
- values: ProductOptionValueConnection
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** An option type that has a fixed list of values. */
-export type MultipleChoiceOptionValuesArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A simple multiple choice value comprised of an id and a label. */
-export type MultipleChoiceOptionValue = CatalogProductOptionValue & {
- __typename?: 'MultipleChoiceOptionValue'
- /** Unique ID for the option value. */
- entityId: Scalars['Int']
- /** Label for the option value. */
- label: Scalars['String']
- /** Indicates whether this value is the chosen default selected value. */
- isDefault: Scalars['Boolean']
-}
-
-/** An object with an ID */
-export type Node = {
- /** The id of the object. */
- id: Scalars['ID']
-}
-
-/** A single line text input field that only accepts numbers. */
-export type NumberFieldOption = CatalogProductOption & {
- __typename?: 'NumberFieldOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** A connection to a list of items. */
-export type OptionConnection = {
- __typename?: 'OptionConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type OptionEdge = {
- __typename?: 'OptionEdge'
- /** The item at the end of the edge. */
- node: ProductOption
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type OptionValueConnection = {
- __typename?: 'OptionValueConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type OptionValueEdge = {
- __typename?: 'OptionValueEdge'
- /** The item at the end of the edge. */
- node: ProductOptionValue
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-export type OptionValueId = {
- optionEntityId: Scalars['Int']
- valueEntityId: Scalars['Int']
-}
-
-/** Information about pagination in a connection. */
-export type PageInfo = {
- __typename?: 'PageInfo'
- /** When paginating forwards, are there more items? */
- hasNextPage: Scalars['Boolean']
- /** When paginating backwards, are there more items? */
- hasPreviousPage: Scalars['Boolean']
- /** When paginating backwards, the cursor to continue. */
- startCursor?: Maybe
- /** When paginating forwards, the cursor to continue. */
- endCursor?: Maybe
-}
-
-/** The min and max range of prices that apply to this product. */
-export type PriceRanges = {
- __typename?: 'PriceRanges'
- /** Product price min/max range. */
- priceRange: MoneyRange
- /** Product retail price min/max range. */
- retailPriceRange?: Maybe
-}
-
-/** The various prices that can be set on a product. */
-export type Prices = {
- __typename?: 'Prices'
- /** Calculated price of the product. */
- price: Money
- /** Sale price of the product. */
- salePrice?: Maybe
- /** Original price of the product. */
- basePrice?: Maybe
- /** Retail price of the product. */
- retailPrice?: Maybe
- /** Minimum advertised price of the product. */
- mapPrice?: Maybe
- /** Product price min/max range. */
- priceRange: MoneyRange
- /** Product retail price min/max range. */
- retailPriceRange?: Maybe
- /** The difference between the retail price (MSRP) and the current price, which can be presented to the shopper as their savings. */
- saved?: Maybe
- /** List of bulk pricing tiers applicable to a product or variant. */
- bulkPricing: Array
-}
-
-/** Product */
-export type Product = Node & {
- __typename?: 'Product'
- /** The ID of an object */
- id: Scalars['ID']
- /** Id of the product. */
- entityId: Scalars['Int']
- /** Default product variant when no options are selected. */
- sku: Scalars['String']
- /** Relative URL path to product page. */
- path: Scalars['String']
- /** Name of the product. */
- name: Scalars['String']
- /** Description of the product. */
- description: Scalars['String']
- /** Description of the product in plain text. */
- plainTextDescription: Scalars['String']
- /** Warranty information of the product. */
- warranty: Scalars['String']
- /** Minimum purchasable quantity for this product in a single order. */
- minPurchaseQuantity?: Maybe
- /** Maximum purchasable quantity for this product in a single order. */
- maxPurchaseQuantity?: Maybe
- /** Absolute URL path for adding a product to cart. */
- addToCartUrl: Scalars['String']
- /** Absolute URL path for adding a product to customer's wishlist. */
- addToWishlistUrl: Scalars['String']
- /** Prices object determined by supplied product ID, variant ID, and selected option IDs. */
- prices?: Maybe
- /**
- * The minimum and maximum price of this product based on variant pricing and/or modifier price rules.
- * @deprecated Use priceRanges inside prices node instead.
- */
- priceRanges?: Maybe
- /** Weight of the product. */
- weight?: Maybe
- /** Height of the product. */
- height?: Maybe
- /** Width of the product. */
- width?: Maybe
- /** Depth of the product. */
- depth?: Maybe
- /** Product options. */
- options: OptionConnection
- /** Product options. */
- productOptions: ProductOptionConnection
- /** Summary of the product reviews, includes the total number of reviews submitted and summation of the ratings on the reviews (ratings range from 0-5 per review). */
- reviewSummary: Reviews
- /** Type of product, ex: physical, digital */
- type: Scalars['String']
- /**
- * The availability state of the product.
- * @deprecated Use status inside availabilityV2 instead.
- */
- availability: Scalars['String']
- /**
- * A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.
- * @deprecated Use description inside availabilityV2 instead.
- */
- availabilityDescription: Scalars['String']
- /** The availability state of the product. */
- availabilityV2: ProductAvailability
- /** List of categories associated with the product. */
- categories: CategoryConnection
- /** Brand associated with the product. */
- brand?: Maybe
- /** Variants associated with the product. */
- variants: VariantConnection
- /** Custom fields of the product. */
- customFields: CustomFieldConnection
- /** A list of the images for a product. */
- images: ImageConnection
- /** Default image for a product. */
- defaultImage?: Maybe
- /** Related products for this product. */
- relatedProducts: RelatedProductsConnection
- /** Inventory information of the product. */
- inventory: ProductInventory
- /** Metafield data related to a product. */
- metafields: MetafieldConnection
- /**
- * Product creation date
- * @deprecated Alpha version. Do not use in production.
- */
- createdAt: DateTimeExtended
-}
-
-/** Product */
-export type ProductPlainTextDescriptionArgs = {
- characterLimit?: Maybe
-}
-
-/** Product */
-export type ProductPricesArgs = {
- includeTax?: Maybe
- currencyCode?: Maybe
-}
-
-/** Product */
-export type ProductPriceRangesArgs = {
- includeTax?: Maybe
-}
-
-/** Product */
-export type ProductOptionsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductProductOptionsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductCategoriesArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductVariantsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
- entityIds?: Maybe>
- optionValueIds?: Maybe>
-}
-
-/** Product */
-export type ProductCustomFieldsArgs = {
- names?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductImagesArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductRelatedProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductMetafieldsArgs = {
- namespace: Scalars['String']
- keys?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product availability */
-export type ProductAvailability = {
- /** The availability state of the product. */
- status: ProductAvailabilityStatus
- /** A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. */
- description: Scalars['String']
-}
-
-/** Product availability status */
-export enum ProductAvailabilityStatus {
- Available = 'Available',
- Preorder = 'Preorder',
- Unavailable = 'Unavailable',
-}
-
-/** Available Product */
-export type ProductAvailable = ProductAvailability & {
- __typename?: 'ProductAvailable'
- /** The availability state of the product. */
- status: ProductAvailabilityStatus
- /** A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. */
- description: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type ProductConnection = {
- __typename?: 'ProductConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type ProductEdge = {
- __typename?: 'ProductEdge'
- /** The item at the end of the edge. */
- node: Product
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Product Inventory Information */
-export type ProductInventory = {
- __typename?: 'ProductInventory'
- /** Indicates whether this product is in stock. */
- isInStock: Scalars['Boolean']
- /** Indicates whether this product's inventory is being tracked on variant level. If true, you may wish to check the variants node to understand the true inventory of each individual variant, rather than relying on this product-level aggregate to understand how many items may be added to cart. */
- hasVariantInventory: Scalars['Boolean']
- /** Aggregated product inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront. */
- aggregated?: Maybe
-}
-
-/** Product Option */
-export type ProductOption = {
- __typename?: 'ProductOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
- /** Option values. */
- values: OptionValueConnection
-}
-
-/** Product Option */
-export type ProductOptionValuesArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A connection to a list of items. */
-export type ProductOptionConnection = {
- __typename?: 'ProductOptionConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type ProductOptionEdge = {
- __typename?: 'ProductOptionEdge'
- /** The item at the end of the edge. */
- node: CatalogProductOption
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Product Option Value */
-export type ProductOptionValue = {
- __typename?: 'ProductOptionValue'
- /** Unique ID for the option value. */
- entityId: Scalars['Int']
- /** Label for the option value. */
- label: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type ProductOptionValueConnection = {
- __typename?: 'ProductOptionValueConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type ProductOptionValueEdge = {
- __typename?: 'ProductOptionValueEdge'
- /** The item at the end of the edge. */
- node: CatalogProductOptionValue
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** A Product PickList Value - a product to be mapped to the base product if selected. */
-export type ProductPickListOptionValue = CatalogProductOptionValue & {
- __typename?: 'ProductPickListOptionValue'
- /** The ID of the product associated with this option value. */
- productId: Scalars['Int']
- /** Unique ID for the option value. */
- entityId: Scalars['Int']
- /** Label for the option value. */
- label: Scalars['String']
- /** Indicates whether this value is the chosen default selected value. */
- isDefault: Scalars['Boolean']
-}
-
-/** PreOrder Product */
-export type ProductPreOrder = ProductAvailability & {
- __typename?: 'ProductPreOrder'
- /** The message to be shown in the store when a product is put into the pre-order availability state, e.g. "Expected release date is %%DATE%%" */
- message?: Maybe
- /** Product release date */
- willBeReleasedAt?: Maybe
- /** The availability state of the product. */
- status: ProductAvailabilityStatus
- /** A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. */
- description: Scalars['String']
-}
-
-/** Unavailable Product */
-export type ProductUnavailable = ProductAvailability & {
- __typename?: 'ProductUnavailable'
- /** The message to be shown in the store when "Call for pricing" is enabled for this product, e.g. "Contact us at 555-5555" */
- message?: Maybe
- /** The availability state of the product. */
- status: ProductAvailabilityStatus
- /** A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. */
- description: Scalars['String']
-}
-
-export type Query = {
- __typename?: 'Query'
- site: Site
- /** The currently logged in customer. */
- customer?: Maybe
- /** Fetches an object given its ID */
- node?: Maybe
- /** @deprecated Alpha version. Do not use in production. */
- inventory: Inventory
-}
-
-export type QueryNodeArgs = {
- id: Scalars['ID']
-}
-
-/** A connection to a list of items. */
-export type RelatedProductsConnection = {
- __typename?: 'RelatedProductsConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type RelatedProductsEdge = {
- __typename?: 'RelatedProductsEdge'
- /** The item at the end of the edge. */
- node: Product
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Review Rating Summary */
-export type Reviews = {
- __typename?: 'Reviews'
- /** Total number of reviews on product. */
- numberOfReviews: Scalars['Int']
- /** Summation of rating scores from each review. */
- summationOfRatings: Scalars['Int']
-}
-
-/** route */
-export type Route = {
- __typename?: 'Route'
- /** node */
- node?: Maybe
-}
-
-/** Store settings information from the control panel. */
-export type Settings = {
- __typename?: 'Settings'
- /** The name of the store. */
- storeName: Scalars['String']
- /** The hash of the store. */
- storeHash: Scalars['String']
- /** The current store status. */
- status: StorefrontStatusType
- /** Logo information for the store. */
- logo: LogoField
- /** Contact information for the store. */
- contact?: Maybe
- /** Store urls. */
- url: UrlField
- /** Store display format information. */
- display: DisplayField
- /** Channel ID. */
- channelId: Scalars['Long']
-}
-
-/** A site */
-export type Site = {
- __typename?: 'Site'
- categoryTree: Array
- /** Details of the brand. */
- brands: BrandConnection
- /** Details of the products. */
- products: ProductConnection
- /** Details of the newest products. */
- newestProducts: ProductConnection
- /** Details of the best selling products. */
- bestSellingProducts: ProductConnection
- /** Details of the featured products. */
- featuredProducts: ProductConnection
- /** A single product object with variant pricing overlay capabilities. */
- product?: Maybe
- /** Route for a node */
- route: Route
- /** Store settings. */
- settings?: Maybe
-}
-
-/** A site */
-export type SiteBrandsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
- productEntityIds?: Maybe>
-}
-
-/** A site */
-export type SiteProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
- ids?: Maybe>
- entityIds?: Maybe>
-}
-
-/** A site */
-export type SiteNewestProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A site */
-export type SiteBestSellingProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A site */
-export type SiteFeaturedProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A site */
-export type SiteProductArgs = {
- id?: Maybe
- entityId?: Maybe
- variantEntityId?: Maybe
- optionValueIds?: Maybe>
- sku?: Maybe
-}
-
-/** A site */
-export type SiteRouteArgs = {
- path: Scalars['String']
-}
-
-/** Storefront Mode */
-export enum StorefrontStatusType {
- Launched = 'LAUNCHED',
- Maintenance = 'MAINTENANCE',
- PreLaunch = 'PRE_LAUNCH',
- Hibernation = 'HIBERNATION',
-}
-
-/** A swatch option value - swatch values can be associated with a list of hexidecimal colors or an image. */
-export type SwatchOptionValue = CatalogProductOptionValue & {
- __typename?: 'SwatchOptionValue'
- /** List of up to 3 hex encoded colors to associate with a swatch value. */
- hexColors: Array
- /** Absolute path of a swatch texture image. */
- imageUrl?: Maybe
- /** Unique ID for the option value. */
- entityId: Scalars['Int']
- /** Label for the option value. */
- label: Scalars['String']
- /** Indicates whether this value is the chosen default selected value. */
- isDefault: Scalars['Boolean']
-}
-
-/** A swatch option value - swatch values can be associated with a list of hexidecimal colors or an image. */
-export type SwatchOptionValueImageUrlArgs = {
- width: Scalars['Int']
- height?: Maybe
-}
-
-/** A single line text input field. */
-export type TextFieldOption = CatalogProductOption & {
- __typename?: 'TextFieldOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** Url field */
-export type UrlField = {
- __typename?: 'UrlField'
- /** Store url. */
- vanityUrl: Scalars['String']
- /** CDN url to fetch assets. */
- cdnUrl: Scalars['String']
-}
-
-/** Variant */
-export type Variant = Node & {
- __typename?: 'Variant'
- /** The ID of an object */
- id: Scalars['ID']
- /** Id of the variant. */
- entityId: Scalars['Int']
- /** Sku of the variant. */
- sku: Scalars['String']
- /** The variant's weight. If a weight was not explicitly specified on the variant, this will be the product's weight. */
- weight?: Maybe
- /** The variant's height. If a height was not explicitly specified on the variant, this will be the product's height. */
- height?: Maybe
- /** The variant's width. If a width was not explicitly specified on the variant, this will be the product's width. */
- width?: Maybe
- /** The variant's depth. If a depth was not explicitly specified on the variant, this will be the product's depth. */
- depth?: Maybe
- /** The options which define a variant. */
- options: OptionConnection
- /** Product options that compose this variant. */
- productOptions: ProductOptionConnection
- /** Default image for a variant. */
- defaultImage?: Maybe
- /** Variant prices */
- prices?: Maybe
- /** Variant inventory */
- inventory?: Maybe
- /** Metafield data related to a variant. */
- metafields: MetafieldConnection
-}
-
-/** Variant */
-export type VariantOptionsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Variant */
-export type VariantProductOptionsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Variant */
-export type VariantPricesArgs = {
- includeTax?: Maybe
- currencyCode?: Maybe
-}
-
-/** Variant */
-export type VariantMetafieldsArgs = {
- namespace: Scalars['String']
- keys?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A connection to a list of items. */
-export type VariantConnection = {
- __typename?: 'VariantConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type VariantEdge = {
- __typename?: 'VariantEdge'
- /** The item at the end of the edge. */
- node: Variant
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Variant Inventory */
-export type VariantInventory = {
- __typename?: 'VariantInventory'
- /** Aggregated product variant inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront. */
- aggregated?: Maybe
- /** Indicates whether this product is in stock. */
- isInStock: Scalars['Boolean']
- /** Inventory by locations. */
- byLocation?: Maybe
-}
-
-/** Variant Inventory */
-export type VariantInventoryByLocationArgs = {
- locationEntityIds?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Please select a currency */
-export enum CurrencyCode {
- Adp = 'ADP',
- Aed = 'AED',
- Afa = 'AFA',
- Afn = 'AFN',
- Alk = 'ALK',
- All = 'ALL',
- Amd = 'AMD',
- Ang = 'ANG',
- Aoa = 'AOA',
- Aok = 'AOK',
- Aon = 'AON',
- Aor = 'AOR',
- Ara = 'ARA',
- Arl = 'ARL',
- Arm = 'ARM',
- Arp = 'ARP',
- Ars = 'ARS',
- Ats = 'ATS',
- Aud = 'AUD',
- Awg = 'AWG',
- Azm = 'AZM',
- Azn = 'AZN',
- Bad = 'BAD',
- Bam = 'BAM',
- Ban = 'BAN',
- Bbd = 'BBD',
- Bdt = 'BDT',
- Bec = 'BEC',
- Bef = 'BEF',
- Bel = 'BEL',
- Bgl = 'BGL',
- Bgm = 'BGM',
- Bgn = 'BGN',
- Bgo = 'BGO',
- Bhd = 'BHD',
- Bif = 'BIF',
- Bmd = 'BMD',
- Bnd = 'BND',
- Bob = 'BOB',
- Bol = 'BOL',
- Bop = 'BOP',
- Bov = 'BOV',
- Brb = 'BRB',
- Brc = 'BRC',
- Bre = 'BRE',
- Brl = 'BRL',
- Brn = 'BRN',
- Brr = 'BRR',
- Brz = 'BRZ',
- Bsd = 'BSD',
- Btn = 'BTN',
- Buk = 'BUK',
- Bwp = 'BWP',
- Byb = 'BYB',
- Byr = 'BYR',
- Bzd = 'BZD',
- Cad = 'CAD',
- Cdf = 'CDF',
- Che = 'CHE',
- Chf = 'CHF',
- Chw = 'CHW',
- Cle = 'CLE',
- Clf = 'CLF',
- Clp = 'CLP',
- Cnx = 'CNX',
- Cny = 'CNY',
- Cop = 'COP',
- Cou = 'COU',
- Crc = 'CRC',
- Csd = 'CSD',
- Csk = 'CSK',
- Cve = 'CVE',
- Cyp = 'CYP',
- Czk = 'CZK',
- Ddm = 'DDM',
- Dem = 'DEM',
- Djf = 'DJF',
- Dkk = 'DKK',
- Dop = 'DOP',
- Dzd = 'DZD',
- Ecs = 'ECS',
- Ecv = 'ECV',
- Eek = 'EEK',
- Egp = 'EGP',
- Ern = 'ERN',
- Esa = 'ESA',
- Esb = 'ESB',
- Esp = 'ESP',
- Etb = 'ETB',
- Eur = 'EUR',
- Fim = 'FIM',
- Fjd = 'FJD',
- Fkp = 'FKP',
- Frf = 'FRF',
- Gbp = 'GBP',
- Gek = 'GEK',
- Gel = 'GEL',
- Ghc = 'GHC',
- Ghs = 'GHS',
- Gip = 'GIP',
- Gmd = 'GMD',
- Gnf = 'GNF',
- Gns = 'GNS',
- Gqe = 'GQE',
- Grd = 'GRD',
- Gtq = 'GTQ',
- Gwe = 'GWE',
- Gwp = 'GWP',
- Gyd = 'GYD',
- Hkd = 'HKD',
- Hnl = 'HNL',
- Hrd = 'HRD',
- Hrk = 'HRK',
- Htg = 'HTG',
- Huf = 'HUF',
- Idr = 'IDR',
- Iep = 'IEP',
- Ilp = 'ILP',
- Ilr = 'ILR',
- Ils = 'ILS',
- Inr = 'INR',
- Iqd = 'IQD',
- Isj = 'ISJ',
- Isk = 'ISK',
- Itl = 'ITL',
- Jmd = 'JMD',
- Jod = 'JOD',
- Jpy = 'JPY',
- Kes = 'KES',
- Kgs = 'KGS',
- Khr = 'KHR',
- Kmf = 'KMF',
- Krh = 'KRH',
- Kro = 'KRO',
- Krw = 'KRW',
- Kwd = 'KWD',
- Kyd = 'KYD',
- Kzt = 'KZT',
- Lak = 'LAK',
- Lbp = 'LBP',
- Lkr = 'LKR',
- Lrd = 'LRD',
- Lsl = 'LSL',
- Ltl = 'LTL',
- Ltt = 'LTT',
- Luc = 'LUC',
- Luf = 'LUF',
- Lul = 'LUL',
- Lvl = 'LVL',
- Lvr = 'LVR',
- Lyd = 'LYD',
- Mad = 'MAD',
- Maf = 'MAF',
- Mcf = 'MCF',
- Mdc = 'MDC',
- Mdl = 'MDL',
- Mga = 'MGA',
- Mgf = 'MGF',
- Mkd = 'MKD',
- Mkn = 'MKN',
- Mlf = 'MLF',
- Mmk = 'MMK',
- Mnt = 'MNT',
- Mop = 'MOP',
- Mro = 'MRO',
- Mtl = 'MTL',
- Mtp = 'MTP',
- Mur = 'MUR',
- Mvp = 'MVP',
- Mvr = 'MVR',
- Mwk = 'MWK',
- Mxn = 'MXN',
- Mxp = 'MXP',
- Mxv = 'MXV',
- Myr = 'MYR',
- Mze = 'MZE',
- Mzm = 'MZM',
- Mzn = 'MZN',
- Nad = 'NAD',
- Ngn = 'NGN',
- Nic = 'NIC',
- Nio = 'NIO',
- Nlg = 'NLG',
- Nok = 'NOK',
- Npr = 'NPR',
- Nzd = 'NZD',
- Omr = 'OMR',
- Pab = 'PAB',
- Pei = 'PEI',
- Pen = 'PEN',
- Pes = 'PES',
- Pgk = 'PGK',
- Php = 'PHP',
- Pkr = 'PKR',
- Pln = 'PLN',
- Plz = 'PLZ',
- Pte = 'PTE',
- Pyg = 'PYG',
- Qar = 'QAR',
- Rhd = 'RHD',
- Rol = 'ROL',
- Ron = 'RON',
- Rsd = 'RSD',
- Rub = 'RUB',
- Rur = 'RUR',
- Rwf = 'RWF',
- Sar = 'SAR',
- Sbd = 'SBD',
- Scr = 'SCR',
- Sdd = 'SDD',
- Sdg = 'SDG',
- Sdp = 'SDP',
- Sek = 'SEK',
- Sgd = 'SGD',
- Shp = 'SHP',
- Sit = 'SIT',
- Skk = 'SKK',
- Sll = 'SLL',
- Sos = 'SOS',
- Srd = 'SRD',
- Srg = 'SRG',
- Ssp = 'SSP',
- Std = 'STD',
- Sur = 'SUR',
- Svc = 'SVC',
- Syp = 'SYP',
- Szl = 'SZL',
- Thb = 'THB',
- Tjr = 'TJR',
- Tjs = 'TJS',
- Tmm = 'TMM',
- Tmt = 'TMT',
- Tnd = 'TND',
- Top = 'TOP',
- Tpe = 'TPE',
- Trl = 'TRL',
- Try = 'TRY',
- Ttd = 'TTD',
- Twd = 'TWD',
- Tzs = 'TZS',
- Uah = 'UAH',
- Uak = 'UAK',
- Ugs = 'UGS',
- Ugx = 'UGX',
- Usd = 'USD',
- Usn = 'USN',
- Uss = 'USS',
- Uyi = 'UYI',
- Uyp = 'UYP',
- Uyu = 'UYU',
- Uzs = 'UZS',
- Veb = 'VEB',
- Vef = 'VEF',
- Vnd = 'VND',
- Vnn = 'VNN',
- Vuv = 'VUV',
- Wst = 'WST',
- Xaf = 'XAF',
- Xcd = 'XCD',
- Xeu = 'XEU',
- Xfo = 'XFO',
- Xfu = 'XFU',
- Xof = 'XOF',
- Xpf = 'XPF',
- Xre = 'XRE',
- Ydd = 'YDD',
- Yer = 'YER',
- Yud = 'YUD',
- Yum = 'YUM',
- Yun = 'YUN',
- Yur = 'YUR',
- Zal = 'ZAL',
- Zar = 'ZAR',
- Zmk = 'ZMK',
- Zmw = 'ZMW',
- Zrn = 'ZRN',
- Zrz = 'ZRZ',
- Zwd = 'ZWD',
- Zwl = 'ZWL',
- Zwr = 'ZWR',
-}
-
-export type GetLoggedInCustomerQueryVariables = Exact<{ [key: string]: never }>
-
-export type GetLoggedInCustomerQuery = { __typename?: 'Query' } & {
- customer?: Maybe<
- { __typename?: 'Customer' } & Pick<
- Customer,
- | 'entityId'
- | 'firstName'
- | 'lastName'
- | 'email'
- | 'company'
- | 'customerGroupId'
- | 'notes'
- | 'phone'
- | 'addressCount'
- | 'attributeCount'
- > & {
- storeCredit: Array<
- { __typename?: 'Money' } & Pick
- >
- }
- >
-}
-
-export type CategoryTreeItemFragment = {
- __typename?: 'CategoryTreeItem'
-} & Pick<
- CategoryTreeItem,
- 'entityId' | 'name' | 'path' | 'description' | 'productCount'
->
-
-export type ProductPricesFragment = { __typename?: 'Prices' } & {
- price: { __typename?: 'Money' } & Pick
- salePrice?: Maybe<
- { __typename?: 'Money' } & Pick
- >
- retailPrice?: Maybe<
- { __typename?: 'Money' } & Pick
- >
-}
-
-export type SwatchOptionFragment = { __typename?: 'SwatchOptionValue' } & Pick<
- SwatchOptionValue,
- 'isDefault' | 'hexColors'
->
-
-export type MultipleChoiceOptionFragment = {
- __typename?: 'MultipleChoiceOption'
-} & {
- values: { __typename?: 'ProductOptionValueConnection' } & {
- edges?: Maybe<
- Array<
- Maybe<
- { __typename?: 'ProductOptionValueEdge' } & {
- node:
- | ({ __typename?: 'MultipleChoiceOptionValue' } & Pick<
- MultipleChoiceOptionValue,
- 'label'
- >)
- | ({ __typename?: 'ProductPickListOptionValue' } & Pick<
- ProductPickListOptionValue,
- 'label'
- >)
- | ({ __typename?: 'SwatchOptionValue' } & Pick<
- SwatchOptionValue,
- 'label'
- > &
- SwatchOptionFragment)
- }
- >
- >
- >
- }
-}
-
-export type ProductInfoFragment = { __typename?: 'Product' } & Pick<
- Product,
- 'entityId' | 'name' | 'path' | 'description'
-> & {
- brand?: Maybe<{ __typename?: 'Brand' } & Pick>
- prices?: Maybe<{ __typename?: 'Prices' } & ProductPricesFragment>
- images: { __typename?: 'ImageConnection' } & {
- edges?: Maybe<
- Array<
- Maybe<
- { __typename?: 'ImageEdge' } & {
- node: { __typename?: 'Image' } & Pick<
- Image,
- 'urlOriginal' | 'altText' | 'isDefault'
- >
- }
- >
- >
- >
- }
- variants: { __typename?: 'VariantConnection' } & {
- edges?: Maybe<
- Array<
- Maybe<
- { __typename?: 'VariantEdge' } & {
- node: { __typename?: 'Variant' } & Pick & {
- defaultImage?: Maybe<
- { __typename?: 'Image' } & Pick<
- Image,
- 'urlOriginal' | 'altText' | 'isDefault'
- >
- >
- }
- }
- >
- >
- >
- }
- productOptions: { __typename?: 'ProductOptionConnection' } & {
- edges?: Maybe<
- Array<
- Maybe<
- { __typename?: 'ProductOptionEdge' } & {
- node:
- | ({ __typename: 'CheckboxOption' } & Pick<
- CheckboxOption,
- 'entityId' | 'displayName'
- >)
- | ({ __typename: 'DateFieldOption' } & Pick<
- DateFieldOption,
- 'entityId' | 'displayName'
- >)
- | ({ __typename: 'FileUploadFieldOption' } & Pick<
- FileUploadFieldOption,
- 'entityId' | 'displayName'
- >)
- | ({ __typename: 'MultiLineTextFieldOption' } & Pick<
- MultiLineTextFieldOption,
- 'entityId' | 'displayName'
- >)
- | ({ __typename: 'MultipleChoiceOption' } & Pick<
- MultipleChoiceOption,
- 'entityId' | 'displayName'
- > &
- MultipleChoiceOptionFragment)
- | ({ __typename: 'NumberFieldOption' } & Pick<
- NumberFieldOption,
- 'entityId' | 'displayName'
- >)
- | ({ __typename: 'TextFieldOption' } & Pick<
- TextFieldOption,
- 'entityId' | 'displayName'
- >)
- }
- >
- >
- >
- }
- localeMeta: { __typename?: 'MetafieldConnection' } & {
- edges?: Maybe<
- Array<
- Maybe<
- { __typename?: 'MetafieldEdge' } & {
- node: { __typename?: 'Metafields' } & Pick<
- Metafields,
- 'key' | 'value'
- >
- }
- >
- >
- >
- }
- }
-
-export type ProductConnnectionFragment = {
- __typename?: 'ProductConnection'
-} & {
- pageInfo: { __typename?: 'PageInfo' } & Pick<
- PageInfo,
- 'startCursor' | 'endCursor'
- >
- edges?: Maybe<
- Array<
- Maybe<
- { __typename?: 'ProductEdge' } & Pick & {
- node: { __typename?: 'Product' } & ProductInfoFragment
- }
- >
- >
- >
-}
-
-export type GetAllProductPathsQueryVariables = Exact<{
- first?: Maybe
-}>
-
-export type GetAllProductPathsQuery = { __typename?: 'Query' } & {
- site: { __typename?: 'Site' } & {
- products: { __typename?: 'ProductConnection' } & {
- edges?: Maybe<
- Array<
- Maybe<
- { __typename?: 'ProductEdge' } & {
- node: { __typename?: 'Product' } & Pick
- }
- >
- >
- >
- }
- }
-}
-
-export type GetAllProductsQueryVariables = Exact<{
- hasLocale?: Maybe
- locale?: Maybe
- entityIds?: Maybe>
- first?: Maybe
- products?: Maybe
- featuredProducts?: Maybe
- bestSellingProducts?: Maybe
- newestProducts?: Maybe
-}>
-
-export type GetAllProductsQuery = { __typename?: 'Query' } & {
- site: { __typename?: 'Site' } & {
- products: { __typename?: 'ProductConnection' } & ProductConnnectionFragment
- featuredProducts: {
- __typename?: 'ProductConnection'
- } & ProductConnnectionFragment
- bestSellingProducts: {
- __typename?: 'ProductConnection'
- } & ProductConnnectionFragment
- newestProducts: {
- __typename?: 'ProductConnection'
- } & ProductConnnectionFragment
- }
-}
-
-export type GetCustomerIdQueryVariables = Exact<{ [key: string]: never }>
-
-export type GetCustomerIdQuery = { __typename?: 'Query' } & {
- customer?: Maybe<{ __typename?: 'Customer' } & Pick>
-}
-
-export type GetProductQueryVariables = Exact<{
- hasLocale?: Maybe
- locale?: Maybe
- path: Scalars['String']
-}>
-
-export type GetProductQuery = { __typename?: 'Query' } & {
- site: { __typename?: 'Site' } & {
- route: { __typename?: 'Route' } & {
- node?: Maybe<
- | { __typename: 'Brand' }
- | { __typename: 'Category' }
- | ({ __typename: 'Product' } & {
- variants: { __typename?: 'VariantConnection' } & {
- edges?: Maybe<
- Array<
- Maybe<
- { __typename?: 'VariantEdge' } & {
- node: { __typename?: 'Variant' } & Pick<
- Variant,
- 'entityId'
- > & {
- defaultImage?: Maybe<
- { __typename?: 'Image' } & Pick<
- Image,
- 'urlOriginal' | 'altText' | 'isDefault'
- >
- >
- prices?: Maybe<
- { __typename?: 'Prices' } & ProductPricesFragment
- >
- inventory?: Maybe<
- { __typename?: 'VariantInventory' } & Pick<
- VariantInventory,
- 'isInStock'
- > & {
- aggregated?: Maybe<
- { __typename?: 'Aggregated' } & Pick<
- Aggregated,
- 'availableToSell' | 'warningLevel'
- >
- >
- }
- >
- productOptions: {
- __typename?: 'ProductOptionConnection'
- } & {
- edges?: Maybe<
- Array<
- Maybe<
- { __typename?: 'ProductOptionEdge' } & {
- node:
- | ({
- __typename: 'CheckboxOption'
- } & Pick<
- CheckboxOption,
- 'entityId' | 'displayName'
- >)
- | ({
- __typename: 'DateFieldOption'
- } & Pick<
- DateFieldOption,
- 'entityId' | 'displayName'
- >)
- | ({
- __typename: 'FileUploadFieldOption'
- } & Pick<
- FileUploadFieldOption,
- 'entityId' | 'displayName'
- >)
- | ({
- __typename: 'MultiLineTextFieldOption'
- } & Pick<
- MultiLineTextFieldOption,
- 'entityId' | 'displayName'
- >)
- | ({
- __typename: 'MultipleChoiceOption'
- } & Pick<
- MultipleChoiceOption,
- 'entityId' | 'displayName'
- > &
- MultipleChoiceOptionFragment)
- | ({
- __typename: 'NumberFieldOption'
- } & Pick<
- NumberFieldOption,
- 'entityId' | 'displayName'
- >)
- | ({
- __typename: 'TextFieldOption'
- } & Pick<
- TextFieldOption,
- 'entityId' | 'displayName'
- >)
- }
- >
- >
- >
- }
- }
- }
- >
- >
- >
- }
- } & ProductInfoFragment)
- | { __typename: 'Variant' }
- >
- }
- }
-}
-
-export type GetSiteInfoQueryVariables = Exact<{ [key: string]: never }>
-
-export type GetSiteInfoQuery = { __typename?: 'Query' } & {
- site: { __typename?: 'Site' } & {
- categoryTree: Array<
- { __typename?: 'CategoryTreeItem' } & {
- children: Array<
- { __typename?: 'CategoryTreeItem' } & {
- children: Array<
- { __typename?: 'CategoryTreeItem' } & CategoryTreeItemFragment
- >
- } & CategoryTreeItemFragment
- >
- } & CategoryTreeItemFragment
- >
- brands: { __typename?: 'BrandConnection' } & {
- pageInfo: { __typename?: 'PageInfo' } & Pick<
- PageInfo,
- 'startCursor' | 'endCursor'
- >
- edges?: Maybe<
- Array<
- Maybe<
- { __typename?: 'BrandEdge' } & Pick & {
- node: { __typename?: 'Brand' } & Pick<
- Brand,
- | 'entityId'
- | 'name'
- | 'pageTitle'
- | 'metaDesc'
- | 'metaKeywords'
- | 'searchKeywords'
- | 'path'
- > & {
- defaultImage?: Maybe<
- { __typename?: 'Image' } & Pick<
- Image,
- 'urlOriginal' | 'altText'
- >
- >
- }
- }
- >
- >
- >
- }
- }
-}
-
-export type LoginMutationVariables = Exact<{
- email: Scalars['String']
- password: Scalars['String']
-}>
-
-export type LoginMutation = { __typename?: 'Mutation' } & {
- login: { __typename?: 'LoginResult' } & Pick
-}
diff --git a/packages/bigcommerce/schema.graphql b/packages/bigcommerce/schema.graphql
deleted file mode 100644
index 79de347fe..000000000
--- a/packages/bigcommerce/schema.graphql
+++ /dev/null
@@ -1,2422 +0,0 @@
-"""
-Login result
-"""
-type LoginResult {
- """
- The result of a login
- """
- result: String!
-}
-
-"""
-Logout result
-"""
-type LogoutResult {
- """
- The result of a logout
- """
- result: String!
-}
-
-type Mutation {
- login(email: String!, password: String!): LoginResult!
- logout: LogoutResult!
-}
-
-"""
-Aggregated
-"""
-type Aggregated {
- """
- Number of available products in stock. This can be 'null' if inventory is not set orif the store's Inventory Settings disable displaying stock levels on the storefront.
- """
- availableToSell: Long!
-
- """
- Indicates a threshold low-stock level. This can be 'null' if the inventory warning level is not set or if the store's Inventory Settings disable displaying stock levels on the storefront.
- """
- warningLevel: Int!
-}
-
-"""
-Aggregated Product Inventory
-"""
-type AggregatedInventory {
- """
- Number of available products in stock. This can be 'null' if inventory is not set orif the store's Inventory Settings disable displaying stock levels on the storefront.
- """
- availableToSell: Int!
-
- """
- Indicates a threshold low-stock level. This can be 'null' if the inventory warning level is not set or if the store's Inventory Settings disable displaying stock levels on the storefront.
- """
- warningLevel: Int!
-}
-
-"""
-Brand
-"""
-type Brand implements Node {
- """
- The ID of an object
- """
- id: ID!
-
- """
- Id of the brand.
- """
- entityId: Int!
-
- """
- Name of the brand.
- """
- name: String!
-
- """
- Default image for brand.
- """
- defaultImage: Image
-
- """
- Page title for the brand.
- """
- pageTitle: String!
-
- """
- Meta description for the brand.
- """
- metaDesc: String!
-
- """
- Meta keywords for the brand.
- """
- metaKeywords: [String!]!
-
- """
- Search keywords for the brand.
- """
- searchKeywords: [String!]!
-
- """
- Path for the brand page.
- """
- path: String!
- products(
- before: String
- after: String
- first: Int
- last: Int
- ): ProductConnection!
-
- """
- Metafield data related to a brand.
- """
- metafields(
- namespace: String!
- keys: [String!] = []
- before: String
- after: String
- first: Int
- last: Int
- ): MetafieldConnection!
-}
-
-"""
-A connection to a list of items.
-"""
-type BrandConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [BrandEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type BrandEdge {
- """
- The item at the end of the edge.
- """
- node: Brand!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-Breadcrumb
-"""
-type Breadcrumb {
- """
- Category id.
- """
- entityId: Int!
-
- """
- Name of the category.
- """
- name: String!
-}
-
-"""
-A connection to a list of items.
-"""
-type BreadcrumbConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [BreadcrumbEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type BreadcrumbEdge {
- """
- The item at the end of the edge.
- """
- node: Breadcrumb!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-Bulk pricing tier that sets a fixed price for the product or variant.
-"""
-type BulkPricingFixedPriceDiscount implements BulkPricingTier {
- """
- This price will override the current product price.
- """
- price: BigDecimal!
-
- """
- Minimum item quantity that applies to this bulk pricing tier.
- """
- minimumQuantity: Int!
-
- """
- Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound.
- """
- maximumQuantity: Int
-}
-
-"""
-Bulk pricing tier that reduces the price of the product or variant by a percentage.
-"""
-type BulkPricingPercentageDiscount implements BulkPricingTier {
- """
- The percentage that will be removed from the product price.
- """
- percentOff: BigDecimal!
-
- """
- Minimum item quantity that applies to this bulk pricing tier.
- """
- minimumQuantity: Int!
-
- """
- Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound.
- """
- maximumQuantity: Int
-}
-
-"""
-Bulk pricing tier that will subtract an amount from the price of the product or variant.
-"""
-type BulkPricingRelativePriceDiscount implements BulkPricingTier {
- """
- The price of the product/variant will be reduced by this priceAdjustment.
- """
- priceAdjustment: BigDecimal!
-
- """
- Minimum item quantity that applies to this bulk pricing tier.
- """
- minimumQuantity: Int!
-
- """
- Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound.
- """
- maximumQuantity: Int
-}
-
-"""
-A set of bulk pricing tiers that define price discounts which apply when purchasing specified quantities of a product or variant.
-"""
-interface BulkPricingTier {
- """
- Minimum item quantity that applies to this bulk pricing tier.
- """
- minimumQuantity: Int!
-
- """
- Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound.
- """
- maximumQuantity: Int
-}
-
-"""
-Product Option
-"""
-interface CatalogProductOption {
- """
- Unique ID for the option.
- """
- entityId: Int!
-
- """
- Display name for the option.
- """
- displayName: String!
-
- """
- One of the option values is required to be selected for the checkout.
- """
- isRequired: Boolean!
-}
-
-"""
-Product Option Value
-"""
-interface CatalogProductOptionValue {
- """
- Unique ID for the option value.
- """
- entityId: Int!
-
- """
- Label for the option value.
- """
- label: String!
-
- """
- Indicates whether this value is the chosen default selected value.
- """
- isDefault: Boolean!
-}
-
-"""
-Category
-"""
-type Category implements Node {
- """
- The ID of an object
- """
- id: ID!
-
- """
- Unique ID for the category.
- """
- entityId: Int!
-
- """
- Category name.
- """
- name: String!
-
- """
- Category path.
- """
- path: String!
-
- """
- Default image for the category.
- """
- defaultImage: Image
-
- """
- Category description.
- """
- description: String!
-
- """
- Category breadcrumbs.
- """
- breadcrumbs(
- depth: Int!
- before: String
- after: String
- first: Int
- last: Int
- ): BreadcrumbConnection!
- products(
- before: String
- after: String
- first: Int
- last: Int
- ): ProductConnection!
-
- """
- Metafield data related to a category.
- """
- metafields(
- namespace: String!
- keys: [String!] = []
- before: String
- after: String
- first: Int
- last: Int
- ): MetafieldConnection!
-}
-
-"""
-A connection to a list of items.
-"""
-type CategoryConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [CategoryEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type CategoryEdge {
- """
- The item at the end of the edge.
- """
- node: Category!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-An item in a tree of categories.
-"""
-type CategoryTreeItem {
- """
- The id category.
- """
- entityId: Int!
-
- """
- The name of category.
- """
- name: String!
-
- """
- Path assigned to this category
- """
- path: String!
-
- """
- The description of this category.
- """
- description: String!
-
- """
- The number of products in this category.
- """
- productCount: Int!
-
- """
- Subcategories of this category
- """
- children: [CategoryTreeItem!]!
-}
-
-"""
-A simple yes/no question represented by a checkbox.
-"""
-type CheckboxOption implements CatalogProductOption {
- """
- Indicates the default checked status.
- """
- checkedByDefault: Boolean!
-
- """
- Unique ID for the option.
- """
- entityId: Int!
-
- """
- Display name for the option.
- """
- displayName: String!
-
- """
- One of the option values is required to be selected for the checkout.
- """
- isRequired: Boolean!
-}
-
-"""
-Contact field
-"""
-type ContactField {
- """
- Store address line.
- """
- address: String!
-
- """
- Store country.
- """
- country: String!
-
- """
- Store address type.
- """
- addressType: String!
-
- """
- Store email.
- """
- email: String!
-
- """
- Store phone number.
- """
- phone: String!
-}
-
-"""
-Custom field
-"""
-type CustomField {
- """
- Custom field id.
- """
- entityId: Int!
-
- """
- Name of the custom field.
- """
- name: String!
-
- """
- Value of the custom field.
- """
- value: String!
-}
-
-"""
-A connection to a list of items.
-"""
-type CustomFieldConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [CustomFieldEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type CustomFieldEdge {
- """
- The item at the end of the edge.
- """
- node: CustomField!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-A customer that shops on a store
-"""
-type Customer {
- """
- The ID of the customer.
- """
- entityId: Int!
-
- """
- The company name of the customer.
- """
- company: String!
-
- """
- The customer group id of the customer.
- """
- customerGroupId: Int!
-
- """
- The email address of the customer.
- """
- email: String!
-
- """
- The first name of the customer.
- """
- firstName: String!
-
- """
- The last name of the customer.
- """
- lastName: String!
-
- """
- The notes of the customer.
- """
- notes: String!
-
- """
- The phone number of the customer.
- """
- phone: String!
-
- """
- The tax exempt category of the customer.
- """
- taxExemptCategory: String!
-
- """
- Customer addresses count.
- """
- addressCount: Int!
-
- """
- Customer attributes count.
- """
- attributeCount: Int!
-
- """
- Customer store credit.
- """
- storeCredit: [Money!]!
-
- """
- Customer attributes.
- """
- attributes: CustomerAttributes!
-}
-
-"""
-A custom, store-specific attribute for a customer
-"""
-type CustomerAttribute {
- """
- The ID of the custom customer attribute
- """
- entityId: Int!
-
- """
- The value of the custom customer attribute
- """
- value: String
-
- """
- The name of the custom customer attribute
- """
- name: String!
-}
-
-"""
-Custom, store-specific customer attributes
-"""
-type CustomerAttributes {
- attribute(
- """
- The ID of the customer attribute
- """
- entityId: Int!
- ): CustomerAttribute!
-}
-
-"""
-A calendar for allowing selection of a date.
-"""
-type DateFieldOption implements CatalogProductOption {
- """
- Unique ID for the option.
- """
- entityId: Int!
-
- """
- Display name for the option.
- """
- displayName: String!
-
- """
- One of the option values is required to be selected for the checkout.
- """
- isRequired: Boolean!
-}
-
-scalar DateTime
-
-"""
-Date Time Extended
-"""
-type DateTimeExtended {
- """
- ISO-8601 formatted date in UTC
- """
- utc: DateTime!
-}
-
-"""
-Display field
-"""
-type DisplayField {
- """
- Short date format.
- """
- shortDateFormat: String!
-
- """
- Extended date format.
- """
- extendedDateFormat: String!
-}
-
-"""
-A form allowing selection and uploading of a file from the user's local computer.
-"""
-type FileUploadFieldOption implements CatalogProductOption {
- """
- Unique ID for the option.
- """
- entityId: Int!
-
- """
- Display name for the option.
- """
- displayName: String!
-
- """
- One of the option values is required to be selected for the checkout.
- """
- isRequired: Boolean!
-}
-
-"""
-Image
-"""
-type Image {
- """
- Absolute path to image using store CDN.
- """
- url(width: Int!, height: Int): String!
-
- """
- Absolute path to original image using store CDN.
- """
- urlOriginal: String!
-
- """
- Text description of an image that can be used for SEO and/or accessibility purposes.
- """
- altText: String!
-
- """
- Indicates whether this is the primary image.
- """
- isDefault: Boolean!
-}
-
-"""
-A connection to a list of items.
-"""
-type ImageConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [ImageEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type ImageEdge {
- """
- The item at the end of the edge.
- """
- node: Image!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-An inventory
-"""
-type Inventory {
- """
- Locations
- """
- locations(
- entityIds: [Int!]
- codes: [String!]
- typeIds: [String!]
- before: String
- after: String
- first: Int
- last: Int
- ): LocationConnection!
-}
-
-"""
-Inventory By Locations
-"""
-type InventoryByLocations {
- """
- Location id.
- """
- locationEntityId: Long!
-
- """
- Number of available products in stock.
- """
- availableToSell: Long!
-
- """
- Indicates a threshold low-stock level.
- """
- warningLevel: Int!
-
- """
- Indicates whether this product is in stock.
- """
- isInStock: Boolean!
-}
-
-"""
-A connection to a list of items.
-"""
-type LocationConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [LocationEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type LocationEdge {
- """
- The item at the end of the edge.
- """
- node: InventoryByLocations!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-Logo field
-"""
-type LogoField {
- """
- Logo title.
- """
- title: String!
-
- """
- Store logo image.
- """
- image: Image!
-}
-
-"""
-Measurement
-"""
-type Measurement {
- """
- Unformatted weight measurement value.
- """
- value: Float!
-
- """
- Unit of measurement.
- """
- unit: String!
-}
-
-"""
-A connection to a list of items.
-"""
-type MetafieldConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [MetafieldEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type MetafieldEdge {
- """
- The item at the end of the edge.
- """
- node: Metafields!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-Key/Value pairs of data attached tied to a resource entity (product, brand, category, etc.)
-"""
-type Metafields {
- """
- The ID of an object
- """
- id: ID!
-
- """
- The ID of the metafield when referencing via our backend API.
- """
- entityId: Int!
-
- """
- A label for identifying a metafield data value.
- """
- key: String!
-
- """
- A metafield value.
- """
- value: String!
-}
-
-"""
-A money object - includes currency code and a money amount
-"""
-type Money {
- """
- Currency code of the current money.
- """
- currencyCode: String!
-
- """
- The amount of money.
- """
- value: BigDecimal!
-}
-
-"""
-A min and max pair of money objects
-"""
-type MoneyRange {
- """
- Minimum money object.
- """
- min: Money!
-
- """
- Maximum money object.
- """
- max: Money!
-}
-
-"""
-A multi-line text input field, aka a text box.
-"""
-type MultiLineTextFieldOption implements CatalogProductOption {
- """
- Unique ID for the option.
- """
- entityId: Int!
-
- """
- Display name for the option.
- """
- displayName: String!
-
- """
- One of the option values is required to be selected for the checkout.
- """
- isRequired: Boolean!
-}
-
-"""
-An option type that has a fixed list of values.
-"""
-type MultipleChoiceOption implements CatalogProductOption {
- """
- The chosen display style for this multiple choice option.
- """
- displayStyle: String!
-
- """
- List of option values.
- """
- values(
- before: String
- after: String
- first: Int
- last: Int
- ): ProductOptionValueConnection!
-
- """
- Unique ID for the option.
- """
- entityId: Int!
-
- """
- Display name for the option.
- """
- displayName: String!
-
- """
- One of the option values is required to be selected for the checkout.
- """
- isRequired: Boolean!
-}
-
-"""
-A simple multiple choice value comprised of an id and a label.
-"""
-type MultipleChoiceOptionValue implements CatalogProductOptionValue {
- """
- Unique ID for the option value.
- """
- entityId: Int!
-
- """
- Label for the option value.
- """
- label: String!
-
- """
- Indicates whether this value is the chosen default selected value.
- """
- isDefault: Boolean!
-}
-
-"""
-An object with an ID
-"""
-interface Node {
- """
- The id of the object.
- """
- id: ID!
-}
-
-"""
-A single line text input field that only accepts numbers.
-"""
-type NumberFieldOption implements CatalogProductOption {
- """
- Unique ID for the option.
- """
- entityId: Int!
-
- """
- Display name for the option.
- """
- displayName: String!
-
- """
- One of the option values is required to be selected for the checkout.
- """
- isRequired: Boolean!
-}
-
-"""
-A connection to a list of items.
-"""
-type OptionConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [OptionEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type OptionEdge {
- """
- The item at the end of the edge.
- """
- node: ProductOption!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-A connection to a list of items.
-"""
-type OptionValueConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [OptionValueEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type OptionValueEdge {
- """
- The item at the end of the edge.
- """
- node: ProductOptionValue!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-input OptionValueId {
- optionEntityId: Int!
- valueEntityId: Int!
-}
-
-"""
-Information about pagination in a connection.
-"""
-type PageInfo {
- """
- When paginating forwards, are there more items?
- """
- hasNextPage: Boolean!
-
- """
- When paginating backwards, are there more items?
- """
- hasPreviousPage: Boolean!
-
- """
- When paginating backwards, the cursor to continue.
- """
- startCursor: String
-
- """
- When paginating forwards, the cursor to continue.
- """
- endCursor: String
-}
-
-"""
-The min and max range of prices that apply to this product.
-"""
-type PriceRanges {
- """
- Product price min/max range.
- """
- priceRange: MoneyRange!
-
- """
- Product retail price min/max range.
- """
- retailPriceRange: MoneyRange
-}
-
-"""
-The various prices that can be set on a product.
-"""
-type Prices {
- """
- Calculated price of the product.
- """
- price: Money!
-
- """
- Sale price of the product.
- """
- salePrice: Money
-
- """
- Original price of the product.
- """
- basePrice: Money
-
- """
- Retail price of the product.
- """
- retailPrice: Money
-
- """
- Minimum advertised price of the product.
- """
- mapPrice: Money
-
- """
- Product price min/max range.
- """
- priceRange: MoneyRange!
-
- """
- Product retail price min/max range.
- """
- retailPriceRange: MoneyRange
-
- """
- The difference between the retail price (MSRP) and the current price, which can be presented to the shopper as their savings.
- """
- saved: Money
-
- """
- List of bulk pricing tiers applicable to a product or variant.
- """
- bulkPricing: [BulkPricingTier!]!
-}
-
-"""
-Product
-"""
-type Product implements Node {
- """
- The ID of an object
- """
- id: ID!
-
- """
- Id of the product.
- """
- entityId: Int!
-
- """
- Default product variant when no options are selected.
- """
- sku: String!
-
- """
- Relative URL path to product page.
- """
- path: String!
-
- """
- Name of the product.
- """
- name: String!
-
- """
- Description of the product.
- """
- description: String!
-
- """
- Description of the product in plain text.
- """
- plainTextDescription(characterLimit: Int = 120): String!
-
- """
- Warranty information of the product.
- """
- warranty: String!
-
- """
- Minimum purchasable quantity for this product in a single order.
- """
- minPurchaseQuantity: Int
-
- """
- Maximum purchasable quantity for this product in a single order.
- """
- maxPurchaseQuantity: Int
-
- """
- Absolute URL path for adding a product to cart.
- """
- addToCartUrl: String!
-
- """
- Absolute URL path for adding a product to customer's wishlist.
- """
- addToWishlistUrl: String!
-
- """
- Prices object determined by supplied product ID, variant ID, and selected option IDs.
- """
- prices(includeTax: Boolean = false, currencyCode: currencyCode): Prices
-
- """
- The minimum and maximum price of this product based on variant pricing and/or modifier price rules.
- """
- priceRanges(includeTax: Boolean = false): PriceRanges
- @deprecated(reason: "Use priceRanges inside prices node instead.")
-
- """
- Weight of the product.
- """
- weight: Measurement
-
- """
- Height of the product.
- """
- height: Measurement
-
- """
- Width of the product.
- """
- width: Measurement
-
- """
- Depth of the product.
- """
- depth: Measurement
-
- """
- Product options.
- """
- options(
- before: String
- after: String
- first: Int
- last: Int
- ): OptionConnection!
-
- """
- Product options.
- """
- productOptions(
- before: String
- after: String
- first: Int
- last: Int
- ): ProductOptionConnection!
-
- """
- Summary of the product reviews, includes the total number of reviews submitted and summation of the ratings on the reviews (ratings range from 0-5 per review).
- """
- reviewSummary: Reviews!
-
- """
- Type of product, ex: physical, digital
- """
- type: String!
-
- """
- The availability state of the product.
- """
- availability: String!
- @deprecated(reason: "Use status inside availabilityV2 instead.")
-
- """
- A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.
- """
- availabilityDescription: String!
- @deprecated(reason: "Use description inside availabilityV2 instead.")
-
- """
- The availability state of the product.
- """
- availabilityV2: ProductAvailability!
-
- """
- List of categories associated with the product.
- """
- categories(
- before: String
- after: String
- first: Int
- last: Int
- ): CategoryConnection!
-
- """
- Brand associated with the product.
- """
- brand: Brand
-
- """
- Variants associated with the product.
- """
- variants(
- before: String
- after: String
- first: Int
- last: Int
- entityIds: [Int!] = []
- optionValueIds: [OptionValueId!] = []
- ): VariantConnection!
-
- """
- Custom fields of the product.
- """
- customFields(
- names: [String!] = []
- before: String
- after: String
- first: Int
- last: Int
- ): CustomFieldConnection!
-
- """
- A list of the images for a product.
- """
- images(before: String, after: String, first: Int, last: Int): ImageConnection!
-
- """
- Default image for a product.
- """
- defaultImage: Image
-
- """
- Related products for this product.
- """
- relatedProducts(
- before: String
- after: String
- first: Int
- last: Int
- ): RelatedProductsConnection!
-
- """
- Inventory information of the product.
- """
- inventory: ProductInventory!
-
- """
- Metafield data related to a product.
- """
- metafields(
- namespace: String!
- keys: [String!] = []
- before: String
- after: String
- first: Int
- last: Int
- ): MetafieldConnection!
-
- """
- Product creation date
- """
- createdAt: DateTimeExtended!
- @deprecated(reason: "Alpha version. Do not use in production.")
-}
-
-"""
-Product availability
-"""
-interface ProductAvailability {
- """
- The availability state of the product.
- """
- status: ProductAvailabilityStatus!
-
- """
- A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.
- """
- description: String!
-}
-
-"""
-Product availability status
-"""
-enum ProductAvailabilityStatus {
- Available
- Preorder
- Unavailable
-}
-
-"""
-Available Product
-"""
-type ProductAvailable implements ProductAvailability {
- """
- The availability state of the product.
- """
- status: ProductAvailabilityStatus!
-
- """
- A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.
- """
- description: String!
-}
-
-"""
-A connection to a list of items.
-"""
-type ProductConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [ProductEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type ProductEdge {
- """
- The item at the end of the edge.
- """
- node: Product!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-Product Inventory Information
-"""
-type ProductInventory {
- """
- Indicates whether this product is in stock.
- """
- isInStock: Boolean!
-
- """
- Indicates whether this product's inventory is being tracked on variant level. If true, you may wish to check the variants node to understand the true inventory of each individual variant, rather than relying on this product-level aggregate to understand how many items may be added to cart.
- """
- hasVariantInventory: Boolean!
-
- """
- Aggregated product inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront.
- """
- aggregated: AggregatedInventory
-}
-
-"""
-Product Option
-"""
-type ProductOption {
- """
- Unique ID for the option.
- """
- entityId: Int!
-
- """
- Display name for the option.
- """
- displayName: String!
-
- """
- One of the option values is required to be selected for the checkout.
- """
- isRequired: Boolean!
-
- """
- Option values.
- """
- values(
- before: String
- after: String
- first: Int
- last: Int
- ): OptionValueConnection!
-}
-
-"""
-A connection to a list of items.
-"""
-type ProductOptionConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [ProductOptionEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type ProductOptionEdge {
- """
- The item at the end of the edge.
- """
- node: CatalogProductOption!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-Product Option Value
-"""
-type ProductOptionValue {
- """
- Unique ID for the option value.
- """
- entityId: Int!
-
- """
- Label for the option value.
- """
- label: String!
-}
-
-"""
-A connection to a list of items.
-"""
-type ProductOptionValueConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [ProductOptionValueEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type ProductOptionValueEdge {
- """
- The item at the end of the edge.
- """
- node: CatalogProductOptionValue!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-A Product PickList Value - a product to be mapped to the base product if selected.
-"""
-type ProductPickListOptionValue implements CatalogProductOptionValue {
- """
- The ID of the product associated with this option value.
- """
- productId: Int!
-
- """
- Unique ID for the option value.
- """
- entityId: Int!
-
- """
- Label for the option value.
- """
- label: String!
-
- """
- Indicates whether this value is the chosen default selected value.
- """
- isDefault: Boolean!
-}
-
-"""
-PreOrder Product
-"""
-type ProductPreOrder implements ProductAvailability {
- """
- The message to be shown in the store when a product is put into the pre-order availability state, e.g. "Expected release date is %%DATE%%"
- """
- message: String
-
- """
- Product release date
- """
- willBeReleasedAt: DateTimeExtended
-
- """
- The availability state of the product.
- """
- status: ProductAvailabilityStatus!
-
- """
- A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.
- """
- description: String!
-}
-
-"""
-Unavailable Product
-"""
-type ProductUnavailable implements ProductAvailability {
- """
- The message to be shown in the store when "Call for pricing" is enabled for this product, e.g. "Contact us at 555-5555"
- """
- message: String
-
- """
- The availability state of the product.
- """
- status: ProductAvailabilityStatus!
-
- """
- A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.
- """
- description: String!
-}
-
-type Query {
- site: Site!
-
- """
- The currently logged in customer.
- """
- customer: Customer
-
- """
- Fetches an object given its ID
- """
- node(
- """
- The ID of an object
- """
- id: ID!
- ): Node
- inventory: Inventory!
- @deprecated(reason: "Alpha version. Do not use in production.")
-}
-
-"""
-A connection to a list of items.
-"""
-type RelatedProductsConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [RelatedProductsEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type RelatedProductsEdge {
- """
- The item at the end of the edge.
- """
- node: Product!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-Review Rating Summary
-"""
-type Reviews {
- """
- Total number of reviews on product.
- """
- numberOfReviews: Int!
-
- """
- Summation of rating scores from each review.
- """
- summationOfRatings: Int!
-}
-
-"""
-route
-"""
-type Route {
- """
- node
- """
- node: Node
-}
-
-"""
-Store settings information from the control panel.
-"""
-type Settings {
- """
- The name of the store.
- """
- storeName: String!
-
- """
- The hash of the store.
- """
- storeHash: String!
-
- """
- The current store status.
- """
- status: StorefrontStatusType!
-
- """
- Logo information for the store.
- """
- logo: LogoField!
-
- """
- Contact information for the store.
- """
- contact: ContactField
-
- """
- Store urls.
- """
- url: UrlField!
-
- """
- Store display format information.
- """
- display: DisplayField!
-
- """
- Channel ID.
- """
- channelId: Long!
-}
-
-"""
-A site
-"""
-type Site {
- categoryTree: [CategoryTreeItem!]!
-
- """
- Details of the brand.
- """
- brands(
- before: String
- after: String
- first: Int
- last: Int
- productEntityIds: [Int!] = []
- ): BrandConnection!
-
- """
- Details of the products.
- """
- products(
- before: String
- after: String
- first: Int
- last: Int
- ids: [ID!] = []
- entityIds: [Int!] = []
- ): ProductConnection!
-
- """
- Details of the newest products.
- """
- newestProducts(
- before: String
- after: String
- first: Int
- last: Int
- ): ProductConnection!
-
- """
- Details of the best selling products.
- """
- bestSellingProducts(
- before: String
- after: String
- first: Int
- last: Int
- ): ProductConnection!
-
- """
- Details of the featured products.
- """
- featuredProducts(
- before: String
- after: String
- first: Int
- last: Int
- ): ProductConnection!
-
- """
- A single product object with variant pricing overlay capabilities.
- """
- product(
- id: ID
- entityId: Int
- variantEntityId: Int
- optionValueIds: [OptionValueId!] = []
- sku: String
- ): Product
-
- """
- Route for a node
- """
- route(path: String!): Route!
-
- """
- Store settings.
- """
- settings: Settings
-}
-
-"""
-Storefront Mode
-"""
-enum StorefrontStatusType {
- LAUNCHED
- MAINTENANCE
- PRE_LAUNCH
- HIBERNATION
-}
-
-"""
-A swatch option value - swatch values can be associated with a list of hexidecimal colors or an image.
-"""
-type SwatchOptionValue implements CatalogProductOptionValue {
- """
- List of up to 3 hex encoded colors to associate with a swatch value.
- """
- hexColors: [String!]!
-
- """
- Absolute path of a swatch texture image.
- """
- imageUrl(width: Int!, height: Int): String
-
- """
- Unique ID for the option value.
- """
- entityId: Int!
-
- """
- Label for the option value.
- """
- label: String!
-
- """
- Indicates whether this value is the chosen default selected value.
- """
- isDefault: Boolean!
-}
-
-"""
-A single line text input field.
-"""
-type TextFieldOption implements CatalogProductOption {
- """
- Unique ID for the option.
- """
- entityId: Int!
-
- """
- Display name for the option.
- """
- displayName: String!
-
- """
- One of the option values is required to be selected for the checkout.
- """
- isRequired: Boolean!
-}
-
-"""
-Url field
-"""
-type UrlField {
- """
- Store url.
- """
- vanityUrl: String!
-
- """
- CDN url to fetch assets.
- """
- cdnUrl: String!
-}
-
-"""
-Variant
-"""
-type Variant implements Node {
- """
- The ID of an object
- """
- id: ID!
-
- """
- Id of the variant.
- """
- entityId: Int!
-
- """
- Sku of the variant.
- """
- sku: String!
-
- """
- The variant's weight. If a weight was not explicitly specified on the variant, this will be the product's weight.
- """
- weight: Measurement
-
- """
- The variant's height. If a height was not explicitly specified on the variant, this will be the product's height.
- """
- height: Measurement
-
- """
- The variant's width. If a width was not explicitly specified on the variant, this will be the product's width.
- """
- width: Measurement
-
- """
- The variant's depth. If a depth was not explicitly specified on the variant, this will be the product's depth.
- """
- depth: Measurement
-
- """
- The options which define a variant.
- """
- options(
- before: String
- after: String
- first: Int
- last: Int
- ): OptionConnection!
-
- """
- Product options that compose this variant.
- """
- productOptions(
- before: String
- after: String
- first: Int
- last: Int
- ): ProductOptionConnection!
-
- """
- Default image for a variant.
- """
- defaultImage: Image
-
- """
- Variant prices
- """
- prices(includeTax: Boolean = false, currencyCode: currencyCode): Prices
-
- """
- Variant inventory
- """
- inventory: VariantInventory
-
- """
- Metafield data related to a variant.
- """
- metafields(
- namespace: String!
- keys: [String!] = []
- before: String
- after: String
- first: Int
- last: Int
- ): MetafieldConnection!
-}
-
-"""
-A connection to a list of items.
-"""
-type VariantConnection {
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- A list of edges.
- """
- edges: [VariantEdge]
-}
-
-"""
-An edge in a connection.
-"""
-type VariantEdge {
- """
- The item at the end of the edge.
- """
- node: Variant!
-
- """
- A cursor for use in pagination.
- """
- cursor: String!
-}
-
-"""
-Variant Inventory
-"""
-type VariantInventory {
- """
- Aggregated product variant inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront.
- """
- aggregated: Aggregated
-
- """
- Indicates whether this product is in stock.
- """
- isInStock: Boolean!
-
- """
- Inventory by locations.
- """
- byLocation(
- locationEntityIds: [Int!] = []
- before: String
- after: String
- first: Int
- last: Int
- ): LocationConnection
-}
-
-"""
-Please select a currency
-"""
-enum currencyCode {
- ADP
- AED
- AFA
- AFN
- ALK
- ALL
- AMD
- ANG
- AOA
- AOK
- AON
- AOR
- ARA
- ARL
- ARM
- ARP
- ARS
- ATS
- AUD
- AWG
- AZM
- AZN
- BAD
- BAM
- BAN
- BBD
- BDT
- BEC
- BEF
- BEL
- BGL
- BGM
- BGN
- BGO
- BHD
- BIF
- BMD
- BND
- BOB
- BOL
- BOP
- BOV
- BRB
- BRC
- BRE
- BRL
- BRN
- BRR
- BRZ
- BSD
- BTN
- BUK
- BWP
- BYB
- BYR
- BZD
- CAD
- CDF
- CHE
- CHF
- CHW
- CLE
- CLF
- CLP
- CNX
- CNY
- COP
- COU
- CRC
- CSD
- CSK
- CVE
- CYP
- CZK
- DDM
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- ECV
- EEK
- EGP
- ERN
- ESA
- ESB
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GEK
- GEL
- GHC
- GHS
- GIP
- GMD
- GNF
- GNS
- GQE
- GRD
- GTQ
- GWE
- GWP
- GYD
- HKD
- HNL
- HRD
- HRK
- HTG
- HUF
- IDR
- IEP
- ILP
- ILR
- ILS
- INR
- IQD
- ISJ
- ISK
- ITL
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KRH
- KRO
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LTT
- LUC
- LUF
- LUL
- LVL
- LVR
- LYD
- MAD
- MAF
- MCF
- MDC
- MDL
- MGA
- MGF
- MKD
- MKN
- MLF
- MMK
- MNT
- MOP
- MRO
- MTL
- MTP
- MUR
- MVP
- MVR
- MWK
- MXN
- MXP
- MXV
- MYR
- MZE
- MZM
- MZN
- NAD
- NGN
- NIC
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEI
- PEN
- PES
- PGK
- PHP
- PKR
- PLN
- PLZ
- PTE
- PYG
- QAR
- RHD
- ROL
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDD
- SDG
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRD
- SRG
- SSP
- STD
- SUR
- SVC
- SYP
- SZL
- THB
- TJR
- TJS
- TMM
- TMT
- TND
- TOP
- TPE
- TRL
- TRY
- TTD
- TWD
- TZS
- UAH
- UAK
- UGS
- UGX
- USD
- USN
- USS
- UYI
- UYP
- UYU
- UZS
- VEB
- VEF
- VND
- VNN
- VUV
- WST
- XAF
- XCD
- XEU
- XFO
- XFU
- XOF
- XPF
- XRE
- YDD
- YER
- YUD
- YUM
- YUN
- YUR
- ZAL
- ZAR
- ZMK
- ZMW
- ZRN
- ZRZ
- ZWD
- ZWL
- ZWR
-}
-
-"""
-The `BigDecimal` scalar type represents signed fractional values with arbitrary precision.
-"""
-scalar BigDecimal
-
-"""
-The `Long` scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.
-"""
-scalar Long
diff --git a/packages/bigcommerce/scripts/generate-definitions.js b/packages/bigcommerce/scripts/generate-definitions.js
deleted file mode 100644
index a2b830d3b..000000000
--- a/packages/bigcommerce/scripts/generate-definitions.js
+++ /dev/null
@@ -1,49 +0,0 @@
-/**
- * Generates definitions for REST API endpoints that are being
- * used by ../api using https://github.com/drwpow/swagger-to-ts
- */
-const { readFileSync, promises } = require('fs')
-const path = require('path')
-const fetch = require('node-fetch')
-const swaggerToTS = require('@manifoldco/swagger-to-ts').default
-
-async function getSchema(filename) {
- const url = `https://next-api.stoplight.io/projects/8433/files/${filename}`
- const res = await fetch(url)
-
- if (!res.ok) {
- throw new Error(`Request failed with ${res.status}: ${res.statusText}`)
- }
-
- return res.json()
-}
-
-const schemas = Object.entries({
- '../api/definitions/catalog.ts':
- 'BigCommerce_Catalog_API.oas2.yml?ref=version%2F20.930',
- '../api/definitions/store-content.ts':
- 'BigCommerce_Store_Content_API.oas2.yml?ref=version%2F20.930',
- '../api/definitions/wishlist.ts':
- 'BigCommerce_Wishlist_API.oas2.yml?ref=version%2F20.930',
- // swagger-to-ts is not working for the schema of the cart API
- // '../api/definitions/cart.ts':
- // 'BigCommerce_Server_to_Server_Cart_API.oas2.yml',
-})
-
-async function writeDefinitions() {
- const ops = schemas.map(async ([dest, filename]) => {
- const destination = path.join(__dirname, dest)
- const schema = await getSchema(filename)
- const definition = swaggerToTS(schema.content, {
- prettierConfig: 'package.json',
- })
-
- await promises.writeFile(destination, definition)
-
- console.log(`âď¸ Added definitions for: ${dest}`)
- })
-
- await Promise.all(ops)
-}
-
-writeDefinitions()
diff --git a/packages/bigcommerce/src/api/definitions/catalog.ts b/packages/bigcommerce/src/api/definitions/catalog.ts
deleted file mode 100644
index 2c483f781..000000000
--- a/packages/bigcommerce/src/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/packages/bigcommerce/src/api/definitions/store-content.ts b/packages/bigcommerce/src/api/definitions/store-content.ts
deleted file mode 100644
index f00c28844..000000000
--- a/packages/bigcommerce/src/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: /.
- */
- name?: string
- /**
- * a negative or positive number, identifying the offset from UTC/GMT, in seconds, during winter/standard time.
- */
- raw_offset?: number
- /**
- * "-/+" offset from UTC/GMT, in seconds, during summer/daylight saving time.
- */
- dst_offset?: number
- /**
- * a boolean indicating whether this time zone observes daylight saving time.
- */
- dst_correction?: boolean
- date_format?: definitions['dateFormat']
- }
- count_Response: { count?: number }
- dateFormat: {
- /**
- * string that defines datesâ display format, in the pattern: M jS Y
- */
- display?: string
- /**
- * string that defines the CSV export format for orders, customers, and products, in the pattern: M jS Y
- */
- export?: string
- /**
- * string that defines datesâ extended-display format, in the pattern: M jS Y @ g:i A.
- */
- extended_display?: string
- }
- blogTags: { tag?: string; post_ids?: number[] }[]
- blogPost_Base: {
- /**
- * Title of this blog post.
- */
- title: string
- /**
- * URL for the public blog post.
- */
- url?: string
- /**
- * URL to preview the blog post. (READ-ONLY)
- */
- preview_url?: string
- /**
- * Text body of the blog post.
- */
- body: string
- /**
- * Tags to characterize the blog post.
- */
- tags?: string[]
- /**
- * Summary of the blog post. (READ-ONLY)
- */
- summary?: string
- /**
- * Whether the blog post is published.
- */
- is_published?: boolean
- published_date?: definitions['publishedDate']
- /**
- * Published date in `ISO 8601` format.
- */
- published_date_iso8601?: string
- /**
- * Description text for this blog postâs `` element.
- */
- meta_description?: string
- /**
- * Keywords for this blog postâs `` element.
- */
- meta_keywords?: string
- /**
- * Name of the blog postâs author.
- */
- author?: string
- /**
- * Local path to a thumbnail uploaded to `product_images/` via [WebDav](https://support.bigcommerce.com/s/article/File-Access-WebDAV).
- */
- thumbnail_path?: string
- }
- publishedDate: { timezone_type?: string; date?: string; timezone?: string }
- /**
- * 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
- }
- customer_Base: { [key: string]: any }
- page_Base: {
- /**
- * ID of any parent Web page.
- */
- parent_id?: number
- /**
- * `page`: free-text page
- * `link`: link to another web address
- * `rss_feed`: syndicated content from an RSS feed
- * `contact_form`: When the store's contact form is used.
- */
- type: 'page' | 'rss_feed' | 'contact_form' | 'raw' | 'link'
- /**
- * Where the pageâs type is a contact form: object whose members are the fields enabled (in the control panel) for storefront display. Possible members are:`fullname`: full name of the customer submitting the form; `phone`: customerâs phone number, as submitted on the form; `companyname`: customerâs submitted company name; `orderno`: customerâs submitted order number; `rma`: customerâs submitted RMA (Return Merchandise Authorization) number.
- */
- contact_fields?: string
- /**
- * Where the pageâs type is a contact form: email address that receives messages sent via the form.
- */
- email?: string
- /**
- * Page name, as displayed on the storefront.
- */
- name: string
- /**
- * Relative URL on the storefront for this page.
- */
- url?: string
- /**
- * Description contained within this pageâs `` element.
- */
- meta_description?: string
- /**
- * HTML or variable that populates this pageâs `` element, in default/desktop view. Required in POST if page type is `raw`.
- */
- body: string
- /**
- * HTML to use for this page's body when viewed in the mobile template (deprecated).
- */
- mobile_body?: string
- /**
- * If true, this page has a mobile version.
- */
- has_mobile_version?: boolean
- /**
- * If true, this page appears in the storefrontâs navigation menu.
- */
- is_visible?: boolean
- /**
- * If true, this page is the storefrontâs home page.
- */
- is_homepage?: boolean
- /**
- * Text specified for this pageâs `` element. (If empty, the value of the name property is used.)
- */
- meta_title?: string
- /**
- * Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
- */
- layout_file?: string
- /**
- * Order in which this page should display on the storefront. (Lower integers specify earlier display.)
- */
- sort_order?: number
- /**
- * Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
- */
- search_keywords?: string
- /**
- * Comma-separated list of SEO-relevant keywords to include in the pageâs `<meta/>` element.
- */
- meta_keywords?: string
- /**
- * If page type is `rss_feed` the n this field is visisble. Required in POST required for `rss page` type.
- */
- feed: string
- /**
- * If page type is `link` this field is returned. Required in POST to create a `link` page.
- */
- link: string
- content_type?: 'application/json' | 'text/javascript' | 'text/html'
- }
-}
diff --git a/packages/bigcommerce/src/api/definitions/wishlist.ts b/packages/bigcommerce/src/api/definitions/wishlist.ts
deleted file mode 100644
index 6ec21c103..000000000
--- a/packages/bigcommerce/src/api/definitions/wishlist.ts
+++ /dev/null
@@ -1,142 +0,0 @@
-/**
- * This file was auto-generated by swagger-to-ts.
- * Do not make direct changes to the file.
- */
-
-export interface definitions {
- wishlist_Post: {
- /**
- * The customer id.
- */
- customer_id: number
- /**
- * Whether the wishlist is available to the public.
- */
- is_public?: boolean
- /**
- * The title of the wishlist.
- */
- name?: string
- /**
- * Array of Wishlist items.
- */
- items?: {
- /**
- * The ID of the product.
- */
- product_id?: number
- /**
- * The variant ID of the product.
- */
- variant_id?: number
- }[]
- }
- wishlist_Put: {
- /**
- * The customer id.
- */
- customer_id: number
- /**
- * Whether the wishlist is available to the public.
- */
- is_public?: boolean
- /**
- * The title of the wishlist.
- */
- name?: string
- /**
- * Array of Wishlist items.
- */
- items?: {
- /**
- * The ID of the item
- */
- id?: number
- /**
- * The ID of the product.
- */
- product_id?: number
- /**
- * The variant ID of the item.
- */
- variant_id?: number
- }[]
- }
- wishlist_Full: {
- /**
- * Wishlist ID, provided after creating a wishlist with a POST.
- */
- id?: number
- /**
- * The ID the customer to which the wishlist belongs.
- */
- customer_id?: number
- /**
- * The Wishlist's name.
- */
- name?: string
- /**
- * Whether the Wishlist is available to the public.
- */
- is_public?: boolean
- /**
- * The token of the Wishlist. This is created internally within BigCommerce. The Wishlist ID is to be used for external apps. Read-Only
- */
- token?: string
- /**
- * Array of Wishlist items
- */
- items?: definitions['wishlistItem_Full'][]
- }
- wishlistItem_Full: {
- /**
- * The ID of the item
- */
- id?: number
- /**
- * The ID of the product.
- */
- product_id?: number
- /**
- * The variant ID of the item.
- */
- variant_id?: number
- }
- wishlistItem_Post: {
- /**
- * The ID of the product.
- */
- product_id?: number
- /**
- * The variant ID of the product.
- */
- variant_id?: number
- }
- /**
- * Data about the response, including pagination and collection totals.
- */
- pagination: {
- /**
- * 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
- }
- error: { status?: number; title?: string; type?: string }
- metaCollection: { pagination?: definitions['pagination'] }
-}
diff --git a/packages/bigcommerce/src/api/endpoints/cart/add-item.ts b/packages/bigcommerce/src/api/endpoints/cart/add-item.ts
deleted file mode 100644
index d2bb7ad6d..000000000
--- a/packages/bigcommerce/src/api/endpoints/cart/add-item.ts
+++ /dev/null
@@ -1,46 +0,0 @@
-import { normalizeCart } from '../../../lib/normalize'
-import { parseCartItem } from '../../utils/parse-item'
-import getCartCookie from '../../utils/get-cart-cookie'
-import type { CartEndpoint } from '.'
-
-const addItem: CartEndpoint['handlers']['addItem'] = async ({
- res,
- body: { cartId, item },
- config,
-}) => {
- if (!item) {
- return res.status(400).json({
- data: null,
- errors: [{ message: 'Missing item' }],
- })
- }
- if (!item.quantity) item.quantity = 1
-
- const options = {
- method: 'POST',
- body: JSON.stringify({
- line_items: [parseCartItem(item)],
- ...(!cartId && config.storeChannelId
- ? { channel_id: config.storeChannelId }
- : {}),
- }),
- }
- const { data } = cartId
- ? await config.storeApiFetch(
- `/v3/carts/${cartId}/items?include=line_items.physical_items.options,line_items.digital_items.options`,
- options
- )
- : await config.storeApiFetch(
- '/v3/carts?include=line_items.physical_items.options,line_items.digital_items.options',
- options
- )
-
- // Create or update the cart cookie
- res.setHeader(
- 'Set-Cookie',
- getCartCookie(config.cartCookie, data.id, config.cartCookieMaxAge)
- )
- res.status(200).json({ data: normalizeCart(data) })
-}
-
-export default addItem
diff --git a/packages/bigcommerce/src/api/endpoints/cart/get-cart.ts b/packages/bigcommerce/src/api/endpoints/cart/get-cart.ts
deleted file mode 100644
index b6a7d88e9..000000000
--- a/packages/bigcommerce/src/api/endpoints/cart/get-cart.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-import { normalizeCart } from '../../../lib/normalize'
-import { BigcommerceApiError } from '../../utils/errors'
-import getCartCookie from '../../utils/get-cart-cookie'
-import type { BigcommerceCart } from '../../../types/cart'
-import type { CartEndpoint } from '.'
-
-// Return current cart info
-const getCart: CartEndpoint['handlers']['getCart'] = async ({
- res,
- body: { cartId },
- config,
-}) => {
- let result: { data?: BigcommerceCart } = {}
-
- if (cartId) {
- try {
- result = await config.storeApiFetch(
- `/v3/carts/${cartId}?include=line_items.physical_items.options,line_items.digital_items.options`
- )
- } catch (error) {
- if (error instanceof BigcommerceApiError && error.status === 404) {
- // Remove the cookie if it exists but the cart wasn't found
- res.setHeader('Set-Cookie', getCartCookie(config.cartCookie))
- } else {
- throw error
- }
- }
- }
-
- res.status(200).json({
- data: result.data ? normalizeCart(result.data) : null,
- })
-}
-
-export default getCart
diff --git a/packages/bigcommerce/src/api/endpoints/cart/index.ts b/packages/bigcommerce/src/api/endpoints/cart/index.ts
deleted file mode 100644
index 376651178..000000000
--- a/packages/bigcommerce/src/api/endpoints/cart/index.ts
+++ /dev/null
@@ -1,26 +0,0 @@
-import { GetAPISchema, createEndpoint } from '@vercel/commerce/api'
-import cartEndpoint from '@vercel/commerce/api/endpoints/cart'
-import type { CartSchema } from '../../../types/cart'
-import type { BigcommerceAPI } from '../..'
-import getCart from './get-cart'
-import addItem from './add-item'
-import updateItem from './update-item'
-import removeItem from './remove-item'
-
-export type CartAPI = GetAPISchema<BigcommerceAPI, CartSchema>
-
-export type CartEndpoint = CartAPI['endpoint']
-
-export const handlers: CartEndpoint['handlers'] = {
- getCart,
- addItem,
- updateItem,
- removeItem,
-}
-
-const cartApi = createEndpoint<CartAPI>({
- handler: cartEndpoint,
- handlers,
-})
-
-export default cartApi
diff --git a/packages/bigcommerce/src/api/endpoints/cart/remove-item.ts b/packages/bigcommerce/src/api/endpoints/cart/remove-item.ts
deleted file mode 100644
index baf10c80f..000000000
--- a/packages/bigcommerce/src/api/endpoints/cart/remove-item.ts
+++ /dev/null
@@ -1,34 +0,0 @@
-import { normalizeCart } from '../../../lib/normalize'
-import getCartCookie from '../../utils/get-cart-cookie'
-import type { CartEndpoint } from '.'
-
-const removeItem: CartEndpoint['handlers']['removeItem'] = async ({
- res,
- body: { cartId, itemId },
- config,
-}) => {
- if (!cartId || !itemId) {
- return res.status(400).json({
- data: null,
- errors: [{ message: 'Invalid request' }],
- })
- }
-
- const result = await config.storeApiFetch<{ data: any } | null>(
- `/v3/carts/${cartId}/items/${itemId}?include=line_items.physical_items.options`,
- { method: 'DELETE' }
- )
- const data = result?.data ?? null
-
- res.setHeader(
- 'Set-Cookie',
- data
- ? // Update the cart cookie
- getCartCookie(config.cartCookie, cartId, config.cartCookieMaxAge)
- : // Remove the cart cookie if the cart was removed (empty items)
- getCartCookie(config.cartCookie)
- )
- res.status(200).json({ data: data && normalizeCart(data) })
-}
-
-export default removeItem
diff --git a/packages/bigcommerce/src/api/endpoints/cart/update-item.ts b/packages/bigcommerce/src/api/endpoints/cart/update-item.ts
deleted file mode 100644
index 113553fad..000000000
--- a/packages/bigcommerce/src/api/endpoints/cart/update-item.ts
+++ /dev/null
@@ -1,36 +0,0 @@
-import { normalizeCart } from '../../../lib/normalize'
-import { parseCartItem } from '../../utils/parse-item'
-import getCartCookie from '../../utils/get-cart-cookie'
-import type { CartEndpoint } from '.'
-
-const updateItem: CartEndpoint['handlers']['updateItem'] = async ({
- res,
- body: { cartId, itemId, item },
- config,
-}) => {
- if (!cartId || !itemId || !item) {
- return res.status(400).json({
- data: null,
- errors: [{ message: 'Invalid request' }],
- })
- }
-
- const { data } = await config.storeApiFetch(
- `/v3/carts/${cartId}/items/${itemId}?include=line_items.physical_items.options`,
- {
- method: 'PUT',
- body: JSON.stringify({
- line_item: parseCartItem(item),
- }),
- }
- )
-
- // Update the cart cookie
- res.setHeader(
- 'Set-Cookie',
- getCartCookie(config.cartCookie, cartId, config.cartCookieMaxAge)
- )
- res.status(200).json({ data: normalizeCart(data) })
-}
-
-export default updateItem
diff --git a/packages/bigcommerce/src/api/endpoints/catalog/products/get-products.ts b/packages/bigcommerce/src/api/endpoints/catalog/products/get-products.ts
deleted file mode 100644
index f88a231e1..000000000
--- a/packages/bigcommerce/src/api/endpoints/catalog/products/get-products.ts
+++ /dev/null
@@ -1,79 +0,0 @@
-import { Product } from '@vercel/commerce/types/product'
-import { ProductsEndpoint } from '.'
-
-const SORT: { [key: string]: string | undefined } = {
- latest: 'id',
- trending: 'total_sold',
- price: 'price',
-}
-
-const LIMIT = 12
-
-// Return current cart info
-const getProducts: ProductsEndpoint['handlers']['getProducts'] = async ({
- res,
- body: { search, categoryId, brandId, sort },
- config,
- commerce,
-}) => {
- // Use a dummy base as we only care about the relative path
- const url = new URL('/v3/catalog/products', 'http://a')
-
- url.searchParams.set('is_visible', 'true')
- url.searchParams.set('limit', String(LIMIT))
-
- if (search) url.searchParams.set('keyword', search)
-
- if (categoryId && Number.isInteger(Number(categoryId)))
- url.searchParams.set('categories:in', String(categoryId))
-
- if (brandId && Number.isInteger(Number(brandId)))
- url.searchParams.set('brand_id', String(brandId))
-
- if (sort) {
- const [_sort, direction] = sort.split('-')
- const sortValue = SORT[_sort]
-
- if (sortValue && direction) {
- url.searchParams.set('sort', sortValue)
- url.searchParams.set('direction', direction)
- }
- }
-
- // We only want the id of each product
- url.searchParams.set('include_fields', 'id')
-
- const { data } = await config.storeApiFetch<{ data: { id: number }[] }>(
- url.pathname + url.search
- )
-
- const ids = data.map((p) => String(p.id))
- const found = ids.length > 0
-
- // We want the GraphQL version of each product
- const graphqlData = await commerce.getAllProducts({
- variables: { first: LIMIT, ids },
- config,
- })
-
- // Put the products in an object that we can use to get them by id
- const productsById = graphqlData.products.reduce<{
- [k: string]: Product
- }>((prods, p) => {
- prods[Number(p.id)] = p
- return prods
- }, {})
-
- const products: Product[] = found ? [] : graphqlData.products
-
- // Populate the products array with the graphql products, in the order
- // assigned by the list of entity ids
- ids.forEach((id) => {
- const product = productsById[id]
- if (product) products.push(product)
- })
-
- res.status(200).json({ data: { products, found } })
-}
-
-export default getProducts
diff --git a/packages/bigcommerce/src/api/endpoints/catalog/products/index.ts b/packages/bigcommerce/src/api/endpoints/catalog/products/index.ts
deleted file mode 100644
index 24472434d..000000000
--- a/packages/bigcommerce/src/api/endpoints/catalog/products/index.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-import { GetAPISchema, createEndpoint } from '@vercel/commerce/api'
-import productsEndpoint from '@vercel/commerce/api/endpoints/catalog/products'
-import type { ProductsSchema } from '../../../../types/product'
-import type { BigcommerceAPI } from '../../..'
-import getProducts from './get-products'
-
-export type ProductsAPI = GetAPISchema<BigcommerceAPI, ProductsSchema>
-
-export type ProductsEndpoint = ProductsAPI['endpoint']
-
-export const handlers: ProductsEndpoint['handlers'] = { getProducts }
-
-const productsApi = createEndpoint<ProductsAPI>({
- handler: productsEndpoint,
- handlers,
-})
-
-export default productsApi
diff --git a/packages/bigcommerce/src/api/endpoints/checkout/get-checkout.ts b/packages/bigcommerce/src/api/endpoints/checkout/get-checkout.ts
deleted file mode 100644
index e98e6ca54..000000000
--- a/packages/bigcommerce/src/api/endpoints/checkout/get-checkout.ts
+++ /dev/null
@@ -1,90 +0,0 @@
-import type { CheckoutEndpoint } from '.'
-import getCustomerId from '../../utils/get-customer-id'
-import jwt from 'jsonwebtoken'
-import { uuid } from 'uuidv4'
-
-const fullCheckout = true
-
-const getCheckout: CheckoutEndpoint['handlers']['getCheckout'] = async ({
- req,
- res,
- config,
-}) => {
- const { cookies } = req
- const cartId = cookies[config.cartCookie]
- const customerToken = cookies[config.customerCookie]
- if (!cartId) {
- res.redirect('/cart')
- return
- }
- const { data } = await config.storeApiFetch(
- `/v3/carts/${cartId}/redirect_urls`,
- {
- method: 'POST',
- }
- )
- const customerId =
- customerToken && (await getCustomerId({ customerToken, config }))
-
- //if there is a customer create a jwt token
- if (!customerId) {
- if (fullCheckout) {
- res.redirect(data.checkout_url)
- return
- }
- } else {
- const dateCreated = Math.round(new Date().getTime() / 1000)
- const payload = {
- iss: config.storeApiClientId,
- iat: dateCreated,
- jti: uuid(),
- operation: 'customer_login',
- store_hash: config.storeHash,
- customer_id: customerId,
- channel_id: config.storeChannelId,
- redirect_to: data.checkout_url.replace(config.storeUrl, ""),
- }
- let token = jwt.sign(payload, config.storeApiClientSecret!, {
- algorithm: 'HS256',
- })
- let checkouturl = `${config.storeUrl}/login/token/${token}`
- console.log('checkouturl', checkouturl)
- if (fullCheckout) {
- res.redirect(checkouturl)
- return
- }
- }
-
- // TODO: make the embedded checkout work too!
- const html = `
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="UTF-8">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Checkout
-
-
-
-
-
-
-